include/glob.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1989, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * This code is derived from software contributed to Berkeley by
  27  * Guido van Rossum.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  * 1. Redistributions of source code must retain the above copyright
  33  *    notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  *    notice, this list of conditions and the following disclaimer in the
  36  *    documentation and/or other materials provided with the distribution.
  37  * 3. All advertising materials mentioning features or use of this software
  38  *    must display the following acknowledgement:
  39  *      This product includes software developed by the University of
  40  *      California, Berkeley and its contributors.
  41  * 4. Neither the name of the University nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  *
  57  *      @(#)glob.h      8.1 (Berkeley) 6/2/93
  58  */
  59
  60 #ifndef _GLOB_H_
  61 #define _GLOB_H_
  62
  63 #include <sys/cdefs.h>
  64
  65 struct stat;
  66 typedef struct {
  67         int gl_pathc;           /* Count of total paths so far. */
  68         int gl_matchc;          /* Count of paths matching pattern. */
  69         int gl_offs;            /* Reserved at beginning of gl_pathv. */
  70         int gl_flags;           /* Copy of flags parameter to glob. */
  71         char **gl_pathv;        /* List of paths matching pattern. */
  72                                 /* Copy of errfunc parameter to glob. */
  73         int (*gl_errfunc) __P((const char *, int));
  74
  75         /*
  76          * Alternate filesystem access methods for glob; replacement
  77          * versions of closedir(3), readdir(3), opendir(3), stat(2)
  78          * and lstat(2).
  79          */
  80         void (*gl_closedir) __P((void *));
  81         struct dirent *(*gl_readdir) __P((void *));
  82         void *(*gl_opendir) __P((const char *));
  83         int (*gl_lstat) __P((const char *, struct stat *));
  84         int (*gl_stat) __P((const char *, struct stat *));
  85 } glob_t;
  86
  87 #define GLOB_APPEND     0x0001  /* Append to output from previous call. */
  88 #define GLOB_DOOFFS     0x0002  /* Use gl_offs. */
  89 #define GLOB_ERR        0x0004  /* Return on error. */
  90 #define GLOB_MARK       0x0008  /* Append / to matching directories. */
  91 #define GLOB_NOCHECK    0x0010  /* Return pattern itself if nothing matches. */
  92 #define GLOB_NOSORT     0x0020  /* Don't sort. */
  93
  94 #ifndef _POSIX_SOURCE
  95 #define GLOB_ALTDIRFUNC 0x0040  /* Use alternately specified directory funcs. */
  96 #define GLOB_BRACE      0x0080  /* Expand braces ala csh. */
  97 #define GLOB_MAGCHAR    0x0100  /* Pattern had globbing characters. */
  98 #define GLOB_NOMAGIC    0x0200  /* GLOB_NOCHECK without magic chars (csh). */
  99 #define GLOB_QUOTE      0x0400  /* Quote special chars with \. */
 100 #define GLOB_TILDE      0x0800  /* Expand tilde names from the passwd file. */
 101 #endif
 102
 103 #define GLOB_NOSPACE    (-1)    /* Malloc call failed. */
 104 #define GLOB_ABEND      (-2)    /* Unignored error. */
 105
 106 __BEGIN_DECLS
 107 int     glob __P((const char *, int, int (*)(const char *, int), glob_t *));
 108 void    globfree __P((glob_t *));
 109 __END_DECLS
 110
 111 #endif /* !_GLOB_H_ */