[perl5.git] / ext / File-Glob / bsd_glob.h

/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Guido van Rossum.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)glob.h	8.1 (Berkeley) 6/2/93
 *	[lots of perl-specific changes since then--see bsd_glob.c]
 */

#ifndef _BSD_GLOB_H_
#define	_BSD_GLOB_H_

/* #include <sys/cdefs.h> */

typedef struct {
	int gl_pathc;		/* Count of total paths so far. */
	int gl_matchc;		/* Count of paths matching pattern. */
	int gl_offs;		/* Reserved at beginning of gl_pathv. */
	int gl_flags;		/* Copy of flags parameter to glob. */
	char **gl_pathv;	/* List of paths matching pattern. */
				/* Copy of errfunc parameter to glob. */
	int (*gl_errfunc)(const char *, int);

	/*
	 * Alternate filesystem access methods for glob; replacement
	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
	 * and lstat(2).
	 */
	void (*gl_closedir)(void *);
	Direntry_t *(*gl_readdir)(void *);
	void *(*gl_opendir)(const char *);
	int (*gl_lstat)(const char *, Stat_t *);
	int (*gl_stat)(const char *, Stat_t *);
} glob_t;

#define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
#define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
#define	GLOB_ERR	0x0004	/* Return on error. */
#define	GLOB_MARK	0x0008	/* Append / to matching directories. */
#define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
#define	GLOB_NOSORT	0x0020	/* Don't sort. */

#define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
#define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
#define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
#define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
#define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
#define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
#define	GLOB_NOCASE	0x1000	/* Treat filenames without regard for case. */
#define	GLOB_ALPHASORT	0x2000	/* Alphabetic, not ASCII sort, like csh. */
#define	GLOB_LIMIT	0x4000	/* Limit pattern match output to ARG_MAX
				   (usually from limits.h). */

#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
#define	GLOB_ABEND	(-2)	/* Unignored error. */

int	bsd_glob(const char *, int, int (*)(const char *, int), glob_t *);
void	bsd_globfree(glob_t *);

#endif /* !_BSD_GLOB_H_ */
Commit	Line	Data
72b16652 GS	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.
0e950d83	16	* 3. Neither the name of the University nor the names of its contributors
72b16652 GS	17	* may be used to endorse or promote products derived from this software
	18	* without specific prior written permission.
	19	*
882ce583	20	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
72b16652 GS	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
bac331f5	33	* [lots of perl-specific changes since then--see bsd_glob.c]
72b16652 GS	34	*/
72b16652 GS	35
72b16652 GS	36	#ifndef _BSD_GLOB_H_
	37	#define _BSD_GLOB_H_
	38
	39	/* #include <sys/cdefs.h> */
	40
	41	typedef struct {
	42	int gl_pathc; /* Count of total paths so far. */
	43	int gl_matchc; /* Count of paths matching pattern. */
	44	int gl_offs; /* Reserved at beginning of gl_pathv. */
	45	int gl_flags; /* Copy of flags parameter to glob. */
	46	char *gl_pathv; / List of paths matching pattern. */
	47	/* Copy of errfunc parameter to glob. */
	48	int (gl_errfunc)(const char , int);
	49
	50	/*
	51	* Alternate filesystem access methods for glob; replacement
	52	* versions of closedir(3), readdir(3), opendir(3), stat(2)
	53	* and lstat(2).
	54	*/
	55	void (gl_closedir)(void );
	56	Direntry_t (gl_readdir)(void *);
	57	void (gl_opendir)(const char *);
	58	int (gl_lstat)(const char , Stat_t *);
	59	int (gl_stat)(const char , Stat_t *);
	60	} glob_t;
	61
	62	#define GLOB_APPEND 0x0001 /* Append to output from previous call. */
	63	#define GLOB_DOOFFS 0x0002 /* Use gl_offs. */
	64	#define GLOB_ERR 0x0004 /* Return on error. */
	65	#define GLOB_MARK 0x0008 /* Append / to matching directories. */
	66	#define GLOB_NOCHECK 0x0010 /* Return pattern itself if nothing matches. */
	67	#define GLOB_NOSORT 0x0020 /* Don't sort. */
	68
	69	#define GLOB_ALTDIRFUNC 0x0040 /* Use alternately specified directory funcs. */
	70	#define GLOB_BRACE 0x0080 /* Expand braces ala csh. */
	71	#define GLOB_MAGCHAR 0x0100 /* Pattern had globbing characters. */
	72	#define GLOB_NOMAGIC 0x0200 /* GLOB_NOCHECK without magic chars (csh). */
	73	#define GLOB_QUOTE 0x0400 /* Quote special chars with \. */
	74	#define GLOB_TILDE 0x0800 /* Expand tilde names from the passwd file. */
220398a0	75	#define GLOB_NOCASE 0x1000 /* Treat filenames without regard for case. */
2d5e9e5d	76	#define GLOB_ALPHASORT 0x2000 /* Alphabetic, not ASCII sort, like csh. */
b8ef571c JH	77	#define GLOB_LIMIT 0x4000 /* Limit pattern match output to ARG_MAX
b8ef571c JH	78	(usually from limits.h). */
72b16652 GS	79
	80	#define GLOB_NOSPACE (-1) /* Malloc call failed. */
	81	#define GLOB_ABEND (-2) /* Unignored error. */
	82
	83	int bsd_glob(const char , int, int ()(const char , int), glob_t );
	84	void bsd_globfree(glob_t *);
	85
	86	#endif /* !_BSD_GLOB_H_ */