achievements.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef COMMON_ACHIEVEMENTS_H
#define COMMON_ACHIEVEMENTS_H

#include "common/array.h"
#include "common/formats/ini-file.h"
#include "common/hashmap.h"
#include "common/singleton.h"
#include "common/str.h"

namespace Common {

enum AchievementsPlatform {
    STEAM_ACHIEVEMENTS,
    GALAXY_ACHIEVEMENTS,
    UNK_ACHIEVEMENTS = -1
};

struct StatDescription {
    String id;      
    String comment; 
    String start;   
};

struct AchievementDescription {
    String id;      
    String title;   
    String comment; 
    bool isHidden;  
};

struct AchievementsInfo {
    Common::AchievementsPlatform platform;              
    Common::String appId;                               

    AchievementsInfo() { platform = Common::UNK_ACHIEVEMENTS; }
};

struct AchievementDescriptionList {
    const char *gameId;
    Common::AchievementsPlatform platform;
    const char *appId;
};

#define ACHIEVEMENT_DESC_TABLE_END_MARKER \
    { nullptr, Common::UNK_ACHIEVEMENTS, nullptr }

class AchievementsManager : public Singleton<AchievementsManager> {
public:
    AchievementsManager();
    ~AchievementsManager();

    bool setActiveDomain(const AchievementsInfo &info);
    bool unsetActiveDomain();                            
    bool isReady() const { return _iniFile != nullptr; } 

    bool setAchievement(const String &id);

    bool isAchieved(const String &id) const;

    bool clearAchievement(const String &id);

    int getStatInt(const String &id) const;

    bool setStatInt(const String &id, int value);

    float getStatFloat(const String &id) const;

    bool setStatFloat(const String &id, float value);

    const String getStatRaw(const String &id) const;

    float getAverageRateStatFloat(const String &id) const;

    bool updateAverageRateStatFloat(const String &id, float count, float times);

    bool resetAllAchievements(); 
    bool resetAllStats();        

    bool setSpecialString(const String &id, const String &value);

    uint16 getAchievementCount() const;

    const AchievementDescription *getAchievementDescription(uint16 index) const;

    uint16 getStatCount() const;

    const StatDescription *getStatDescription(uint16 index) const;

private:
    String getCurrentLang() const;
    bool loadAchievementsData(const char *platform, const char *appId);

    float getStatFloatEx(const String &id, const String &section) const;
    bool setStatFloatEx(const String &id, float value, const String &section) const;

    INIFile *_iniFile;
    String _iniFileName;
    Common::Array<StatDescription> _stats;
    Common::HashMap<String, Common::Array<AchievementDescription> > _achievements;
};

#define AchMan Common::AchievementsManager::instance()

} // End of namespace Common

#endif // #ifndef COMMON_ACHIEVEMENTS_MANAGER_H