src/addon/addon_manager.hpp

   1 //  SuperTux - Add-on Manager
   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_MANAGER_HPP
  18 #define HEADER_SUPERTUX_ADDON_ADDON_MANAGER_HPP
  19
  20 #include <string>
  21 #include <vector>
  22
  23 #include "util/reader_fwd.hpp"
  24 #include "util/writer_fwd.hpp"
  25
  26 class Addon;
  27
  28 /**
  29  * Checks for, installs and removes Add-ons
  30  */
  31 class AddonManager
  32 {
  33 public:
  34   /**
  35    * returns a list of installed Add-ons
  36    */
  37   std::vector<Addon*> get_addons();
  38
  39   /**
  40    * downloads list of available Add-ons
  41    */
  42   void check_online();
  43
  44   /**
  45    * Download and install Add-on
  46    */
  47   void install(Addon* addon);
  48
  49   /**
  50    * Physically delete Add-on
  51    */
  52   void remove(Addon* addon);
  53
  54   /**
  55    * Unload Add-on and mark as not to be loaded automatically
  56    */
  57   void disable(Addon* addon);
  58
  59   /**
  60    * Load Add-on and mark as to be loaded automatically
  61    */
  62   void enable(Addon* addon);
  63
  64   /**
  65    * Remove Add-on from search path
  66    */
  67   void unload(Addon* addon);
  68
  69   /**
  70    * Add Add-on to search path
  71    */
  72   void load(Addon* addon);
  73
  74   /**
  75    * Loads all enabled Add-ons, i.e. adds them to the search path
  76    */
  77   void load_addons();
  78
  79   /**
  80    * Returns the shared AddonManager instance
  81    */
  82   static AddonManager& get_instance();
  83
  84   /**
  85    * Write AddonManager configuration to Lisp
  86    */
  87   void write(lisp::Writer& writer);
  88
  89   /**
  90    * Read AddonManager configuration from Lisp
  91    */
  92   void read(const Reader& lisp);
  93
  94 protected:
  95   std::vector<Addon*> addons;
  96   std::vector<std::string> ignored_addon_filenames;
  97
  98   AddonManager();
  99   ~AddonManager();
 100 };
 101
 102 #endif
 103
 104 /* EOF */