translation.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_TRANSLATION_H
#define COMMON_TRANSLATION_H

#include "common/array.h"
#include "common/fs.h"
#include "common/str.h"
#include "common/singleton.h"
#include "common/str-array.h"
#include "common/language.h"

#ifdef USE_TRANSLATION

namespace Common {

class File;

enum TranslationIDs {
    kTranslationAutodetectId = 0, 
    kTranslationBuiltinId = 1000  
};

struct TLanguage {
    U32String name; 
    int id;         
    TLanguage() : id(0) {}

    TLanguage(const U32String &n, int i) : name(n), id(i) {}
};

bool operator<(const TLanguage &l, const TLanguage &r);

typedef Array<TLanguage> TLangArray;

struct PoMessageEntry {
    int msgid;         
    String msgctxt;    
    String msgstr;     
};

class TranslationManager : public NonCopyable {
public:
    TranslationManager(const Common::String &fileName);
    ~TranslationManager();

    String getLangById(int id) const;

    void setLanguage(const String &lang);

    void setLanguage(int id) {
        setLanguage(getLangById(id));
    }

    int parseLanguage(const String &lang) const;

    U32String getTranslation(const char *message) const;

    U32String getTranslation(const String &message) const;

    U32String getTranslation(const char *message, const char *context) const;

    U32String getTranslation(const String &message, const String &context) const;

    U32String getTranslation(uint32 index) const;

    const StringArray getContexts() const;

    const TLangArray getSupportedLanguageNames() const;

    String getCurrentLanguage() const;

    int getCurrentLanguageId() const;

    bool currentIsBuiltinLanguage() const;

private:
    int32 findMatchingLanguage(const String &lang);

    bool openTranslationsFile(File &);

    bool openTranslationsFile(const FSNode &node, File &, int depth = -1);

    void loadTranslationsInfoDat(const Common::String &name);

    void loadLanguageDat(int index);

    bool checkHeader(File &in);

    StringArray _langs;
    StringArray _langNames;

    StringArray _messageIds;
    Array<PoMessageEntry> _currentTranslationMessages;
    int _currentLang;
    Common::String _translationsFileName;
};

class MainTranslationManager : public TranslationManager, public Singleton<MainTranslationManager> {
public:
    MainTranslationManager() : TranslationManager("translations.dat") {}
    ~MainTranslationManager() {}
};

} // End of namespace Common

#define TransMan Common::MainTranslationManager::instance()

#define _(str) TransMan.getTranslation(str)
#define _c(str, context) TransMan.getTranslation(str, context)

#else // !USE_TRANSLATION

#define _(str) Common::U32String(str)
#define _c(str, context) Common::U32String(str)

#endif // USE_TRANSLATION

#define _s(str) str
#define _sc(str, ctxt) str
#define DECLARE_TRANSLATION_ADDITIONAL_CONTEXT(str, ctxt)

#endif // COMMON_TRANSLATION_H