scummvm/common/file.h
2005-01-09 01:41:43 +00:00

80 lines
2.2 KiB
C++

/* ScummVM - Scumm Interpreter
* Copyright (C) 2002-2005 The ScummVM project
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
* $Header$
*
*/
#ifndef COMMON_FILE_H
#define COMMON_FILE_H
#include "stdafx.h"
#include "common/scummsys.h"
#include "common/str.h"
#include "common/stream.h"
class File : public Common::SeekableReadStream, public Common::WriteStream {
protected:
/** POSIX file handle to the actual file; 0 if no file is open. */
FILE *_handle;
/** Status flag which tells about recent I/O failures. */
bool _ioFailed;
/** Simple ref-counter for File objects. */
int32 _refcount;
/** The name of this file, for debugging. */
Common::String _name;
static Common::StringList _defaultDirectories;
public:
enum AccessMode {
kFileReadMode = 1,
kFileWriteMode = 2
};
static void addDefaultDirectory(const Common::String &directory);
static void resetDefaultDirectories();
File();
virtual ~File();
void incRef();
void decRef();
virtual bool open(const char *filename, AccessMode mode = kFileReadMode, const char *directory = NULL);
virtual bool exists(const char *filename, const char *directory = NULL);
virtual void close();
bool isOpen() const;
bool ioFailed() const;
void clearIOFailed();
bool eof() const;
uint32 pos() const;
uint32 size() const;
const char *name() const { return _name.c_str(); }
void seek(int32 offs, int whence = SEEK_SET);
uint32 read(void *ptr, uint32 size);
uint32 write(const void *ptr, uint32 size);
char *gets(void *ptr, uint32 size);
};
#endif