addons_manager.hpp

//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2010-2015 Lucas Baudin, Joerg Henrichs
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 
#ifndef HEADER_ADDONS_MANAGER_HPP
#define HEADER_ADDONS_MANAGER_HPP
 
#ifndef SERVER_ONLY
 
#include <atomic>
#include <string>
#include <map>
#include <memory>
#include <vector>
 
#include "addons/addon.hpp"
#include "io/xml_node.hpp"
#include "utils/synchronised.hpp"
 
class AddonsManager
{
private:
    Synchronised<std::vector<Addon> >  m_addons_list;
    std::string                        m_file_installed;
 
    std::vector<std::string> m_icon_list;
 
    enum  STATE_TYPE {STATE_INIT, STATE_READY, STATE_ERROR};
    // Synchronise the state between threads (e.g. GUI and update thread)
    Synchronised<STATE_TYPE> m_state;
 
    /* Return true if any icons have been downloaded, so we need to call
     * saveInstalled in mobile stk when pressing home button, so the icons
     * won't need to be redownload when stk is killed by OS in the
     * background. */
    bool m_downloaded_icons;
 
    std::atomic_bool m_has_new_addons;
 
    void  loadInstalledAddons();
 
public:
                 AddonsManager();
                ~AddonsManager();
    void         init(const XMLNode *xml, bool force_refresh);
    void         initAddons(const XMLNode *xml);
    void         checkInstalledAddons();
    Addon* getAddon(const std::string &id);
    int          getAddonIndex(const std::string &id) const;
    bool         install(const Addon &addon);
    bool         uninstall(const Addon &addon);
    void         reInit();
    bool         anyAddonsInstalled() const;
    void         downloadIconForAddon(const std::string& addon_id,
                                      std::weak_ptr<bool> result);
    // ------------------------------------------------------------------------
    bool         onlineReady() const {return m_state.getAtomic()==STATE_READY; }
    // ------------------------------------------------------------------------
    bool         wasError()    const { return m_state.getAtomic()==STATE_ERROR;}
    // ------------------------------------------------------------------------
    bool         isLoading()   const { return m_state.getAtomic()==STATE_INIT; }
    // ------------------------------------------------------------------------
    void         setErrorState() { m_state.setAtomic(STATE_ERROR); }
    // ------------------------------------------------------------------------
    void         saveInstalled();
    // ------------------------------------------------------------------------
    unsigned int getNumAddons() const { return (unsigned int) m_addons_list.getData().size();}
    // ------------------------------------------------------------------------
    const Addon& getAddon(unsigned int i) { return m_addons_list.getData()[i];}
    // ------------------------------------------------------------------------
    bool hasDownloadedIcons() const { return m_downloaded_icons; }
    // ------------------------------------------------------------------------
    bool hasNewAddons() const { return m_has_new_addons; }
};   // class AddonsManager
 
extern AddonsManager *addons_manager;
 
#endif
#endif