initial commit, lordsawar source, slightly modified

[lordsawar] / src / recently-played-game-list.h

diff --git a/src/recently-played-game-list.h b/src/recently-played-game-list.h
new file mode 100644 (file)
index 0000000..8c1dc83
--- /dev/null
+++ b/src/recently-played-game-list.h
@@ -0,0 +1,121 @@
+//  Copyright (C) 2008, Ben Asselstine
+//
+//  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 RECENTLYPLAYEDGAMELIST_H
+#define RECENTLYPLAYEDGAMELIST_H
+
+#include <gtkmm.h>
+#include <string>
+#include <list>
+#include <sigc++/trackable.h>
+
+#include "xmlhelper.h"
+
+class GameScenario;
+class RecentlyPlayedGame;
+
+//! A list of games that we've recently played.
+/** 
+ * This is only used for network games at the moment.
+ * It is implemented as a singleton.
+ *
+ */
+class RecentlyPlayedGameList: public std::list<RecentlyPlayedGame*>, public sigc::trackable
+{
+    public:
+
+       //! The xml tag of this object in a recently played game file.
+       static std::string d_tag; 
+       
+       static const int TWO_WEEKS_OLD = 1209600; /* seconds */
+
+
+       // Methods that operate on the class data and do not modify the class.
+
+       //! Save the recently played game list to the given file.
+       bool saveToFile(std::string filename) const;
+
+       //! Save the recently played game list to an opened file.
+       bool save(XML_Helper* helper) const;
+
+
+       // Methods that operate on the class data and modify the class.
+
+       //! Load the recently game list from the given file.
+       bool loadFromFile(std::string filename);
+
+       //! Add a game entry to the list of recently played games.
+       void addEntry(GameScenario *game_scenario, std::string filename);
+
+       //! Add a networked game entry to the list of recently played games.
+       void addNetworkedEntry(GameScenario *game_scenario, std::string host, guint32 port);
+
+       //! Touch the game in the recently played list.
+       void updateEntry(GameScenario *game_scenario);
+
+       //! Remove a game entry from the list, by it's scenario id.
+       bool removeEntry(std::string id);
+
+       //! Removes all networked games from the list.
+       void removeAllNetworkedGames();
+
+       //! Removes games from the list that are too old, or just too numerous.
+       void pruneGames();
+       
+
+       // Static Methods
+
+        //! return the singleton instance of this class.
+        static RecentlyPlayedGameList * getInstance();
+
+        //! Loads the singleton instance from an opened file.
+        static RecentlyPlayedGameList * getInstance(XML_Helper *helper);
+
+        //! Explicitly delete the singleton instance of this class.
+        static void deleteInstance();
+
+    protected:
+        //! Default Constructor.
+        RecentlyPlayedGameList();
+
+       //! Loading constructor
+        RecentlyPlayedGameList(XML_Helper *helper);
+        
+        //! Destructor.
+        ~RecentlyPlayedGameList();
+
+    private:
+        //! Callback for loading recentlyplayedgames into this list.
+       bool load(std::string tag, XML_Helper *helper);
+
+       //! Helper method to sort the list by it's last-played time.
+       static bool orderByTime(RecentlyPlayedGame*rhs, RecentlyPlayedGame *lhs);
+
+       //! Remove the old games from the list.
+       void pruneOldGames(int stale = TWO_WEEKS_OLD);
+
+       //! Remove extraneous games form the list.
+       void pruneTooManyGames(int too_many = 10);
+
+       // DATA
+
+        //! A static pointer for the singleton instance.
+        static RecentlyPlayedGameList* s_instance;
+};
+
+#endif // RECENTLYPLAYEDGAMELIST_H
+