localize.cpp

/*
 * 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.
 *
*/




#include <cctype>

#include "cfile/cfile.h"
#include "localization/localize.h"
#include "osapi/osregistry.h"
#include "parse/encrypt.h"
#include "parse/parselo.h"
#include "playerman/player.h"
#include "mod_table/mod_table.h"
#include "options/Option.h"

#include <optional>

// ------------------------------------------------------------------------------------------------------------
// LOCALIZE DEFINES/VARS
//

// general language/localization data ---------------------

// current language
int Lcl_current_lang = LCL_RETAIL_HYBRID;
SCP_vector<lang_info> Lcl_languages;

// These are the original languages supported by FS2. The code expects these languages to be supported even if the tables don't

lang_info Lcl_builtin_languages[NUM_BUILTIN_LANGUAGES] = {
	{ "English",  1888, "",   {127,0,176,0,0}, 589986744},    // English ("" is correct; the game data files do not use a language extension for English)
	{ "German",   1889, "gr", {164,0,176,0,0}, -1132430286 }, // German
	{ "French",   1890, "fr", {164,0,176,0,0}, 0 },           // French
	{ "Polish",   1891, "pl", {127,0,176,0,0}, -1131728960},  // Polish
};

int Lcl_special_chars;

// use these to replace *_BUILD, values before
// only 1 will be active at a time
int Lcl_fr = 0;
int Lcl_gr = 0;
int Lcl_pl = 0;
int Lcl_en = 1;

bool *Lcl_unexpected_tstring_check = nullptr;


// executable string localization data --------------------

// XSTR_SIZE is the total count of unique XSTR index numbers.  An index is used to
// reference an entry in strings.tbl.  This is used for translation of strings from
// the english version (in the code) to a foreign version (in the table).  Thus, if you
// add a new string to the code, you must assign it a new index.  Use the number below for
// that index and increase the number below by one.
// NOTE: with map storage of XSTR strings, the indexes no longer need to be contiguous,
// but internal strings should still increment XSTR_SIZE to avoid collisions.
// retail XSTR_SIZE = 1570
// #define XSTR_SIZE	1932 // This is the next available ID

// struct to allow for strings.tbl-determined x offset
// offset is 0 for english, by default
typedef struct {
	const char *str;
	int  offset_x;				// string offset in 640
	int  offset_x_hi;			// string offset in 1024
} lcl_xstr;

SCP_unordered_map<int, lcl_xstr> Xstr_table_map;
bool Xstr_inited = false;


// table/mission externalization stuff --------------------
#define PARSE_TEXT_BUF_SIZE			PARSE_BUF_SIZE
#define PARSE_ID_BUF_SIZE			8	// 7 digits and a \0

SCP_unordered_map<int, char*> Lcl_ext_str;

// Lcl_ext_str will only keep translations for the active language, so if we're not running in English,
// keep the English strings so that we can compare untranslated to English-translated.  But to save space,
// we only need to keep the NAME_LENGTH strings, since we only need to test mission names.
SCP_unordered_map<int, char*> Lcl_ext_str_explicit_default;


// ------------------------------------------------------------------------------------------------------------
// LOCALIZE FORWARD DECLARATIONS
//

// parses the string.tbl and reports back only on the languages it found
void parse_stringstbl_quick(const char *filename);

int language_deserializer(const json_t* value)
{
	const char* lang;
	const char* ext;

	json_error_t err;
	if (json_unpack_ex((json_t*)value, &err, 0, "{s:s, s:s}", "name", &lang, "ext", &ext) != 0) {
		throw json_exception(err);
	}

	int id = lcl_find_lang_index_by_name(lang);

	//does the extension also match? If not then we probably have a new language, so use default instead
	if (SCP_vector_inbounds(Lcl_languages, id) && !stricmp(Lcl_languages[id].lang_ext, ext)) {
		return id;
	}

	return -1;
}

/**
 * Converts/serializes language reference data into a json line
 */
json_t* language_serializer(int lang)
{
	return json_pack("{ssss}", "name", Lcl_languages[lang].lang_name, "ext", Lcl_languages[lang].lang_ext);
}

static SCP_vector<int> language_enumerator()
{
	SCP_vector<int> vals;
	for (int i = 0; i < static_cast<int>(Lcl_languages.size()); i++) {
		vals.push_back(i);
	}

	return vals;
}

static SCP_string language_display(int value)
{
	return XSTR(Lcl_languages[value].lang_name, Lcl_languages[value].xstr);
}

auto LanguageOption = options::OptionBuilder<int>("Game.Language",
							   std::pair<const char*, int>{"Select Language", 1143},
							   std::pair<const char*, int>{"The language to display", 1807})
							   .deserializer(language_deserializer)
							   .serializer(language_serializer)
							   .enumerator(language_enumerator)
							   .display(language_display)
							   .change_listener([](int, bool){
							       return false; //This makes it so that changing the language requires a game restart
							   })
							   .flags({options::OptionFlags::ForceMultiValueSelection})
							   .category(std::make_pair("Game", 1824))
							   .default_val(0)
							   .finish();


// ------------------------------------------------------------------------------------------------------------
// LOCALIZE FUNCTIONS
//

// find a language's index
int lcl_find_lang_index_by_name(const SCP_string& lang)
{
	for (int i = 0; i < static_cast<int>(Lcl_languages.size()); i++) {
		if (!stricmp(Lcl_languages[i].lang_name, lang.c_str())) {
			return i;
		}
	}

	return -1;
}

// get an index we can use to look into the array
int lcl_get_current_lang_index()
{
	Assertion(Lcl_current_lang >= 0, "Lcl_current_lang should never be negative!");

	if (Lcl_current_lang < static_cast<int>(Lcl_languages.size()))
		return Lcl_current_lang;

	return LCL_DEFAULT;
}

// initialize localization, if no language is passed - use the language specified in the registry
void lcl_init(int lang_init)
{
	// initialize encryption
	encrypt_init();

	// set up the first language (which should be English)
	Lcl_languages.push_back(Lcl_builtin_languages[0]);

	// check string.tbl to see which languages we support
	try
	{
		parse_stringstbl_quick("strings.tbl");
	}
	catch (const parse::ParseException& e)
	{
		mprintf(("TABLES: Unable to parse '%s'!  Error message = %s.\n", "strings.tbl", e.what()));
	}

	parse_modular_table(NOX("*-lcl.tbm"), parse_stringstbl_quick);

	// if we only have one language at this point, we need to setup the builtin languages as we might be dealing with an old style strings.tbl
	// which doesn't support anything beyond the builtin languages. Note, we start at i = 1 because we added the first language above.
	if (!No_built_in_languages && (static_cast<int>(Lcl_languages.size()) == 1)) {
		for (int i=1; i<NUM_BUILTIN_LANGUAGES; i++) {
			Lcl_languages.push_back(Lcl_builtin_languages[i]);
		}
	}

	// read the language from the commandline and then registry
	int lang = -1;
	if (lang_init < 0) {

		// first we start with any persisted in-game option choice
		if (Using_in_game_options) {
			lang = LanguageOption->getValue();

			// make sure the language index is valid for the current mod
			if (!SCP_vector_inbounds(Lcl_languages, lang)) {
				lang = -1;
			}
		}

		// now try the the commandline
		if (lang < 0) {
			if (!Cmdline_lang.empty()) {
				lang = lcl_find_lang_index_by_name(Cmdline_lang);
			}
		}

		// still nothing, so go to the ini file
		if (lang < 0) {
			char lang_string[128];
			memset(lang_string, 0, 128);
			// default to DEFAULT_LANGUAGE (which should be English so we don't have to put German text
			// in tstrings in the #default section)
			const char* ret = os_config_read_string(nullptr, "Language", Lcl_languages[LCL_DEFAULT].lang_name);
			strcpy_s(lang_string, ret);

			// look it up
			lang = lcl_find_lang_index_by_name(lang_string);
			if (lang < 0) {
				lang = LCL_DEFAULT;
			}
		}
	} else {
		Assert(lang_init == LCL_UNTRANSLATED || lang_init == LCL_RETAIL_HYBRID || (lang_init >= 0 && lang_init < (int)Lcl_languages.size()));
		lang = lang_init;
	}

	// and after all that... the default language reverts to hybrid unless we are specifically translating it
	if (lang == LCL_DEFAULT && !Use_tabled_strings_for_default_language) {
		lang = LCL_RETAIL_HYBRID;
	}

	// set the language (this function takes care of setting up file pointers)
	lcl_set_language(lang);
}

void lcl_close() {
	lcl_xstr_close();
}

// parses the string.tbl to see which languages are supported. Doesn't read in any strings.
void parse_stringstbl_quick(const char *filename)
{
	lang_info language;
	int lang_idx;
	int i;

	try {
		read_file_text(filename, CF_TYPE_TABLES);
		reset_parse();

		if (optional_string("#Supported Languages")) {
			while (required_string_either("#End","$Language:")) {
				required_string("$Language:");
				stuff_string(language.lang_name, F_RAW, LCL_LANG_NAME_LEN + 1);
				if (optional_string("+XSTR:")) {
					stuff_int(&language.xstr);
				} else {
					language.xstr = -1;
				}
				required_string("+Extension:");
				stuff_string(language.lang_ext, F_RAW, LCL_LANG_NAME_LEN + 1);

				if (!Unicode_text_mode) {
					required_string("+Special Character Index:");
					ubyte special_char;
					stuff_ubyte(&special_char);

					if (language.special_char_indexes.empty()){
						language.special_char_indexes.push_back(special_char);
					}
					else {
						language.special_char_indexes[0] = special_char;
					}

					for (i = 1; i < LCL_MIN_FONTS; ++i) {
						// default to "none"/0 except for font03 which defaults to 176
						// NOTE: fonts.tbl may override these values
						if (i == font::FONT3) {
							special_char = 176;
						} else {
							special_char = 0;
						}

						// if more than one language is defined, the vector may not be increased to this size already.
						if (i < (int)language.special_char_indexes.size()) {
							language.special_char_indexes[i] = special_char;
						} else {
							language.special_char_indexes.push_back(special_char);
						}

					}
				} else {
					if (optional_string("+Special Character Index:")) {
						ubyte temp_index;
						stuff_ubyte(&temp_index);
					}

					// Set all indices to valid values
					for (i = 0; i < LCL_MIN_FONTS; ++i) {
						if (i >= (int)language.special_char_indexes.size()) {
							language.special_char_indexes.push_back(0);
						} else {
							language.special_char_indexes[i] = 0;
						}
					}
				}

				lang_idx = -1;

				// see if we already have this language
				for (i = 0; i < (int)Lcl_languages.size(); i++) {
					if (!strcmp(Lcl_languages[i].lang_name, language.lang_name)) {
						strcpy_s(Lcl_languages[i].lang_ext, language.lang_ext);
						Lcl_languages[i].special_char_indexes[0] = language.special_char_indexes[0];
						lang_idx = i;
						break;
					}
				}

				// if we have a new language, add it.
				if (lang_idx == -1) {
					Lcl_languages.push_back(language);

					if (Lcl_languages.size() > LCL_UNTRANSLATED) {
						Warning(LOCATION, "Too many custom languages; this will conflict with certain special-case language definitions and cause unexpected behavior");
					}
				}
			}
		}
	}
	catch (const parse::ParseException& e)
	{
		mprintf(("WMCGUI: Unable to parse '%s'!  Error message = %s.\n", filename, e.what()));
		return;
	}
}

// Unified function for loading strings.tbl and tstrings.tbl (and their modular versions).
// The "external" parameter controls which format to load: true for tstrings.tbl, false for strings.tbl
void parse_stringstbl_common(const char *filename, const bool external)
{
	char chr, buf[4096];
	char language_tag[512];
	int z, index;
	char *p_offset = nullptr;
	int offset_lo = 0, offset_hi = 0;
	int lcl_index = lcl_get_current_lang_index();

	try {
		read_file_text(filename, CF_TYPE_TABLES);
		reset_parse();

		// move down to the proper section
		memset(language_tag, 0, sizeof(language_tag));
		strcpy_s(language_tag, "#");
		if (external && (lcl_index == LCL_DEFAULT)) {
			strcat_s(language_tag, "default");
		} else {
			strcat_s(language_tag, Lcl_languages[lcl_index].lang_name);
		}

		if ( skip_to_string(language_tag) != 1 ) {
			mprintf(("Language tag %s not found in %s\n", language_tag, filename));
			return;
		}

		// parse all the strings in this section of the table
		while ( !check_for_string("#") ) {
			int num_offsets_on_this_line = 0;

			stuff_int(&index);
			if (external) {
				ignore_white_space();
				get_string(buf, sizeof(buf));
			} else {
				stuff_string(buf, F_RAW, sizeof(buf));
			}

			if (external && index < 0) {
				error_display(0, "Invalid tstrings table index specified (%i). The index must be positive.", index);
				return;
			} else if (!external && index < 0) {
				Error(LOCATION, "Invalid strings table index specified (%i)", index);
			}

			if (!external) {

				size_t i = strlen(buf);

				while (i--) {
					if ( !isspace(buf[i]) )
						break;
				}

				// trim unnecessary end of string
				// Assert(buf[i] == '"');
				if (buf[i] != '"') {
					// probably an offset on this entry

					// drop down a null terminator (prolly unnecessary)
					buf[i+1] = 0;

					// back up over the potential offset
					while ( !is_white_space(buf[i]) )
						i--;

					// now back up over intervening spaces
					while ( is_white_space(buf[i]) )
						i--;

					num_offsets_on_this_line = 1;

					if (buf[i] != '"') {
						// could have a 2nd offset value (one for 640, one for 1024)
						// so back up again
						while ( !is_white_space(buf[i]) )
							i--;

						// now back up over intervening spaces
						while ( is_white_space(buf[i]) )
							i--;

						num_offsets_on_this_line = 2;
					}

					p_offset = &buf[i+1];			// get ptr to string section with offset in it

					if (buf[i] != '"')
						error_display(1, "%s is corrupt", filename);		// now its an error
				}

				buf[i] = 0;

				// copy string into buf
				z = 0;
				for (i = 1; buf[i]; i++) {
					chr = buf[i];

					if (chr == '\\') {
						chr = buf[++i];

						if (chr == 'n')
							chr = '\n';
						else if (chr == 'r')
							chr = '\r';
					}

					buf[z++] = chr;
				}

				// null terminator on buf
				buf[z] = 0;
			}

			// write into Xstr_table (for strings.tbl) or Lcl_ext_str (for tstrings.tbl)
			if (Parsing_modular_table) {
				if (external) {
					auto entry = Lcl_ext_str.find(index);
					if (entry != Lcl_ext_str.end()) {
						vm_free((void*)entry->second);
						Lcl_ext_str.erase(entry);
					}
				} else {
					auto entry = Xstr_table_map.find(index);
					if (entry != Xstr_table_map.end()) {
						vm_free((void*)entry->second.str);
						Xstr_table_map.erase(entry);
					}
				}
			}

			if (external && (Lcl_ext_str.find(index) != Lcl_ext_str.end())) {
				Warning(LOCATION, "Tstrings table index %d used more than once", index);
			} else if (!external && (Xstr_table_map.find(index) != Xstr_table_map.end())) {
				Warning(LOCATION, "Strings table index %d used more than once", index);
			}

			if (external) {
				Lcl_ext_str.insert(std::make_pair(index, vm_strdup(buf)));
			} else {
				Xstr_table_map.insert(std::make_pair(index, lcl_xstr{ vm_strdup(buf), 0, 0 }));
			}

			// the rest of this loop applies only to strings.tbl,
			// so we can move on to the next line if we're reading from tstrings.tbl
			if (external) {
				continue;
			}

			// read offset information, assume 0 if nonexistant
			if (p_offset != nullptr) {
				if (sscanf(p_offset, "%d%d", &offset_lo, &offset_hi) < num_offsets_on_this_line) {
					// whatever is in the file ain't a proper offset
					Error(LOCATION, "%s is corrupt", filename);
				}
			}

			Xstr_table_map[index].offset_x = offset_lo;

			if (num_offsets_on_this_line == 2) {
				Xstr_table_map[index].offset_x_hi = offset_hi;
			} else {
				Xstr_table_map[index].offset_x_hi = offset_lo;
			}

			// clear out our vars
			p_offset = nullptr;
			offset_lo = 0;
			offset_hi = 0;
		}
	}
	catch (const parse::ParseException& e)
	{
		mprintf(("TABLES: Unable to parse 'controlconfigdefaults.tbl'!  Error message = %s.\n", e.what()));
		return;
	}
}

void parse_stringstbl(const char *filename)
{
	parse_stringstbl_common(filename, false);
}

void parse_tstringstbl(const char *filename)
{
	parse_stringstbl_common(filename, true);
}

struct xstr_delayed_order {
	SCP_string& toFill;
	const char* name;
	int xstr;
};

static void lcl_delayed_xstr_internal(std::optional<xstr_delayed_order> to_init) {
	static SCP_vector<xstr_delayed_order> delayed_init;

	if (to_init) {
		if (Xstr_inited)
			to_init->toFill = XSTR(to_init->name, to_init->xstr);
		else
			delayed_init.emplace_back(std::move(*to_init));
	}
	else {
		Assertion(Xstr_inited, "Tried to resolve delayed XSTR before XSTR init!");

		for (const auto& delayed : delayed_init)
			delayed.toFill = XSTR(delayed.name, delayed.xstr);

		delayed_init.clear();
	}
}

void lcl_delayed_xstr(SCP_string& str, const char* name, int xstr) {
	lcl_delayed_xstr_internal(xstr_delayed_order{ str, name, xstr });
}

// initialize the xstr table
void lcl_xstr_init()
{
	Xstr_table_map.clear();

	Assertion(Lcl_ext_str.empty() && Lcl_ext_str_explicit_default.empty(), "Localize system was not shut down properly!");
	Lcl_ext_str.clear();
	Lcl_ext_str_explicit_default.clear();


	try
	{
		parse_stringstbl("strings.tbl");
	}
	catch (const parse::ParseException& e)
	{
		mprintf(("TABLES: Unable to parse '%s'!  Error message = %s.\n", "strings.tbl", e.what()));
	}
	parse_modular_table(NOX("*-lcl.tbm"), parse_stringstbl);


	// If this is a non-English language, parse English and keep a copy of the table that's just the NAME_LENGTH strings
	if (lcl_get_current_lang_index() != LCL_DEFAULT)
	{
		auto saved_language = Lcl_current_lang;
		Lcl_current_lang = LCL_DEFAULT;

		// same parsing as below
		try
		{
			parse_tstringstbl("tstrings.tbl");
		}
		catch (const parse::ParseException& e)
		{
			mprintf(("TABLES: Unable to parse '%s'!  Error message = %s.\n", "tstrings.tbl", e.what()));
		}
		parse_modular_table(NOX("*-tlc.tbm"), parse_tstringstbl);

		// copy entries containing short strings and free the rest
		for (const auto& entry : Lcl_ext_str)
		{
			if (entry.second != nullptr)
			{
				if (strlen(entry.second) < NAME_LENGTH)
					Lcl_ext_str_explicit_default.insert(entry);
				else
					vm_free(entry.second);
			}
		}

		// reset things so that we can parse the language properly
		Lcl_ext_str.clear();
		Lcl_current_lang = saved_language;
	}


	try
	{
		parse_tstringstbl("tstrings.tbl");
	}
	catch (const parse::ParseException& e)
	{
		mprintf(("TABLES: Unable to parse '%s'!  Error message = %s.\n", "tstrings.tbl", e.what()));
	}
	parse_modular_table(NOX("*-tlc.tbm"), parse_tstringstbl);


	Xstr_inited = true;

	lcl_delayed_xstr_internal(std::nullopt);
}


// free Xstr table
void lcl_xstr_close()
{
	for (const auto& entry : Xstr_table_map) {
		if (entry.second.str != nullptr) {
			vm_free((void*)entry.second.str);
		}
	}
	Xstr_table_map.clear();

	for (const auto& entry : Lcl_ext_str) {
		if (entry.second != nullptr) {
			vm_free(entry.second);
		}
	}
	Lcl_ext_str.clear();

	for (const auto& entry : Lcl_ext_str_explicit_default) {
		if (entry.second != nullptr) {
			vm_free(entry.second);
		}
	}
	Lcl_ext_str_explicit_default.clear();
}


// set our current language
void lcl_set_language(int lang)
{
	Lcl_current_lang = lang;

	if (lang == LCL_UNTRANSLATED) {
		nprintf(("General", "Setting language to UNTRANSLATED\n"));
		// but for the purposes of array access, we use the default
		lang = LCL_DEFAULT;
	} else if (lang == LCL_RETAIL_HYBRID) {
		nprintf(("General", "Setting language to RETAIL HYBRID\n"));
		// but for the purposes of array access, we use the default
		lang = LCL_DEFAULT;
	} else {
		nprintf(("General", "Setting language to %s\n", Lcl_languages[lang].lang_name));
	}

	Assertion((lang >= 0) && (lang < (int)Lcl_languages.size()), "Attempt to set language to an invalid language");

	// flag the proper language as being active
	Lcl_special_chars = Lcl_languages[lang].special_char_indexes[0];
	Lcl_fr = 0;
	Lcl_gr = 0;
	Lcl_pl = 0;
	Lcl_en = 0;
	if (!strcmp(Lcl_languages[lang].lang_name, Lcl_builtin_languages[LCL_ENGLISH].lang_name)) {
		Lcl_en = 1;
	} else if (!strcmp(Lcl_languages[lang].lang_name, Lcl_builtin_languages[LCL_FRENCH].lang_name)) {
		Lcl_fr = 1;
	} else if (!strcmp(Lcl_languages[lang].lang_name, Lcl_builtin_languages[LCL_GERMAN].lang_name)) {
		Lcl_gr = 1;
	} else if (!strcmp(Lcl_languages[lang].lang_name, Lcl_builtin_languages[LCL_POLISH].lang_name)) {
		Lcl_pl = 1;
	}
}

ubyte lcl_get_font_index(int font_num)
{
	int lang = lcl_get_current_lang_index();

	if (Unicode_text_mode) {
		// In Unicode mode there are no special characters. Some of the code still uses this function in that mode so
		// we just return 0 to signify that there are no special characters in this font
		return 0;
	} else {
		Assertion((lang >= 0) && (lang < (int)Lcl_languages.size()), "Current language %d is not valid, can't get font indexes. This is a coder error, please report.", lang);
		Assertion((font_num >= 0) && (font_num < (int)Lcl_languages[lang].special_char_indexes.size()), "Passed an invalid font index, %d. This is a coder error, please report.", font_num);

		return Lcl_languages[lang].special_char_indexes[font_num];
	}
}

// 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 lang = lcl_get_current_lang_index();

	// if the disk extension is 0 length, don't add anything
	if (strlen(Lcl_languages[lang].lang_ext) <= 0) {
		return 1;
	}

	size_t str_size = path_max + 1;

	char *temp = new char[str_size];
	memset(temp, 0, str_size * sizeof(char));

	// find position of last slash and copy rest of filename (not counting slash) to temp
	// mark end of current path with '\0', so strcat will work
	char *last_slash = strrchr(current_path, DIR_SEPARATOR_CHAR);
	if (last_slash == NULL) {
		strncpy(temp, current_path, path_max);
		current_path[0] = '\0';
	} else {
		strncpy(temp, last_slash+1, path_max);
		last_slash[1] = '\0';
	}

	// add extension
	strcat_s(current_path, path_max, Lcl_languages[lang].lang_ext);
	strcat_s(current_path, path_max, DIR_SEPARATOR_STR );

	// copy rest of filename from temp
	strcat_s(current_path, path_max, temp);

	delete [] temp;
	return 1;
}

int lcl_add_dir_to_path_with_filename(SCP_string &current_path)
{
	int lang = lcl_get_current_lang_index();

	// if the disk extension is 0 length, don't add anything
	if (strlen(Lcl_languages[lang].lang_ext) <= 0) {
		return 1;
	}

	SCP_string filename;

	auto sep = current_path.find_last_of(DIR_SEPARATOR_CHAR);

	if (sep == SCP_string::npos) {
		filename = current_path;
		current_path.clear();
	} else {
		filename = current_path.substr(sep+1);
		current_path.erase(sep+1);
	}

	// add extension
	current_path += Lcl_languages[lang].lang_ext;
	current_path += DIR_SEPARATOR_STR;

	// copy rest of filename
	current_path += filename;

	return 1;
}


// externalization of table/mission files ----------------------- 

void lcl_replace_stuff(char *text, size_t max_len, bool force)
{
	if (Fred_running && !force)
		return;

	Assert(text);	// Goober5000

	// delegate to SCP_string for the replacements
	SCP_string temp_text = text;
	lcl_replace_stuff(temp_text);

	// fill up the original string
	size_t len = temp_text.copy(text, max_len);
	text[len] = 0;
}

// Goober5000 - replace stuff in the string, e.g. $callsign with player's callsign
// now will also replace $rank with rank, e.g. "Lieutenant"
// now will also replace $quote with double quotation marks
// now will also replace $semicolon with semicolon mark
// now will also replace $slash and $backslash
void lcl_replace_stuff(SCP_string &text, bool force)
{
	if (Fred_running && !force)
		return;

	if (!Fred_running && Player != nullptr)
	{
		replace_all(text, "$callsign", Player->callsign);
		replace_all(text, "$rank", get_rank_display_name(&Ranks[verify_rank(Player->stats.rank)]).c_str());
		replace_all(text, "$rtitle", Ranks[verify_rank(Player->stats.rank)].title.c_str());
	}

	replace_all(text, "$quote", "\"");
	replace_all(text, "$semicolon", ";");
	replace_all(text, "$slash", "/");
	replace_all(text, "$backslash", "\\");
}

void lcl_fred_replace_stuff(char *text, size_t max_len)
{
	if (!Fred_running)
		return;

	Assert(text);	// Goober5000

	// delegate to SCP_string for the replacements
	SCP_string temp_text = text;
	lcl_fred_replace_stuff(temp_text);

	// fill up the original string
	size_t len = temp_text.copy(text, max_len);
	text[len] = 0;
}

void lcl_fred_replace_stuff(SCP_string &text)
{
	if (!Fred_running)
		return;

	// this should be kept in sync with the FRED functions in management.cpp and Editor.cpp
	replace_all(text, "\"", "$quote");
	replace_all(text, ";", "$semicolon");
	replace_all(text, "/", "$slash");
	replace_all(text, "\\", "$backslash");
}

// 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
// NOTE: max_len is the maximum string length, not buffer length
// fills in id if non-NULL. a value of -2 indicates it is not an external string
// returns true if we were able to extract the XSTR elements (text_str and maybe id are populated)
bool lcl_ext_localize_sub(const char *in, char *text_str, char *out, size_t max_len, int *id, bool use_default_translation = false)
{
	Assert(in);
	Assert(out);

	// NOTE: "Token too long" warnings are disabled when Lcl_unexpected_tstring_check is active,
	// because in such cases we actually anticipate that the length might be exceeded.

	// set up return values
	auto xstr_str = in;
	int xstr_id = -2;			// default (non-external string) value
	bool xstr_valid = false;

	auto ch = in;
	bool attempted_xstr = false;

	// this is a pseudo-goto block, not a loop
	do {
		// check to see if this is an XSTR() tag
		if (strnicmp(ch, "XSTR", 4) != 0)
			break;
		ch += 4;

		// the next non-whitespace char should be a (
		ignore_white_space(&ch);
		if (*ch != '(')
			break;
		ch++;

		// by not setting the flag until after the parenthesis, XSTR by itself can be plain text, but XSTR( starts a tag
		attempted_xstr = true;

		// the next should be a quote
		ignore_white_space(&ch);
		if (*ch != '\"')
			break;
		ch++;

		// now we have the start of the string
		auto str_start = ch;

		// find the end of the string
		ch = strchr(ch, '"');
		if (ch == nullptr)
			break;

		// now we have the end of the string (past the last character in it)
		auto str_end = ch;
		ch++;	// skip the quote

		// the next non-whitespace char should be a ,
		ignore_white_space(&ch);
		if (*ch != ',')
			break;
		ch++;

		// check for number, being mindful of negative
		ignore_white_space(&ch);
		bool is_negative = false;
		if (*ch == '-')
		{
			is_negative = true;
			ch++;
		}
		if (!isdigit(*ch))
			break;

		// now we have the start of the id
		auto id_start = ch;

		// find all the digits
		while (isdigit(*ch))
			ch++;

		// now we have the end of the id (past the last character in it)
		auto id_end = ch;

		// the next non-whitespace char should be a )
		ignore_white_space(&ch);
		if (*ch != ')')
			break;

		// if we got this far, we know we have a parseable XSTR of some sort
		xstr_id = -1;

		//
		// split off the strings and id sections
		//

		// check bounds
		auto str_length = str_end - str_start;
		if (str_length > PARSE_BUF_SIZE - 1)
		{
			error_display(0, "String cannot fit within XSTR buffer!\n\n%s\n", str_start);
			break;
		}

		// now that we know the boundaries of the actual string in the XSTR() tag, copy it
		strncpy(text_str, str_start, str_length);
		text_str[str_length] = '\0';

		// bounds for id too
		auto id_length = id_end - id_start;
		if (id_length > PARSE_ID_BUF_SIZE - 1)
		{
			error_display(0, "Number cannot fit within XSTR buffer!\n\n%s\n", id_start);
			break;
		}

		// copy id
		char xstr_id_buf[PARSE_ID_BUF_SIZE];
		strncpy(xstr_id_buf, id_start, id_length);
		xstr_id_buf[id_length] = '\0';

		//
		// now we have the information we want
		//

		xstr_str = text_str;
		xstr_id = atoi(xstr_id_buf);
		if (is_negative)
			xstr_id *= -1;
		xstr_valid = true;

		// if the localization file is not open, or there's no entry, or we're not translating, return the original string
		if (!Xstr_inited || (xstr_id < 0) || (!use_default_translation && ((Lcl_current_lang == LCL_UNTRANSLATED) || (Lcl_current_lang == LCL_RETAIL_HYBRID))))
			break;

		//
		// we are translating
		//

		auto lookup_map = &Lcl_ext_str;
		if (use_default_translation && lcl_get_current_lang_index() != LCL_DEFAULT)
		{
			// if we're not already using the default, then switch to our explicit default
			lookup_map = &Lcl_ext_str_explicit_default;
		}

		// get the string if it exists
		auto entry = lookup_map->find(xstr_id);
		if (entry != lookup_map->end())
		{
			xstr_str = entry->second;
		}
		// otherwise use what we have, but complain about it
		else
		{
			mprintf(("Could not find entry %d in the external string table!\n", xstr_id));
		}
	} while (false);


	// set whatever id we have
	if (id != nullptr)
		*id = xstr_id;

	// if we made an attempt but failed, let the modder know (using a ReleaseWarning)
	if (xstr_id == -2 && attempted_xstr)
		error_display(2, "Malformed XSTR detected:\n\n%s\n", in);

	// copy the entire string (or as much as we can)
	auto str_len = strlen(xstr_str);
	strncpy(out, xstr_str, max_len);
	if (str_len > max_len)
		out[max_len] = '\0';
	else
		out[str_len] = '\0';

	// maybe warn about length
	if (str_len > max_len && !Lcl_unexpected_tstring_check)
		error_display(0, "Token too long: [%s].  Length = " SIZE_T_ARG ".  Max is " SIZE_T_ARG ".\n", xstr_str, str_len, max_len);

	return xstr_valid;
}

// ditto for SCP_string
bool lcl_ext_localize_sub(const SCP_string &in, SCP_string &text_str, SCP_string &out, int *id, bool use_default_translation = false)
{
	// set up return values
	auto xstr_str = in.c_str();
	int xstr_id = -2;			// default (non-external string) value
	bool xstr_valid = false;

	auto ch = in.c_str();
	bool attempted_xstr = false;

	// this is a pseudo-goto block, not a loop
	do {
		// check to see if this is an XSTR() tag
		if (strnicmp(ch, "XSTR", 4) != 0)
			break;
		ch += 4;

		// the next non-whitespace char should be a (
		ignore_white_space(&ch);
		if (*ch != '(')
			break;
		ch++;

		// by not setting the flag until after the parenthesis, XSTR by itself can be plain text, but XSTR( starts a tag
		attempted_xstr = true;

		// the next should be a quote
		ignore_white_space(&ch);
		if (*ch != '\"')
			break;
		ch++;

		// now we have the start of the string
		auto str_start = ch;

		// find the end of the string
		ch = strchr(ch, '"');
		if (ch == nullptr)
			break;

		// now we have the end of the string (past the last character in it)
		auto str_end = ch;
		ch++;	// skip the quote

		// the next non-whitespace char should be a ,
		ignore_white_space(&ch);
		if (*ch != ',')
			break;
		ch++;

		// check for number, being mindful of negative
		ignore_white_space(&ch);
		bool is_negative = false;
		if (*ch == '-')
		{
			is_negative = true;
			ch++;
		}
		if (!isdigit(*ch))
			break;

		// now we have the start of the id
		auto id_start = ch;

		// find all the digits
		while (isdigit(*ch))
			ch++;

		// now we have the end of the id (past the last character in it)
		auto id_end = ch;

		// the next non-whitespace char should be a )
		ignore_white_space(&ch);
		if (*ch != ')')
			break;

		// if we got this far, we know we have a parseable XSTR of some sort
		xstr_id = -1;

		//
		// split off the strings and id sections
		//

		// now that we know the boundaries of the actual string in the XSTR() tag, copy it
		text_str.assign(str_start, str_end);

		// bounds for id too
		auto id_length = id_end - id_start;
		if (id_length > PARSE_ID_BUF_SIZE - 1)
		{
			error_display(0, "Number cannot fit within XSTR buffer!\n\n%s\n", id_start);
			break;
		}

		// copy id
		char xstr_id_buf[PARSE_ID_BUF_SIZE];
		strncpy(xstr_id_buf, id_start, id_length);
		xstr_id_buf[id_length] = '\0';

		//
		// now we have the information we want
		//

		xstr_str = text_str.c_str();
		xstr_id = atoi(xstr_id_buf);
		if (is_negative)
			xstr_id *= -1;
		xstr_valid = true;

		// if the localization file is not open, or there's no entry, or we're not translating, return the original string
		if (!Xstr_inited || (xstr_id < 0) || (!use_default_translation && ((Lcl_current_lang == LCL_UNTRANSLATED) || (Lcl_current_lang == LCL_RETAIL_HYBRID))))
			break;

		//
		// we are translating
		//

		auto lookup_map = &Lcl_ext_str;
		if (use_default_translation && lcl_get_current_lang_index() != LCL_DEFAULT)
		{
			// if we're not already using the default, then switch to our explicit default
			lookup_map = &Lcl_ext_str_explicit_default;
		}

		// get the string if it exists
		auto entry = lookup_map->find(xstr_id);
		if (entry != lookup_map->end())
		{
			xstr_str = entry->second;
		}
		// otherwise use what we have, but complain about it
		else
		{
			mprintf(("Could not find entry %d in the external string table!\n", xstr_id));
		}
	} while (false);


	// set whatever id we have
	if (id != nullptr)
		*id = xstr_id;

	// if we made an attempt but failed, let the modder know (using a ReleaseWarning)
	if (xstr_id == -2 && attempted_xstr)
		error_display(2, "Malformed XSTR detected:\n\n%s\n", in.c_str());

	// copy the entire string
	out = xstr_str;

	return xstr_valid;
}

// Goober5000 - wrapper for lcl_ext_localize_sub; used because lcl_replace_stuff has to
// be called *after* the translation is done, and the original function returned in so
// many places that it would be messy to call lcl_replace_stuff everywhere
// Addendum: Now, of course, it provides a handy way to encapsulate the unexpected tstring check.
void lcl_ext_localize(const char *in, char *out, size_t max_len, int *id)
{
	// buffer for the untranslated string inside the XSTR tag
	char text_str[PARSE_BUF_SIZE] = "";

	// if we're doing this extra check, then we have to compare the untranslated string with the default language string and see if they're different
	if (Lcl_unexpected_tstring_check)
	{
		// explicitly use the default table for the translation lookup
		bool extracted = lcl_ext_localize_sub(in, text_str, out, max_len, id, true);

		// only check short strings, since those are the only ones we keep in the explicit default table
		if (strlen(text_str) < NAME_LENGTH)
		{
			// the untranslated and default-translated strings should always be identical, so if they're different, it might mean we have some data from a different mod
			if (extracted && strcmp(text_str, out) != 0)
				*Lcl_unexpected_tstring_check = true;
		}

		// at this point, we can go back to our usual language and do the translation for real
		if (lcl_get_current_lang_index() != LCL_DEFAULT)
			lcl_ext_localize_sub(in, text_str, out, max_len, id);
	}
	// most of the time we're not going to do the check, so localize as normal
	else
	{
		// do XSTR translation
		lcl_ext_localize_sub(in, text_str, out, max_len, id);
	}

	// do translation of $callsign, $rank, etc.
	lcl_replace_stuff(out, max_len);
}

// ditto for SCP_string
void lcl_ext_localize(const SCP_string &in, SCP_string &out, int *id)
{
	// buffer for the untranslated string inside the XSTR tag
	SCP_string text_str = "";

	// if we're doing this extra check, then we have to compare the untranslated string with the default language string and see if they're different
	if (Lcl_unexpected_tstring_check)
	{
		// explicitly use the default table for the translation lookup
		bool extracted = lcl_ext_localize_sub(in, text_str, out, id, true);

		// only check short strings, since those are the only ones we keep in the explicit default table
		if (text_str.length() < NAME_LENGTH)
		{
			// the untranslated and default-translated strings should always be identical, so if they're different, it might mean we have some data from a different mod
			if (extracted && text_str != out)
				*Lcl_unexpected_tstring_check = true;
		}

		// at this point, we can go back to our usual language and do the translation for real
		if (lcl_get_current_lang_index() != LCL_DEFAULT)
			lcl_ext_localize_sub(in, text_str, out, id);
	}
	// most of the time we're not going to do the check, so localize as normal
	else
	{
		// do XSTR translation
		lcl_ext_localize_sub(in, text_str, out, id);
	}

	// do translation of $callsign, $rank, etc.
	lcl_replace_stuff(out);
}

// translate the specified string based upon the current language
const char *XSTR(const char *str, int index, bool force_lookup)
{
	if(!Xstr_inited)
	{
		//If you're here then you should use lcl_delayed_xstr instead!
		Int3();
		return str;
	}

#ifndef NDEBUG
	nprintf(("XSTR", "Localizing String: %i, \"%s\"\n", index, str));
#endif

	// for some internal strings, such as the ones we loaded using $Has XStr:,
	// we want to force a lookup even if we're normally untranslated
	if (Lcl_current_lang != LCL_UNTRANSLATED || force_lookup)
	{
		// perform a lookup
		if (index >= 0)
		{
			// return translation of string
			auto entry = Xstr_table_map.find(index);
			if (entry != Xstr_table_map.end())
				return entry->second.str;
#ifndef NDEBUG
			else
			{
				// make sure missing strings are only logged once
				static SCP_unordered_set<int> Warned_xstr_indexes;
				if (Warned_xstr_indexes.count(index) == 0)
				{
					Warned_xstr_indexes.insert(index);
					mprintf(("No XSTR entry in strings.tbl for index %d\n", index));
				}
			}
#endif
		}
	}

	// can't translate; return original English string
	return str;
}

// retrieve the offset for a localized string
int lcl_get_xstr_offset(int index, int res)
{
	auto entry = Xstr_table_map.find(index);
	if (entry == Xstr_table_map.end())
		return 0;

	if (res == GR_640) {
		return entry->second.offset_x;
	} else {
		return entry->second.offset_x_hi;
	}
}


// ------------------------------------------------------------------------------------------------------------
// LOCALIZE FORWARD DEFINITIONS
//

void lcl_get_language_name(char *lang_name)
{
	int lang = lcl_get_current_lang_index();

	Assert(lang >= 0 && lang < (int)Lcl_languages.size());
	strcpy(lang_name, Lcl_languages[lang].lang_name);
}

// ------------------------------------------------------------------
// lcl_translate_wep_name_gr()
//
// For displaying weapon names in german version
// since we can't actually just change them outright.
//
void lcl_translate_wep_name_gr(SCP_string &name)
{
	if (name == "Morning Star") {
		name = "Morgenstern";
	} else if (name == "MorningStar") {
		name = "Morgenstern D";
	} else if (name == "UD-8 Kayser") {
		name = "Kayserstrahl";
	} else if (name == "UD-D Kayser") {
		name = "Kayserstrahl";
	}
}

// ------------------------------------------------------------------
// lcl_translate_brief_icon_name_gr()
//
// For displaying ship names in german version
// since we can't actually just change them outright.
//
void lcl_translate_brief_icon_name_gr(char *name)
{
	char *pos;
	char buf[128];

	if (!stricmp(name, "Subspace Portal")) {	
		strcpy(name, "Subraum Portal");

	} else if (!stricmp(name, "Alpha Wing")) {
		strcpy(name, "Alpha");

	} else if (!stricmp(name, "Beta Wing")) {
		strcpy(name, "Beta");

	} else if (!stricmp(name, "Zeta Wing")) {
		strcpy(name, "Zeta");

	} else if (!stricmp(name, "Capella Node")) {
		strcpy(name, "Capella");

	} else if (!stricmp(name, "Hostile")) {
		strcpy(name, "Gegner");

	} else if (!stricmp(name, "Hostile Craft")) {
		strcpy(name, "Gegner");

	} else if (!stricmp(name, "Rebel Wing")) {
		strcpy(name, "Rebellen");

	} else if (!stricmp(name, "Rebel Fleet")) {
		strcpy(name, "Rebellenflotte");

	} else if (!stricmp(name, "Sentry Gun")) {
		strcpy(name, "Gesch\x81tz");

	} else if (!stricmp(name, "Cargo")) {
		strcpy(name, "Fracht");

	} else if (!stricmp(name, "Knossos Device")) {
		strcpy(name, "Knossosger\x84t");
	
	} else if (!stricmp(name, "Support")) {
		strcpy(name, "Versorger");

	} else if (!stricmp(name, "Unknown")) {
		strcpy(name, "Unbekannt");

	} else if (!stricmp(name, "Instructor")) {
		strcpy(name, "Ausbilder");
	
	} else if (!stricmp(name, "Jump Node")) {
		strcpy(name, "Sprungknoten");

	} else if (!stricmp(name, "Escort")) {
		strcpy(name, "Geleitschutz");

	} else if (!stricmp(name, "Asteroid Field")) {
		strcpy(name, "Asteroidenfeld");

	} else if (!stricmp(name, "Enif Station")) {
		strcpy(name, "Station Enif");

	} else if (!stricmp(name, "Rally Point")) {
		strcpy(name, "Sammelpunkt");

	} else if ((pos = strstr(name, "Transport")) != NULL) {
		pos += 9;		// strlen of "transport"
		strcpy_s(buf, "Transporter");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Jump Node")) != NULL) {
		pos += 9;		// strlen of "jump node"
		strcpy_s(buf, "Sprungknoten");
		strcat_s(buf, pos);
		strcpy(name, buf);
	
	} else if (!stricmp(name, "Orion under repair")) {
		strcpy(name, "Orion wird repariert");

	// SOTY-specific ones below!
	
	} else if (!stricmp(name, "Wayfarer Station")) {
		strcpy(name, "Station Wayfarer");
	} else if (!stricmp(name, "Enemy")) {
		strcpy(name, "Gegner");
	} else if (!stricmp(name, "Supply Depot")) {
		strcpy(name, "Nachschubdepot");
	} else if (!stricmp(name, "Fighter Escort")) {
		strcpy(name, "Jagdschutz");
	} else if (!stricmp(name, "Shivans")) {
		strcpy(name, "Shivaner");
	} else if (!stricmp(name, "NTF Base of Operations")) {
		strcpy(name, "NTF-Operationsbasis");
	} else if (!stricmp(name, "NTF Bombers")) {
		strcpy(name, "NTF-Bomber");
	} else if (!stricmp(name, "NTF Fighters")) {
		strcpy(name, "NTF-J\x84ger");
	} else if (!stricmp(name, "Sentry")) {
		strcpy(name, "Sperrgesch\x81tz");
	} else if (!stricmp(name, "Cargo Containers")) {
		strcpy(name, "Frachtbeh\x84lter");
	} else if (!stricmp(name, "NTF Reinforcements")) {
		strcpy(name, "NTF-Verst\x84rkungen");
	} else if (!stricmp(name, "NTF Base")) {
		strcpy(name, "NTF-St\x81tzpunkt");
	} else if (!stricmp(name, "Refugee Convoy")) {
		strcpy(name, "Fl\x81""chtlingskonvoi");
	} else if (!stricmp(name, "Food Convoy")) {
		strcpy(name, "Nachschubkonvoi");
	} else if (!stricmp(name, "Governor's Shuttle")) {
		strcpy(name, "F\x84hre des Gouverneurs");
	} else if (!stricmp(name, "GTVA Patrol")) {
		strcpy(name, "GTVA-Patrouille");
	} else if (!stricmp(name, "Escort fighters")) {
		strcpy(name, "Geleitschutz");
	} else if (!stricmp(name, "Nagada Outpost")) {
		strcpy(name, "Nagada-Aussenposten");
	} else if (!stricmp(name, "Fighters")) {
		strcpy(name, "J\x84ger");
	} else if (!stricmp(name, "Bombers")) {
		strcpy(name, "Bomber");
	} else if (!stricmp(name, "Enemy Destroyers")) {
		strcpy(name, "Feindliche Zerst\x94rer");
	} else if (!stricmp(name, "Ross 128 System")) {
		strcpy(name, "System Ross 128");
	} else if (!stricmp(name, "Knossos Station")) {
		strcpy(name, "Knossos-Station");
	} else if (!stricmp(name, "Transporters")) {
		strcpy(name, "Transporter");
	} else if (!stricmp(name, "Pirates?")) {
		strcpy(name, "Piraten?");
	} else if (!stricmp(name, "Escorts")) {
		strcpy(name, "Geleitschutz");
	} else if (!stricmp(name, "Shivan Fighters")) {
		strcpy(name, "J\x84ger");
	} else if (!stricmp(name, "Shivan Territory")) {
		strcpy(name, "Shivaner");
	}
}

// ------------------------------------------------------------------
// lcl_translate_brief_icon_name_pl()
//
// For displaying ship names in polish version
// since we can't actually just change them outright.
//
void lcl_translate_brief_icon_name_pl(char *name)
{
char *pos;
char buf[128];
  	 
	if (!stricmp(name, "Subspace Portal")) {
		strcpy(name, "Portal podprz.");

	} else if (!stricmp(name, "Alpha Wing")) {
		strcpy(name, "Alfa");

	} else if (!stricmp(name, "Beta Wing")) {
		strcpy(name, "Beta");

	} else if (!stricmp(name, "Zeta Wing")) {
		strcpy(name, "Zeta");

	} else if (!stricmp(name, "Capella Node")) {
		strcpy(name, "Capella");

	} else if (!stricmp(name, "Hostile")) {
		strcpy(name, "Wr\xF3g");

	} else if (!stricmp(name, "Hostile Craft")) {
		strcpy(name, "Wr\xF3g");

	} else if (!stricmp(name, "Rebel Wing")) {
		strcpy(name, "Rebelianci");

	} else if (!stricmp(name, "Rebel Fleet")) {
		strcpy(name, "Flota Rebelii");

	} else if (!stricmp(name, "Sentry Gun")) {
		strcpy(name, "Dzia\xB3o str.");

	} else if (!stricmp(name, "Cargo")) {
		strcpy(name, "\xA3\x61\x64unek");

	} else if (!stricmp(name, "Knossos Device")) {
		strcpy(name, "Urz. Knossos");

	} else if (!stricmp(name, "Support")) {
		strcpy(name, "Wsparcie");

	} else if (!stricmp(name, "Unknown")) {
		strcpy(name, "Nieznany");

	} else if (!stricmp(name, "Instructor")) {
		strcpy(name, "Instruktor");

	} else if (!stricmp(name, "Jump Node")) {
		strcpy(name, "W\xEAze\xB3 skokowy");

	} else if (!stricmp(name, "Escort")) {
		strcpy(name, "Eskorta");

	} else if (!stricmp(name, "Asteroid Field")) {
		strcpy(name, "Pole asteroid");

	} else if (!stricmp(name, "Enif Station")) {
		strcpy(name, "Stacja Enif");

	} else if (!stricmp(name, "Rally Point")) {
		strcpy(name, "Pkt zborny");

	} else if ((pos = strstr(name, "Transport")) != NULL) {
		pos += 9;		// strlen of "transport"
		strcpy_s(buf, "Transportowiec");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Jump Node")) != NULL) {
		pos += 9;		// strlen of "jump node"
		strcpy_s(buf, "W\xEAze\xB3 skokowy");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if (!stricmp(name, "Orion under repair")) {
		strcpy(name, "Naprawiany Orion");
	}
}

// ------------------------------------------------------------------
// lcl_translate_ship_name_gr()
//
// For displaying ship names in german version in the briefing
// since we can't actually just change them outright.
//
void lcl_translate_ship_name_gr(SCP_string &name)
{
	if (name == "GTDR Amazon Advanced") {
		name = "GTDR Amazon VII";
	} 
}

// ------------------------------------------------------------------
// lcl_translate_targetbox_name_gr()
//
// For displaying ship names in german version in the targetbox
// since we can't actually just change them outright.
//
void lcl_translate_targetbox_name_gr(char *name)
{
	char *pos;
	char buf[128];
	
	if ((pos = strstr(name, "Sentry")) != NULL) {
		pos += 6;		// strlen of "sentry"
		strcpy_s(buf, "Sperrgesch\x81tz");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Support")) != NULL) {
		pos += 7;		// strlen of "support"
		strcpy_s(buf, "Versorger");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Unknown")) != NULL) {
		pos += 7;		// strlen of "unknown"
		strcpy_s(buf, "Unbekannt");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Drone")) != NULL) {
		pos += 5;		// strlen of "drone"
		strcpy_s(buf, "Drohne");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Jump Node")) != NULL) {
		pos += 9;		// strlen of "jump node"
		strcpy_s(buf, "Sprungknoten");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if (!stricmp(name, "Instructor")) {
		strcpy(name, "Ausbilder");

	} else if (!stricmp(name, "NTF Vessel")) {
		strcpy(name, "NTF-Schiff");

	} else if (!stricmp(name, "Enif Station")) {
		strcpy(name, "Station Enif");
	}
}

// ------------------------------------------------------------------
// lcl_translate_targetbox_name_pl()
//
// For displaying ship names in polish version in the targetbox
// since we can't actually just change them outright.
//
void lcl_translate_targetbox_name_pl(char *name)
{
	char *pos;
	char buf[128];

	if ((pos = strstr(name, "Sentry")) != NULL) {
		pos += 6;		// strlen of "sentry"
		strcpy_s(buf, "Stra\xBFnik");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Support")) != NULL) {
		pos += 7;		// strlen of "support"
		strcpy_s(buf, "Wsparcie");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Unknown")) != NULL) {
		pos += 7;		// strlen of "unknown"
		strcpy_s(buf, "Nieznany");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Drone")) != NULL) {
		pos += 5;		// strlen of "drone"
		strcpy_s(buf, "Sonda");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if ((pos = strstr(name, "Jump Node")) != NULL) {
		pos += 9;		// strlen of "jump node"
		strcpy_s(buf, "W\xEAze\xB3 skokowy");
		strcat_s(buf, pos);
		strcpy(name, buf);

	} else if (!stricmp(name, "Instructor")) {
		strcpy(name, "Instruktor");

	} else if (!stricmp(name, "NTF Vessel")) {
		strcpy(name, "Okr\xEAt NTF");

	} else if (!stricmp(name, "Enif Station")) {
		strcpy(name, "Stacja Enif");
	}
}

// this is just a hack to display translated names without actually changing the names, 
// which would break stuff
// (this used to be in medals.cpp)
void lcl_translate_medal_name_gr(char *name)
{
	if (!strcmp(name, "Epsilon Pegasi Liberation")) {
		strcpy(name, "Epsilon Pegasi Befreiungsmedaille");

	} else if (!strcmp(name, "Imperial Order of Vasuda")) {
		strcpy(name, "Imperialer Orden von Vasuda ");

	} else if (!strcmp(name, "Distinguished Flying Cross")) {
		strcpy(name, "Fliegerkreuz Erster Klasse");

	} else if (!strcmp(name, "SOC Service Medallion")) {
		strcpy(name, "SEK-Dienstmedaille ");

	} else if (!strcmp(name, "Intelligence Cross")) {
		strcpy(name, "Geheimdienstkreuz am Bande");

	} else if (!strcmp(name, "Order of Galatea")) {
		strcpy(name, "Orden von Galatea ");

	} else if (!strcmp(name, "Meritorious Unit Commendation")) {
		strcpy(name, "Ehrenspange der Allianz");

	} else if (!strcmp(name, "Medal of Valor")) {
		strcpy(name, "Tapferkeitsmedaille ");

	} else if (!strcmp(name, "GTVA Legion of Honor")) {
		strcpy(name, "Orden der GTVA-Ehrenlegion");

	} else if (!strcmp(name, "Allied Defense Citation")) {
		strcpy(name, "Alliierte Abwehrspange ");

	} else if (!strcmp(name, "Nebula Campaign Victory Star")) {
		strcpy(name, "Nebel-Siegesstern");

	} else if (!strcmp(name, "NTF Campaign Victory Star")) {
		strcpy(name, "NTF-Siegesstern ");

	} else if (!strcmp(name, "Rank")) {
		strcpy(name, "Dienstgrad");

	} else if (!strcmp(name, "Wings")) {
		strcpy(name, "Fliegerspange");

	} else if (!strcmp(name, "Ace")) {
		strcpy(name, "Flieger-As");

	} else if (!strcmp(name, "Double Ace")) {
		strcpy(name, "Doppel-As ");

	} else if (!strcmp(name, "Triple Ace")) {
		strcpy(name, "Dreifach-As ");
		
	} else if (!strcmp(name, "SOC Unit Crest")) {
		strcpy(name, "SEK-Abzeichen ");
	}
}

// this is just a hack to display translated names without actually changing the names, 
// which would break stuff
// (this used to be in medals.cpp)
void lcl_translate_medal_name_pl(char *name)
{
	if (!strcmp(name, "Epsilon Pegasi Liberation")) {
		strcpy(name, "Order Wyzwolenia Epsilon Pegasi");

	} else if (!strcmp(name, "Imperial Order of Vasuda")) {
		strcpy(name, "Imperialny Order Vasudy");

	} else if (!strcmp(name, "Distinguished Flying Cross")) {
		strcpy(name, "Krzy\xBF Wybitnego Pilota");

	} else if (!strcmp(name, "SOC Service Medallion")) {
		strcpy(name, "Krzy\xBF S\xB3u\xBF\x62 Specjalnych");

	} else if (!strcmp(name, "Intelligence Cross")) {
		strcpy(name, "Krzy\xBF Wywiadu");

	} else if (!strcmp(name, "Order of Galatea")) {
		strcpy(name, "Order Galatei");

	} else if (!strcmp(name, "Meritorious Unit Commendation")) {
		strcpy(name, "Medal Pochwalny");

	} else if (!strcmp(name, "Medal of Valor")) {
		strcpy(name, "Medal za Odwag\xEA");

	} else if (!strcmp(name, "GTVA Legion of Honor")) {
		strcpy(name, "Legia Honorowa GTVA");

	} else if (!strcmp(name, "Allied Defense Citation")) {
		strcpy(name, "Order za Obron\xEA Sojuszu");

	} else if (!strcmp(name, "Nebula Campaign Victory Star")) {
		strcpy(name, "Gwiazda Wiktorii Kampanii w Mg\xB3\x61wicy");

	} else if (!strcmp(name, "NTF Campaign Victory Star")) {
		strcpy(name, "Gwiazda Wiktorii Kampanii NTF");

	} else if (!strcmp(name, "Rank")) {
		strcpy(name, "Ranga");

	} else if (!strcmp(name, "Wings")) {
		strcpy(name, "Skrzyd\xB3\x61");

	} else if (!strcmp(name, "Ace")) {
		strcpy(name, "As");	

	} else if (!strcmp(name, "Double Ace")) {
		strcpy(name, "Podw\xF3jny As");

	} else if (!strcmp(name, "Triple Ace")) {
		strcpy(name, "Potr\xF3jny As");
		
	} else if (!strcmp(name, "SOC Unit Crest")) {
		strcpy(name, "Tarcza S\xB3u\xBF\x62 Specjalnych");	
	}
}