glob.h 6.5 KB

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