newgrf_text.h

Go to the documentation of this file.
00001 /* $Id: newgrf_text.h 23812 2012-01-15 19:29:49Z yexo $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD 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, version 2.
00006  * OpenTTD 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.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #ifndef NEWGRF_TEXT_H
00013 #define NEWGRF_TEXT_H
00014 
00015 #include "string_type.h"
00016 #include "strings_type.h"
00017 #include "core/smallvec_type.hpp"
00018 #include "table/control_codes.h"
00019 
00021 static const WChar NFO_UTF8_IDENTIFIER = 0x00DE;
00022 
00023 StringID AddGRFString(uint32 grfid, uint16 stringid, byte langid, bool new_scheme, bool allow_newlines, const char *text_to_add, StringID def_string);
00024 StringID GetGRFStringID(uint32 grfid, uint16 stringid);
00025 const char *GetGRFStringFromGRFText(const struct GRFText *text);
00026 const char *GetGRFStringPtr(uint16 stringid);
00027 void CleanUpStrings();
00028 void SetCurrentGrfLangID(byte language_id);
00029 char *TranslateTTDPatchCodes(uint32 grfid, uint8 language_id, bool allow_newlines, const char *str, int *olen = NULL, StringControlCode byte80 = SCC_NEWGRF_PRINT_WORD_STRING_ID);
00030 struct GRFText *DuplicateGRFText(struct GRFText *orig);
00031 void AddGRFTextToList(struct GRFText **list, struct GRFText *text_to_add);
00032 void AddGRFTextToList(struct GRFText **list, byte langid, uint32 grfid, bool allow_newlines, const char *text_to_add);
00033 void AddGRFTextToList(struct GRFText **list, const char *text_to_add);
00034 void CleanUpGRFText(struct GRFText *grftext);
00035 
00036 bool CheckGrfLangID(byte lang_id, byte grf_version);
00037 
00038 void StartTextRefStackUsage(byte numEntries, const uint32 *values = NULL);
00039 void StopTextRefStackUsage();
00040 void RewindTextRefStack();
00041 bool UsingNewGRFTextStack();
00042 struct TextRefStack *CreateTextRefStackBackup();
00043 void RestoreTextRefStackBackup(struct TextRefStack *backup);
00044 uint RemapNewGRFStringControlCode(uint scc, char *buf_start, char **buff, const char **str, int64 *argv, bool modify_argv);
00045 
00046 StringID TTDPStringIDToOTTDStringIDMapping(StringID string);
00047 
00049 struct LanguageMap {
00051   struct Mapping {
00052     byte newgrf_id;  
00053     byte openttd_id; 
00054   };
00055 
00056   /* We need a vector and can't use SmallMap due to the fact that for "setting" a
00057    * gender of a string or requesting a case for a substring we want to map from
00058    * the NewGRF's internal ID to OpenTTD's ID whereas for the choice lists we map
00059    * the genders/cases/plural OpenTTD IDs to the NewGRF's internal IDs. In this
00060    * case a NewGRF developer/translator might want a different translation for
00061    * both cases. Thus we are basically implementing a multi-map. */
00062   SmallVector<Mapping, 1> gender_map; 
00063   SmallVector<Mapping, 1> case_map;   
00064   int plural_form;                    
00065 
00066   int GetMapping(int newgrf_id, bool gender) const;
00067   int GetReverseMapping(int openttd_id, bool gender) const;
00068   static const LanguageMap *GetLanguageMap(uint32 grfid, uint8 language_id);
00069 };
00070 
00071 #endif /* NEWGRF_TEXT_H */