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