From 49fafb48a7f089c97ed3baa9aefe65ec56dce682 Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Sun, 10 Jun 2012 05:04:59 +0200
Subject: GUI: Refactor default savegame description creation.

Formerly the GMM, AGI and SCI duplicated the logic for USE_SAVEGAME_TIMESTAMP.
Now I added a method to SaveLoadChooser instead, which takes care of this. This
might not be the best placement of such a functionality, thus I added a TODO
which talks about moving it to a better place.
---
 engines/agi/saveload.cpp     | 10 +---------
 engines/dialogs.cpp          | 10 +---------
 engines/sci/engine/kfile.cpp | 10 +---------
 gui/saveload.cpp             | 13 +++++++++++++
 gui/saveload.h               | 15 +++++++++++++++
 5 files changed, 31 insertions(+), 27 deletions(-)

diff --git a/engines/agi/saveload.cpp b/engines/agi/saveload.cpp
index 25fa7829ef..3e63da756d 100644
--- a/engines/agi/saveload.cpp
+++ b/engines/agi/saveload.cpp
@@ -807,15 +807,7 @@ int AgiEngine::scummVMSaveLoadDialog(bool isSave) {
 
 		if (desc.empty()) {
 			// create our own description for the saved game, the user didnt enter it
-#if defined(USE_SAVEGAME_TIMESTAMP)
-			TimeDate curTime;
-			g_system->getTimeAndDate(curTime);
-			curTime.tm_year += 1900; // fixup year
-			curTime.tm_mon++; // fixup month
-			desc = Common::String::format("%04d.%02d.%02d / %02d:%02d:%02d", curTime.tm_year, curTime.tm_mon, curTime.tm_mday, curTime.tm_hour, curTime.tm_min, curTime.tm_sec);
-#else
-			desc = Common::String::format("Save %d", slot + 1);
-#endif
+			desc = dialog->createDefaultSaveDescription(slot);
 		}
 
 		if (desc.size() > 28)
diff --git a/engines/dialogs.cpp b/engines/dialogs.cpp
index 9245d9fe62..cf3dfaa44b 100644
--- a/engines/dialogs.cpp
+++ b/engines/dialogs.cpp
@@ -220,15 +220,7 @@ void MainMenuDialog::save() {
 		Common::String result(_saveDialog->getResultString());
 		if (result.empty()) {
 			// If the user was lazy and entered no save name, come up with a default name.
-			#if defined(USE_SAVEGAME_TIMESTAMP)
-			TimeDate curTime;
-			g_system->getTimeAndDate(curTime);
-			curTime.tm_year += 1900; // fixup year
-			curTime.tm_mon++; // fixup month
-			result = Common::String::format("%04d.%02d.%02d / %02d:%02d:%02d", curTime.tm_year, curTime.tm_mon, curTime.tm_mday, curTime.tm_hour, curTime.tm_min, curTime.tm_sec);
-			#else
-			result = Common::String::format("Save %d", slot + 1);
-			#endif
+			result = _saveDialog->createDefaultSaveDescription(slot);
 		}
 
 		Common::Error status = _engine->saveGameState(slot, result);
diff --git a/engines/sci/engine/kfile.cpp b/engines/sci/engine/kfile.cpp
index 4af71f41af..42f8b8832c 100644
--- a/engines/sci/engine/kfile.cpp
+++ b/engines/sci/engine/kfile.cpp
@@ -567,15 +567,7 @@ reg_t kSaveGame(EngineState *s, int argc, reg_t *argv) {
 		game_description = dialog->getResultString();
 		if (game_description.empty()) {
 			// create our own description for the saved game, the user didnt enter it
-			#if defined(USE_SAVEGAME_TIMESTAMP)
-			TimeDate curTime;
-			g_system->getTimeAndDate(curTime);
-			curTime.tm_year += 1900; // fixup year
-			curTime.tm_mon++; // fixup month
-			game_description = Common::String::format("%04d.%02d.%02d / %02d:%02d:%02d", curTime.tm_year, curTime.tm_mon, curTime.tm_mday, curTime.tm_hour, curTime.tm_min, curTime.tm_sec);
-			#else
-			game_description = Common::String::format("Save %d", savegameId + 1);
-			#endif
+			game_description = dialog->createDefaultSaveDescription(savegameId);
 		}
 		delete dialog;
 		g_sci->_soundCmd->pauseAll(false); // unpause music ( we can't have it paused during save)
diff --git a/gui/saveload.cpp b/gui/saveload.cpp
index 366efa7a90..67d871e133 100644
--- a/gui/saveload.cpp
+++ b/gui/saveload.cpp
@@ -21,6 +21,7 @@
 
 #include "common/config-manager.h"
 #include "common/translation.h"
+#include "common/system.h"
 
 #include "gui/widgets/list.h"
 #include "gui/message.h"
@@ -126,6 +127,18 @@ const Common::String &SaveLoadChooser::getResultString() const {
 	return (selItem >= 0) ? _list->getSelectedString() : _resultString;
 }
 
+Common::String SaveLoadChooser::createDefaultSaveDescription(const int slot) const {
+#if defined(USE_SAVEGAME_TIMESTAMP)
+	TimeDate curTime;
+	g_system->getTimeAndDate(curTime);
+	curTime.tm_year += 1900; // fixup year
+	curTime.tm_mon++; // fixup month
+	return Common::String::format("%04d.%02d.%02d / %02d:%02d:%02d", curTime.tm_year, curTime.tm_mon, curTime.tm_mday, curTime.tm_hour, curTime.tm_min, curTime.tm_sec);
+#else
+	return Common::String::format("Save %d", slot + 1);
+#endif
+}
+
 void SaveLoadChooser::handleCommand(CommandSender *sender, uint32 cmd, uint32 data) {
 	int selItem = _list->getSelected();
 
diff --git a/gui/saveload.h b/gui/saveload.h
index dc0f0429c7..e81b10d214 100644
--- a/gui/saveload.h
+++ b/gui/saveload.h
@@ -79,6 +79,21 @@ public:
 
 	const Common::String &getResultString() const;
 
+	/**
+	 * Creates a default save description for the specified slot. Depending
+	 * on the ScummVM configuration this might be a simple "Slot #" description
+	 * or the current date and time.
+	 *
+	 * TODO: This might not be the best place to put this, since engines not
+	 * using this class might want to mimic the same behavior. Check whether
+	 * moving this to a better place makes sense and find what this place would
+	 * be.
+	 *
+	 * @param slot The slot number (must be >= 0).
+	 * @return The slot description.
+	 */
+	Common::String createDefaultSaveDescription(const int slot) const;
+
 	virtual void reflowLayout();
 
 	virtual void close();
-- 
cgit v1.2.3