initial commit, lordsawar source, slightly modified

[lordsawar] / src / Commentator.h

diff --git a/src/Commentator.h b/src/Commentator.h
new file mode 100644 (file)
index 0000000..901c97b
--- /dev/null
+++ b/src/Commentator.h
@@ -0,0 +1,59 @@
+// Copyright (C) 2009 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 COMMENTATOR_H
+#define COMMENTATOR_H
+
+#include <string>
+#include <vector>
+#include <gtkmm.h>
+
+class Player;
+//! A Commentator is the in-game commentator.
+/** 
+ * 
+ * Periodically a message will be conveyed to human players at the start of 
+ * their turn.  This Commentator object determines appropriate messages to
+ * be conveyed.
+ */
+
+class Commentator
+{
+    public:
+
+        //! Returns the singleton instance.
+       static Commentator* getInstance();
+        
+        //! Explicitly deletes the singleton instance.
+        static void deleteInstance();
+
+        bool hasComment() const;
+
+        std::vector<std::string> getComments(Player *player) const;
+
+    protected:
+       //! Creates a new Commentator from scratch.
+        Commentator();
+
+        //! Destructor.
+        virtual ~Commentator();
+    private:
+
+        static Commentator* d_instance;
+};
+
+#endif //COMMENTATOR_H