language.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef AURORA_LANGUAGE_H
#define AURORA_LANGUAGE_H

#include <map>
#include <vector>

#include "src/common/types.h"
#include "src/common/singleton.h"
#include "src/common/encoding.h"

#include "src/aurora/types.h"

namespace Common {
    class UString;

    class SeekableReadStream;
    class MemoryReadStream;
}

namespace Aurora {

enum Language {
    kLanguageEnglish,
    kLanguageFrench,
    kLanguageGerman,
    kLanguageItalian,
    kLanguageSpanish,
    kLanguagePolish,
    kLanguageCzech,
    kLanguageHungarian,
    kLanguageRussian,
    kLanguageKorean,
    kLanguageChineseTraditional,
    kLanguageChineseSimplified,
    kLanguageJapanese,

    kLanguageMAX,
    kLanguageDebug   = 0xFFFFFFFD, 
    kLanguageChinese = 0xFFFFFFFE, 
    kLanguageInvalid = 0xFFFFFFFF
};

enum LanguageGender {
    kLanguageGenderMale   = 0,
    kLanguageGenderFemale = 1,

    kLanguageGenderMAX,
    kLanguageGenderCurrent = 0xFF 
};

class LanguageManager : public Common::Singleton<LanguageManager> {
public:
    struct Declaration {
        Language language;

        uint32 id;
        Common::Encoding encoding;
        Common::Encoding encodingLocString;
    };

    LanguageManager();
    ~LanguageManager();

    // .--- Managed language methods
    void clear();

    void addLanguage(Language language, uint32 id, Common::Encoding encoding);
    void addLanguage(Language language, uint32 id, Common::Encoding encoding,
                     Common::Encoding encodingLocString);
    void addLanguage(const Declaration &languageDeclaration);
    void addLanguages(const Declaration *languageDeclarations, size_t count);

    std::vector<Language> getLanguages() const;

    uint32 getLanguageID(Language language) const;

    uint32 getLanguageID(Language language, LanguageGender gender) const;

    Language getLanguage(uint32 languageID) const;

    Language getLanguage(uint32 languageID, LanguageGender &gender) const;

    Language getLanguageGendered(uint32 languageID) const;

    Common::Encoding getEncoding(Language language) const;
    Common::Encoding getEncodingLocString(Language language) const;
    // '---

    // .--- Current language
    void setCurrentLanguage(Language language);
    void setCurrentLanguage(Language languageText, Language languageVoice);
    void setCurrentLanguageText(Language language);
    void setCurrentLanguageVoice(Language language);
    void setCurrentGender(LanguageGender gender);

    Language getCurrentLanguageText() const;
    Language getCurrentLanguageVoice() const;
    LanguageGender getCurrentGender() const;

    Common::Encoding getCurrentEncoding() const;
    Common::Encoding getCurrentEncodingLocString() const;
    // '---

    // .--- Static language utility methods
    static Common::UString getLanguageName(Language language);

    static Language parseLanguage(const Common::UString &str);

    static uint32 convertLanguageIDToGendered(uint32 languageID, LanguageGender gender);
    static uint32 convertLanguageIDToUngendered(uint32 languageID);

    static LanguageGender getLanguageGender(uint32 languageID);

    static uint32 swapLanguageGender(uint32 languageID);

    static Common::MemoryReadStream *preParseColorCodes(Common::SeekableReadStream &stream);
    // '---

private:
    typedef std::map<uint32  , Declaration> LanguageByID;
    typedef std::map<Language, Declaration> LanguageByLanguage;

    LanguageByID _langByID;
    LanguageByLanguage _langByLang;

    Language _currentLanguageText;
    Language _currentLanguageVoice;
    LanguageGender _currentGender;

    const Declaration *find(Language language) const;
    const Declaration *find(uint32 id) const;
};

} // End of namespace Aurora

#define LangMan ::Aurora::LanguageManager::instance()

#endif // AURORA_LANGUAGE_H