Ufopaedia.h

/*
 * Copyright 2010-2014 OpenXcom Developers.
 *
 * This file is part of OpenXcom.
 *
 * OpenXcom 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.
 *
 * OpenXcom 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 OpenXcom.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef OPENXCOM_UFOPAEDIA_H
#define OPENXCOM_UFOPAEDIA_H

#include <vector>
#include <string>

namespace OpenXcom
{
    class Game;
    class SavedGame;
    class Ruleset;
    class ArticleDefinition;
    class ArticleState;

    typedef std::vector<ArticleDefinition *> ArticleDefinitionList;

    static const std::string UFOPAEDIA_XCOM_CRAFT_ARMAMENT = "STR_XCOM_CRAFT_ARMAMENT";
    static const std::string UFOPAEDIA_HEAVY_WEAPONS_PLATFORMS = "STR_HEAVY_WEAPONS_PLATFORMS";
    static const std::string UFOPAEDIA_WEAPONS_AND_EQUIPMENT = "STR_WEAPONS_AND_EQUIPMENT";
    static const std::string UFOPAEDIA_ALIEN_ARTIFACTS = "STR_ALIEN_ARTIFACTS";
    static const std::string UFOPAEDIA_BASE_FACILITIES = "STR_BASE_FACILITIES";
    static const std::string UFOPAEDIA_ALIEN_LIFE_FORMS = "STR_ALIEN_LIFE_FORMS";
    static const std::string UFOPAEDIA_ALIEN_RESEARCH = "STR_ALIEN_RESEARCH_UC";
    static const std::string UFOPAEDIA_UFO_COMPONENTS = "STR_UFO_COMPONENTS";
    static const std::string UFOPAEDIA_UFOS = "STR_UFOS";
    static const std::string UFOPAEDIA_NOT_AVAILABLE = "STR_NOT_AVAILABLE";
    // This last section is meant for articles, that have to be activated,
    // but have no own entry in a list. E.g. Ammunition items.
    // Maybe others as well, that should just not be selectable.

    class Ufopaedia
    {
    public:
        static bool isArticleAvailable(SavedGame *save, ArticleDefinition *article);

        static void openArticle(Game *game, std::string &article_id);

        static void openArticle(Game *game, ArticleDefinition *article);

        static void open(Game *game);

        static void next(Game *game);

        static void prev(Game *game);

        static void list(SavedGame *save, Ruleset *rule, const std::string &section, ArticleDefinitionList &data);

    protected:

        static size_t _current_index;

        static size_t getArticleIndex(SavedGame *save, Ruleset *rule, std::string &article_id);

        static ArticleDefinitionList getAvailableArticles(SavedGame *save, Ruleset *rule);

        static ArticleState *createArticleState(Game *game, ArticleDefinition *article);
    };
}

#endif