StdLib: Replace some non-ASCII characters with ASCII equivalents.

[mirror_edk2.git] / StdLib / Include / sys / dirent.h

/** @file\r
  Declarations pertaining to directory entries under the UEFI environment.\r
\r
  The information is based upon the EFI_FILE_INFO structure\r
  in MdePkg/Include/Guid/FileInfo.h.\r
\r
  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  Copyright (c) 1989, 1993\r
   The Regents of the University of California.  All rights reserved.\r
\r
  Redistribution and use in source and binary forms, with or without\r
  modification, are permitted provided that the following conditions\r
  are met:\r
    1. Redistributions of source code must retain the above copyright\r
       notice, this list of conditions and the following disclaimer.\r
    2. Redistributions in binary form must reproduce the above copyright\r
       notice, this list of conditions and the following disclaimer in the\r
       documentation and/or other materials provided with the distribution.\r
    3. Neither the name of the University nor the names of its contributors\r
       may be used to endorse or promote products derived from this software\r
       without specific prior written permission.\r
\r
  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND\r
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE\r
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  SUCH DAMAGE.\r
\r
   @(#)dirent.h  8.3 (Berkeley) 8/10/94\r
   NetBSD: dirent.h,v 1.23 2005/12/26 18:41:36 perry Exp\r
**/\r
\r
#ifndef _SYS_DIRENT_H_\r
#define _SYS_DIRENT_H_\r
\r
#include  <sys/featuretest.h>\r
#include  <time.h>\r
#include  <sys/time.h>\r
\r
#define MAXNAMLEN 511\r
\r
/*\r
 * The dirent structure defines the format of directory entries returned by\r
 * read(fd, ...) when fd refers to a directory.\r
 *\r
 * All names are wide characters and are guaranteed to be null terminated.\r
 * The maximum length of a name in a directory is MAXNAMLEN.\r
 */\r
struct dirent {\r
  UINT64    Size;               // Size of this dirent structure instance,\r
                                  // including the Null-terminated FileName string.\r
  UINT64    FileSize;           // The size of the file in bytes.\r
  UINT64    PhysicalSize;       // The amount of physical space the file consumes\r
                                  // on the file system volume.\r
  UINT64    Attribute;          // The time the file was created.\r
  struct timespec  CreateTime;         // The time when the file was last accessed.\r
  struct timespec  LastAccessTime;     // The time when the file's contents were last modified.\r
  struct timespec  ModificationTime;   // The attribute bits for the file. See below.\r
  CHAR16    FileName[1];         // The Null-terminated name of the file.\r
};\r
\r
/*\r
 * File Attributes\r
 */\r
#define DT_UNKNOWN    0\r
#define DT_READ_ONLY  0x0000000000000001\r
#define DT_HIDDEN     0x0000000000000002\r
#define DT_SYSTEM     0x0000000000000004\r
#define DT_RESERVED   0x0000000000000008\r
#define DT_DIRECTORY  0x0000000000000010\r
#define DT_ARCHIVE    0x0000000000000020\r
#define DT_CHR        0x0000000000010000  // File attaches to a character device\r
#define DT_BLK        0x0000000000020000  // File attaches to a block device\r
#define DT_SOCKET     0x0000000000030000  // File attaches to a socket\r
#define DT_VALID_ATTR 0x0000000000030037  // Mask for valid attribute bits\r
\r
#endif  /* !_SYS_DIRENT_H_ */\r