ppapi/c/pp_file_info.h

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /* From pp_file_info.idl modified Thu Mar 28 11:11:01 2013. */
   7
   8 #ifndef PPAPI_C_PP_FILE_INFO_H_
   9 #define PPAPI_C_PP_FILE_INFO_H_
  10
  11 #include "ppapi/c/pp_macros.h"
  12 #include "ppapi/c/pp_stdint.h"
  13 #include "ppapi/c/pp_time.h"
  14
  15 /**
  16  * @file
  17  * This file defines three enumerations for use in the PPAPI C file IO APIs.
  18  */
  19
  20
  21 /**
  22  * @addtogroup Enums
  23  * @{
  24  */
  25 /**
  26  * The <code>PP_FileType</code> enum contains file type constants.
  27  */
  28 typedef enum {
  29   /** A regular file type */
  30   PP_FILETYPE_REGULAR = 0,
  31   /** A directory */
  32   PP_FILETYPE_DIRECTORY = 1,
  33   /** A catch-all for unidentified types */
  34   PP_FILETYPE_OTHER = 2
  35 } PP_FileType;
  36 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_FileType, 4);
  37
  38 /**
  39  * The <code>PP_FileSystemType</code> enum contains file system type constants.
  40  */
  41 typedef enum {
  42   /** For identified invalid return values */
  43   PP_FILESYSTEMTYPE_INVALID = 0,
  44   /** For external file system types */
  45   PP_FILESYSTEMTYPE_EXTERNAL = 1,
  46   /** For local persistent file system types */
  47   PP_FILESYSTEMTYPE_LOCALPERSISTENT = 2,
  48   /** For local temporary file system types */
  49   PP_FILESYSTEMTYPE_LOCALTEMPORARY = 3
  50 } PP_FileSystemType;
  51 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_FileSystemType, 4);
  52 /**
  53  * @}
  54  */
  55
  56 /**
  57  * @addtogroup Structs
  58  * @{
  59  */
  60 /**
  61  * The <code>PP_FileInfo</code> struct represents all information about a file,
  62  * such as size, type, and creation time.
  63  */
  64 struct PP_FileInfo {
  65   /** This value represents the size of the file measured in bytes */
  66   int64_t size;
  67   /**
  68    * This value represents the type of file as defined by the
  69    * <code>PP_FileType</code> enum
  70    */
  71   PP_FileType type;
  72   /**
  73    * This value represents the file system type of the file as defined by the
  74    * <code>PP_FileSystemType</code> enum.
  75    */
  76   PP_FileSystemType system_type;
  77   /**
  78    * This value represents the creation time of the file.
  79    */
  80   PP_Time creation_time;
  81   /**
  82    * This value represents the last time the file was accessed.
  83    */
  84   PP_Time last_access_time;
  85   /**
  86    * This value represents the last time the file was modified.
  87    */
  88   PP_Time last_modified_time;
  89 };
  90 PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_FileInfo, 40);
  91 /**
  92  * @}
  93  */
  94
  95 #endif  /* PPAPI_C_PP_FILE_INFO_H_ */
  96