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/currenton.hpp"
  24 #include "util/reader_fwd.hpp"
  25 #include "util/writer_fwd.hpp"
  26
  27 class Addon;
  28
  29 /**
  30  * Checks for, installs and removes Add-ons
  31  */
  32 class AddonManager : public Currenton<AddonManager>
  33 {
  34 public:
  35   AddonManager(std::vector<std::string>& ignored_addon_filenames_);
  36   ~AddonManager();
  37
  38   /**
  39    * returns a list of installed Add-ons
  40    */
  41   std::vector<Addon*> get_addons();
  42
  43   /**
  44    * downloads list of available Add-ons
  45    */
  46   void check_online();
  47
  48   /**
  49    * Download and install Add-on
  50    */
  51   void install(Addon* addon);
  52
  53   /**
  54    * Physically delete Add-on
  55    */
  56   void remove(Addon* addon);
  57
  58   /**
  59    * Unload Add-on and mark as not to be loaded automatically
  60    */
  61   void disable(Addon* addon);
  62
  63   /**
  64    * Load Add-on and mark as to be loaded automatically
  65    */
  66   void enable(Addon* addon);
  67
  68   /**
  69    * Remove Add-on from search path
  70    */
  71   void unload(Addon* addon);
  72
  73   /**
  74    * Add Add-on to search path
  75    */
  76   void load(Addon* addon);
  77
  78   /**
  79    * Loads all enabled Add-ons, i.e. adds them to the search path
  80    */
  81   void load_addons();
  82
  83 private:
  84   std::vector<Addon*> addons;
  85   std::vector<std::string>& ignored_addon_filenames;
  86 };
  87
  88 #endif
  89
  90 /* EOF */