initial commit, lordsawar source, slightly modified

[lordsawar] / src / Configuration.h

diff --git a/src/Configuration.h b/src/Configuration.h
new file mode 100644 (file)
index 0000000..e736c4d
--- /dev/null
+++ b/src/Configuration.h
@@ -0,0 +1,144 @@
+//  Copyright (C) 2002, 2003 Michael Bartl
+//  Copyright (C) 2003, 2004, 2005, 2006 Ulf Lorenz
+//  Copyright (C) 2004, 2005 Andrea Paternesi
+//  Copyright (C) 2005 Josef Spillner
+//  Copyright (C) 2006 Ben Asselstine
+//  Copyright (C) 2007 Ole Laursen
+//
+//  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 3 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 Library 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.
+
+#ifndef CONFIGURATION_H
+#define CONFIGURATION_H
+
+#include <gtkmm.h>
+#include <string>
+#include <sigc++/trackable.h>
+
+class XML_Helper;
+
+#include "game-parameters.h"
+
+// helper for making sure we got the initial configuration stuff up running
+void initialize_configuration();
+
+/** \brief The class which holds all configuration options
+  * 
+  * Basically, this class is more of a namespace than a real class. It
+  * provides all global information about directories, settings etc.
+  */
+
+// TODO: do we really want all this static stuff or rather do a singleton or such?
+
+class Configuration : public sigc::trackable
+{
+    public:
+        // CREATORS
+        Configuration();
+        ~Configuration();
+
+        /** \brief Load a configuration file
+          * 
+          * @param fileName     the full name of the config file
+          *
+          * This class loads an xml-style config file and sets the settings
+          * appropriately.
+          */
+        bool loadConfigurationFile(std::string fileName);
+
+        /** \brief Save the configuration file
+          * 
+          * @param fileName     the full name of the config file
+          *
+          * This class saves the current config to an xml-style config file.
+          */
+        static bool saveConfigurationFile(std::string filename);
+
+        static std::string configuration_file_path;
+       
+        // as the name implies
+        static bool s_showNextPlayer;
+        static int s_displaySpeedDelay;
+        static int s_displayFightRoundDelayFast;
+        static int s_displayFightRoundDelaySlow;
+        static bool s_displayCommentator;
+        
+        //the paths
+        static std::string s_dataPath;
+        static std::string s_savePath;
+
+        // Language setting
+        static std::string s_lang;
+
+        //the maximum size of the graphics cache
+        static guint32 s_cacheSize;
+
+        //zip and obfuscate save files
+        static bool s_zipfiles;
+
+       // when to save autosave files
+       // 0 = never, 1 = once a round overwrting, 
+       // 2 = once a round not-overwriting
+       static int s_autosave_policy;
+
+        // music settings; the cache size is given in pieces instead of memory
+        static bool s_musicenable;
+        static guint32 s_musicvolume;
+        static guint32 s_musiccache;
+
+       // various default game settings
+        static bool s_see_opponents_stacks;
+        static bool s_see_opponents_production;
+        static GameParameters::QuestPolicy s_play_with_quests;
+        static bool s_hidden_map;
+        static bool s_diplomacy;
+        static GameParameters::NeutralCities s_neutral_cities;
+        static GameParameters::RazingCities s_razing_cities;
+        static bool s_intense_combat;
+        static bool s_military_advisor;
+        static bool s_random_turns;
+        static GameParameters::QuickStartPolicy s_quick_start;
+        static bool s_cusp_of_war;
+        static bool s_decorated;
+        static bool s_remember_recent_games;
+       static guint32 s_double_click_threshold;
+
+       static GameParameters::NeutralCities neutralCitiesFromString(const std::string str);
+       static std::string neutralCitiesToString(const GameParameters::NeutralCities neutrals);
+       static GameParameters::RazingCities razingCitiesFromString(const std::string str);
+       static std::string razingCitiesToString(const GameParameters::RazingCities razing);
+        enum SavingPolicy {
+         NO_SAVING = 0,
+         WRITE_UNNUMBERED_AUTOSAVE_FILE = 1,
+         WRITE_NUMBERED_AUTOSAVE_FILE = 2,
+       };
+       static Configuration::SavingPolicy savingPolicyFromString(const std::string str);
+       static std::string savingPolicyToString(const Configuration::SavingPolicy policy);
+       static GameParameters::QuickStartPolicy quickStartPolicyFromString(const std::string str);
+        static std::string quickStartPolicyToString(const GameParameters::QuickStartPolicy policy);
+        static GameParameters::QuestPolicy questPolicyFromString(std::string str);
+        static std::string questPolicyToString(const GameParameters::QuestPolicy quest);
+    private:
+        /** \brief The callback for the XML_Helper
+          * 
+          * See the XML_Helper documentation for an explanation what the
+          * callback is good for.
+          */
+        bool parseConfiguration(std::string tag, XML_Helper* helper);
+
+        static std::string s_filename;
+};
+
+#endif // CONFIGURATION_H