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