epoc32/include/stdapis/sys/dirent.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     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.3 (Berkeley) 8/10/94
    30  * $FreeBSD: src/sys/sys/dirent.h,v 1.14 2004/04/07 04:19:49 imp Exp $
    31  */
    32 
    33 #ifndef	_SYS_DIRENT_H_
    34 #define	_SYS_DIRENT_H_
    35 
    36 #include <sys/cdefs.h>
    37 #include <sys/_types.h>
    38 #include <stddef.h>
    39 
    40 /*
    41  * The dirent structure defines the format of directory entries returned by
    42  * the getdirentries(2) system call.
    43  *
    44  * A directory entry has a struct dirent at the front of it, containing its
    45  * inode number, the length of the entry, and the length of the name
    46  * contained in the entry.  These are followed by the name padded to a 4
    47  * byte boundary with null bytes.  All names are guaranteed null terminated.
    48  * The maximum length of a name in a directory is MAXNAMLEN.
    49  */
    50 
    51 struct dirent {
    52 	__uint32_t d_fileno;		/* file number of entry */
    53 	__uint16_t d_reclen;		/* length of this record */
    54 	__uint8_t  d_type; 		/* file type, see below */
    55 	__uint8_t  d_namlen;		/* length of string in d_name */
    56 #if __BSD_VISIBLE
    57 #define	MAXNAMLEN	255
    58 	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
    59 #else
    60 	char	d_name[255 + 1];	/* name must be no longer than this */
    61 #endif
    62 };
    63 
    64 #ifdef __SYMBIAN32__
    65 struct wdirent {
    66 	unsigned long	d_fileno;
    67 	unsigned short	d_namlen;
    68 	wchar_t*		d_name;
    69 };
    70 
    71 typedef struct __EPOC32_WDIR WDIR;
    72 #endif
    73 
    74 
    75 #if __BSD_VISIBLE
    76 /*
    77  * File types
    78  */
    79 #define	DT_UNKNOWN	 0
    80 #define	DT_FIFO		 1
    81 #define	DT_CHR		 2
    82 #define	DT_DIR		 4
    83 #define	DT_BLK		 6
    84 #define	DT_REG		 8
    85 #define	DT_LNK		10
    86 #define	DT_SOCK		12
    87 #define	DT_WHT		14
    88 
    89 /*
    90  * Convert between stat structure types and directory types.
    91  */
    92 #define	IFTODT(mode)	(((mode) & 0170000) >> 12)
    93 #define	DTTOIF(dirtype)	((dirtype) << 12)
    94 
    95 /*
    96  * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold
    97  * the directory entry.  This requires the amount of space in struct direct
    98  * without the d_name field, plus enough space for the name with a terminating
    99  * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
   100  *
   101  * XXX although this macro is in the implementation namespace, it requires
   102  * a manifest constant that is not.
   103  */
   104 #define	_GENERIC_DIRSIZ(dp) \
   105     ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
   106 #endif /* __BSD_VISIBLE */
   107 
   108 #ifdef _KERNEL
   109 #define	GENERIC_DIRSIZ(dp)	_GENERIC_DIRSIZ(dp)
   110 #endif
   111 
   112 #endif /* !_SYS_DIRENT_H_ */