StdLib/Include/dirent.h

/** @file
    Declarations pertaining to directory entries under the UEFI environment.

    The information is based upon the EFI_FILE_INFO structure
    in MdePkg/Include/Guid/FileInfo.h.

    Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
    This program and the accompanying materials
    are licensed and made available under the terms and conditions of the BSD License
    which accompanies this distribution.  The full text of the license may be found at
    http://opensource.org/licenses/bsd-license.php

    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

    Copyright (c) 1989, 1993
    The Regents of the University of California.  All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    3. Neither the name of the University nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    SUCH DAMAGE.

    NetBSD: dirent.h,v 1.30 2008/01/09 20:55:03 christos Exp
    @(#)dirent.h  8.2 (Berkeley) 7/28/94
**/
#ifndef _DIRENT_H_
#define _DIRENT_H_

#include <sys/featuretest.h>
#include <sys/types.h>

#include <sys/dirent.h>

typedef struct _dirdesc DIR;

/* definitions for library routines operating on directories. */
#define DIRBLKSIZ 1024

/* structure describing an open directory. */
struct _dirdesc {
  int     dd_fd;          /* file descriptor associated with directory */
  long    dd_loc;         /* offset in current buffer */
  long    dd_size;        /* amount of data returned by getdents */
  char   *dd_buf;         /* data buffer */
  int     dd_len;         /* size of data buffer */
  off_t   dd_seek;        /* magic cookie returned by getdents */
  void   *dd_internal;    /* state for seekdir/telldir */
  int     dd_flags;       /* flags for readdir */
  void   *dd_lock;        /* lock for concurrent access */
};

#define dirfd(dirp) ((dirp)->dd_fd)

/* flags for __opendir2() */
#define DTF_HIDEW       0x0001  /* hide whiteout entries */
#define DTF_NODUP       0x0002  /* don't return duplicate names */
#define DTF_REWIND      0x0004  /* rewind after reading union stack */
#define __DTF_READALL   0x0008  /* everything has been read */

#include <sys/cdefs.h>

__BEGIN_DECLS
  int             closedir(DIR *);
  void            rewinddir(DIR *);

  DIR            *opendir(const char *)                                       __RENAME(__opendir30);
  struct dirent  *readdir(DIR *)                                              __RENAME(__readdir30);
  int             readdir_r(DIR * __restrict, struct dirent * __restrict,
                            struct dirent ** __restrict)                      __RENAME(__readdir_r30);

  void            seekdir(DIR *, long);
  long            telldir(DIR *);
  DIR            *__opendir2(const char *, int)                               __RENAME(__opendir230);

  //#ifndef __LIBC12_SOURCE__
  //int             scandir(const char *, struct dirent ***,
  //                        int (*)(const struct dirent *), int (*)(const void *,
  //                        const void *))  __RENAME(__scandir30);
  //int             getdents(int, char *, size_t) __RENAME(__getdents30);
  //#endif

  //int             alphasort(const void *, const void *);
__END_DECLS


#endif /* _DIRENT_H_ */