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