Language.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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 2
 *   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#ifndef _Language_H__
#define _Language_H__

#include "CorePrereqs.h"

#include <map>
#include <string>
#include <cassert>
#include "util/Singleton.h"

namespace orxonox
{
    // ###############################
    // ###      LanguageEntry      ###
    // ###############################
    class _CoreExport LanguageEntry
    {
        public:
            explicit LanguageEntry(const std::string& fallbackEntry);
            void setLocalisation(const std::string& localisation);
            void setDefault(const std::string& fallbackEntry);

            inline const std::string& getLocalisation()
                { return this->localisedEntry_; }

            inline const std::string& getDefault()
                { return this->fallbackEntry_; }

            inline void setLabel(const LanguageEntryLabel& label)
                { this->label_ = label; }

            inline const LanguageEntryLabel& getLabel() const
                { return this->label_; }

        private:
            LanguageEntryLabel label_;              
            std::string fallbackEntry_;             
            std::string localisedEntry_;            
            bool bLocalisationSet_;                 
    };


    // ###############################
    // ###         Language        ###
    // ###############################
    class _CoreExport Language : public Singleton<Language>
    {
        friend class Singleton<Language>;
        friend class CoreConfig;

        public:
            Language();
            ~Language();

            void addEntry(const LanguageEntryLabel& label, const std::string& entry);
            const std::string& getLocalisation(const LanguageEntryLabel& label, bool bError = true) const;

        private:
            // non-copyable:
            Language(const Language&) = delete;
            Language& operator=(const Language&) = delete;

            void readDefaultLanguageFile();
            bool readTranslatedLanguageFile(const std::string& language);
            void writeDefaultLanguageFile() const;
            static std::string getFilename(const std::string& language);
            LanguageEntry* createEntry(const LanguageEntryLabel& label, const std::string& entry);

            std::string defaultLanguage_;                           
            std::string defaultLocalisation_;                       
            std::map<std::string, LanguageEntry*> languageEntries_; 

            static Language* singletonPtr_s;
    };

    inline void AddLanguageEntry(const LanguageEntryLabel& label, const std::string& fallbackString)
    {
        Language::getInstance().addEntry(label, fallbackString);
    }

    inline const std::string& GetLocalisation(const LanguageEntryLabel& label)
    {
        return Language::getInstance().getLocalisation(label);
    }

    inline const std::string& GetLocalisation_noerror(const LanguageEntryLabel& label)
    {
        return Language::getInstance().getLocalisation(label, false);
    }
}

#endif /* _Language_H__ */