Public API Reference

iutil/vfs.h

Go to the documentation of this file.

/*
    Crystal Space Virtual File System SCF interface
    Copyright (C) 1998,1999 by Andrew Zabolotny <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IUTIL_VFS_H__
#define __CS_IUTIL_VFS_H__

#include "csutil/scf.h"
#include "iutil/databuff.h"

struct iConfigFile;

class csStringArray;

struct csFileTime
{
  int sec;
  int min;
  int hour;
  int day;
  int mon;
  int year;
};

#define ASSIGN_FILETIME(ft,tm)  \
  (ft).sec = (tm).tm_sec;       \
  (ft).min = (tm).tm_min;       \
  (ft).hour = (tm).tm_hour;     \
  (ft).day = (tm).tm_mday;      \
  (ft).mon = (tm).tm_mon;       \
  (ft).year = (tm).tm_year + 1900;

#define VFS_PATH_DIVIDER        ','
#define VFS_PATH_SEPARATOR      '/'
#define VFS_MAX_PATH_LEN        256


#define VFS_FILE_MODE           0x0000000f
#define VFS_FILE_READ           0x00000000
#define VFS_FILE_WRITE          0x00000001
#define VFS_FILE_APPEND         0x00000002
#define VFS_FILE_UNCOMPRESSED   0x80000000


#define VFS_STATUS_OK           0
#define VFS_STATUS_OTHER        1
#define VFS_STATUS_NOSPACE      2
#define VFS_STATUS_RESOURCES    3

#define VFS_STATUS_ACCESSDENIED 4
#define VFS_STATUS_IOERROR      5

struct iFile : public virtual iBase
{
  SCF_INTERFACE(iFile, 2, 0, 0);

  virtual const char *GetName () = 0;

  virtual size_t GetSize () = 0;

  virtual int GetStatus () = 0;

  virtual size_t Read (char *Data, size_t DataSize) = 0;

  virtual size_t Write (const char *Data, size_t DataSize) = 0;

  virtual void Flush () = 0;

  virtual bool AtEOF () = 0;

  virtual size_t GetPos () = 0;

  virtual bool SetPos (size_t newpos) = 0;

  virtual csPtr<iDataBuffer> GetAllData (bool nullterm = false) = 0;
};


struct iVFS : public virtual iBase
{
  SCF_INTERFACE(iVFS, 2, 0, 0);

  virtual bool ChDir (const char *Path) = 0;

  virtual const char *GetCwd () const = 0;

  virtual void PushDir (char const* Path = 0) = 0;
  virtual bool PopDir () = 0;

  virtual csPtr<iDataBuffer> ExpandPath (
    const char *Path, bool IsDir = false) const = 0;

  virtual bool Exists (const char *Path) const = 0;

  virtual csPtr<iStringArray> FindFiles (const char *Path) const = 0;

  virtual csPtr<iFile> Open (const char *FileName, int Mode) = 0;

  virtual csPtr<iDataBuffer> ReadFile (const char *FileName,
    bool nullterm = true) = 0;

  virtual bool WriteFile (const char *Name, const char *Data, size_t Size) = 0;

  virtual bool DeleteFile (const char *FileName) = 0;

  virtual bool Sync () = 0;

  virtual bool Mount (const char *VirtualPath, const char *RealPath) = 0;

  virtual bool Unmount (const char *VirtualPath, const char *RealPath) = 0;

  virtual csRef<iStringArray> MountRoot (const char *VirtualPath) = 0;

  virtual bool SaveMounts (const char *FileName) = 0;
  virtual bool LoadMountsFromFile (iConfigFile* file) = 0;

  virtual bool ChDirAuto (const char* path, const csStringArray* paths = 0,
        const char* vfspath = 0, const char* filename = 0) = 0;

  virtual bool GetFileTime (const char *FileName, csFileTime &oTime) const = 0;
  virtual bool SetFileTime (const char *FileName, const csFileTime &iTime) = 0;

  virtual bool GetFileSize (const char *FileName, size_t &oSize) = 0;

  virtual csPtr<iDataBuffer> GetRealPath (const char *FileName) = 0;

  virtual csRef<iStringArray> GetMounts () = 0;

  virtual csRef<iStringArray> GetRealMountPaths (const char *VirtualPath) = 0;
};

#endif // __CS_IUTIL_VFS_H__

---