include/glob.h

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