1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #ifndef GLK_MAGNETIC_DETECTION
24 #define GLK_MAGNETIC_DETECTION
25 
26 #include "common/fs.h"
27 #include "common/hash-str.h"
28 #include "engines/game.h"
29 #include "glk/detection.h"
30 
31 namespace Glk {
32 namespace Magnetic {
33 
34 /**
35  * The following game database is built from Generic/games.txt, and is used
36  * to identify the game being run.  Magnetic Scrolls games don't generally
37  * supply a status line, so this data can be used instead.
38  */
39 struct gms_game_table_t {
40 	const uint32 undo_size;   ///< Header word at offset 0x22
41 	const uint32 undo_pc;     ///< Header word at offset 0x26
42 	const char *const name;   ///< Game title and platform
43 };
44 typedef const gms_game_table_t *gms_game_tableref_t;
45 
46 /**
47  * Meta engine for Magnetic interpreter
48  */
49 class MagneticMetaEngine {
50 public:
51 	/**
52 	 * Get a list of supported games
53 	 */
54 	static void getSupportedGames(PlainGameList &games);
55 
56 	/**
57 	 * Returns a game description for the given game Id, if it's supported
58 	 */
59 	static GameDescriptor findGame(const char *gameId);
60 
61 	/**
62 	 * Detect supported games
63 	 */
64 	static bool detectGames(const Common::FSList &fslist, DetectedGames &gameList);
65 
66 	/**
67 	 * Check for game Id clashes with other sub-engines
68 	 */
69 	static void detectClashes(Common::StringMap &map);
70 };
71 
72 /**
73  * Look up and return the game table entry given a game's undo size and
74  * undo pc values.  Returns the entry, or NULL if not found.
75  */
76 extern const gms_game_table_t *gms_gameid_lookup_game(uint32 undo_size, uint32 undo_pc);
77 
78 } // End of namespace Magnetic
79 } // End of namespace Glk
80 
81 #endif
82