include/glob.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Guido van Rossum.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)glob.h      8.1 (Berkeley) 6/2/93
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _GLOB_H_
  39 #define _GLOB_H_
  40
  41 #include <sys/cdefs.h>
  42 #include <sys/_types.h>
  43
  44 #ifndef _SIZE_T_DECLARED
  45 typedef __size_t        size_t;
  46 #define _SIZE_T_DECLARED
  47 #endif
  48
  49 struct stat;
  50 typedef struct {
  51         size_t gl_pathc;        /* Count of total paths so far. */
  52         size_t gl_matchc;       /* Count of paths matching pattern. */
  53         size_t gl_offs;         /* Reserved at beginning of gl_pathv. */
  54         int gl_flags;           /* Copy of flags parameter to glob. */
  55         char **gl_pathv;        /* List of paths matching pattern. */
  56                                 /* Copy of errfunc parameter to glob. */
  57         int (*gl_errfunc)(const char *, int);
  58
  59         /*
  60          * Alternate filesystem access methods for glob; replacement
  61          * versions of closedir(3), readdir(3), opendir(3), stat(2)
  62          * and lstat(2).
  63          */
  64         void (*gl_closedir)(void *);
  65         struct dirent *(*gl_readdir)(void *);
  66         void *(*gl_opendir)(const char *);
  67         int (*gl_lstat)(const char *, struct stat *);
  68         int (*gl_stat)(const char *, struct stat *);
  69 } glob_t;
  70
  71 #if __POSIX_VISIBLE >= 199209
  72 /* Believed to have been introduced in 1003.2-1992 */
  73 #define GLOB_APPEND     0x0001  /* Append to output from previous call. */
  74 #define GLOB_DOOFFS     0x0002  /* Use gl_offs. */
  75 #define GLOB_ERR        0x0004  /* Return on error. */
  76 #define GLOB_MARK       0x0008  /* Append / to matching directories. */
  77 #define GLOB_NOCHECK    0x0010  /* Return pattern itself if nothing matches. */
  78 #define GLOB_NOSORT     0x0020  /* Don't sort. */
  79 #define GLOB_NOESCAPE   0x2000  /* Disable backslash escaping. */
  80
  81 /* Error values returned by glob(3) */
  82 #define GLOB_NOSPACE    (-1)    /* Malloc call failed. */
  83 #define GLOB_ABORTED    (-2)    /* Unignored error. */
  84 #define GLOB_NOMATCH    (-3)    /* No match and GLOB_NOCHECK was not set. */
  85 #define GLOB_NOSYS      (-4)    /* Obsolete: source comptability only. */
  86 #endif /* __POSIX_VISIBLE >= 199209 */
  87
  88 #if __BSD_VISIBLE
  89 #define GLOB_ALTDIRFUNC 0x0040  /* Use alternately specified directory funcs. */
  90 #define GLOB_BRACE      0x0080  /* Expand braces ala csh. */
  91 #define GLOB_MAGCHAR    0x0100  /* Pattern had globbing characters. */
  92 #define GLOB_NOMAGIC    0x0200  /* GLOB_NOCHECK without magic chars (csh). */
  93 #define GLOB_QUOTE      0x0400  /* Quote special chars with \. */
  94 #define GLOB_TILDE      0x0800  /* Expand tilde names from the passwd file. */
  95 #define GLOB_LIMIT      0x1000  /* limit number of returned paths */
  96
  97 /* source compatibility, these are the old names */
  98 #define GLOB_MAXPATH    GLOB_LIMIT
  99 #define GLOB_ABEND      GLOB_ABORTED
 100 #endif /* __BSD_VISIBLE */
 101
 102 __BEGIN_DECLS
 103 int     glob(const char * __restrict, int,
 104         int (*)(const char *, int), glob_t * __restrict);
 105 void    globfree(glob_t *);
 106 __END_DECLS
 107
 108 #endif /* !_GLOB_H_ */