glob.h 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. /* Copyright (C) 1991,1992,1995-1998,2000,2001,2004,2010
  2. Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. The GNU C Library is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public
  6. License as published by the Free Software Foundation; either
  7. version 2.1 of the License, or (at your option) any later version.
  8. The GNU C Library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with the GNU C Library; if not, write to the Free
  14. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  15. 02111-1307 USA. */
  16. #ifndef _GLOB_H
  17. #define _GLOB_H 1
  18. #include <sys/cdefs.h>
  19. __BEGIN_DECLS
  20. /* We need `size_t' for the following definitions. */
  21. #ifndef __size_t
  22. # if defined __GNUC__ && __GNUC__ >= 2
  23. typedef __SIZE_TYPE__ __size_t;
  24. # if defined __USE_XOPEN || __USE_XOPEN2K8
  25. typedef __SIZE_TYPE__ size_t;
  26. # endif
  27. # else
  28. # include <stddef.h>
  29. # ifndef __size_t
  30. # define __size_t size_t
  31. # endif
  32. # endif
  33. #else
  34. /* The GNU CC stddef.h version defines __size_t as empty. We need a real
  35. definition. */
  36. # undef __size_t
  37. # define __size_t size_t
  38. #endif
  39. /* Bits set in the FLAGS argument to `glob'. */
  40. #define GLOB_ERR (1 << 0)/* Return on read errors. */
  41. #define GLOB_MARK (1 << 1)/* Append a slash to each name. */
  42. #define GLOB_NOSORT (1 << 2)/* Don't sort the names. */
  43. #define GLOB_DOOFFS (1 << 3)/* Insert PGLOB->gl_offs NULLs. */
  44. #define GLOB_NOCHECK (1 << 4)/* If nothing matches, return the pattern. */
  45. #define GLOB_APPEND (1 << 5)/* Append to results of a previous call. */
  46. #define GLOB_NOESCAPE (1 << 6)/* Backslashes don't quote metacharacters. */
  47. #define GLOB_PERIOD (1 << 7)/* Leading `.' can be matched by metachars. */
  48. #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
  49. # define GLOB_MAGCHAR (1 << 8)/* Set in gl_flags if any metachars seen. */
  50. # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions. */
  51. # define GLOB_BRACE (1 << 10)/* Expand "{a,b}" to "a" "b". */
  52. # define GLOB_NOMAGIC (1 << 11)/* If no magic chars, return the pattern. */
  53. # define GLOB_TILDE (1 << 12)/* Expand ~user and ~ to home directories. */
  54. # define GLOB_ONLYDIR (1 << 13)/* Match only directories. */
  55. # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
  56. if the user name is not available. */
  57. # define __GLOB_FLAGS (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  58. GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND| \
  59. GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE| \
  60. GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
  61. #else
  62. # define __GLOB_FLAGS (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
  63. GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND| \
  64. GLOB_PERIOD)
  65. #endif
  66. /* Error returns from `glob'. */
  67. #define GLOB_NOSPACE 1 /* Ran out of memory. */
  68. #define GLOB_ABORTED 2 /* Read error. */
  69. #define GLOB_NOMATCH 3 /* No matches found. */
  70. #define GLOB_NOSYS 4 /* Not implemented. */
  71. #ifdef __USE_GNU
  72. /* Previous versions of this file defined GLOB_ABEND instead of
  73. GLOB_ABORTED. Provide a compatibility definition here. */
  74. # define GLOB_ABEND GLOB_ABORTED
  75. #endif
  76. /* Structure describing a globbing run. */
  77. #ifdef __USE_GNU
  78. struct stat;
  79. #endif
  80. typedef struct
  81. {
  82. __size_t gl_pathc; /* Count of paths matched by the pattern. */
  83. char **gl_pathv; /* List of matched pathnames. */
  84. __size_t gl_offs; /* Slots to reserve in `gl_pathv'. */
  85. int gl_flags; /* Set to FLAGS, maybe | GLOB_MAGCHAR. */
  86. /* If the GLOB_ALTDIRFUNC flag is set, the following functions
  87. are used instead of the normal file access functions. */
  88. void (*gl_closedir) (void *);
  89. #ifdef __USE_GNU
  90. struct dirent *(*gl_readdir) (void *);
  91. #else
  92. void *(*gl_readdir) (void *);
  93. #endif
  94. void *(*gl_opendir) (__const char *);
  95. #ifdef __USE_GNU
  96. int (*gl_lstat) (__const char *__restrict, struct stat *__restrict);
  97. int (*gl_stat) (__const char *__restrict, struct stat *__restrict);
  98. #else
  99. int (*gl_lstat) (__const char *__restrict, void *__restrict);
  100. int (*gl_stat) (__const char *__restrict, void *__restrict);
  101. #endif
  102. } glob_t;
  103. #ifdef __USE_LARGEFILE64
  104. # ifdef __USE_GNU
  105. struct stat64;
  106. # endif
  107. typedef struct
  108. {
  109. __size_t gl_pathc;
  110. char **gl_pathv;
  111. __size_t gl_offs;
  112. int gl_flags;
  113. /* If the GLOB_ALTDIRFUNC flag is set, the following functions
  114. are used instead of the normal file access functions. */
  115. void (*gl_closedir) (void *);
  116. # ifdef __USE_GNU
  117. struct dirent64 *(*gl_readdir) (void *);
  118. # else
  119. void *(*gl_readdir) (void *);
  120. # endif
  121. void *(*gl_opendir) (__const char *);
  122. # ifdef __USE_GNU
  123. int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
  124. int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
  125. # else
  126. int (*gl_lstat) (__const char *__restrict, void *__restrict);
  127. int (*gl_stat) (__const char *__restrict, void *__restrict);
  128. # endif
  129. } glob64_t;
  130. #endif
  131. #if __USE_FILE_OFFSET64 && __GNUC__ < 2
  132. # define glob glob64
  133. # define globfree globfree64
  134. #endif
  135. /* Do glob searching for PATTERN, placing results in PGLOB.
  136. The bits defined above may be set in FLAGS.
  137. If a directory cannot be opened or read and ERRFUNC is not nil,
  138. it is called with the pathname that caused the error, and the
  139. `errno' value from the failing call; if it returns non-zero
  140. `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
  141. If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
  142. Otherwise, `glob' returns zero. */
  143. #if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2
  144. extern int glob (__const char *__restrict __pattern, int __flags,
  145. int (*__errfunc) (__const char *, int),
  146. glob_t *__restrict __pglob) __THROW;
  147. /* Free storage allocated in PGLOB by a previous `glob' call. */
  148. extern void globfree (glob_t *__pglob) __THROW;
  149. #else
  150. extern int __REDIRECT_NTH (glob, (__const char *__restrict __pattern,
  151. int __flags,
  152. int (*__errfunc) (__const char *, int),
  153. glob_t *__restrict __pglob), glob64);
  154. extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64);
  155. #endif
  156. #ifdef __USE_LARGEFILE64
  157. extern int glob64 (__const char *__restrict __pattern, int __flags,
  158. int (*__errfunc) (__const char *, int),
  159. glob64_t *__restrict __pglob) __THROW;
  160. extern void globfree64 (glob64_t *__pglob) __THROW;
  161. #endif
  162. #ifdef __USE_GNU
  163. /* Return nonzero if PATTERN contains any metacharacters.
  164. Metacharacters can be quoted with backslashes if QUOTE is nonzero.
  165. This function is not part of the interface specified by POSIX.2
  166. but several programs want to use it. */
  167. extern int glob_pattern_p (__const char *__pattern, int __quote) __THROW;
  168. #endif
  169. __END_DECLS
  170. #endif /* glob.h */