epoc32/include/stdapis/sys/dirent.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*-
williamr@2
     2
 * Copyright (c) 1989, 1993
williamr@2
     3
 *	The Regents of the University of California.  All rights reserved.
williamr@2
     4
 *
williamr@2
     5
 * Redistribution and use in source and binary forms, with or without
williamr@2
     6
 * modification, are permitted provided that the following conditions
williamr@2
     7
 * are met:
williamr@2
     8
 * 1. Redistributions of source code must retain the above copyright
williamr@2
     9
 *    notice, this list of conditions and the following disclaimer.
williamr@2
    10
 * 2. Redistributions in binary form must reproduce the above copyright
williamr@2
    11
 *    notice, this list of conditions and the following disclaimer in the
williamr@2
    12
 *    documentation and/or other materials provided with the distribution.
williamr@2
    13
 * 4. Neither the name of the University nor the names of its contributors
williamr@2
    14
 *    may be used to endorse or promote products derived from this software
williamr@2
    15
 *    without specific prior written permission.
williamr@2
    16
 *
williamr@2
    17
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
williamr@2
    18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2
    19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
williamr@2
    20
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
williamr@2
    21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
williamr@2
    22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
williamr@2
    23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2
    24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
williamr@2
    25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
williamr@2
    26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
williamr@2
    27
 * SUCH DAMAGE.
williamr@2
    28
 *
williamr@2
    29
 *	@(#)dirent.h	8.3 (Berkeley) 8/10/94
williamr@2
    30
 * $FreeBSD: src/sys/sys/dirent.h,v 1.14 2004/04/07 04:19:49 imp Exp $
williamr@2
    31
 */
williamr@2
    32
williamr@2
    33
#ifndef	_SYS_DIRENT_H_
williamr@2
    34
#define	_SYS_DIRENT_H_
williamr@2
    35
williamr@2
    36
#include <sys/cdefs.h>
williamr@2
    37
#include <sys/_types.h>
williamr@2
    38
#include <stddef.h>
williamr@2
    39
williamr@2
    40
/*
williamr@2
    41
 * The dirent structure defines the format of directory entries returned by
williamr@2
    42
 * the getdirentries(2) system call.
williamr@2
    43
 *
williamr@2
    44
 * A directory entry has a struct dirent at the front of it, containing its
williamr@2
    45
 * inode number, the length of the entry, and the length of the name
williamr@2
    46
 * contained in the entry.  These are followed by the name padded to a 4
williamr@2
    47
 * byte boundary with null bytes.  All names are guaranteed null terminated.
williamr@2
    48
 * The maximum length of a name in a directory is MAXNAMLEN.
williamr@2
    49
 */
williamr@2
    50
williamr@2
    51
struct dirent {
williamr@2
    52
	__uint32_t d_fileno;		/* file number of entry */
williamr@2
    53
	__uint16_t d_reclen;		/* length of this record */
williamr@2
    54
	__uint8_t  d_type; 		/* file type, see below */
williamr@2
    55
	__uint8_t  d_namlen;		/* length of string in d_name */
williamr@2
    56
#if __BSD_VISIBLE
williamr@2
    57
#define	MAXNAMLEN	255
williamr@2
    58
	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
williamr@2
    59
#else
williamr@2
    60
	char	d_name[255 + 1];	/* name must be no longer than this */
williamr@2
    61
#endif
williamr@2
    62
};
williamr@2
    63
williamr@2
    64
#ifdef __SYMBIAN32__
williamr@2
    65
struct wdirent {
williamr@2
    66
	unsigned long	d_fileno;
williamr@2
    67
	unsigned short	d_namlen;
williamr@2
    68
	wchar_t*		d_name;
williamr@2
    69
};
williamr@2
    70
williamr@2
    71
typedef struct __EPOC32_WDIR WDIR;
williamr@2
    72
#endif
williamr@2
    73
williamr@2
    74
williamr@2
    75
#if __BSD_VISIBLE
williamr@2
    76
/*
williamr@2
    77
 * File types
williamr@2
    78
 */
williamr@2
    79
#define	DT_UNKNOWN	 0
williamr@2
    80
#define	DT_FIFO		 1
williamr@2
    81
#define	DT_CHR		 2
williamr@2
    82
#define	DT_DIR		 4
williamr@2
    83
#define	DT_BLK		 6
williamr@2
    84
#define	DT_REG		 8
williamr@2
    85
#define	DT_LNK		10
williamr@2
    86
#define	DT_SOCK		12
williamr@2
    87
#define	DT_WHT		14
williamr@2
    88
williamr@2
    89
/*
williamr@2
    90
 * Convert between stat structure types and directory types.
williamr@2
    91
 */
williamr@2
    92
#define	IFTODT(mode)	(((mode) & 0170000) >> 12)
williamr@2
    93
#define	DTTOIF(dirtype)	((dirtype) << 12)
williamr@2
    94
williamr@2
    95
/*
williamr@2
    96
 * The _GENERIC_DIRSIZ macro gives the minimum record length which will hold
williamr@2
    97
 * the directory entry.  This requires the amount of space in struct direct
williamr@2
    98
 * without the d_name field, plus enough space for the name with a terminating
williamr@2
    99
 * null byte (dp->d_namlen+1), rounded up to a 4 byte boundary.
williamr@2
   100
 *
williamr@2
   101
 * XXX although this macro is in the implementation namespace, it requires
williamr@2
   102
 * a manifest constant that is not.
williamr@2
   103
 */
williamr@2
   104
#define	_GENERIC_DIRSIZ(dp) \
williamr@2
   105
    ((sizeof (struct dirent) - (MAXNAMLEN+1)) + (((dp)->d_namlen+1 + 3) &~ 3))
williamr@2
   106
#endif /* __BSD_VISIBLE */
williamr@2
   107
williamr@2
   108
#ifdef _KERNEL
williamr@2
   109
#define	GENERIC_DIRSIZ(dp)	_GENERIC_DIRSIZ(dp)
williamr@2
   110
#endif
williamr@2
   111
williamr@2
   112
#endif /* !_SYS_DIRENT_H_ */