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