Ticket #8775: saves-2.patch

engines/sword1/sword1.cpp

@@ -169 +169 @@
         return kNoError;
 }
 
+static SaveStateList Engine_SWORD1_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 REGISTER_PLUGIN(SWORD1, "Broken Sword", "Broken Sword Games (C) Revolution");
 
 namespace Sword1 {

engines/sword2/sword2.cpp

@@ -162 +162 @@
         return kNoGameDataFoundError;
 }
 
+static SaveStateList Engine_SWORD2_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 REGISTER_PLUGIN(SWORD2, "Broken Sword 2", "Broken Sword Games (C) Revolution");
 
 namespace Sword2 {

engines/scumm/dialogs.cpp

@@ -421 +421 @@
 Common::StringList generateSavegameList(ScummEngine *scumm, bool saveMode) {
         // Get savegame descriptions
         Common::StringList descriptions;
-        char name[32];
         uint i = saveMode ? 1 : 0;              //the autosave is on slot #0
         bool avail_saves[81];
 
         scumm->listSavegames(avail_saves, ARRAYSIZE(avail_saves));
         for (; i < ARRAYSIZE(avail_saves); i++) {
+                Common::String name;
                 if (avail_saves[i])
                         scumm->getSavegameName(i, name);
-                else
-                        name[0] = 0;
                 descriptions.push_back(name);
         }
 

engines/scumm/scumm.h

@@ -623 +623 @@
         int getKeyState(int key);
 
 public:
-        bool getSavegameName(int slot, char *desc);
+        bool getSavegameName(int slot, Common::String &desc);
         void listSavegames(bool *marks, int num);
 
         void requestSave(int slot, const char *name, bool temporary = false);

engines/scumm/saveload.cpp

@@ -431 +431 @@
         }
 }
 
-bool ScummEngine::getSavegameName(int slot, char *desc) {
+bool getSavegameName(Common::InSaveFile *in, Common::String &desc, int heversion);
+
+bool ScummEngine::getSavegameName(int slot, Common::String &desc) {
+        Common::InSaveFile *in = 0;
+        bool result = false;
         char filename[256];
-        Common::InSaveFile *in;
-        SaveGameHeader hdr;
 
+        desc.clear();
         makeSavegameName(filename, slot, false);
-        if (!(in = _saveFileMan->openForLoading(filename))) {
-                strcpy(desc, "");
-                return false;
+        in = _saveFileMan->openForLoading(filename);
+        if (in) {
+                result = Scumm::getSavegameName(in, desc, _game.heversion);
+                delete in;
         }
+        return result;
+}
 
+bool getSavegameName(Common::InSaveFile *in, Common::String &desc, int heversion) {
+        SaveGameHeader hdr;
+
         if (!loadSaveGameHeader(in, hdr)) {
-                delete in;
-                strcpy(desc, "Invalid savegame");
+                desc = "Invalid savegame";
                 return false;
         }
-        delete in;
 
         if (hdr.ver > CURRENT_VER)
                 hdr.ver = TO_LE_32(hdr.ver);
         if (hdr.ver < VER(7) || hdr.ver > CURRENT_VER) {
-                strcpy(desc, "Invalid version");
+                desc = "Invalid version";
                 return false;
         }
 
         // We (deliberately) broke HE savegame compatibility at some point.
-        if (hdr.ver < VER(57) && _game.heversion >= 60) {
-                strcpy(desc, "Unsupported version");
+        if (hdr.ver < VER(57) && heversion >= 60) {
+                desc = "Unsupported version";
                 return false;
         }
 
-        memcpy(desc, hdr.name, sizeof(hdr.name));
-        desc[sizeof(hdr.name) - 1] = 0;
+        hdr.name[sizeof(hdr.name) - 1] = 0;
+        desc = hdr.name;
         return true;
 }
 

engines/scumm/script_v5.cpp

@@ -942 +942 @@
                         int slotSize;
                         byte* slotContent;
                         int savegameId;
-                        char name[32];
                         bool avail_saves[100];
 
                         if (a == STRINGID_IQ_SERIES && b == STRINGID_IQ_SERIES) {
@@ -960 +959 @@
 
                                 // load savegame names
                                 savegameId = slot - a + 1;
+                                Common::String name;
                                 if (avail_saves[savegameId] && getSavegameName(savegameId, name)) {
                                         int pos;
-                                        char *ptr = name;
+                                        const char *ptr = name.c_str();
                                         // slotContent ends with {'\0','@'} -> max. length = slotSize-2
                                         for (pos = 0; pos < slotSize - 2; ++pos) {
                                                 if (!ptr[pos])

engines/scumm/detection.cpp

@@ -29 +29 @@
 #include "common/fs.h"
 #include "common/list.h"
 #include "common/md5.h"
+#include "common/savefile.h"
+#include "common/system.h"
 
 #include "scumm/detection.h"
 #include "scumm/detection_tables.h"
@@ -904 +906 @@
         return kNoError;
 }
 
+namespace Scumm {
+        extern bool getSavegameName(Common::InSaveFile *in, Common::String &desc, int heversion);
+}
+
+static SaveStateList Engine_SCUMM_listSaves(const char *target) {
+        Common::SaveFileManager *saveFileMan = g_system->getSavefileManager();
+        Common::StringList filenames;
+        Common::String saveDesc;
+        Common::String pattern = target;
+        pattern += ".s??";
+
+        filenames = saveFileMan->listSavefiles(pattern.c_str());
+        sort(filenames.begin(), filenames.end());       // Sort (hopefully ensuring we are sorted numerically..)
+
+        SaveStateList saveList;
+        for (Common::StringList::const_iterator file = filenames.begin(); file != filenames.end(); file++){
+                // Obtain the last 2 digits of the filename, since they correspond to the save slot
+                int slotNum = atoi(file->c_str() + file->size() - 2);
+                
+                if (slotNum >= 0 && slotNum <= 99) {
+                        Common::InSaveFile *in = saveFileMan->openForLoading(file->c_str());
+                        if (in) {
+                                Scumm::getSavegameName(in, saveDesc, 0);        // FIXME: heversion?!?
+                                saveList.push_back(SaveStateDescriptor(slotNum, saveDesc, *file));
+                                delete in;
+                        }
+                }
+        }
+
+        return saveList;
+}
+
 REGISTER_PLUGIN(SCUMM, "Scumm Engine",
                                 "LucasArts SCUMM Games (C) LucasArts\n"
                                 "Humongous SCUMM Games (C) Humongous" );

engines/scumm/script_v8.cpp

@@ -1235 +1235 @@
                 removeBlastTexts();
                 break;
         case 25: {      // saveGameReadName
-                char name[30];
+                Common::String name;
                 if (getSavegameName(args[1], name)) {
-                        int size = resStrLen((const byte *)name) + 1;
+                        int size = name.size() + 1;
                         _res->nukeResource(rtString, args[2]);
 
                         ArrayHeader *ah = (ArrayHeader *)_res->createResource(rtString, args[2], size + sizeof(ArrayHeader));
@@ -1245 +1245 @@
                         ah->dim1 = TO_LE_16(size + 1);
                         ah->dim2 = TO_LE_16(1);
 
-                        memcpy(getStringAddress(args[2]), name, size);
+                        memcpy(getStringAddress(args[2]), name.c_str(), size);
                 }
                 break;
         }

engines/touche/detection.cpp

@@ -132 +132 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_TOUCHE_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(TOUCHE, Engine_TOUCHE_createInstance, detectionParams);
 
 REGISTER_PLUGIN(TOUCHE, "Touche Engine", "Touche: The Adventures of the 5th Musketeer (C) Clipper Software");

engines/agos/detection.cpp

@@ -136 +136 @@
         return res;
 }
 
+static SaveStateList Engine_AGOS_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(AGOS, engineCreateAgos, detectionParams);
 
 REGISTER_PLUGIN(AGOS, "AGOS", "AGOS (C) Adventure Soft");

engines/cruise/detection.cpp

@@ -131 +131 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_CRUISE_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(CRUISE, Engine_CRUISE_createInstance, detectionParams);
 
 REGISTER_PLUGIN(CRUISE, "Cinematique evo 2 engine", "Cruise for a Corpse (C) Delphine Software");

engines/drascula/detection.cpp

@@ -171 +171 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_DRASCULA_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(DRASCULA, Engine_DRASCULA_createInstance, detectionParams);
 
 REGISTER_PLUGIN(DRASCULA, "Drascula Engine", "Drascula Engine (C) 2000 Alcachofa Soft, 1996 (C) Digital Dreams Multimedia, 1994 (C) Emilio de Paz");

engines/agi/detection.cpp

@@ -2271 +2271 @@
         return res;
 }
 
+static SaveStateList Engine_AGI_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(AGI, engineCreateAgi, detectionParams);
 
 REGISTER_PLUGIN(AGI, "AGI preAGI + v2 + v3 Engine", "Sierra AGI Engine (C) Sierra On-Line Software");

engines/igor/detection.cpp

@@ -119 +119 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_IGOR_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(IGOR, Engine_IGOR_createInstance, igorDetectionParams);
 
 REGISTER_PLUGIN(IGOR, "Igor: Objective Uikokahonia", "Igor: Objective Uikokahonia (C) Pendulo Studios");

engines/kyra/detection.cpp

@@ -469 +469 @@
         return res;
 }
 
+static SaveStateList Engine_KYRA_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(KYRA, engineCreateKyra, detectionParams);
 
 REGISTER_PLUGIN(KYRA, "Legend of Kyrandia Engine", "The Legend of Kyrandia (C) Westwood Studios");

engines/sky/sky.cpp

@@ -172 +172 @@
         return kNoError;
 }
 
+static SaveStateList Engine_SKY_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 REGISTER_PLUGIN(SKY, "Beneath a Steel Sky", "Beneath a Steel Sky (C) Revolution");
 
 

engines/gob/detection.cpp

@@ -1751 +1751 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_GOB_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(GOB, Engine_GOB_createInstance, detectionParams);
 
 REGISTER_PLUGIN(GOB, "Gob Engine", "Goblins Games (C) Coktel Vision");

engines/lure/detection.cpp

@@ -182 +182 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_LURE_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(LURE, Engine_LURE_createInstance, detectionParams);
 
 REGISTER_PLUGIN(LURE, "Lure of the Temptress Engine", "Lure of the Temptress (C) Revolution");

engines/parallaction/detection.cpp

@@ -203 +203 @@
         return res;
 }
 
+static SaveStateList Engine_PARALLACTION_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(PARALLACTION, Engine_PARALLACTION_createInstance, detectionParams);
 
 REGISTER_PLUGIN(PARALLACTION, "Parallaction engine", "Nippon Safes Inc. (C) Dynabyte");

engines/saga/detection.cpp

@@ -147 +147 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_SAGA_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(SAGA, Engine_SAGA_createInstance, detectionParams);
 
 REGISTER_PLUGIN(SAGA, "SAGA Engine", "Inherit the Earth (C) Wyrmkeep Entertainment");

engines/queen/queen.cpp

@@ -105 +105 @@
         return kNoError;
 }
 
+static SaveStateList Engine_QUEEN_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 REGISTER_PLUGIN(QUEEN, "Flight of the Amazon Queen", "Flight of the Amazon Queen (C) John Passfield and Steve Stamatiadis");
 
 namespace Queen {

engines/cine/detection.cpp

@@ -496 +496 @@
         return gd != 0;
 }
 
+static SaveStateList Engine_CINE_listSaves(const char *target) {
+        return SaveStateList();
+}
+
 ADVANCED_DETECTOR_DEFINE_PLUGIN(CINE, Engine_CINE_createInstance, detectionParams);
 
 REGISTER_PLUGIN(CINE, "Cinematique evo 1 engine", "Future Wars & Operation Stealth (C) Delphine Software");

base/game.h

@@ -30 +30 @@
 #include "common/array.h"
 #include "common/hash-str.h"
 
+namespace Graphics {
+        class Surface;
+}
+
 /**
  * A simple structure used to map gameids (like "monkey", "sword1", ...) to
  * nice human readable and descriptive game titles (like "The Secret of Monkey Island").
@@ -67 +71 @@
                 setVal("description", pgd.description);
         }
 
-        GameDescriptor(Common::String g, Common::String d, Common::Language l  = Common::UNK_LANG,
+        GameDescriptor(const Common::String &g, const Common::String &d, Common::Language l  = Common::UNK_LANG,
                      Common::Platform p = Common::kPlatformUnknown) {
                 setVal("gameid", g);
                 setVal("description", d);
@@ -103 +107 @@
         }
 };
 
+/**
+ * A hashmap describing details about a given save state.
+ * TODO
+ * Guaranteed to contain save_slot, filename and description values.
+ * Additional ideas: Playtime, creation date, thumbnail, ...
+ */
+class SaveStateDescriptor : public Common::StringMap {
+protected:
+        Graphics::Surface       *_thumbnail;    // can be NULL
+public:
+        SaveStateDescriptor() : _thumbnail(0) {
+                setVal("save_slot", "-1");      // FIXME: default to 0 (first slot) or to -1 (invalid slot) ?
+                setVal("description", "");
+                setVal("filename", "");
+        }
 
+        SaveStateDescriptor(int s, const Common::String &d, const Common::String &f) : _thumbnail(0) {
+                char buf[16];
+                sprintf(buf, "%d", s);
+                setVal("save_slot", buf);
+                setVal("description", d);
+                setVal("filename", f);
+        }
 
+        SaveStateDescriptor(const Common::String &s, const Common::String &d, const Common::String &f) : _thumbnail(0) {
+                setVal("save_slot", s);
+                setVal("description", d);
+                setVal("filename", f);
+        }
+
+        ~SaveStateDescriptor() {
+                setThumbnail(0);
+        }
+
+        /** The saveslot id, as it would be passed to the "-x" command line switch. */
+        Common::String &save_slot() { return getVal("save_slot"); }
+
+        /** The saveslot id, as it would be passed to the "-x" command line switch (read-only variant). */
+        const Common::String &save_slot() const { return getVal("save_slot"); }
+
+        /** A human readable description of the save state. */
+        Common::String &description() { return getVal("description"); }
+
+        /** A human readable description of the save state (read-only variant). */
+        const Common::String &description() const { return getVal("description"); }
+
+        /** The filename of the savestate, for use with the SaveFileManager API. */
+        Common::String &filename() { return getVal("filename"); }
+
+        /** The filename of the savestate, for use with the SaveFileManager API (read-only variant). */
+        const Common::String &filename() const { return getVal("filename"); }
+
+        /**
+         * Return a thumbnail graphics surface representing the savestate visually
+         * This is usually a scaled down version of the game graphics. The size
+         * should be either 160x100 or 160x120 pixels, depending on the aspect
+         * ratio of the game. If another ratio is required, contact the core team.
+         *
+         * TODO: it is probably a bad idea to read this for *all* games at once,
+         * at least on low-end devices. So this info should probably normally only
+         * be included optionally. I.e. only upon a query for a specific savegame...
+         * To this end, add a getFullSaveStateInfo(target, slot) to the plugin API.
+         */
+        const Graphics::Surface *getThumbnail() const { return _thumbnail; }
+
+        
+        void setThumbnail(Graphics::Surface *t);
+};
+
+/** List of savestates. */
+typedef Common::Array<SaveStateDescriptor> SaveStateList;
+
+
 class Plugin;
 
 namespace Base {

base/plugins.cpp

@@ -62 +62 @@
                 assert(_plugin->_df);
                 return (*_plugin->_df)(fslist);
         }
+
+        SaveStateList listSaves(const char *target) const {
+                assert(_plugin->_lsf);
+                return (*_plugin->_lsf)(target);
+        }
 };
 
 class StaticPluginProvider : public PluginProvider {

base/plugins.h

@@ -59 +59 @@
 public:
         virtual ~Plugin() {}
 
+//      virtual bool isLoaded() const = 0;      // TODO
         virtual bool loadPlugin() = 0;
         virtual void unloadPlugin() = 0;
 
@@ -70 +71 @@
         virtual GameDescriptor findGame(const char *gameid) const = 0;
         virtual GameList detectGames(const FSList &fslist) const = 0;
 
+        virtual SaveStateList listSaves(const char *target) const = 0;
+
         virtual PluginError createInstance(OSystem *syst, Engine **engine) const = 0;
 };
 
@@ -106 +109 @@
                         Engine_##ID##_gameIDList(), \
                         Engine_##ID##_findGameID, \
                         Engine_##ID##_create, \
-                        Engine_##ID##_detectGames \
+                        Engine_##ID##_detectGames, \
+                        Engine_##ID##_listSaves \
                         );\
         } \
         void dummyFuncToAllowTrailingSemicolon()
@@ -119 +123 @@
                 PLUGIN_EXPORT GameDescriptor PLUGIN_findGameID(const char *gameid) { return Engine_##ID##_findGameID(gameid); } \
                 PLUGIN_EXPORT PluginError PLUGIN_createEngine(OSystem *syst, Engine **engine) { return Engine_##ID##_create(syst, engine); } \
                 PLUGIN_EXPORT GameList PLUGIN_detectGames(const FSList &fslist) { return Engine_##ID##_detectGames(fslist); } \
+                PLUGIN_EXPORT SaveStateList PLUGIN_listSaves(const char *target) { return Engine_##ID##_listSaves(target); } \
         } \
         void dummyFuncToAllowTrailingSemicolon()
 #endif
@@ -134 +139 @@
         typedef GameDescriptor (*GameIDQueryFunc)(const char *gameid);
         typedef PluginError (*EngineFactory)(OSystem *syst, Engine **engine);
         typedef GameList (*DetectFunc)(const FSList &fslist);
+        typedef SaveStateList (*ListSavesFunc)(const char *target);
 
 protected:
         const char *_name;
@@ -141 +147 @@
         GameIDQueryFunc _qf;
         EngineFactory _ef;
         DetectFunc _df;
+        ListSavesFunc _lsf;
         GameList _games;
 
 public:
-        PluginRegistrator(const char *name, const char *copyright, GameList games, GameIDQueryFunc qf, EngineFactory ef, DetectFunc df)
-                : _name(name), _copyright(copyright), _qf(qf), _ef(ef), _df(df), _games(games) {}
+        PluginRegistrator(const char *name, const char *copyright, GameList games, GameIDQueryFunc qf, EngineFactory ef, DetectFunc df, ListSavesFunc lsf)
+                : _name(name), _copyright(copyright), _qf(qf), _ef(ef), _df(df), _lsf(lsf), _games(games) {}
 };
 #endif
 

base/commandLine.cpp

@@ -567 +567 @@
         printf("Target               Description                                           \n"
                "-------------------- ------------------------------------------------------\n");
 
+#if 1
+        // FIXME HACK
+        g_system->initBackend();
+#endif
+
         using namespace Common;
         const ConfigManager::DomainMap &domains = ConfMan.getGameDomains();
-        ConfigManager::DomainMap::const_iterator iter = domains.begin();
+        ConfigManager::DomainMap::const_iterator iter;
         for (iter = domains.begin(); iter != domains.end(); ++iter) {
                 Common::String name(iter->_key);
                 Common::String description(iter->_value.get("description"));
@@ -585 +590 @@
                 }
 
                 printf("%-20s %s\n", name.c_str(), description.c_str());
+
+#if 1
+                // FIXME HACK: List all savegames for that target
+
+                // Grab the gameid from the domain
+                Common::String gameid(iter->_value.get("gameid"));
+                if (gameid.empty())
+                        gameid = name;
+                gameid.toLowercase();
+
+                // Find the plugin that will handle the specified gameid
+                const Plugin *plugin = 0;
+                GameDescriptor game = Base::findGame(gameid, &plugin);
+
+                if (!plugin)
+                        continue;
+
+                // Query the plugin for a list of savegames
+                SaveStateList saveList = plugin->listSaves(name.c_str());
+
+                //saveList = FOO;
+                if (!saveList.empty()) {
+                        printf("  Saves:\n");
+                        for (SaveStateList::const_iterator x = saveList.begin(); x != saveList.end(); ++x) {
+                                printf("    slot %-4s %s\n", x->save_slot().c_str(), x->description().c_str());
+                                // TODO: Could also iterate over the full hashmap, printing all key-value pairs
+                        }
+                }
+#endif
         }
 }
 

base/game.cpp

@@ -25 +25 @@
 
 #include "base/game.h"
 #include "base/plugins.h"
+#include "graphics/surface.h"
 
+
 const PlainGameDescriptor *findPlainGameDescriptor(const char *gameid, const PlainGameDescriptor *list) {
         const PlainGameDescriptor *g = list;
         while (g->gameid) {
@@ -66 +68 @@
         }
 }
 
+void SaveStateDescriptor::setThumbnail(Graphics::Surface *t) {
+        if (_thumbnail && _thumbnail != t) {
+                _thumbnail->free();
+                delete _thumbnail;
+        }
+        _thumbnail = t;
+}
+
+
 namespace Base {
 
 // TODO: Find a better name & place for this function.

backends/plugins/dynamic-plugin.h

@@ -36 +36 @@
 typedef GameDescriptor (*GameIDQueryFunc)(const char *gameid);
 typedef GameList (*GameIDListFunc)();
 typedef GameList (*DetectFunc)(const FSList &fslist);
+typedef SaveStateList (*ListSavesFunc)(const char *target);
 
 
 class DynamicPlugin : public Plugin {
@@ -47 +48 @@
         GameIDQueryFunc _qf;
         EngineFactory _ef;
         DetectFunc _df;
+        ListSavesFunc _lsf;
         GameList _games;
 
+        // FIXME: We should really split the ScummVM engine plugin specific stuff
+        // into a separate class and keep only the findSymbol function...
         virtual VoidFunc findSymbol(const char *symbol) = 0;
 
 public:
-        DynamicPlugin() : _qf(0), _ef(0), _df(0), _games() {}
+        DynamicPlugin() : _qf(0), _ef(0), _df(0), _lsf(0), _games() {}
 
         const char *getName() const                                     { return _name.c_str(); }
         const char *getCopyright() const                        { return _copyright.c_str(); }
@@ -74 +78 @@
                 return (*_df)(fslist);
         }
 
+
+        SaveStateList listSaves(const char *target) const {
+                assert(_lsf);
+                return (*_lsf)(fslist);
+        }
+
         virtual bool loadPlugin() {
                 // Query the plugin's name
                 NameFunc nameFunc = (NameFunc)findSymbol("PLUGIN_name");