Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem/src/core/Language.cc @ 2255

Last change on this file since 2255 was 1747, checked in by landauf, 16 years ago

merged core3 back to trunk

  • Property svn:eol-style set to native
File size: 11.8 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 Language.cc
31    @brief Implementation of the Language and the LanguageEntry classes.
32*/
33
34#include "Language.h"
35
36#include <fstream>
37
38#include "Core.h"
39#include "util/Debug.h"
40
41namespace orxonox
42{
43    // ###############################
44    // ###      LanguageEntry      ###
45    // ###############################
46    /**
47        @brief Constructor: Sets the default entry.
48        @param fallbackEntry The default entry
49    */
50    LanguageEntry::LanguageEntry(const std::string& fallbackEntry)
51    {
52        this->fallbackEntry_ = fallbackEntry;
53        this->localisedEntry_ = fallbackEntry; // Set the localisation to the fallback entry, for the case that no translation gets assigned
54        this->bLocalisationSet_ = false;
55    }
56
57    /**
58        @brief Sets the localisation of the entry.
59        @param localisation The localisation
60    */
61    void LanguageEntry::setLocalisation(const std::string& localisation)
62    {
63        // Check if the translation is more than just an empty string
64        if ((localisation != "") && (localisation.size() > 0))
65        {
66            this->localisedEntry_ = localisation;
67            this->bLocalisationSet_ = true;
68        }
69        else
70            this->localisedEntry_ = this->fallbackEntry_;
71    }
72
73    /**
74        @brief Sets the default entry.
75        @param fallbackEntry The default entry
76    */
77    void LanguageEntry::setDefault(const std::string& fallbackEntry)
78    {
79        // If the default entry changes and the translation wasn't set yet, use the new default entry as translation
80        if (!this->bLocalisationSet_)
81            this->localisedEntry_ = fallbackEntry;
82
83        this->fallbackEntry_ = fallbackEntry;
84    }
85
86    // ###############################
87    // ###        Language         ###
88    // ###############################
89    /**
90        @brief Constructor: Reads the default language file and sets some values.
91    */
92    Language::Language()
93    {
94        this->defaultLanguage_ = "default";
95        this->defaultLocalisation_ = "ERROR: LANGUAGE ENTRY DOESN'T EXIST!";
96
97        // Read the default language file to create all known LanguageEntry objects
98        this->readDefaultLanguageFile();
99    }
100
101    /**
102        @brief Destructor: Deletes all language entries.
103    */
104    Language::~Language()
105    {
106        for (std::map<std::string, LanguageEntry*>::iterator it = this->languageEntries_.begin(); it != this->languageEntries_.end(); ++it)
107            delete (it->second);
108    }
109
110    /**
111        @brief Returns a reference to the only existing instance of the Language class and calls the setConfigValues() function.
112        @return The reference to the only existing instance
113    */
114    Language& Language::getLanguage()
115    {
116        static Language instance = Language();
117        return instance;
118    }
119
120    /**
121        @brief Creates a new LanguageEntry with a given label and a given default entry.
122        @param label The label of the entry
123        @param entry The default entry
124        @return The created LanguageEntry object
125    */
126    LanguageEntry* Language::createEntry(const LanguageEntryLabel& label, const std::string& entry)
127    {
128        std::map<std::string, LanguageEntry*>::const_iterator it = this->languageEntries_.find(label);
129
130        // Make sure we don't create a duplicate entry
131        if (it == this->languageEntries_.end())
132        {
133            LanguageEntry* newEntry = new LanguageEntry(entry);
134            newEntry->setLabel(label);
135            this->languageEntries_[label] = newEntry;
136            return newEntry;
137        }
138
139        COUT(2) << "Warning: Language entry " << label << " is duplicate in " << getFileName(this->defaultLanguage_) << "!" << std::endl;
140        return it->second;
141    }
142
143    /**
144        @brief Adds a new LanguageEntry, if it's not already existing.
145        @param label The label of the entry
146        @param entry The default entry
147    */
148    void Language::addEntry(const LanguageEntryLabel& label, const std::string& entry)
149    {
150        COUT(5) << "Language: Called addEntry with\n  label: " << label << "\n  entry: " <<  entry << std::endl;
151        std::map<std::string, LanguageEntry*>::const_iterator it = this->languageEntries_.find(label);
152        if (it == this->languageEntries_.end())
153        {
154            // The entry isn't available yet, meaning it's new, so create it
155            this->createEntry(label, entry);
156        }
157        else if (it->second->getDefault().compare(entry) == 0)
158        {
159            // The entry is available and the default string is the same, so return because everything is fine
160            return;
161        }
162        else
163        {
164            // The defined default entry is not the same as in the default language file - change it to the new entry
165            it->second->setDefault(entry);
166        }
167
168        // Write the default language file because either a new entry was created or an existing entry has changed
169        this->writeDefaultLanguageFile();
170
171    }
172
173    /**
174        @brief Returns the localisation of a given entry.
175        @param label The label of the entry
176        @return The localisation
177    */
178    const std::string& Language::getLocalisation(const LanguageEntryLabel& label) const
179    {
180        std::map<std::string, LanguageEntry*>::const_iterator it = this->languageEntries_.find(label);
181        if (it != this->languageEntries_.end())
182            return it->second->getLocalisation();
183        else
184        {
185            // Uh, oh, an undefined entry was requested: return the default string
186            COUT(2) << "Warning: Language entry \"" << label << "\" not found!" << std::endl;
187            return this->defaultLocalisation_;
188        }
189    }
190
191    /**
192        @brief Creates the name of the language file out of the languages name.
193        @param language The name of the language
194        @return The filename
195    */
196    const std::string Language::getFileName(const std::string& language)
197    {
198        return std::string("translation_" + language + ".lang");
199    }
200
201    /**
202        @brief Reads the default language file and creates a LanguageEntry objects for every entry.
203    */
204    void Language::readDefaultLanguageFile()
205    {
206        COUT(4) << "Read default language file." << std::endl;
207
208        // This creates the file if it's not existing
209        std::ofstream createFile;
210        createFile.open(getFileName(this->defaultLanguage_).c_str(), std::fstream::app);
211        createFile.close();
212
213        // Open the file
214        std::ifstream file;
215        file.open(getFileName(this->defaultLanguage_).c_str(), std::fstream::in);
216
217        if (!file.is_open())
218        {
219            COUT(1) << "An error occurred in Language.cc:" << std::endl;
220            COUT(1) << "Error: Couldn't open file " << getFileName(this->defaultLanguage_) << " to read the default language entries!" << std::endl;
221            return;
222        }
223
224        char line[1024];
225
226        // Iterate through the file and create the LanguageEntries
227        while (file.good() && !file.eof())
228        {
229            file.getline(line, 1024);
230            std::string lineString = std::string(line);
231
232            // Check if the line is empty
233            if ((lineString != "") && (lineString.size() > 0))
234            {
235                unsigned int pos = lineString.find('=');
236
237                // Check if the length is at least 3 and if there's an entry before and behind the =
238                if (pos > 0 && pos < (lineString.size() - 1) && lineString.size() >= 3)
239                    this->createEntry(lineString.substr(0, pos), lineString.substr(pos + 1));
240                else
241                {
242                    COUT(2) << "Warning: Invalid language entry \"" << lineString << "\" in " << getFileName(this->defaultLanguage_) << std::endl;
243                }
244            }
245        }
246
247        file.close();
248    }
249
250    /**
251        @brief Reads the language file of the configured language and assigns the localisation to the corresponding LanguageEntry object.
252    */
253    void Language::readTranslatedLanguageFile()
254    {
255        COUT(4) << "Read translated language file (" << Core::getLanguage() << ")." << std::endl;
256
257        // Open the file
258        std::ifstream file;
259        file.open(getFileName(Core::getLanguage()).c_str(), std::fstream::in);
260
261        if (!file.is_open())
262        {
263            COUT(1) << "An error occurred in Language.cc:" << std::endl;
264            COUT(1) << "Error: Couldn't open file " << getFileName(Core::getLanguage()) << " to read the translated language entries!" << std::endl;
265            Core::resetLanguage();
266            COUT(3) << "Info: Reset language to " << this->defaultLanguage_ << "." << std::endl;
267            return;
268        }
269
270        char line[1024];
271
272        // Iterate through the file and create the LanguageEntries
273        while (file.good() && !file.eof())
274        {
275            file.getline(line, 1024);
276            std::string lineString = std::string(line);
277
278            // Check if the line is empty
279            if ((lineString != "") && (lineString.size() > 0))
280            {
281                unsigned int pos = lineString.find('=');
282
283                // Check if the length is at least 3 and if there's an entry before and behind the =
284                if (pos > 0 && pos < (lineString.size() - 1) && lineString.size() >= 3)
285                {
286                    std::map<std::string, LanguageEntry*>::const_iterator it = this->languageEntries_.find(lineString.substr(0, pos));
287
288                    // Check if the entry exists
289                    if (it != this->languageEntries_.end())
290                        it->second->setLocalisation(lineString.substr(pos + 1));
291                    else
292                        this->createEntry(lineString.substr(0, pos), this->defaultLocalisation_)->setLocalisation(lineString.substr(pos + 1));
293                }
294                else
295                {
296                    COUT(2) << "Warning: Invalid language entry \"" << lineString << "\" in " << getFileName(Core::getLanguage()) << std::endl;
297                }
298            }
299        }
300
301        file.close();
302    }
303
304    /**
305        @brief Writes all default entries to the default language file.
306    */
307    void Language::writeDefaultLanguageFile() const
308    {
309        COUT(4) << "Language: Write default language file." << std::endl;
310
311        // Open the file
312        std::ofstream file;
313        file.open(getFileName(this->defaultLanguage_).c_str(), std::fstream::out);
314
315        if (!file.is_open())
316        {
317            COUT(1) << "An error occurred in Language.cc:" << std::endl;
318            COUT(1) << "Error: Couldn't open file " << getFileName(this->defaultLanguage_) << " to write the default language entries!" << std::endl;
319            return;
320        }
321
322        // Iterate through the list an write the lines into the file
323        for (std::map<std::string, LanguageEntry*>::const_iterator it = this->languageEntries_.begin(); it != this->languageEntries_.end(); ++it)
324        {
325            file << (*it).second->getLabel() << "=" << (*it).second->getDefault() << std::endl;
326        }
327
328        file.close();
329    }
330}
Note: See TracBrowser for help on using the repository browser.