Logo Search packages:      
Sourcecode: scummvm version File versions  Download package

ds-fs.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program 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 General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/tags/release-1-2-1/backends/fs/ds/ds-fs.h $
 * $Id: ds-fs.h 50741 2010-07-07 23:22:53Z fingolfin $
 *
 */

#ifndef _DS_FS_H
#define _DS_FS_H

#include "common/fs.h"
#include "common/stream.h"
#include "backends/fs/abstract-fs.h"

#include "zipreader.h"
#include "fat/gba_nds_fat.h"

namespace DS {

/**
 * Implementation of the ScummVM file system API.
 * This class is used when a Flash cart is in use.
 *
 * Parts of this class are documented in the base interface class, AbstractFSNode.
 */
00044 class DSFileSystemNode : public AbstractFSNode {
protected:
      static ZipFile *_zipFile;

      Common::String _displayName;
      Common::String _path;
      bool _isDirectory;
      bool _isValid;

public:
      /**
       * Creates a DSFilesystemNode with the root node as path.
       */
      DSFileSystemNode();

      /**
       * Creates a DSFilesystemNode for a given path.
       *
       * @param path String with the path the new node should point to.
       */
      DSFileSystemNode(const Common::String &path);

      /**
       * Creates a DSFilesystemNode for a given path.
       *
       * @param path String with the path the new node should point to.
       * @param path true if path is a directory, false otherwise.
       */
      DSFileSystemNode(const Common::String& path, bool isDir);

      /**
       * Copy constructor.
       */
      DSFileSystemNode(const DSFileSystemNode *node);

      virtual bool exists() const { return true; }          //FIXME: this is just a stub
00080       virtual Common::String getDisplayName() const {  return _displayName; }
00081       virtual Common::String getName() const {  return _displayName; }
00082       virtual Common::String getPath() const { return _path; }
00083       virtual bool isDirectory() const { return _isDirectory; }
00084       virtual bool isReadable() const { return true; }      //FIXME: this is just a stub
00085       virtual bool isWritable() const { return true; }      //FIXME: this is just a stub

      /**
       * Returns a copy of this node.
       */
00090       virtual AbstractFSNode *clone() const { return new DSFileSystemNode(this); }
      virtual AbstractFSNode *getChild(const Common::String& name) const;
      virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const;
      virtual AbstractFSNode *getParent() const;

      virtual Common::SeekableReadStream *createReadStream();
      virtual Common::WriteStream *createWriteStream();

      /**
       * Returns the zip file this node points to.
       * TODO: check this documentation.
       */
00102       static ZipFile *getZip() { return _zipFile; }
};

 /**
 * Implementation of the ScummVM file system API.
 * This class is used when the GBAMP (GBA Movie Player) is used with a CompactFlash card.
 *
 * Parts of this class are documented in the base interface class, AbstractFSNode.
 */
00111 class GBAMPFileSystemNode : public AbstractFSNode {
protected:
      Common::String _displayName;
      Common::String _path;
      bool _isDirectory;
      bool _isValid;

public:
      /**
       * Creates a GBAMPFilesystemNode with the root node as path.
       */
      GBAMPFileSystemNode();

      /**
       * Creates a GBAMPFilesystemNode for a given path.
       *
       * @param path String with the path the new node should point to.
       */
      GBAMPFileSystemNode(const Common::String &path);

      /**
       * Creates a DSFilesystemNode for a given path.
       *
       * @param path String with the path the new node should point to.
       * @param path true if path is a directory, false otherwise.
       */
      GBAMPFileSystemNode(const Common::String &path, bool isDirectory);

      /**
       * Copy constructor.
       */
      GBAMPFileSystemNode(const GBAMPFileSystemNode *node);

      virtual bool exists() const { return _isValid || _isDirectory; }
00145       virtual Common::String getDisplayName() const {  return _displayName; }
00146       virtual Common::String getName() const {  return _displayName; }
00147       virtual Common::String getPath() const { return _path; }
00148       virtual bool isDirectory() const { return _isDirectory; }
00149       virtual bool isReadable() const { return true; }      //FIXME: this is just a stub
00150       virtual bool isWritable() const { return true; }      //FIXME: this is just a stub

      /**
       * Returns a copy of this node.
       */
00155       virtual AbstractFSNode *clone() const { return new GBAMPFileSystemNode(this); }
      virtual AbstractFSNode *getChild(const Common::String& name) const;
      virtual bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const;
      virtual AbstractFSNode *getParent() const;

      virtual Common::SeekableReadStream *createReadStream();
      virtual Common::WriteStream *createWriteStream();
};

00164 struct fileHandle {
      int pos;
      bool used;
      char *data;
      int size;
};


00172 class DSFileStream : public Common::SeekableReadStream, public Common::WriteStream, public Common::NonCopyable {
protected:
      enum {
            WRITE_BUFFER_SIZE = 512
      };

      /** File handle to the actual file. */
00179       void  *_handle;

      char  _writeBuffer[WRITE_BUFFER_SIZE];
      int   _writeBufferPos;

public:
      /**
       * Given a path, invokes fopen on that path and wrap the result in a
       * StdioStream instance.
       */
      static DSFileStream *makeFromPath(const Common::String &path, bool writeMode);

      DSFileStream(void *handle);
      virtual ~DSFileStream();

      bool err() const;
      void clearErr();
      bool eos() const;

      virtual uint32 write(const void *dataPtr, uint32 dataSize);
      virtual bool flush();

      virtual int32 pos() const;
      virtual int32 size() const;
      bool seek(int32 offs, int whence = SEEK_SET);
      uint32 read(void *dataPtr, uint32 dataSize);
};


#undef stderr
#undef stdout
#undef stdin

#define stdout ((DS::fileHandle *) -1)
#define stderr ((DS::fileHandle *) -2)
#define stdin ((DS::fileHandle *) -3)

#define FILE DS::fileHandle

// Please do not remove any of these prototypes that appear not to be required.
FILE* std_fopen(const char *name, const char *mode);
void  std_fclose(FILE *handle);
size_t      std_fread(void *ptr, size_t size, size_t numItems, FILE *handle);
size_t      std_fwrite(const void *ptr, size_t size, size_t numItems, FILE *handle);
bool  std_feof(FILE *handle);
long int std_ftell(FILE *handle);
int         std_fseek(FILE *handle, long int offset, int whence);
void  std_clearerr(FILE *handle);
int         std_fflush(FILE *handle);
int         std_ferror(FILE *handle);

}     // End of namespace DS

#endif //_DS_FS_H

Generated by  Doxygen 1.6.0   Back to index