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
|
/* ScummVM - Scumm Interpreter
* Copyright (C) 2005-2006 The ScummVM project
*
* 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.
*
* $URL$
* $Id$
*
*/
#ifndef COMMON_ADVANCED_DETECTOR_H
#define COMMON_ADVANCED_DETECTOR_H
#include "common/fs.h"
#include "base/game.h" // For PlainGameDescriptor and GameList
#include "base/plugins.h" // For PluginError
namespace Common {
struct ADGameFileDescription {
const char *fileName;
uint16 fileType; // Optional. Not used during detection, only by engines.
const char *md5; // Optional. May be NULL.
const int32 fileSize; // Optional. Set to -1 to ignore.
};
struct ADGameDescription {
const char *gameid;
const char *extra;
const ADGameFileDescription filesDescriptions[14];
Language language;
Platform platform;
};
struct ADObsoleteGameID {
const char *from;
const char *to;
Common::Platform platform;
};
struct ADParams {
// Pointer to ADGameDescription or its superset structure
const byte *descs;
// Size of that superset structure
const int descItemSize;
// Number of bytes to compute MD5 sum for
const int md5Bytes;
// List of all engine targets
const PlainGameDescriptor *list;
// Structure for autoupgrading obsolete targets
const Common::ADObsoleteGameID *obsoleteList;
};
typedef Array<int> ADList;
typedef Array<const ADGameDescription*> ADGameDescList;
#define AD_ENTRY1(f, x) {{ f, 0, x, -1}, {NULL, 0, NULL, 0}}
// FIXME/TODO: Rename this function to something more sensible.
GameDescriptor ADVANCED_DETECTOR_FIND_GAMEID(
const char *gameid,
const Common::ADParams ¶ms
);
// FIXME/TODO: Rename this function to something more sensible.
GameList ADVANCED_DETECTOR_DETECT_GAMES_FUNCTION(
const FSList &fslist,
const Common::ADParams ¶ms
);
// FIXME/TODO: Rename this function to something more sensible.
int ADVANCED_DETECTOR_DETECT_INIT_GAME(
const Common::ADParams ¶ms
);
// FIXME/TODO: Rename this function to something more sensible.
PluginError ADVANCED_DETECTOR_ENGINE_CREATE(
GameList (*detectFunc)(const FSList &fslist),
const Common::ADParams ¶ms
);
#define ADVANCED_DETECTOR_DEFINE_PLUGIN(engine,className,detectFunc,params) \
GameList Engine_##engine##_gameIDList() { \
return GameList(params.list); \
} \
GameDescriptor Engine_##engine##_findGameID(const char *gameid) { \
return Common::ADVANCED_DETECTOR_FIND_GAMEID(gameid, params); \
} \
GameList Engine_##engine##_detectGames(const FSList &fslist) { \
return detectFunc(fslist); \
} \
PluginError Engine_##engine##_create(OSystem *syst, Engine **engine) { \
assert(syst); \
assert(engine); \
PluginError err = ADVANCED_DETECTOR_ENGINE_CREATE(detectFunc, params); \
if (err == kNoError) \
*engine = new className(syst); \
return err; \
} \
void dummyFuncToAllowTrailingSemicolon()
} // End of namespace Common
#endif
|
