1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* Copyright (C) Volition, Inc. 1999. All rights reserved.
*
* All source code herein is the property of Volition, Inc. You may not sell
* or otherwise commercially exploit the source or things you created based on the
* source.
*
*/
#ifndef __FREESPACE2_LOCALIZATION_UTILITIES_HEADER_FILE
#define __FREESPACE2_LOCALIZATION_UTILITIES_HEADER_FILE
#include "globalincs/pstypes.h"
#include "graphics/font.h"
// ------------------------------------------------------------------------------------------------------------
// LOCALIZE DEFINES/VARS
//
// language defines (English should always be index 0)
#define LCL_ENGLISH 0
#define LCL_GERMAN 1
#define LCL_FRENCH 2
#define LCL_POLISH 3
#define LCL_UNTRANSLATED 100 // this should be higher than the highest builtin or custom language index
#define LCL_RETAIL_HYBRID 101 // ditto; this is the weird retail behavior where internal is translated but external isn't
#define LCL_DEFAULT 0
// for language name strings
#define LCL_LANG_NAME_LEN 32
#define LCL_MIN_FONTS 3
// language info table
typedef struct lang_info {
char lang_name[LCL_LANG_NAME_LEN + 1]; // literal name of the language
int xstr; // the xstr id for the language name itself. Used for the built-in language selector
char lang_ext[LCL_LANG_NAME_LEN + 1]; // the extension used for adding to names on disk access
SCP_vector<ubyte> special_char_indexes; // where in the font do we have the special characters for this language
// note: treats 0 as "none" since a zero offset in a font makes no sense
// i.e. all the normal chars start at zero
int checksum; // used for language auto-detection
} lang_info;
// These are the original languages supported by FS2. The code expects these languages to be supported even if the tables don't
#define NUM_BUILTIN_LANGUAGES 4
extern lang_info Lcl_builtin_languages[NUM_BUILTIN_LANGUAGES];
extern SCP_vector<lang_info> Lcl_languages;
// following is the offset where special characters start in our font
extern int Lcl_special_chars;
// use these to replace *_BUILD values
// only 1 will be active at a time
extern int Lcl_fr;
extern int Lcl_gr;
extern int Lcl_pl;
extern int Lcl_en;
// The currently active language. Index into Lcl_languages.
extern int Lcl_current_lang;
// special check for misplaced mod data (see Mantis #2942)
extern bool *Lcl_unexpected_tstring_check;
// ------------------------------------------------------------------------------------------------------------
// LOCALIZE FUNCTIONS
//
// get the index of a language in the array by name
int lcl_find_lang_index_by_name(const SCP_string& lang);
// get an index we can use to look into the array, since we now have three different ways of using English
// (translated, untranslated, and hybrid: internal translated, external untranslated)
int lcl_get_current_lang_index();
// initialize localization, if no language is passed - use the language specified in the registry
void lcl_init(int lang = -1);
// shutdown localization
void lcl_close();
// initialize the xstr table
void lcl_xstr_init();
// free the xstr table
void lcl_xstr_close();
// returns the current language character string
void lcl_get_language_name(char *lang_name);
// set our current language
void lcl_set_language(int lang);
// get a fonts special characters index
ubyte lcl_get_font_index(int font_num);
// NOTE : generally you should only care about the above functions. Below are very low level functions
// which should already be well entrenched in FreeSpace. If you think you need to use one of the below
// functions - ask first :)
// externalization of table/mission files (only parse routines ever need to deal with these functions) -----------------------
// maybe add localized directory to full path with file name when opening a localized file
int lcl_add_dir_to_path_with_filename(char *current_path, size_t path_max);
int lcl_add_dir_to_path_with_filename(SCP_string ¤t_path);
// Goober5000
void lcl_replace_stuff(char *text, size_t max_len, bool force = false);
void lcl_replace_stuff(SCP_string &text, bool force = false);
// Karajorma
void lcl_fred_replace_stuff(char *text, size_t max_len);
void lcl_fred_replace_stuff(SCP_string &text);
// get the localized version of the string. if none exists, return the original string
// valid input to this function includes :
// "this is some text"
// XSTR("wheeee", -1)
// XSTR("whee", 2000)
// and these should cover all the externalized string cases
// fills in id if non-NULL. a value of -2 indicates it is not an external string
void lcl_ext_localize(const char *in, char *out, size_t max_len, int *id = nullptr);
void lcl_ext_localize(const SCP_string &in, SCP_string &out, int *id = nullptr);
// translate the specified string based upon the current language
int lcl_get_xstr_offset(int index, int res);
void lcl_translate_wep_name_gr(char *name);
void lcl_translate_ship_name_gr(char *name);
void lcl_translate_brief_icon_name_gr(char *name);
void lcl_translate_brief_icon_name_pl(char *name);
void lcl_translate_targetbox_name_gr(char *name);
void lcl_translate_targetbox_name_pl(char *name);
void lcl_translate_medal_name_gr(char *name);
void lcl_translate_medal_name_pl(char *name);
void lcl_delayed_xstr(SCP_string& str, const char* name, int xstr);
#endif // defined __FREESPACE2_LOCALIZATION_UTILITIES_HEADER_FILE
|
