Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/core/Language.h @ 3015

Last change on this file since 3015 was 2662, checked in by rgrieder, 16 years ago

Merged presentation branch back to trunk.

  • Property svn:eol-style set to native
File size: 5.2 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @brief Definition of the Language and the LanguageEntry class.
32
33    The Language class is used, to get a localisation of a string in the configured language.
34    The string is identified by another string, the label of the entry.
35    If the translation in the configured language isn't available, the default entry, defined in the code, is used.
36
37    Usage:
38     - Set the entry with the default string:
39       Language::getLanguage()->addEntry("label of the entry", "the string to translate");
40
41     - Get the localisation of the entry in the configured language:
42       std::cout << Language::getLanguage()->getLocalisation("name of the entry") << std::endl;
43*/
44
45#ifndef _Language_H__
46#define _Language_H__
47
48#include "CorePrereqs.h"
49
50#include <map>
51#include <string>
52#include <cassert>
53
54#define AddLanguageEntry(label, fallbackstring) \
55    orxonox::Language::getLanguage().addEntry(label, fallbackstring)
56
57#define GetLocalisation(label) \
58    orxonox::Language::getLanguage().getLocalisation(label)
59
60
61namespace orxonox
62{
63    // ###############################
64    // ###      LanguageEntry      ###
65    // ###############################
66    //! The LanguageEntry class stores the default- and the translated string of a given entry in the language file.
67    class _CoreExport LanguageEntry
68    {
69        public:
70            explicit LanguageEntry(const std::string& fallbackEntry);
71            void setLocalisation(const std::string& localisation);
72            void setDefault(const std::string& fallbackEntry);
73
74            /**
75              @brief Returns the localised entry in the configured language.
76              @return The translated entry
77            */
78            inline const std::string& getLocalisation()
79                { return this->localisedEntry_; }
80
81            /**
82              @brief Returns the default entry.
83              @return The default entry
84            */
85            inline const std::string& getDefault()
86                { return this->fallbackEntry_; }
87
88            /**
89                @brief Sets the label of this entry.
90                @param label The label
91            */
92            inline void setLabel(const LanguageEntryLabel& label)
93                { this->label_ = label; }
94
95            /**
96                @brief Returns the label of this entry.
97                @return The label
98            */
99            inline const LanguageEntryLabel& getLabel() const
100                { return this->label_; }
101
102        private:
103            LanguageEntryLabel label_;              //!< The label of the entry
104            std::string fallbackEntry_;             //!< The default entry: Used, if no translation is available or no language configured
105            std::string localisedEntry_;            //!< The localised entry in the configured language
106            bool bLocalisationSet_;                 //!< True if the translation was set
107    };
108
109
110    // ###############################
111    // ###         Language        ###
112    // ###############################
113    //! The Language class manges the language files and entries and stores the LanguageEntry objects in a map.
114    class _CoreExport Language
115    {
116        friend class Core;
117
118        public:
119            Language();
120            ~Language();
121
122            static Language& getLanguage() { assert(singletonRef_s); return *singletonRef_s; }
123            void addEntry(const LanguageEntryLabel& label, const std::string& entry);
124            const std::string& getLocalisation(const LanguageEntryLabel& label) const;
125
126        private:
127            Language(const Language&);
128
129            void readDefaultLanguageFile();
130            void readTranslatedLanguageFile();
131            void writeDefaultLanguageFile() const;
132            static const std::string getFilename(const std::string& language);
133            LanguageEntry* createEntry(const LanguageEntryLabel& label, const std::string& entry);
134
135            std::string defaultLanguage_;                           //!< The default language
136            std::string defaultLocalisation_;                       //!< The returned string, if an entry unavailable entry is requested
137            std::map<std::string, LanguageEntry*> languageEntries_; //!< A map to store all LanguageEntry objects and their labels
138
139            static Language* singletonRef_s;
140    };
141}
142
143#endif /* _Language_H__ */
Note: See TracBrowser for help on using the repository browser.