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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/* 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 COMMON_WINEXE_H
#define COMMON_WINEXE_H
#include "common/hash-str.h"
#include "common/str.h"
#include "common/types.h"
namespace Common {
/**
* @defgroup common_winexe Windows resources
* @ingroup common
*
* @brief API for managing Windows resources.
*
* @{
*/
class Path;
class SeekableReadStream;
/** The default Windows resources. */
enum WinResourceType {
kWinCursor = 0x01,
kWinBitmap = 0x02,
kWinIcon = 0x03,
kWinMenu = 0x04,
kWinDialog = 0x05,
kWinString = 0x06,
kWinFontDir = 0x07,
kWinFont = 0x08,
kWinAccelerator = 0x09,
kWinRCData = 0x0A,
kWinMessageTable = 0x0B,
kWinGroupCursor = 0x0C,
kWinGroupIcon = 0x0E,
kWinNameTable = 0x0F,
kWinVersion = 0x10,
kWinDlgInclude = 0x11,
kWinPlugPlay = 0x13,
kWinVXD = 0x14,
kWinAniCursor = 0x15,
kWinAniIcon = 0x16,
kWinHTML = 0x17,
kWinManifest = 0x18
};
class WinResourceID {
public:
WinResourceID() { _idType = kIDTypeNull; _id = 0; }
WinResourceID(String x) { _idType = kIDTypeString; _name = x; }
WinResourceID(uint32 x) { _idType = kIDTypeNumerical; _id = x; }
WinResourceID &operator=(const String &x);
WinResourceID &operator=(uint32 x);
bool operator==(const String &x) const;
bool operator==(const uint32 &x) const;
bool operator==(const WinResourceID &x) const;
String getString() const;
uint32 getID() const;
String toString() const;
private:
/** An ID Type. */
enum IDType {
kIDTypeNull, ///< No type set
kIDTypeNumerical, ///< A numerical ID.
kIDTypeString ///< A string ID.
} _idType;
String _name; ///< The resource's string ID.
uint32 _id; ///< The resource's numerical ID.
};
struct WinResourceID_Hash {
uint operator()(const WinResourceID &id) const { return id.toString().hash(); }
};
struct WinResourceID_EqualTo {
bool operator()(const WinResourceID &id1, const WinResourceID &id2) const { return id1 == id2; }
};
/**
* A class able to load resources from a Windows Executable, such
* as cursors, bitmaps, and sounds.
*/
class WinResources {
public:
virtual ~WinResources() {};
/** Clear all information. */
virtual void clear() = 0;
/** Load from an EXE file. */
virtual bool loadFromEXE(const Path &fileName);
/** Load from a Windows compressed EXE file. */
virtual bool loadFromCompressedEXE(const Path &fileName);
/** Load from a stream. */
virtual bool loadFromEXE(SeekableReadStream *stream, DisposeAfterUse::Flag disposeFileHandle = DisposeAfterUse::YES) = 0;
/** Return a list of IDs for a given type. */
virtual const Array<WinResourceID> getIDList(const WinResourceID &type) const = 0;
/** Return a list of languages for a given type and ID. */
virtual const Array<WinResourceID> getLangList(const WinResourceID &type, const WinResourceID &id) const {
Array<WinResourceID> array;
return array;
}
/** Return a stream to the specified resource, taking the first language found (or 0 if non-existent). */
virtual SeekableReadStream *getResource(const WinResourceID &type, const WinResourceID &id) = 0;
/** Return a stream to the specified resource (or 0 if non-existent). */
virtual SeekableReadStream *getResource(const WinResourceID &type, const WinResourceID &id, const WinResourceID &lang) {
return getResource(type, id);
}
static WinResources *createFromEXE(const Path &fileName);
static WinResources *createFromEXE(SeekableReadStream *stream);
typedef Common::HashMap<Common::String, Common::U32String, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> VersionHash;
/** The structure of the version resource inside an NE EXE */
struct VersionInfo {
VersionInfo();
uint16 fileVersion[4];
uint16 productVersion[4];
uint32 fileFlagsMask;
uint32 fileFlags;
uint32 fileOS;
uint32 fileType;
uint32 fileSubtype;
uint32 fileDate[2];
VersionHash hash;
bool readVSVersionInfo(SeekableReadStream *res);
};
VersionInfo *getVersionResource(const WinResourceID &id);
/** Get a string from a string resource. */
virtual String loadString(uint32 stringID) = 0;
protected:
virtual VersionInfo *parseVersionInfo(SeekableReadStream *stream) = 0;
};
/** @} */
} // End of namespace Common
#endif
|
