src/addon/addon.hpp

   1 //  SuperTux - Add-on
   2 //  Copyright (C) 2007 Christoph Sommer <christoph.sommer@2007.expires.deltadevelopment.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_ADDON_ADDON_HPP
  18 #define HEADER_SUPERTUX_ADDON_ADDON_HPP
  19
  20 #include <string>
  21
  22 #include "util/reader_fwd.hpp"
  23 #include "util/writer_fwd.hpp"
  24
  25 /**
  26  * Represents an (available or installed) Add-on, e.g. a level set
  27  */
  28 class Addon
  29 {
  30 public:
  31   std::string kind;
  32   std::string title;
  33   std::string author;
  34   std::string license;
  35   std::string http_url;
  36   std::string suggested_filename; /**< filename suggested by addon author, e.g. "pak0.zip" */
  37   std::string installed_physfs_filename; /**< PhysFS filename on disk, e.g. "pak0.zip" */
  38   std::string installed_absolute_filename; /**< complete path and filename on disk, e.g. "/home/sommer/.supertux2/pak0.zip" */
  39   std::string stored_md5;
  40   bool installed;
  41   bool loaded;
  42
  43   /**
  44    * Get MD5, based either on installed file's contents or stored value
  45    */
  46   std::string get_md5() const;
  47
  48   /**
  49    * Read additional information from given contents of a (supertux-addoninfo ...) block
  50    */
  51   void parse(const Reader& lisp);
  52
  53   /**
  54    * Read additional information from given file
  55    */
  56   void parse(std::string fname);
  57
  58   /**
  59    * Writes out Add-on metainformation to a Lisp Writer
  60    */
  61   void write(lisp::Writer& writer) const;
  62
  63   /**
  64    * Writes out Add-on metainformation to a file
  65    */
  66   void write(std::string fname) const;
  67
  68   /**
  69    * Checks if Add-on is the same as given one.
  70    * If available, checks MD5 sum, else relies on kind, author and title alone.
  71    */
  72   bool operator==(Addon addon2) const;
  73
  74 protected:
  75   friend class AddonManager;
  76
  77   mutable std::string calculated_md5;
  78
  79   Addon() :
  80     kind(),
  81     title(),
  82     author(),
  83     license(),
  84     http_url(),
  85     suggested_filename(),
  86     installed_physfs_filename(),
  87     installed_absolute_filename(),
  88     stored_md5(),
  89     installed(),
  90     loaded(),
  91     calculated_md5()
  92   {};
  93 };
  94
  95 #endif
  96
  97 /* EOF */