git.maemo.org Git - lordsawar/blob - src/Commentator.h

   1 // Copyright (C) 2009 Ben Asselstine
   2 //
   3 //  This program is free software; you can redistribute it and/or modify
   4 //  it under the terms of the GNU General Public License as published by
   5 //  the Free Software Foundation; either version 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   8 //  This program is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 //  GNU Library General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU General Public License
  14 //  along with this program; if not, write to the Free Software
  15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16 //  02110-1301, USA.
  17
  18 #ifndef COMMENTATOR_H
  19 #define COMMENTATOR_H
  20
  21 #include <string>
  22 #include <vector>
  23 #include <gtkmm.h>
  24
  25 class Player;
  26 //! A Commentator is the in-game commentator.
  27 /**
  28  *
  29  * Periodically a message will be conveyed to human players at the start of
  30  * their turn.  This Commentator object determines appropriate messages to
  31  * be conveyed.
  32  */
  33
  34 class Commentator
  35 {
  36     public:
  37
  38         //! Returns the singleton instance.
  39         static Commentator* getInstance();
  40
  41         //! Explicitly deletes the singleton instance.
  42         static void deleteInstance();
  43
  44         bool hasComment() const;
  45
  46         std::vector<std::string> getComments(Player *player) const;
  47
  48     protected:
  49         //! Creates a new Commentator from scratch.
  50         Commentator();
  51
  52         //! Destructor.
  53         virtual ~Commentator();
  54     private:
  55
  56         static Commentator* d_instance;
  57 };
  58
  59 #endif //COMMENTATOR_H