epoc32/include/stdapis/glob.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // glob.h
     2 
     3 
     4 /*
     5  * Copyright (c) 1989, 1993
     6  *	The Regents of the University of California.  All rights reserved.
     7  *
     8  * This code is derived from software contributed to Berkeley by
     9  * Guido van Rossum.
    10  *
    11  * Redistribution and use in source and binary forms, with or without
    12  * modification, are permitted provided that the following conditions
    13  * are met:
    14  * 1. Redistributions of source code must retain the above copyright
    15  *    notice, this list of conditions and the following disclaimer.
    16  * 2. Redistributions in binary form must reproduce the above copyright
    17  *    notice, this list of conditions and the following disclaimer in the
    18  *    documentation and/or other materials provided with the distribution.
    19  * 4. Neither the name of the University nor the names of its contributors
    20  *    may be used to endorse or promote products derived from this software
    21  *    without specific prior written permission.
    22  *
    23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    33  * SUCH DAMAGE.
    34  *
    35  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
    36  * $FreeBSD: src/include/glob.h,v 1.7 2002/07/17 04:58:09 mikeh Exp $
    37  */
    38 /* Portions Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. */
    39 
    40 #ifndef _GLOB_H_
    41 #define	_GLOB_H_
    42 
    43 #include <sys/cdefs.h>
    44 
    45 struct stat;
    46 typedef struct {
    47 	int gl_pathc;		/* Count of total paths so far. */
    48 	int gl_matchc;		/* Count of paths matching pattern. */
    49 	int gl_offs;		/* Reserved at beginning of gl_pathv. */
    50 	int gl_flags;		/* Copy of flags parameter to glob. */
    51 	char **gl_pathv;	/* List of paths matching pattern. */
    52 				/* Copy of errfunc parameter to glob. */
    53 	int (*gl_errfunc)(const char *, int);
    54 
    55 	/*
    56 	 * Alternate filesystem access methods for glob; replacement
    57 	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
    58 	 * and lstat(2).
    59 	 */
    60 	void (*gl_closedir)(void *);
    61 	struct dirent *(*gl_readdir)(void *);
    62 	void *(*gl_opendir)(const char *);
    63 	int (*gl_lstat)(const char *, struct stat *);
    64 	int (*gl_stat)(const char *, struct stat *);
    65 } glob_t;
    66 
    67 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
    68 #define glob64_t	glob_t
    69 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
    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 
   104 IMPORT_C int	glob(const char *, int, int (*)(const char *, int), glob_t *);
   105 IMPORT_C void	globfree(glob_t *);
   106 
   107 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   108 #define glob64	glob
   109 #define globfree64	globfree
   110 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   111 
   112 __END_DECLS
   113 
   114 #endif /* !_GLOB_H_ */