StdLib/Include/dirent.h

   1 /** @file
   2     Declarations pertaining to directory entries under the UEFI environment.
   3
   4     The information is based upon the EFI_FILE_INFO structure
   5     in MdePkg/Include/Guid/FileInfo.h.
   6
   7     Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
   8     This program and the accompanying materials
   9     are licensed and made available under the terms and conditions of the BSD License
  10     which accompanies this distribution.  The full text of the license may be found at
  11     http://opensource.org/licenses/bsd-license.php
  12
  13     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14     WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16     Copyright (c) 1989, 1993
  17     The Regents of the University of California.  All rights reserved.
  18
  19     Redistribution and use in source and binary forms, with or without
  20     modification, are permitted provided that the following conditions
  21     are met:
  22     1. Redistributions of source code must retain the above copyright
  23       notice, this list of conditions and the following disclaimer.
  24     2. Redistributions in binary form must reproduce the above copyright
  25       notice, this list of conditions and the following disclaimer in the
  26       documentation and/or other materials provided with the distribution.
  27     3. Neither the name of the University nor the names of its contributors
  28       may be used to endorse or promote products derived from this software
  29       without specific prior written permission.
  30
  31     THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  32     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  33     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  34     ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  35     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  39     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  40     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  41     SUCH DAMAGE.
  42
  43     NetBSD: dirent.h,v 1.30 2008/01/09 20:55:03 christos Exp
  44     @(#)dirent.h  8.2 (Berkeley) 7/28/94
  45 **/
  46 #ifndef _DIRENT_H_
  47 #define _DIRENT_H_
  48
  49 #include <sys/featuretest.h>
  50 #include <sys/types.h>
  51
  52 #include <sys/dirent.h>
  53
  54 typedef struct _dirdesc DIR;
  55
  56 /* definitions for library routines operating on directories. */
  57 #define DIRBLKSIZ 1024
  58
  59 /* structure describing an open directory. */
  60 struct _dirdesc {
  61   int     dd_fd;          /* file descriptor associated with directory */
  62   long    dd_loc;         /* offset in current buffer */
  63   long    dd_size;        /* amount of data returned by getdents */
  64   char   *dd_buf;         /* data buffer */
  65   int     dd_len;         /* size of data buffer */
  66   off_t   dd_seek;        /* magic cookie returned by getdents */
  67   void   *dd_internal;    /* state for seekdir/telldir */
  68   int     dd_flags;       /* flags for readdir */
  69   void   *dd_lock;        /* lock for concurrent access */
  70 };
  71
  72 #define dirfd(dirp) ((dirp)->dd_fd)
  73
  74 /* flags for __opendir2() */
  75 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  76 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  77 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
  78 #define __DTF_READALL   0x0008  /* everything has been read */
  79
  80 #include <sys/cdefs.h>
  81
  82 __BEGIN_DECLS
  83   int             closedir(DIR *);
  84   void            rewinddir(DIR *);
  85
  86   DIR            *opendir(const char *)                                       __RENAME(__opendir30);
  87   struct dirent  *readdir(DIR *)                                              __RENAME(__readdir30);
  88   int             readdir_r(DIR * __restrict, struct dirent * __restrict,
  89                             struct dirent ** __restrict)                      __RENAME(__readdir_r30);
  90
  91   void            seekdir(DIR *, long);
  92   long            telldir(DIR *);
  93   DIR            *__opendir2(const char *, int)                               __RENAME(__opendir230);
  94
  95   //#ifndef __LIBC12_SOURCE__
  96   //int             scandir(const char *, struct dirent ***,
  97   //                        int (*)(const struct dirent *), int (*)(const void *,
  98   //                        const void *))  __RENAME(__scandir30);
  99   //int             getdents(int, char *, size_t) __RENAME(__getdents30);
 100   //#endif
 101
 102   //int             alphasort(const void *, const void *);
 103 __END_DECLS
 104
 105
 106 #endif /* _DIRENT_H_ */