Ruby  2.5.0dev(2017-10-22revision60238)
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
dir.c File Reference
#include "internal.h"
#include "encindex.h"
#include "ruby/thread.h"
#include <sys/types.h>
#include <sys/stat.h>
#include <errno.h>
#include <ctype.h>
#include "ruby/util.h"

Go to the source code of this file.

Data Structures

struct  dir_data
 
struct  chdir_data
 
struct  warning_args
 
struct  ruby_glob_funcs_t
 
struct  glob_pattern
 
struct  glob_args
 
struct  glob_error_args
 
struct  brace_args
 
struct  push_glob_args
 

Macros

#define USE_OPENDIR_AT   0
 
#define AT_FDCWD   -1
 
#define dirent   direct
 
#define NAMLEN(dirent)   (dirent)->d_namlen
 
#define HAVE_DIRENT_NAMLEN   1
 
#define IS_WIN32   0
 
#define USE_NAME_ON_FS_REAL_BASENAME
 
#define USE_NAME_ON_FS_BY_FNMATCH
 
#define USE_NAME_ON_FS   0
 
#define NORMALIZE_UTF8PATH   0
 
#define IF_NORMALIZE_UTF8PATH(something)   /* nothing */
 
#define IFTODT(m)   (((m) & S_IFMT) / ((~S_IFMT & S_IFMT-1) + 1))
 
#define FNM_NOESCAPE   0x01
 
#define FNM_PATHNAME   0x02
 
#define FNM_DOTMATCH   0x04
 
#define FNM_CASEFOLD   0x08
 
#define FNM_EXTGLOB   0x10
 
#define FNM_SYSCASE   0
 
#define FNM_SHORTNAME   0
 
#define FNM_NOMATCH   1
 
#define FNM_ERROR   2
 
#define Next(p, e, enc)   ((p)+ rb_enc_mbclen((p), (e), (enc)))
 
#define Inc(p, e, enc)   ((p) = Next((p), (e), (enc)))
 
#define UNESCAPE(p)   (escape && *(p) == '\\' ? (p) + 1 : (p))
 
#define ISEND(p)   (!*(p) || (pathname && *(p) == '/'))
 
#define RETURN(val)   return *pcur = p, *scur = s, (val);
 
#define GlobPathValue(str, safe)
 
#define check_safe_glob(str, safe)   ((safe) ? rb_check_safe_obj(str) : (void)0)
 
#define check_glob_encoding(str)   rb_enc_check((str), rb_enc_from_encoding(rb_usascii_encoding()))
 
#define GetDIR(obj, dirp)   ((dirp) = dir_check(obj))
 
#define dir_fileno   rb_f_notimplement
 
#define READDIR(dir, enc)   readdir((dir))
 
#define dir_tell   rb_f_notimplement
 
#define dir_seek   rb_f_notimplement
 
#define dir_set_pos   rb_f_notimplement
 
#define RUBY_UNTYPED_DATA_WARNING   0
 
#define dir_s_chroot   rb_f_notimplement
 
#define sys_enc_warning_in(func, mesg, enc)   sys_enc_warning(mesg, enc)
 
#define GLOB_VERBOSE   (1U << (sizeof(int) * CHAR_BIT - 1))
 
#define sys_warning(val, enc)   ((flags & GLOB_VERBOSE) ? sys_enc_warning_in(RUBY_FUNCTION_NAME_STRING, (val), (enc)) :(void)0)
 
#define GLOB_ALLOC(type)   ((type *)malloc(sizeof(type)))
 
#define GLOB_ALLOC_N(type, n)   ((type *)malloc(sizeof(type) * (n)))
 
#define GLOB_REALLOC(ptr, size)   realloc((ptr), (size))
 
#define GLOB_FREE(ptr)   free(ptr)
 
#define GLOB_JUMP_TAG(status)   (((status) == -1) ? rb_memerror() : rb_jump_tag(status))
 
#define STAT(p, s)   stat((p), (s))
 
#define do_lstat   do_stat
 
#define S_ISDIR(m)   (((m) & S_IFMT) == S_IFDIR)
 
#define S_ISLNK(m)   (0)
 
#define glob_call_func(func, path, arg, enc)   (*(func))((path), (arg), (void *)(enc))
 

Typedefs

typedef int ruby_glob_errfunc(const char *, VALUE, const void *, int)
 

Enumerations

enum  rb_pathtype_t {
  path_exist, path_directory = IFTODT(S_IFDIR), path_regular = IFTODT(S_IFREG), path_symlink = IFTODT(S_IFLNK),
  path_noent = -1, path_unknown = -2
}
 
enum  glob_pattern_type {
  PLAIN, ALPHA, MAGICAL, RECURSIVE,
  MATCH_ALL, MATCH_DIR
}
 

Functions

char * getenv ()
 
char * strchr (char *, char)
 
VALUE rb_dir_getwd_ospath (void)
 
VALUE rb_dir_getwd (void)
 
 ALWAYS_INLINE (static int to_be_ignored(int e))
 
int ruby_glob (const char *path, int flags, ruby_glob_func *func, VALUE arg)
 
void rb_glob (const char *path, void(*func)(const char *, VALUE, void *), VALUE arg)
 
int ruby_brace_glob_with_enc (const char *str, int flags, ruby_glob_func *func, VALUE arg, rb_encoding *enc)
 
int ruby_brace_glob (const char *str, int flags, ruby_glob_func *func, VALUE arg)
 
void Init_Dir (void)
 

Variables

VALUE rb_cDir
 

Macro Definition Documentation

◆ AT_FDCWD

#define AT_FDCWD   -1

Definition at line 37 of file dir.c.

◆ check_glob_encoding

#define check_glob_encoding (   str)    rb_enc_check((str), rb_enc_from_encoding(rb_usascii_encoding()))

Definition at line 482 of file dir.c.

◆ check_safe_glob

#define check_safe_glob (   str,
  safe 
)    ((safe) ? rb_check_safe_obj(str) : (void)0)

Definition at line 481 of file dir.c.

◆ dir_fileno

#define dir_fileno   rb_f_notimplement

Definition at line 686 of file dir.c.

◆ dir_s_chroot

#define dir_s_chroot   rb_f_notimplement

Definition at line 1191 of file dir.c.

◆ dir_seek

#define dir_seek   rb_f_notimplement

Definition at line 902 of file dir.c.

◆ dir_set_pos

#define dir_set_pos   rb_f_notimplement

Definition at line 927 of file dir.c.

◆ dir_tell

#define dir_tell   rb_f_notimplement

Definition at line 873 of file dir.c.

◆ dirent

#define dirent   direct

Definition at line 48 of file dir.c.

◆ do_lstat

#define do_lstat   do_stat

Definition at line 1349 of file dir.c.

◆ FNM_CASEFOLD

#define FNM_CASEFOLD   0x08

Definition at line 198 of file dir.c.

◆ FNM_DOTMATCH

#define FNM_DOTMATCH   0x04

Definition at line 197 of file dir.c.

◆ FNM_ERROR

#define FNM_ERROR   2

Definition at line 212 of file dir.c.

◆ FNM_EXTGLOB

#define FNM_EXTGLOB   0x10

Definition at line 199 of file dir.c.

◆ FNM_NOESCAPE

#define FNM_NOESCAPE   0x01

Definition at line 195 of file dir.c.

◆ FNM_NOMATCH

#define FNM_NOMATCH   1

Definition at line 211 of file dir.c.

◆ FNM_PATHNAME

#define FNM_PATHNAME   0x02

Definition at line 196 of file dir.c.

◆ FNM_SHORTNAME

#define FNM_SHORTNAME   0

Definition at line 208 of file dir.c.

◆ FNM_SYSCASE

#define FNM_SYSCASE   0

Definition at line 203 of file dir.c.

◆ GetDIR

#define GetDIR (   obj,
  dirp 
)    ((dirp) = dir_check(obj))

Definition at line 619 of file dir.c.

◆ GLOB_ALLOC

#define GLOB_ALLOC (   type)    ((type *)malloc(sizeof(type)))

Definition at line 1288 of file dir.c.

◆ GLOB_ALLOC_N

#define GLOB_ALLOC_N (   type,
 
)    ((type *)malloc(sizeof(type) * (n)))

Definition at line 1289 of file dir.c.

◆ glob_call_func

#define glob_call_func (   func,
  path,
  arg,
  enc 
)    (*(func))((path), (arg), (void *)(enc))

Definition at line 1803 of file dir.c.

◆ GLOB_FREE

#define GLOB_FREE (   ptr)    free(ptr)

Definition at line 1291 of file dir.c.

◆ GLOB_JUMP_TAG

#define GLOB_JUMP_TAG (   status)    (((status) == -1) ? rb_memerror() : rb_jump_tag(status))

Definition at line 1292 of file dir.c.

◆ GLOB_REALLOC

#define GLOB_REALLOC (   ptr,
  size 
)    realloc((ptr), (size))

Definition at line 1290 of file dir.c.

◆ GLOB_VERBOSE

#define GLOB_VERBOSE   (1U << (sizeof(int) * CHAR_BIT - 1))

Definition at line 1284 of file dir.c.

Referenced by ruby_brace_glob_with_enc().

◆ GlobPathValue

#define GlobPathValue (   str,
  safe 
)
Value:
/* can contain null bytes as separators */ \
(!RB_TYPE_P((str), T_STRING) ? \
(void)FilePathValue(str) : \
(void)(check_safe_glob((str), (safe)), \
check_glob_encoding(str), (str)))
#define FilePathValue(v)
Definition: ruby.h:594
#define RB_TYPE_P(obj, type)
Definition: ruby.h:527
#define T_STRING
Definition: ruby.h:496
#define check_safe_glob(str, safe)
Definition: dir.c:481

Definition at line 475 of file dir.c.

◆ HAVE_DIRENT_NAMLEN

#define HAVE_DIRENT_NAMLEN   1

Definition at line 50 of file dir.c.

◆ IF_NORMALIZE_UTF8PATH

#define IF_NORMALIZE_UTF8PATH (   something)    /* nothing */

Definition at line 172 of file dir.c.

◆ IFTODT

#define IFTODT (   m)    (((m) & S_IFMT) / ((~S_IFMT & S_IFMT-1) + 1))

Definition at line 176 of file dir.c.

◆ Inc

#define Inc (   p,
  e,
  enc 
)    ((p) = Next((p), (e), (enc)))

Definition at line 215 of file dir.c.

◆ IS_WIN32

#define IS_WIN32   0

Definition at line 96 of file dir.c.

◆ ISEND

#define ISEND (   p)    (!*(p) || (pathname && *(p) == '/'))

Definition at line 292 of file dir.c.

◆ NAMLEN

#define NAMLEN (   dirent)    (dirent)->d_namlen

Definition at line 49 of file dir.c.

◆ Next

#define Next (   p,
  e,
  enc 
)    ((p)+ rb_enc_mbclen((p), (e), (enc)))

Definition at line 214 of file dir.c.

◆ NORMALIZE_UTF8PATH

#define NORMALIZE_UTF8PATH   0

Definition at line 123 of file dir.c.

◆ READDIR

#define READDIR (   dir,
  enc 
)    readdir((dir))

Definition at line 724 of file dir.c.

◆ RETURN

#define RETURN (   val)    return *pcur = p, *scur = s, (val);

Definition at line 293 of file dir.c.

◆ RUBY_UNTYPED_DATA_WARNING

#define RUBY_UNTYPED_DATA_WARNING   0

◆ S_ISDIR

#define S_ISDIR (   m)    (((m) & S_IFMT) == S_IFDIR)

Definition at line 1783 of file dir.c.

◆ S_ISLNK

#define S_ISLNK (   m)    (0)

Definition at line 1788 of file dir.c.

◆ STAT

#define STAT (   p,
 
)    stat((p), (s))

Definition at line 1310 of file dir.c.

◆ sys_enc_warning_in

#define sys_enc_warning_in (   func,
  mesg,
  enc 
)    sys_enc_warning(mesg, enc)

Definition at line 1257 of file dir.c.

◆ sys_warning

#define sys_warning (   val,
  enc 
)    ((flags & GLOB_VERBOSE) ? sys_enc_warning_in(RUBY_FUNCTION_NAME_STRING, (val), (enc)) :(void)0)

Definition at line 1285 of file dir.c.

◆ UNESCAPE

#define UNESCAPE (   p)    (escape && *(p) == '\\' ? (p) + 1 : (p))

Definition at line 291 of file dir.c.

◆ USE_NAME_ON_FS

#define USE_NAME_ON_FS   0

Definition at line 117 of file dir.c.

◆ USE_NAME_ON_FS_BY_FNMATCH

#define USE_NAME_ON_FS_BY_FNMATCH
Value:
2 /* select the matching
* basename by fnmatch */

Definition at line 105 of file dir.c.

◆ USE_NAME_ON_FS_REAL_BASENAME

#define USE_NAME_ON_FS_REAL_BASENAME
Value:
1 /* platform dependent APIs to
* get real basenames */

Definition at line 103 of file dir.c.

◆ USE_OPENDIR_AT

#define USE_OPENDIR_AT   0

Definition at line 30 of file dir.c.

Typedef Documentation

◆ ruby_glob_errfunc

typedef int ruby_glob_errfunc(const char *, VALUE, const void *, int)

Definition at line 1313 of file dir.c.

Enumeration Type Documentation

◆ glob_pattern_type

Enumerator
PLAIN 
ALPHA 
MAGICAL 
RECURSIVE 
MATCH_ALL 
MATCH_DIR 

Definition at line 1414 of file dir.c.

◆ rb_pathtype_t

Enumerator
path_exist 
path_directory 
path_regular 
path_symlink 
path_noent 
path_unknown 

Definition at line 179 of file dir.c.

Function Documentation

◆ ALWAYS_INLINE()

ALWAYS_INLINE ( static int   to_be_ignoredint e)

◆ getenv()

char* getenv ( )

◆ Init_Dir()

void Init_Dir ( void  )

◆ rb_dir_getwd()

VALUE rb_dir_getwd ( void  )

◆ rb_dir_getwd_ospath()

VALUE rb_dir_getwd_ospath ( void  )

Definition at line 1089 of file dir.c.

Referenced by rb_dir_getwd().

◆ rb_glob()

void rb_glob ( const char *  path,
void(*)(const char *, VALUE, void *)  func,
VALUE  arg 
)

Definition at line 2250 of file dir.c.

References glob_args::enc, glob_args::func, rb_ascii8bit_encoding(), and glob_args::value.

◆ ruby_brace_glob()

int ruby_brace_glob ( const char *  str,
int  flags,
ruby_glob_func func,
VALUE  arg 
)

Definition at line 2366 of file dir.c.

References rb_ascii8bit_encoding(), and ruby_brace_glob_with_enc().

◆ ruby_brace_glob_with_enc()

int ruby_brace_glob_with_enc ( const char *  str,
int  flags,
ruby_glob_func func,
VALUE  arg,
rb_encoding enc 
)

◆ ruby_glob()

int ruby_glob ( const char *  path,
int  flags,
ruby_glob_func func,
VALUE  arg 
)

Definition at line 2225 of file dir.c.

References ruby_glob_funcs_t::error, ruby_glob_funcs_t::match, and NULL.

◆ strchr()

char* strchr ( char *  ,
char   
)

Variable Documentation

◆ rb_cDir

VALUE rb_cDir

Definition at line 437 of file dir.c.

Referenced by Init_Dir().