dirent/dirent.h

   1 /* Copyright (C) 1991 Free Software Foundation, Inc.
   2 This file is part of the GNU C Library.
   3
   4 The GNU C Library is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU Library General Public License as
   6 published by the Free Software Foundation; either version 2 of the
   7 License, or (at your option) any later version.
   8
   9 The GNU C Library is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 Library General Public License for more details.
  13
  14 You should have received a copy of the GNU Library General Public
  15 License along with the GNU C Library; see the file COPYING.LIB.  If
  16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
  17 Cambridge, MA 02139, USA.  */
  18
  19 /*
  20  *      POSIX Standard: 5.1.2 Directory Operations      <dirent.h>
  21  */
  22
  23 #ifndef _DIRENT_H
  24
  25 #define _DIRENT_H       1
  26 #include <features.h>
  27
  28 #include <gnu/types.h>
  29
  30 #define __need_size_t
  31 #include <stddef.h>
  32
  33
  34 /* Directory entry structure.  */
  35 struct dirent
  36   {
  37     __ino_t d_fileno;   /* File serial number.  */
  38     size_t d_namlen;    /* Length of the file name.  */
  39
  40     /* Only this member is in the POSIX standard.  */
  41     char d_name[1];     /* File name (actually longer).  */
  42   };
  43
  44 #if defined(__USE_BSD) || defined(__USE_MISC)
  45 #define d_ino           d_fileno        /* Backward compatibility.  */
  46 #endif
  47
  48 /* Directory stream type.  */
  49 typedef struct
  50   {
  51     int __fd;                   /* File descriptor.  */
  52
  53     char *__data;               /* Directory block.  */
  54     size_t __allocation;        /* Space allocated for the block.  */
  55     size_t __offset;            /* Current offset into the block.  */
  56     size_t __size;              /* Total valid data in the block.  */
  57
  58     struct dirent __entry;      /* Returned by `readdir'.  */
  59   } DIR;
  60
  61
  62 /* Open a directory stream on NAME.
  63    Return a DIR stream on the directory, or NULL if it could not be opened.  */
  64 extern DIR *EXFUN(opendir, (CONST char *__name));
  65
  66 /* Close the directory stream DIRP.
  67    Return 0 if successful, -1 if not.  */
  68 extern int EXFUN(closedir, (DIR *__dirp));
  69
  70 /* Read a directory entry from DIRP.
  71    Return a pointer to a `struct dirent' describing the entry,
  72    or NULL for EOF or error.  The storage returned may be overwritten
  73    by a later readdir call on the same DIR stream.  */
  74 extern struct dirent *EXFUN(readdir, (DIR *__dirp));
  75
  76 /* Rewind DIRP to the beginning of the directory.  */
  77 extern void EXFUN(rewinddir, (DIR *__dirp));
  78
  79 #if defined(__USE_BSD) || defined(__USE_MISC)
  80
  81 #ifndef MAXNAMLEN
  82 /* Get the definitions of the POSIX.1 limits.  */
  83 #include <posix1_limits.h>
  84
  85 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
  86 #ifdef  NAME_MAX
  87 #define MAXNAMLEN       NAME_MAX
  88 #else
  89 #define MAXNAMLEN       255
  90 #endif
  91 #endif
  92
  93 #include <gnu/types.h>
  94
  95 /* Seek to position POS on DIRP.  */
  96 extern void EXFUN(seekdir, (DIR *__dirp, __off_t __pos));
  97
  98 /* Return the current position of DIRP.  */
  99 extern __off_t EXFUN(telldir, (DIR *__dirp));
 100
 101 #endif  /* Use BSD or misc.  */
 102
 103
 104 #endif  /* dirent.h  */