Ticket #2361: save_check.patch

binaries/data/mods/public/gui/common/functions_utility_loadsave.js

@@ -8 +8 @@
     return n < 10 ? "0" + n : n;
 }
 
-function generateLabel(metadata)
+function generateLabel(metadata, majorVersion)
 {
     var t = new Date(metadata.time*1000);
 
     var date = t.getFullYear()+"-"+twoDigits(1+t.getMonth())+"-"+twoDigits(t.getDate());
     var time = twoDigits(t.getHours())+":"+twoDigits(t.getMinutes())+":"+twoDigits(t.getSeconds());
-    return "["+date+" "+time+"] "+metadata.initAttributes.map+(metadata.description ? " - "+metadata.description : "");
+    var label = "["+date+" "+time+"] "+metadata.initAttributes.map.replace("maps/","")+(metadata.description ? " - "+metadata.description : "");
+    if (majorVersion)
+        label = label + (majorVersion != metadata.version_major ? "\nIncompatible version [" + metadata.version_major+"."+metadata.version_minor+"]": "");
+    return label;
 }

binaries/data/mods/public/gui/savedgames/load.js

@@ -12 +12 @@
         return;
     }
 
+    // get current save game version from the game 
+    var saveGameVersion = Engine.GetCurrentSaveGameVersion();
+    var majorVersion = saveGameVersion.saveGameVersionMajor;
+    var minorVersion = saveGameVersion.saveGameVersionMinor;
+
     savedGames.sort(sortDecreasingDate);
 
     var gameListIDs = [ game.id for each (game in savedGames) ];
-    var gameListLabels = [ generateLabel(game.metadata) for each (game in savedGames) ];
+    var gameListLabels = [ generateLabel(game.metadata, majorVersion) for each (game in savedGames) ];
+    var gameListCompatible = [ (majorVersion == game.metadata.version_major ? 1 : 0) for each (game in savedGames) ];
 
     gameSelection.list = gameListLabels;
     gameSelection.list_data = gameListIDs;
+    gameSelection.list_selectable = gameListCompatible;
     gameSelection.selected = 0;
 }
 

source/gui/CDropDown.cpp

@@ -497 +497 @@
         if (m_HideScrollBar)
             *scrollbar = false;
 
-        DrawList(m_ElementHighlight, "sprite_list", "sprite_selectarea", "textcolor");
+        DrawList(m_ElementHighlight, "sprite_list", "sprite_selectarea", "textcolor", "warncolor");
         
         if (m_HideScrollBar)
             *scrollbar = old;

source/gui/CList.cpp

@@ -54 +54 @@
     AddSetting(GUIST_int,                   "selected");    // Index selected. -1 is none.
     AddSetting(GUIST_CStrW,                 "tooltip");
     AddSetting(GUIST_CStr,                  "tooltip_style");
-    // Each list item has both a name (in 'list') and an associated data string (in 'list_data')
+    // Each list item has three: a name (in 'list') and an associated data string (in 'list_data') and a value in list_selectable (0 or 1)
     AddSetting(GUIST_CGUIList,              "list");
     AddSetting(GUIST_CGUIList,              "list_data"); // TODO: this should be a list of raw strings, not of CGUIStrings
-
+    AddSetting(GUIST_CGUIList,              "list_selectable");
+    
     GUI<bool>::SetSetting(this, "scrollbar", false);
 
     // Nothing is selected as default.
@@ -232 +233 @@
         
         if (set != -1)
         {
-            GUI<int>::SetSetting(this, "selected", set);
-            UpdateAutoScroll();
+            // check, if it can be selected
+            if(this->canItemBeSelected(set))
+            {
+                GUI<int>::SetSetting(this, "selected", set);
+                UpdateAutoScroll();
 
-            CStrW soundPath;
-            if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
-                g_SoundManager->PlayAsUI(soundPath.c_str(), false);
+                CStrW soundPath;
+                if (g_SoundManager && GUI<CStrW>::GetSetting(this, "sound_selected", soundPath) == PSRETURN_OK && !soundPath.empty())
+                    g_SoundManager->PlayAsUI(soundPath.c_str(), false);
+            }
         }
         break;
     }
@@ -257 +262 @@
     IGUITextOwner::HandleMessage(Message);
 }
 
+bool CList::canItemBeSelected(unsigned int id)
+{
+    CGUIList *pListSelectable;
+    GUI<CGUIList>::GetSettingPointer(this, "list_selectable", pListSelectable);
+    
+    return pListSelectable->m_Items.size() <= id || pListSelectable->m_Items[id].GetOriginalString().ToInt() != 0;
+}
+
 InReaction CList::ManuallyHandleEvent(const SDL_Event_* ev)
 {
     int szChar = ev->ev.key.keysym.sym;
@@ -303 +316 @@
     int selected;
     GUI<int>::GetSetting(this, "selected", selected);
     
-    DrawList(selected, "sprite", "sprite_selectarea", "textcolor");
+    DrawList(selected, "sprite", "sprite_selectarea", "textcolor", "warncolor");
 }
 
 void CList::DrawList(const int &selected,
                      const CStr& _sprite, 
                      const CStr& _sprite_selected, 
-                     const CStr& _textcolor)
+                     const CStr& _textcolor,
+                     const CStr& _inactiveTextcolor)
 {
     float bz = GetBufferedZ();
 
@@ -376 +390 @@
             }
         }
 
-        CColor color;
+        CColor color, unselColor, colorElement;
         GUI<CColor>::GetSetting(this, _textcolor, color);
+        //GUI<CColor>::GetSetting(this, _inactiveTextcolor, unselColor); // TODO: add the color there...'warncolor'
+        
+        unselColor = CColor(255/255.0f, 128/255.0f, 0/255.0f, 1.0f);;
 
         for (int i=0; i<(int)pList->m_Items.size(); ++i)
         {
@@ -399 +416 @@
                     cliparea.left = GetScrollBar(0).GetOuterRect().right;
             }
 
-            DrawText(i, color, rect.TopLeft() - CPos(0.f, scroll - m_ItemsYPositions[i]), bz+0.1f, cliparea);
+            // select color
+            if( this->canItemBeSelected(i) )
+                colorElement = color;
+            else 
+                colorElement = unselColor;
+
+            DrawText(i, colorElement, rect.TopLeft() - CPos(0.f, scroll - m_ItemsYPositions[i]), bz+0.1f, cliparea);
         }
     }
 }
 
-void CList::AddItem(const CStrW& str, const CStrW& data)
+void CList::AddItem(const CStrW& str, const CStrW& data, bool selectable)
 {
-    CGUIList *pList, *pListData;
+    //TODO: this seems not to work also in version in SVN or does it ?!
+    CGUIList *pList, *pListData, *pListSelectable;
     GUI<CGUIList>::GetSettingPointer(this, "list", pList);
     GUI<CGUIList>::GetSettingPointer(this, "list_data", pListData);
+    GUI<CGUIList>::GetSettingPointer(this, "list_selectable", pListSelectable);
 
     CGUIString gui_string;
     gui_string.SetValue(str);
@@ -418 +443 @@
     data_string.SetValue(data);
     pListData->m_Items.push_back( data_string );
 
+    CGUIString sel_string;
+    sel_string.SetValue(selectable ? L"1" : L"0");
+    pListSelectable->m_Items.push_back( sel_string );
+
     // TODO Temp
     SetupText();
 }
@@ -428 +457 @@
 
     if (child.GetNodeName() == elmt_item)
     {
-        AddItem(child.GetText().FromUTF8(), child.GetText().FromUTF8());
-        
+        XMBAttributeList attrs = child.GetAttributes();
+        CStr selectable = attrs.GetNamedItem(pFile->GetAttributeID("selectable"));
+        AddItem(child.GetText().FromUTF8(), child.GetText().FromUTF8(), !selectable.empty() || selectable.GetHashCode() == CStr8("true").GetHashCode());
         return true;
     }
-    else
-    {
-        return false;
-    }
+    return false;
 }
 
 void CList::SelectNextElement()

source/gui/CList.h

@@ -79 +79 @@
     /**
      * Adds an item last to the list.
      */
-    virtual void AddItem(const CStrW& str, const CStrW& data);
+    virtual void AddItem(const CStrW& str, const CStrW& data, bool selectable = true);
 
 protected:
     /**
@@ -122 +122 @@
     // Extended drawing interface, this is so that classes built on the this one
     //  can use other sprite names.
     virtual void DrawList(const int &selected, const CStr& _sprite,
-                  const CStr& _sprite_selected, const CStr& _textcolor);
+                  const CStr& _sprite_selected, const CStr& _textcolor, const CStr& _inactiveTextcolor);
 
     // Get the area of the list. This is so that it can easily be changed, like in CDropDown
     //  where the area is not equal to m_CachedActualSize.
@@ -132 +132 @@
     // (and thus whether list items have possibly changed).
     virtual bool GetModified() const { return m_Modified; }
 
+    // checks, if a item can be selected
+    bool canItemBeSelected(unsigned int id);
+
     // List of items.
     //CGUIList m_List;
 

source/gui/scripting/ScriptFunctions.cpp

@@ -364 +364 @@
     return SavedGames::DeleteSavedGame(name);
 }
 
+CScriptValRooted GetCurrentSaveGameVersion(ScriptInterface::CxPrivate* pCxPrivate)
+{
+    return SavedGames::GetCurrentSaveGameVersion(*(pCxPrivate->pScriptInterface));
+}
+
 void OpenURL(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), std::string url)
 {
     sys_open_url(url);
@@ -831 +836 @@
     scriptInterface.RegisterFunction<void, std::wstring, std::wstring, CScriptVal, &SaveGamePrefix>("SaveGamePrefix");
     scriptInterface.RegisterFunction<void, &QuickSave>("QuickSave");
     scriptInterface.RegisterFunction<void, &QuickLoad>("QuickLoad");
+    scriptInterface.RegisterFunction<CScriptValRooted, &GetCurrentSaveGameVersion>("GetCurrentSaveGameVersion");
 
     // Misc functions
     scriptInterface.RegisterFunction<std::wstring, std::wstring, &SetCursor>("SetCursor");

source/ps/SavedGame.cpp

@@ -19 +19 @@
 
 #include "SavedGame.h"
 
+#include "graphics/Camera.h"
+#include "graphics/GameView.h"
 #include "gui/GUIManager.h"
 #include "lib/allocators/shared_ptr.h"
 #include "lib/file/archive/archive_zip.h"
 #include "ps/CLogger.h"
 #include "ps/Filesystem.h"
+#include "ps/Game.h"
 #include "scriptinterface/ScriptInterface.h"
 #include "simulation2/Simulation2.h"
 
 static const int SAVED_GAME_VERSION_MAJOR = 1; // increment on incompatible changes to the format
 static const int SAVED_GAME_VERSION_MINOR = 0; // increment on compatible changes to the format
-// TODO: we ought to check version numbers when loading files
 
-
 Status SavedGames::SavePrefix(const std::wstring& prefix, const std::wstring& description, CSimulation2& simulation, shared_ptr<ScriptInterface::StructuredClone> guiMetadataClone, int playerID)
 {
     // Determine the filename to save under
@@ -47 +48 @@
     return Save(filename.Filename().string(), description, simulation, guiMetadataClone, playerID);
 }
 
+
 Status SavedGames::Save(const std::wstring& name, const std::wstring& description, CSimulation2& simulation, shared_ptr<ScriptInterface::StructuredClone> guiMetadataClone, int playerID)
 {
     // Determine the filename to save under
@@ -213 +215 @@
         CScriptValRooted game;
         scriptInterface.Eval("({})", game);
         scriptInterface.SetProperty(game.get(), "id", pathnames[i].Basename());
+        scriptInterface.SetProperty(game.get(), "saveGameVersionMajor", SAVED_GAME_VERSION_MAJOR);
+        scriptInterface.SetProperty(game.get(), "saveGameVersionMinor", SAVED_GAME_VERSION_MINOR);
         scriptInterface.SetProperty(game.get(), "metadata", metadata);
         games.push_back(game);
     }
@@ -241 +245 @@
     // Successfully deleted file
     return true;
 }
+
+
+CScriptValRooted SavedGames::GetCurrentSaveGameVersion(ScriptInterface& scriptInterface)
+{
+    CScriptValRooted metainfo;
+    scriptInterface.Eval("({})", metainfo);
+    scriptInterface.SetProperty(metainfo.get(), "saveGameVersionMajor", SAVED_GAME_VERSION_MAJOR);
+    scriptInterface.SetProperty(metainfo.get(), "saveGameVersionMinor", SAVED_GAME_VERSION_MINOR);
+    return metainfo;
+}
+ No newline at end of file

source/ps/SavedGame.h

@@ -92 +92 @@
  */
 bool DeleteSavedGame(const std::wstring& name);
 
+/**
+ * Gets the current version of the save game format.
+ *
+ * @param scriptInterface the ScriptInterface in which to create the return data.
+ * @return list of objects containing saved game data
+ */
+CScriptValRooted GetCurrentSaveGameVersion(ScriptInterface& scriptInterface);
 }
 
 #endif // INCLUDED_SAVEDGAME