godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/core/string/translation.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

193 lines
8.4 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* translation.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifndef TRANSLATION_H
#define TRANSLATION_H
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/io/resource.h"
Implement override of get_message and get_plural_message
2021-09-29 11:18:45 +00:00
#include "core/object/gdvirtual.gen.inc"
#include "core/object/script_language.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class Translation : public Resource {
ObjectTypeDB was renamed to ClassDB. Types are meant to be more generic to Variant. All usages of "type" to refer to classes were renamed to "class" ClassDB has been exposed to GDScript. OBJ_TYPE() macro is now GDCLASS()
2017-01-03 02:03:46 +00:00
GDCLASS(Translation, Resource);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
OBJ_SAVE_TYPE(Translation);
Rename Godot-specific resource extensions
2017-06-15 22:44:11 +00:00
RES_BASE_EXTENSION("translation");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
String locale = "en";
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, StringName> translation_map;
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
virtual Vector<String> _get_message_list() const;
virtual Dictionary _get_messages() const;
virtual void _set_messages(const Dictionary &p_messages);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
Support loading of translations on threads
2023-06-27 12:21:31 +00:00
void _notify_translation_changed_if_applies();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
protected:
static void _bind_methods();
Implement override of get_message and get_plural_message
2021-09-29 11:18:45 +00:00
GDVIRTUAL2RC(StringName, _get_message, StringName, StringName);
GDVIRTUAL4RC(StringName, _get_plural_message, StringName, StringName, int, StringName);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
void set_locale(const String &p_locale);
_FORCE_INLINE_ String get_locale() const { return locale; }
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
virtual void add_message(const StringName &p_src_text, const StringName &p_xlated_text, const StringName &p_context = "");
virtual void add_plural_message(const StringName &p_src_text, const Vector<String> &p_plural_xlated_texts, const StringName &p_context = "");
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
virtual StringName get_message(const StringName &p_src_text, const StringName &p_context = "") const; //overridable for other implementations
virtual StringName get_plural_message(const StringName &p_src_text, const StringName &p_plural_text, int p_n, const StringName &p_context = "") const;
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
virtual void erase_message(const StringName &p_src_text, const StringName &p_context = "");
virtual void get_message_list(List<StringName> *r_messages) const;
virtual int get_message_count() const;
[Font] Add an import option to pre-render all glyphs required for the translation.
2022-11-09 12:45:21 +00:00
virtual Vector<String> get_translated_message_list() const;
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
Translation() {}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
class TranslationServer : public Object {
ObjectTypeDB was renamed to ClassDB. Types are meant to be more generic to Variant. All usages of "type" to refer to classes were renamed to "class" ClassDB has been exposed to GDScript. OBJ_TYPE() macro is now GDCLASS()
2017-01-03 02:03:46 +00:00
GDCLASS(TranslationServer, Object);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
String locale = "en";
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String fallback;
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
HashSet<Ref<Translation>> translations;
Modified editor strings to be translatable in the future
2016-05-04 01:25:37 +00:00
Ref<Translation> tool_translation;
i18n: Add support for translating the class reference - Parse `.po` files from `doc/translations/*.po` like already done with `editor/translations/*.po`. - Add logic to register a doc translation mapping in `TranslationServer` and `EditorSettings`. - Add `DTR()` to lookup the doc translation mapping (similar to `TTR()`). Strings are automatically dedented and stripped of whitespace to ensure that they would match the translation catalog. - Use `DTR()` to translate relevant strings in `EditorHelp`, `EditorInspector`, `CreateDialog`, `ConnectionsDialog`. - Small simplification to `TranslationLoaderPO`, the path argument was not really meaningful.
2020-03-18 17:34:36 +00:00
Ref<Translation> doc_translation;
Prepare for moving editor and classref translations to godot-editor-l10n repo - Separate editor interface and property translations. - Add property translation in TranslationServer. - The split and merge of the POT/PO/Makefiles and extract scripts is done directly in godot-editor-l10n, the files will be removed in the next commit. - Remove the hardcoded "to_include" lists from the SCsub, we'll only commit the files which are ready to inclue.
2022-12-27 02:58:01 +00:00
Ref<Translation> property_translation;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
bool enabled = true;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
bool pseudolocalization_enabled = false;
bool pseudolocalization_accents_enabled = false;
bool pseudolocalization_double_vowels_enabled = false;
bool pseudolocalization_fake_bidi_enabled = false;
bool pseudolocalization_override_enabled = false;
bool pseudolocalization_skip_placeholders_enabled = false;
bool editor_pseudolocalization = false;
float expansion_ratio = 0.0;
String pseudolocalization_prefix;
String pseudolocalization_suffix;
StringName tool_pseudolocalize(const StringName &p_message) const;
String get_override_string(String &p_message) const;
String double_vowels(String &p_message) const;
String replace_with_accented_string(String &p_message) const;
String wrap_with_fakebidi_characters(String &p_message) const;
Fix some issues found by cppcheck.
2022-04-05 10:40:26 +00:00
String add_padding(const String &p_message, int p_length) const;
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
const char32_t *get_accented_version(char32_t p_character) const;
bool is_placeholder(String &p_message, int p_index) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static TranslationServer *singleton;
bool _load_translations(const String &p_from);
Do not auto add default script and country codes to the locale.
2022-10-27 06:19:01 +00:00
String _standardize_locale(const String &p_locale, bool p_add_defaults) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
StringName _get_message_from_translations(const StringName &p_message, const StringName &p_context, const String &p_locale, bool plural, const String &p_message_plural = "", int p_n = 0) const;
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static void _bind_methods();
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
struct LocaleScriptInfo {
String name;
String script;
String default_country;
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
HashSet<String> supported_countries;
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
};
static Vector<LocaleScriptInfo> locale_script_info;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
static HashMap<String, String> language_map;
static HashMap<String, String> script_map;
static HashMap<String, String> locale_rename_map;
static HashMap<String, String> country_name_map;
static HashMap<String, String> country_rename_map;
static HashMap<String, String> variant_map;
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
void init_locale_info();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
public:
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
_FORCE_INLINE_ static TranslationServer *get_singleton() { return singleton; }
void set_enabled(bool p_enabled) { enabled = p_enabled; }
_FORCE_INLINE_ bool is_enabled() const { return enabled; }
void set_locale(const String &p_locale);
String get_locale() const;
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
Ref<Translation> get_translation_object(const String &p_locale);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
Vector<String> get_all_languages() const;
String get_language_name(const String &p_language) const;
Vector<String> get_all_scripts() const;
String get_script_name(const String &p_script) const;
Vector<String> get_all_countries() const;
String get_country_name(const String &p_country) const;
Add a function to get the full name of a locale
2017-10-25 05:29:20 +00:00
String get_locale_name(const String &p_locale) const;
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
PackedStringArray get_loaded_locales() const;
Added TranslationServer::get_loaded_locales to return an array of all locales with a loaded Translation
2019-04-25 01:39:29 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void add_translation(const Ref<Translation> &p_translation);
void remove_translation(const Ref<Translation> &p_translation);
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
StringName translate(const StringName &p_message, const StringName &p_context = "") const;
StringName translate_plural(const StringName &p_message, const StringName &p_message_plural, int p_n, const StringName &p_context = "") const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
StringName pseudolocalize(const StringName &p_message) const;
bool is_pseudolocalization_enabled() const;
void set_pseudolocalization_enabled(bool p_enabled);
void set_editor_pseudolocalization(bool p_enabled);
void reload_pseudolocalization();
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
String standardize_locale(const String &p_locale) const;
int compare_locales(const String &p_locale_a, const String &p_locale_b) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
String get_tool_locale();
Modified editor strings to be translatable in the future
2016-05-04 01:25:37 +00:00
void set_tool_translation(const Ref<Translation> &p_translation);
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
Ref<Translation> get_tool_translation() const;
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
StringName tool_translate(const StringName &p_message, const StringName &p_context = "") const;
StringName tool_translate_plural(const StringName &p_message, const StringName &p_message_plural, int p_n, const StringName &p_context = "") const;
i18n: Add support for translating the class reference - Parse `.po` files from `doc/translations/*.po` like already done with `editor/translations/*.po`. - Add logic to register a doc translation mapping in `TranslationServer` and `EditorSettings`. - Add `DTR()` to lookup the doc translation mapping (similar to `TTR()`). Strings are automatically dedented and stripped of whitespace to ensure that they would match the translation catalog. - Use `DTR()` to translate relevant strings in `EditorHelp`, `EditorInspector`, `CreateDialog`, `ConnectionsDialog`. - Small simplification to `TranslationLoaderPO`, the path argument was not really meaningful.
2020-03-18 17:34:36 +00:00
void set_doc_translation(const Ref<Translation> &p_translation);
Added plurals and context support to Translation
2020-07-16 08:52:06 +00:00
StringName doc_translate(const StringName &p_message, const StringName &p_context = "") const;
StringName doc_translate_plural(const StringName &p_message, const StringName &p_message_plural, int p_n, const StringName &p_context = "") const;
Prepare for moving editor and classref translations to godot-editor-l10n repo - Separate editor interface and property translations. - Add property translation in TranslationServer. - The split and merge of the POT/PO/Makefiles and extract scripts is done directly in godot-editor-l10n, the files will be removed in the next commit. - Remove the hardcoded "to_include" lists from the SCsub, we'll only commit the files which are ready to inclue.
2022-12-27 02:58:01 +00:00
void set_property_translation(const Ref<Translation> &p_translation);
StringName property_translate(const StringName &p_message) const;
Modified editor strings to be translatable in the future
2016-05-04 01:25:37 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void setup();
Small Issues & Maintenance -=-=-=-=-=-=-=-=-=-=-=-=-= -Begin work on Navigation Meshes (simple pathfinding for now, will improve soon) -More doc on theme overriding -Upgraded OpenSSL to version without bugs -Misc bugfixes
2014-08-02 01:10:38 +00:00
void clear();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void load_translations();
TranslationServer();
};
#endif // TRANSLATION_H