src/addon/addon_manager.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux - Add-on Manager
   4 //  Copyright (C) 2007 Christoph Sommer <christoph.sommer@2007.expires.deltadevelopment.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program 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 this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 //  02111-1307, USA.
  20 //
  21 #ifndef ADDON_MANAGER_H
  22 #define ADDON_MANAGER_H
  23
  24 #include <string>
  25 #include <vector>
  26 namespace lisp {
  27 class Lisp;
  28 class Writer;
  29 }
  30
  31 class Addon;
  32
  33 /**
  34  * Checks for, installs and removes Add-ons
  35  */
  36 class AddonManager
  37 {
  38 public:
  39   /**
  40    * returns a list of installed Add-ons
  41    */
  42   std::vector<Addon*> get_addons();
  43
  44   /**
  45    * downloads list of available Add-ons
  46    */
  47   void check_online();
  48
  49   /**
  50    * Download and install Add-on
  51    */
  52   void install(Addon* addon);
  53
  54   /**
  55    * Physically delete Add-on
  56    */
  57   void remove(Addon* addon);
  58
  59   /**
  60    * Unload Add-on and mark as not to be loaded automatically
  61    */
  62   void disable(Addon* addon);
  63
  64   /**
  65    * Load Add-on and mark as to be loaded automatically
  66    */
  67   void enable(Addon* addon);
  68
  69   /**
  70    * Remove Add-on from search path
  71    */
  72   void unload(Addon* addon);
  73
  74   /**
  75    * Add Add-on to search path
  76    */
  77   void load(Addon* addon);
  78
  79   /**
  80    * Loads all enabled Add-ons, i.e. adds them to the search path
  81    */
  82   void load_addons();
  83
  84   /**
  85    * Returns the shared AddonManager instance
  86    */
  87   static AddonManager& get_instance();
  88
  89   /**
  90    * Write AddonManager configuration to Lisp
  91    */
  92   void write(lisp::Writer& writer);
  93
  94   /**
  95    * Read AddonManager configuration from Lisp
  96    */
  97   void read(const lisp::Lisp& lisp);
  98
  99 protected:
 100   std::vector<Addon*> addons;
 101   std::vector<std::string> ignored_addon_filenames;
 102
 103   AddonManager();
 104   ~AddonManager();
 105 };
 106
 107 #endif