src/common/engine/ModInfo.h

   1 ////////////////////////////////////////////////////////////////////////////////
   2 //    Scorched3D (c) 2000-2009
   3 //
   4 //    This file is part of Scorched3D.
   5 //
   6 //    Scorched3D is free software; you can redistribute it and/or modify
   7 //    it under the terms of the GNU General Public License as published by
   8 //    the Free Software Foundation; either version 2 of the License, or
   9 //    (at your option) any later version.
  10 //
  11 //    Scorched3D is distributed in the hope that it will be useful,
  12 //    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //    GNU General Public License for more details.
  15 //
  16 //    You should have received a copy of the GNU General Public License
  17 //    along with Scorched3D; if not, write to the Free Software
  18 //    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 ////////////////////////////////////////////////////////////////////////////////
  20
  21 #if !defined(__INCLUDE_ModInfoh_INCLUDE__)
  22 #define __INCLUDE_ModInfoh_INCLUDE__
  23
  24 #include <string>
  25 #include <list>
  26
  27 class ModInfo
  28 {
  29 public:
  30         struct MenuEntry
  31         {
  32                 std::string icon;
  33                 std::string shortdescription;
  34                 std::string description;
  35                 std::string gamefile;
  36         };
  37
  38         ModInfo(const std::string &name);
  39         virtual ~ModInfo();
  40
  41         bool parse(const std::string &fileName);
  42
  43         const char *getName() { return name_.c_str(); }
  44         const char *getUrl() { return url_.c_str(); }
  45         const char *getIcon() { return icon_.c_str(); }
  46         const char *getDescription() { return description_.c_str(); }
  47         const char *getShortDescription() { return shortDescription_.c_str(); }
  48         const char *getProtocolVersion() { return protocolversion_.c_str(); }
  49         std::list<MenuEntry> &getMenuEntries() { return entries_; }
  50
  51 protected:
  52         std::string name_;
  53         std::string url_;
  54         std::string icon_;
  55         std::string description_;
  56         std::string shortDescription_;
  57         std::string protocolversion_;
  58         std::list<MenuEntry> entries_;
  59 };
  60
  61 #endif // __INCLUDE_ModInfoh_INCLUDE__