include/glob.h

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