aboutsummaryrefslogtreecommitdiff
path: root/engines/cge/detection.cpp
blob: c377970c51da411434371af591c010d696531bf6 (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
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
/* 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.
 *
 */

#include "common/config-manager.h"
#include "engines/advancedDetector.h"
#include "common/savefile.h"
#include "common/system.h"
#include "base/plugins.h"
#include "graphics/thumbnail.h"
#include "cge/cge.h"

static const PlainGameDescriptor CGEGames[] = {
	{ "soltys", "Soltys" },
	{ "sfinx", "Sfinx" },
	{ 0, 0 }
};

namespace CGE {

struct CgeGameDescription {
	ADGameDescription desc;
	GameType gameType;
};

static const CgeGameDescription gameDescriptions[] = {

	{
		{
			"soltys", "",
			{
				{"vol.cat", 0, "0c33e2c304821a2444d297fc5e2d67c6", 50176},
				{"vol.dat", 0, "f9ae2e7f8f7cac91378cdafca43faf1e", 8437572},
				AD_LISTEND
			},
			Common::PL_POL, Common::kPlatformDOS, ADGF_NO_FLAGS, GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			"soltys", "Soltys Freeware",
			{
				{"vol.cat", 0, "0c33e2c304821a2444d297fc5e2d67c6", 50176},
				{"vol.dat", 0, "f9ae2e7f8f7cac91378cdafca43faf1e", 8437676},
				AD_LISTEND
			},
			Common::PL_POL, Common::kPlatformDOS, ADGF_NO_FLAGS, GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			"soltys", "Soltys Demo (not supported)",
			{
				{"vol.cat", 0, "1e077c8ff58109a187f07ac54b0c873a", 18788},
				{"vol.dat", 0, "75d385a6074c58b69f7730481f256051", 1796710},
				AD_LISTEND
			},
			Common::EN_ANY, Common::kPlatformDOS, ADGF_DEMO , GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			"soltys", "Soltys Demo (not supported)",
			{
				{"vol.cat", 0, "f17987487fab1ebddd781d8d02fedecc", 7168},
				{"vol.dat", 0, "c5d9b15863cab61dc125551576dece04", 1075272},
				AD_LISTEND
			},
			Common::PL_POL, Common::kPlatformDOS, ADGF_DEMO , GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			"soltys", "Soltys Freeware v1.0",
			{
				{"vol.cat", 0, "f1675684c68ab90272f5776f8f2c3974", 50176},
				{"vol.dat", 0, "4ffeff4abc99ac5999b55ccfc56ab1df", 8430868},
				AD_LISTEND
			},
			Common::EN_ANY, Common::kPlatformDOS, ADGF_NO_FLAGS , GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			"soltys", "Soltys Freeware v1.0",
			{
				{"vol.cat", 0, "20fdce799adb618100ef9ee2362be875", 50176},
				{"vol.dat", 0, "0e43331c846094d77f5dd201827e0a3b", 8439339},
				AD_LISTEND
			},
			Common::PL_POL, Common::kPlatformDOS, ADGF_NO_FLAGS, GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			"soltys", "Soltys Freeware v1.0",
			{
				{"vol.cat", 0, "fcae86b20eaa5cedec17b24fa5e85eb4", 50176},
				{"vol.dat", 0, "ff10d54acc2c95696c57e05819b6906f", 8450151},
				AD_LISTEND
			},
			Common::ES_ESP, Common::kPlatformDOS, ADGF_NO_FLAGS , GUIO0()
		},
		kGameTypeSoltys
	},
	{
		{
			// Polish version, provided by Strangerke
			"sfinx", "Sfinx Freeware",
			{
				{"vol.cat", 0, "21197b287d397c53261b6616bf0dd880", 129024},
				{"vol.dat", 0, "de14291869a8eb7c2732ab783c7542ef", 34180844},
				AD_LISTEND
			},
			Common::PL_POL, Common::kPlatformDOS, ADGF_NO_FLAGS, GUIO0()
		},
		kGameTypeSfinx
	},

	{AD_TABLE_END_MARKER, kGameTypeNone}
};

static const ADFileBasedFallback fileBasedFallback[] = {
	{ &gameDescriptions[0].desc, { "vol.cat", "vol.dat", 0 } },
	{ 0, { 0 } }
};

} // End of namespace CGE

class CGEMetaEngine : public AdvancedMetaEngine {
public:
	CGEMetaEngine() : AdvancedMetaEngine(CGE::gameDescriptions, sizeof(CGE::CgeGameDescription), CGEGames) {
		_singleid = "soltys";
	}

	virtual const ADGameDescription *fallbackDetect(const FileMap &allFiles, const Common::FSList &fslist) const {
		return detectGameFilebased(allFiles, fslist, CGE::fileBasedFallback);
	}

	virtual const char *getName() const {
		return "CGE";
	}

	virtual const char *getOriginalCopyright() const {
		return "Soltys (c) 1994-1996 L.K. Avalon";
	}



	virtual bool hasFeature(MetaEngineFeature f) const;
	virtual bool createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const;
	virtual int getMaximumSaveSlot() const;
	virtual SaveStateList listSaves(const char *target) const;
	SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const;
	virtual void removeSaveState(const char *target, int slot) const;
};

bool CGEMetaEngine::hasFeature(MetaEngineFeature f) const {
	return
	    (f == kSupportsListSaves) ||
	    (f == kSupportsLoadingDuringStartup) ||
	    (f == kSupportsDeleteSave) ||
	    (f == kSavesSupportMetaInfo) ||
	    (f == kSavesSupportThumbnail) ||
	    (f == kSavesSupportCreationDate);
}

void CGEMetaEngine::removeSaveState(const char *target, int slot) const {
	Common::String fileName = Common::String::format("%s.%03d", target, slot);
	g_system->getSavefileManager()->removeSavefile(fileName);
}

int CGEMetaEngine::getMaximumSaveSlot() const {
	return 99;
}

SaveStateList CGEMetaEngine::listSaves(const char *target) const {
	Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
	Common::StringArray filenames;
	Common::String pattern = target;
	pattern += ".???";

	filenames = saveFileMan->listSavefiles(pattern);
	sort(filenames.begin(), filenames.end());   // Sort (hopefully ensuring we are sorted numerically..)

	SaveStateList saveList;
	int slotNum = 0;
	for (Common::StringArray::const_iterator filename = filenames.begin(); filename != filenames.end(); ++filename) {
		// Obtain the last 3 digits of the filename, since they correspond to the save slot
		slotNum = atoi(filename->c_str() + filename->size() - 3);

		if (slotNum >= 0 && slotNum <= 99) {

			Common::InSaveFile *file = saveFileMan->openForLoading(*filename);
			if (file) {
				CGE::SavegameHeader header;

				// Check to see if it's a ScummVM savegame or not
				char buffer[kSavegameStrSize + 1];
				file->read(buffer, kSavegameStrSize + 1);

				if (!strncmp(buffer, CGE::savegameStr, kSavegameStrSize + 1)) {
					// Valid savegame
					if (CGE::CGEEngine::readSavegameHeader(file, header)) {
						saveList.push_back(SaveStateDescriptor(slotNum, header.saveName));
						if (header.thumbnail) {
							header.thumbnail->free();
							delete header.thumbnail;
						}
					}
				} else {
					// Must be an original format savegame
					saveList.push_back(SaveStateDescriptor(slotNum, "Unknown"));
				}

				delete file;
			}
		}
	}

	return saveList;
}

SaveStateDescriptor CGEMetaEngine::querySaveMetaInfos(const char *target, int slot) const {
	Common::String fileName = Common::String::format("%s.%03d", target, slot);
	Common::InSaveFile *f = g_system->getSavefileManager()->openForLoading(fileName);

	if (f) {
		CGE::SavegameHeader header;

		// Check to see if it's a ScummVM savegame or not
		char buffer[kSavegameStrSize + 1];
		f->read(buffer, kSavegameStrSize + 1);

		bool hasHeader = !strncmp(buffer, CGE::savegameStr, kSavegameStrSize + 1) &&
			CGE::CGEEngine::readSavegameHeader(f, header);
		delete f;

		if (!hasHeader) {
			// Original savegame perhaps?
			SaveStateDescriptor desc(slot, "Unknown");
			return desc;
		} else {
			// Create the return descriptor
			SaveStateDescriptor desc(slot, header.saveName);
			desc.setThumbnail(header.thumbnail);
			desc.setSaveDate(header.saveYear, header.saveMonth, header.saveDay);
			desc.setSaveTime(header.saveHour, header.saveMinutes);

			// Slot 0 is used for the 'automatic save on exit' save in Soltys, thus
			// we prevent it from being deleted or overwritten by accident.
			desc.setDeletableFlag(slot != 0);
			desc.setWriteProtectedFlag(slot == 0);

			return desc;
		}
	}

	return SaveStateDescriptor();
}

bool CGEMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const {
	if (desc) {
		*engine = new CGE::CGEEngine(syst, desc);
	}
	return desc != 0;
}

#if PLUGIN_ENABLED_DYNAMIC(CGE)
REGISTER_PLUGIN_DYNAMIC(CGE, PLUGIN_TYPE_ENGINE, CGEMetaEngine);
#else
REGISTER_PLUGIN_STATIC(CGE, PLUGIN_TYPE_ENGINE, CGEMetaEngine);
#endif