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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
/* 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/>.
*
*/
#include "common/debug.h"
#include "common/str.h"
#include "common/stream.h"
#include "common/formats/winexe_ne.h"
namespace Common {
NEResources::NEResources() {
_exe = nullptr;
}
NEResources::~NEResources() {
clear();
}
void NEResources::clear() {
if (_exe) {
if (_disposeFileHandle == DisposeAfterUse::YES)
delete _exe;
_exe = nullptr;
}
_resources.clear();
}
bool NEResources::loadFromEXE(SeekableReadStream *stream, DisposeAfterUse::Flag disposeFileHandle) {
clear();
if (!stream)
return false;
_exe = stream;
_disposeFileHandle = disposeFileHandle;
uint32 offsetResourceTable = getResourceTableOffset();
if (offsetResourceTable == 0xFFFFFFFF)
return false;
if (offsetResourceTable == 0)
return true;
if (!readResourceTable(offsetResourceTable))
return false;
return true;
}
uint32 NEResources::getResourceTableOffset() {
if (!_exe)
return 0xFFFFFFFF;
if (!_exe->seek(0))
return 0xFFFFFFFF;
// 'MZ'
if (_exe->readUint16BE() != 0x4D5A)
return 0xFFFFFFFF;
if (!_exe->seek(60))
return 0xFFFFFFFF;
uint32 offsetSegmentEXE = _exe->readUint16LE();
if (!_exe->seek(offsetSegmentEXE))
return 0xFFFFFFFF;
// 'NE'
if (_exe->readUint16BE() != 0x4E45)
return 0xFFFFFFFF;
if (!_exe->seek(offsetSegmentEXE + 36))
return 0xFFFFFFFF;
uint32 offsetResourceTable = _exe->readUint16LE();
if (offsetResourceTable == 0)
// No resource table
return 0;
// Offset relative to the segment _exe header
offsetResourceTable += offsetSegmentEXE;
if (!_exe->seek(offsetResourceTable))
return 0xFFFFFFFF;
return offsetResourceTable;
}
/**
* A "resource ID -> name" mapping found in some NE executables, stored as a resource.
* Not described by any documentation I could find, but the corresponding #define can be encountered in some old header files.
* Mentioned by this blog post https://www.toptensoftware.com/blog/win3mu-5/ (section "The Mysterious Resource Type #15")
*
* The name table records have the following layout:
*
* struct
* {
* WORD lengthEntry; // length of this entry (including this field)
* WORD resourceType; // see WinResourceType constants
* WORD resourceId; // ordinal of resource | 0x8000
* BYTE paddingZero; // maybe ??
* CHAR szName[]; // null-terminated name
* }
*
*/
bool NEResources::readNameTable(uint32 offset, uint32 size) {
if (!_exe)
return false;
uint32 curPos = _exe->pos();
if (!_exe->seek(offset)) {
_exe->seek(curPos);
return false;
}
uint32 offsetEnd = offset + size;
while (_exe->pos() < offsetEnd) {
uint16 lengthEntry = _exe->readUint16LE();
if (lengthEntry == 0)
break;
uint16 resourceType = _exe->readUint16LE();
uint16 resourceId = _exe->readUint16LE();
resourceId &= 0x7FFF;
_exe->skip(1); // paddingZero
Common::String name = _exe->readString('\0', lengthEntry - 7);
if (name.size() + 8 != lengthEntry) {
warning("NEResources::readNameTable(): unexpected string length in name table (expected = %d, found = %d, string = %s)",
lengthEntry - 7, name.size() + 1, name.c_str());
}
debug(2, "NEResources::readNameTable(): resourceType = %d, resourceId = %d, name = %s",
resourceType, resourceId, name.c_str());
_nameTable[resourceType][resourceId] = name;
}
_exe->seek(curPos);
return true;
}
static const char *const s_resTypeNames[] = {
"", "cursor", "bitmap", "icon", "menu", "dialog", "string",
"font_dir", "font", "accelerator", "rc_data", "msg_table",
"group_cursor", "", "group_icon", "name_table", "version", "dlg_include",
"", "plug_play", "vxd", "ani_cursor", "ani_icon", "html",
"manifest"
};
bool NEResources::readResourceTable(uint32 offset) {
if (!_exe)
return false;
if (!_exe->seek(offset))
return false;
uint32 align = 1 << _exe->readUint16LE();
uint16 typeID = _exe->readUint16LE();
while (typeID != 0) {
// High bit of the type means integer type
WinResourceID type;
if (typeID & 0x8000)
type = typeID & 0x7FFF;
else
type = getResourceString(*_exe, offset + typeID);
uint16 resCount = _exe->readUint16LE();
debug(2, "%d resources in table", resCount);
_exe->skip(4); // reserved
if (resCount > 256) {
warning("NEResources::readResourceTable(): resource table looks malformed, %d entries > 256", resCount);
resCount = 256;
}
for (int i = 0; i < resCount; i++) {
Resource res;
// Resource properties
res.offset = _exe->readUint16LE() * align;
res.size = _exe->readUint16LE() * align;
res.flags = _exe->readUint16LE();
uint16 id = _exe->readUint16LE();
res.handle = _exe->readUint16LE();
res.usage = _exe->readUint16LE();
res.type = type;
// High bit means integer type
if (id & 0x8000)
res.id = id & 0x7FFF;
else
res.id = getResourceString(*_exe, offset + id);
if (typeID & 0x8000 && ((typeID & 0x7FFF) < ARRAYSIZE(s_resTypeNames)) && s_resTypeNames[typeID & 0x7FFF][0] != 0)
debug(2, "Found resource %s %s", s_resTypeNames[typeID & 0x7FFF], res.id.toString().c_str());
else
debug(2, "Found resource %s %s", type.toString().c_str(), res.id.toString().c_str());
_resources.push_back(res);
if (type == kWinNameTable)
readNameTable(res.offset, res.size);
}
typeID = _exe->readUint16LE();
}
return true;
}
String NEResources::getResourceString(SeekableReadStream &exe, uint32 offset) {
uint32 curPos = exe.pos();
if (!exe.seek(offset)) {
exe.seek(curPos);
return "";
}
uint8 length = exe.readByte();
String string;
for (uint16 i = 0; i < length; i++) {
char b = (char)exe.readByte();
// Do not read beyond end of string
if (!b) {
break;
}
string += b;
}
exe.seek(curPos);
return string;
}
const NEResources::Resource *NEResources::findResource(const WinResourceID &type, const WinResourceID &id) const {
for (List<Resource>::const_iterator it = _resources.begin(); it != _resources.end(); ++it) {
if (it->type == type &&
(it->id == id ||
(!_nameTable.empty() &&
_nameTable.contains(it->type) &&
_nameTable[it->type].contains(it->id) &&
_nameTable[it->type][it->id] == id.toString())))
return &*it;
}
return nullptr;
}
SeekableReadStream *NEResources::getResource(const WinResourceID &type, const WinResourceID &id) {
const Resource *res = findResource(type, id);
if (!res)
return nullptr;
_exe->seek(res->offset);
return _exe->readStream(res->size);
}
const Array<WinResourceID> NEResources::getIDList(const WinResourceID &type) const {
Array<WinResourceID> idArray;
for (List<Resource>::const_iterator it = _resources.begin(); it != _resources.end(); ++it)
if (it->type == type)
idArray.push_back(it->id);
return idArray;
}
String NEResources::loadString(uint32 stringID) {
// This is how the resource ID is calculated
String string;
SeekableReadStream *stream = getResource(kWinString, (stringID >> 4) + 1);
if (!stream)
return string;
// Skip over strings we don't care about
uint32 startString = stringID & ~0xF;
for (uint32 i = startString; i < stringID; i++)
stream->skip(stream->readByte());
byte size = stream->readByte();
while (size--)
string += (char)stream->readByte();
delete stream;
return string;
}
WinResources::VersionInfo *NEResources::parseVersionInfo(SeekableReadStream *res) {
VersionInfo *info = new VersionInfo;
while (res->pos() < res->size() && !res->eos()) {
while (res->pos() % 4 && !res->eos()) // Pad to 4
res->readByte();
/* uint16 len = */ res->readUint16LE();
/* uint16 valLen = */ res->readUint16LE();
uint16 c;
Common::String key;
while ((c = res->readByte()) != 0 && !res->eos())
key += c;
while (res->pos() % 4 && !res->eos()) // Pad to 4
res->readByte();
if (res->eos())
break;
if (key == "VS_VERSION_INFO") {
if (!info->readVSVersionInfo(res))
return info;
}
}
return info;
}
} // End of namespace Common
|