File: file.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (128 lines) | stat: -rw-r--r-- 3,223 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef MM_SHARED_XEEN_FILE_H
#define MM_SHARED_XEEN_FILE_H

#include "common/file.h"
#include "common/serializer.h"

namespace MM {
namespace Shared {
namespace Xeen {


/**
 * Derived file class
 */
class File : public Common::File {
private:
public:
#ifdef ENABLE_XEEN
	/**
	 * Sets which archive is used by default
	 */
	static void setCurrentArchive(int ccMode);
#endif

	/**
	 * Synchronizes a boolean array as a bitfield set
	 */
	static void syncBitFlags(Common::Serializer &s, bool *startP, bool *endP);
public:
	File() : Common::File() {
	}
	File(const Common::Path &filename);
	File(const Common::Path &filename, Common::Archive &archive);
#ifdef ENABLE_XEEN
	File(const Common::Path &filename, int ccMode);
#endif
	~File() override {}

	/**
	 * Opens the given file, throwing an error if it can't be opened
	 */
	bool open(const Common::Path &filename) override;

	/**
	 * Opens the given file, throwing an error if it can't be opened
	 */
	bool open(const Common::Path &filename, Common::Archive &archive) override;
#ifdef ENABLE_XEEN
	/**
	 * Opens the given file, throwing an error if it can't be opened
	 */
	virtual bool open(const Common::Path &filename, int ccMode);
#endif

	/**
	 * Opens the given file
	 */
	bool open(const Common::FSNode &node) override {
		return Common::File::open(node);
	}

	/**
	 * Opens the given file
	 */
	bool open(SeekableReadStream *stream, const Common::String &name) override {
		return Common::File::open(stream, name);
	}

	/**
	 * Reads in a null terminated string
	 */
	Common::String readString();

	/**
	 * Checks if a given file exists
	 *
	 * @param	filename	the file to check for
	 * @return	true if the file exists, false otherwise
	 */
	static bool exists(const Common::Path &filename);

#ifdef ENABLE_XEEN
	/**
	 * Checks if a given file exists
	 *
	 * @param	filename	the file to check for
	 * @param	ccMode		Archive to use
	 * @return	true if the file exists, false otherwise
	 */
	static bool exists(const Common::Path &filename, int ccMode);
#endif

	/**
	 * Checks if a given file exists
	 *
	 * @param	filename	the file to check for
	 * @param	archive		Archive to use
	 * @return	true if the file exists, false otherwise
	 */
	static bool exists(const Common::Path &filename, Common::Archive &archive);
};

} // namespace Xeen
} // namespace Shared
} // namespace MM

#endif