SF_SysFile.h

Go to the documentation of this file.

/*
 * Copyright 2016 Autodesk, Inc. All rights reserved.
 * Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
 * or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
 */

#pragma once

#include "gwnavruntime/kernel/SF_File.h"

namespace Kaim
{

// ***** 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 really a wrapper around an implementation of File interface for a
// particular platform.
// The underlying file handler is fclose() in the destructor (when refcount comes to zero)
// SysFile --Ptr<File> pFile--> BufferedFile --Ptr<File> pFile--> FILEFile
// where FILEFile constructor calls fopen and destructor calls fclose
class SysFile : public DelegatedFile
{
protected:
    SysFile(const SysFile& source) : DelegatedFile() { KY_UNUSED(source); }

public:
    // ** Constructor
    SysFile();
    // Opens a file
    // For some platforms (PS2,PSP,Wii) buffering will be used even if Open_Buffered flag is not set because
    // of these platforms' file system limitation.
    SysFile(const String& path, int flags = Open_Read | Open_Buffered, int mode = Mode_ReadWrite);

    // ** Open & management
    // Will fail if file's already open
    bool Open(const String& path, int flags = Open_Read | Open_Buffered, int mode = Mode_ReadWrite);

    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 GetFileStat(FileStat* pfileStats, const String& path);

    // ** Overrides
    // Overridden to provide re-open support
    virtual int GetErrorCode();

    virtual bool IsValid();

    virtual bool Close();
};

} // Kaim