epoc32/include/stdapis/dirent.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100 (2010-03-31)
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 /*-
     2  * Copyright (c) 1989, 1993
     3  *	The Regents of the University of California.  All rights reserved.
     4  *
     5  * Redistribution and use in source and binary forms, with or without
     6  * modification, are permitted provided that the following conditions
     7  * are met:
     8  * 1. Redistributions of source code must retain the above copyright
     9  *    notice, this list of conditions and the following disclaimer.
    10  * 2. Redistributions in binary form must reproduce the above copyright
    11  *    notice, this list of conditions and the following disclaimer in the
    12  *    documentation and/or other materials provided with the distribution.
    13  * 4. Neither the name of the University nor the names of its contributors
    14  *    may be used to endorse or promote products derived from this software
    15  *    without specific prior written permission.
    16  *
    17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    27  * SUCH DAMAGE.
    28  *
    29  *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
    30  * $FreeBSD: src/include/dirent.h,v 1.14 2003/12/07 21:10:06 marcel Exp $
    31  */
    32 
    33 #ifndef _DIRENT_H_
    34 #define _DIRENT_H_
    35 
    36 /*
    37  * The kernel defines the format of directory entries returned by
    38  * the getdirentries(2) system call.
    39  */
    40 #include <sys/cdefs.h>
    41 #include <sys/dirent.h>
    42 
    43 #if __BSD_VISIBLE || __XSI_VISIBLE
    44 /*
    45  * XXX this is probably illegal in the __XSI_VISIBLE case, but brings us closer
    46  * to the specification.
    47  */
    48 #define	d_ino		d_fileno	/* backward and XSI compatibility */
    49 #endif
    50 
    51 #if __BSD_VISIBLE
    52 
    53 #include <sys/_null.h>
    54 
    55 /* definitions for library routines operating on directories. */
    56 #define	DIRBLKSIZ	1024
    57 
    58 struct _telldir;		/* see telldir.h */
    59 
    60 /* structure describing an open directory. */
    61 typedef struct _dirdesc {
    62 	int	dd_fd;		/* file descriptor associated with directory */
    63 	long	dd_loc;		/* offset in current buffer */
    64 	long	dd_size;	/* amount of data returned by getdirentries */
    65 	char	*dd_buf;	/* data buffer */
    66 	int	dd_len;		/* size of data buffer */
    67 	long	dd_seek;	/* magic cookie returned by getdirentries */
    68 	long	dd_rewind;	/* magic cookie for rewinding */
    69 	int	dd_flags;	/* flags for readdir */
    70 	void	*dd_lock;	/* hack to avoid including <pthread.h> */
    71 	struct _telldir *dd_td;	/* telldir position recording */
    72 } DIR;
    73 
    74 #define	dirfd(dirp)	((dirp)->dd_fd)
    75 
    76 /* flags for opendir2 */
    77 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
    78 #define DTF_NODUP	0x0002	/* don't return duplicate names */
    79 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
    80 #define __DTF_READALL	0x0008	/* everything has been read */
    81 
    82 #else /* !__BSD_VISIBLE */
    83 
    84 typedef	void *	DIR;
    85 
    86 #endif /* __BSD_VISIBLE */
    87 
    88 #ifndef _KERNEL
    89 
    90 __BEGIN_DECLS
    91 #if __BSD_VISIBLE
    92 IMPORT_C int	 alphasort(const void *, const void *);
    93 /* #define getdirentries _getdirentries */
    94 IMPORT_C int	 getdirentries(int, char *, int, long *);
    95 #endif
    96 IMPORT_C DIR	*opendir(const char *);
    97 IMPORT_C struct dirent *
    98 	 readdir(DIR *);
    99 IMPORT_C void	 rewinddir(DIR *);
   100 IMPORT_C int	 alphasort(const void *, const void *);
   101 IMPORT_C int	 scandir(const char *, struct dirent ***,
   102 	    int (*)(struct dirent *), int (*)(const void *, const void *));
   103 
   104 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   105 #define readdir64	readdir
   106 #define alphasort64	alphasort
   107 #define scandir64	scandir
   108 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   109 
   110 
   111 #if __XSI_VISIBLE
   112 IMPORT_C void	 seekdir(DIR *, long);
   113 IMPORT_C long	 telldir(DIR *);
   114 #endif
   115 IMPORT_C int	 closedir(DIR *);
   116 __END_DECLS
   117 
   118 #endif /* !_KERNEL */
   119 
   120 #endif /* !_DIRENT_H_ */