aboutsummaryrefslogtreecommitdiff
path: root/engines/glk/frotz/pics.h
blob: 68facf5b9ffb6f6e08fb0a60b6d5969f05e24387 (plain)
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
129
130
131
/* 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.
 *
 */

#ifndef GLK_FROTZ_PICS_H
#define GLK_FROTZ_PICS_H

#include "common/archive.h"
#include "common/array.h"

namespace Glk {
namespace Frotz {

enum PicturesMode {
	kMONO  = 0,
	kTEXT  = 1,
	kCGA   = 2,
	kMCGA  = 3,
	kEGA   = 4,
	kAmiga = 5
};

/**
 * Infocom graphics file manager
 */
class Pics : public Common::Archive {
	/**
	 * Describes a single index entry
	 */
	struct Entry {
		uint _number;
		size_t _width, _height;
		uint _flags;
		size_t _dataOffset;
		size_t _dataSize;
		size_t _paletteOffset;
		Common::String _filename;

		/**
		 * Constructor
		 */
		Entry() : _number(0), _width(0), _height(0), _flags(0), _dataOffset(0), _dataSize(0),
			_paletteOffset(0) {}
	};
private:
	Common::String _filename;
	Common::Array<Entry> _index;	///< list of entries
	uint _entrySize;
	uint _version;
	Common::Array<byte> *_palette;
private:
	/**
	 * Returns the filename for the pictures archive
	 */
	static Common::String getFilename();
public:
	/**
	 * Returns true if an mg1 file exists for the game
	 */
	static bool exists();
public:
	/**
	 * Constructor
	 */
	Pics();

	/**
	 * Destructor
	 */
	~Pics();

	/**
	 * Return the number of entries in the file
	 */
	size_t size() const { return _index.size(); }

	/**
	 * Return the version of the file
	 */
	uint version() const { return _version; }

	/**
	 * Check if a member with the given name is present in the Archive.
	 * Patterns are not allowed, as this is meant to be a quick File::exists()
	 * replacement.
	 */
	virtual bool hasFile(const Common::String &name) const override;

	/**
	 * Add all members of the Archive to list.
	 * Must only append to list, and not remove elements from it.
	 *
	 * @return the number of names added to list
	 */
	virtual int listMembers(Common::ArchiveMemberList &list) const override;

	/**
	 * Returns a ArchiveMember representation of the given file.
	 */
	virtual const Common::ArchiveMemberPtr getMember(const Common::String &name) const override;

	/**
	 * Create a stream bound to a member with the specified name in the
	 * archive. If no member with this name exists, 0 is returned.
	 * @return the newly created input stream
	 */
	virtual Common::SeekableReadStream *createReadStreamForMember(const Common::String &name) const override;
};

} // End of namespace Frotz
} // End of namespace Glk

#endif