diff options
Diffstat (limited to 'LibOVR/Src/Kernel/OVR_SysFile.h')
| -rw-r--r-- | LibOVR/Src/Kernel/OVR_SysFile.h | 186 |
1 files changed, 93 insertions, 93 deletions
diff --git a/LibOVR/Src/Kernel/OVR_SysFile.h b/LibOVR/Src/Kernel/OVR_SysFile.h index a9bb0a0..d078df1 100644 --- a/LibOVR/Src/Kernel/OVR_SysFile.h +++ b/LibOVR/Src/Kernel/OVR_SysFile.h @@ -1,93 +1,93 @@ -/************************************************************************************
-
-PublicHeader: Kernel
-Filename : OVR_SysFile.h
-Content : Header for all internal file management - functions and structures
- to be inherited by OS specific subclasses.
-Created : September 19, 2012
-Notes :
-
-Notes : errno may not be preserved across use of GBaseFile member functions
- : Directories cannot be deleted while files opened from them are in use
- (For the GetFullName function)
-
-Copyright : Copyright 2012 Oculus VR, Inc. All Rights reserved.
-
-Use of this software is subject to the terms of the Oculus license
-agreement provided at the time of installation or download, or which
-otherwise accompanies this software in either electronic or hard copy form.
-
-************************************************************************************/
-
-#ifndef OVR_SysFile_h
-#define OVR_SysFile_h
-
-#include "OVR_File.h"
-
-namespace OVR {
-
-// ***** Declared classes
-class SysFile;
-
-//-----------------------------------------------------------------------------------
-// *** File Statistics
-
-// This class contents are similar to _stat, providing
-// creation, modify and other information about the file.
-struct FileStat
-{
- // No change or create time because they are not available on most systems
- SInt64 ModifyTime;
- SInt64 AccessTime;
- SInt64 FileSize;
-
- bool operator== (const FileStat& stat) const
- {
- return ( (ModifyTime == stat.ModifyTime) &&
- (AccessTime == stat.AccessTime) &&
- (FileSize == stat.FileSize) );
- }
-};
-
-//-----------------------------------------------------------------------------------
-// *** System File
-
-// System file is created to access objects on file system directly
-// This file can refer directly to path.
-// System file can be open & closed several times; however, such use is not recommended
-// This class is realy a wrapper around an implementation of File interface for a
-// particular platform.
-
-class SysFile : public DelegatedFile
-{
-protected:
- SysFile(const SysFile &source) : DelegatedFile () { OVR_UNUSED(source); }
-public:
-
- // ** Constructor
- SysFile();
- // Opens a file
- SysFile(const String& path, int flags = Open_Read|Open_Buffered, int mode = Mode_ReadWrite);
-
- // ** Open & management
- bool Open(const String& path, int flags = Open_Read|Open_Buffered, int mode = Mode_ReadWrite);
-
- OVR_FORCE_INLINE bool Create(const String& path, int mode = Mode_ReadWrite)
- { return Open(path, Open_ReadWrite|Open_Create, mode); }
-
- // Helper function: obtain file statistics information. In GFx, this is used to detect file changes.
- // Return 0 if function failed, most likely because the file doesn't exist.
- static bool OVR_CDECL GetFileStat(FileStat* pfileStats, const String& path);
-
- // ** Overrides
- // Overridden to provide re-open support
- virtual int GetErrorCode();
-
- virtual bool IsValid();
-
- virtual bool Close();
-};
-
-} // Scaleform
-
-#endif
+/************************************************************************************ + +PublicHeader: Kernel +Filename : OVR_SysFile.h +Content : Header for all internal file management - functions and structures + to be inherited by OS specific subclasses. +Created : September 19, 2012 +Notes : + +Notes : errno may not be preserved across use of GBaseFile member functions + : Directories cannot be deleted while files opened from them are in use + (For the GetFullName function) + +Copyright : Copyright 2012 Oculus VR, Inc. All Rights reserved. + +Use of this software is subject to the terms of the Oculus license +agreement provided at the time of installation or download, or which +otherwise accompanies this software in either electronic or hard copy form. + +************************************************************************************/ + +#ifndef OVR_SysFile_h +#define OVR_SysFile_h + +#include "OVR_File.h" + +namespace OVR { + +// ***** Declared classes +class SysFile; + +//----------------------------------------------------------------------------------- +// *** File Statistics + +// This class contents are similar to _stat, providing +// creation, modify and other information about the file. +struct FileStat +{ + // No change or create time because they are not available on most systems + SInt64 ModifyTime; + SInt64 AccessTime; + SInt64 FileSize; + + bool operator== (const FileStat& stat) const + { + return ( (ModifyTime == stat.ModifyTime) && + (AccessTime == stat.AccessTime) && + (FileSize == stat.FileSize) ); + } +}; + +//----------------------------------------------------------------------------------- +// *** System File + +// System file is created to access objects on file system directly +// This file can refer directly to path. +// System file can be open & closed several times; however, such use is not recommended +// This class is realy a wrapper around an implementation of File interface for a +// particular platform. + +class SysFile : public DelegatedFile +{ +protected: + SysFile(const SysFile &source) : DelegatedFile () { OVR_UNUSED(source); } +public: + + // ** Constructor + SysFile(); + // Opens a file + SysFile(const String& path, int flags = Open_Read|Open_Buffered, int mode = Mode_ReadWrite); + + // ** Open & management + bool Open(const String& path, int flags = Open_Read|Open_Buffered, int mode = Mode_ReadWrite); + + OVR_FORCE_INLINE bool Create(const String& path, int mode = Mode_ReadWrite) + { return Open(path, Open_ReadWrite|Open_Create, mode); } + + // Helper function: obtain file statistics information. In GFx, this is used to detect file changes. + // Return 0 if function failed, most likely because the file doesn't exist. + static bool OVR_CDECL GetFileStat(FileStat* pfileStats, const String& path); + + // ** Overrides + // Overridden to provide re-open support + virtual int GetErrorCode(); + + virtual bool IsValid(); + + virtual bool Close(); +}; + +} // Scaleform + +#endif |