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
145
146
147
148
149
150
151
152
|
#include "LoadLocalisation.hpp"
#include <godot_cpp/classes/dir_access.hpp>
#include <godot_cpp/classes/file_access.hpp>
#include <godot_cpp/classes/translation_server.hpp>
#include <godot_cpp/variant/utility_functions.hpp>
#include "openvic-extension/utility/Utilities.hpp"
using namespace godot;
using namespace OpenVic;
void LoadLocalisation::_bind_methods() {
ClassDB::bind_method(D_METHOD("load_file", "file_path", "locale"), &LoadLocalisation::load_file);
ClassDB::bind_method(D_METHOD("load_locale_dir", "dir_path", "locale"), &LoadLocalisation::load_locale_dir);
ClassDB::bind_method(D_METHOD("load_localisation_dir", "dir_path"), &LoadLocalisation::load_localisation_dir);
}
LoadLocalisation* LoadLocalisation::get_singleton() {
return _singleton;
}
LoadLocalisation::LoadLocalisation() {
ERR_FAIL_COND(_singleton != nullptr);
_singleton = this;
}
LoadLocalisation::~LoadLocalisation() {
ERR_FAIL_COND(_singleton != this);
_singleton = nullptr;
}
Error LoadLocalisation::_load_file(String const& file_path, Ref<Translation> const& translation) const {
const Ref<FileAccess> file = FileAccess::open(file_path, FileAccess::ModeFlags::READ);
Error err = FileAccess::get_open_error();
ERR_FAIL_COND_V_MSG(
err != OK || file.is_null(), err == OK ? FAILED : err, vformat("Failed to open localisation file: %s", file_path)
);
int line_number = 0;
while (!file->eof_reached()) {
static const String delimeter = ";";
const PackedStringArray line = file->get_csv_line(delimeter);
line_number++;
if (line.size() < 2 || line[0].is_empty() || line[1].is_empty()) {
if (!line[0].is_empty()) {
UtilityFunctions::push_warning(
"Key \"", line[0], "\" missing value on line ", line_number, " in file: ", file_path
);
err = FAILED;
} else if (line.size() >= 2 && !line[1].is_empty()) {
UtilityFunctions::push_warning(
"Value \"", line[1], "\" missing key on line ", line_number, " in file: ", file_path
);
err = FAILED;
}
continue;
}
translation->add_message(line[0], line[1].c_unescape());
}
return err;
}
Ref<Translation> LoadLocalisation::_get_translation(String const& locale) const {
TranslationServer* server = TranslationServer::get_singleton();
ERR_FAIL_NULL_V(server, nullptr);
Ref<Translation> translation = server->get_translation_object(locale);
if (translation.is_null() || translation->get_locale() != locale) {
translation.instantiate();
translation->set_locale(locale);
server->add_translation(translation);
}
return translation;
}
Error LoadLocalisation::load_file(String const& file_path, String const& locale) const {
return _load_file(file_path, _get_translation(locale));
}
/* REQUIREMENTS
* FS-18, FS-24, FS-25
*/
Error LoadLocalisation::load_locale_dir(String const& dir_path, String const& locale) const {
ERR_FAIL_COND_V_MSG(
!DirAccess::dir_exists_absolute(dir_path), FAILED, vformat("Locale directory does not exist: %s", dir_path)
);
/* This will add the locale to the list of loaded locales even if it has no
* localisation files - this is useful for testing other aspects of localisation
* such as number formatting and text direction. To disable this behaviour and
* only show non-empty localisations, move the `_get_translation` call to after
* the `files.size()` check.
*/
const Ref<Translation> translation = _get_translation(locale);
const PackedStringArray files = DirAccess::get_files_at(dir_path);
ERR_FAIL_COND_V_MSG(files.size() < 1, FAILED, vformat("Locale directory does not contain any files: %s", dir_path));
Error err = OK;
for (String const& file_name : files) {
if (file_name.get_extension().to_lower() == "csv") {
if (_load_file(dir_path.path_join(file_name), translation) != OK) {
err = FAILED;
}
}
}
return err;
}
/* REQUIREMENTS
* FS-23
*/
Error LoadLocalisation::load_localisation_dir(String const& dir_path) const {
ERR_FAIL_COND_V_MSG(
!DirAccess::dir_exists_absolute(dir_path), FAILED, vformat("Localisation directory does not exist: %s", dir_path)
);
const PackedStringArray dirs = DirAccess::get_directories_at(dir_path);
ERR_FAIL_COND_V_MSG(
dirs.size() < 1, FAILED, vformat("Localisation directory does not contain any sub-directories: %s", dir_path)
);
TranslationServer* server = TranslationServer::get_singleton();
ERR_FAIL_NULL_V(server, FAILED);
Error err = OK;
for (String const& locale_name : dirs) {
if (locale_name != server->standardize_locale(locale_name)) {
UtilityFunctions::push_error("Invalid locale directory name: ", locale_name);
} else if (load_locale_dir(dir_path.path_join(locale_name), locale_name) == OK) {
continue;
}
err = FAILED;
}
return err;
}
bool LoadLocalisation::add_message(std::string_view key, Dataloader::locale_t locale, std::string_view localisation) {
Ref<Translation>& translation = translations[locale];
if (translation.is_null()) {
translation = _singleton->_get_translation(Dataloader::locale_names[locale]);
ERR_FAIL_NULL_V_MSG(
translation, false, vformat("Failed to get translation object: %s", Dataloader::locale_names[locale])
);
}
const StringName godot_key = Utilities::std_view_to_godot_string_name(key);
const StringName godot_localisation = Utilities::std_view_to_godot_string_name(localisation);
if (0) {
const StringName old_localisation = translation->get_message(godot_key);
if (!old_localisation.is_empty()) {
UtilityFunctions::push_warning(
"Changing translation ", godot_key, " (", Dataloader::locale_names[locale], ") from \"",
old_localisation, "\" to \"", godot_localisation, "\""
);
}
}
translation->add_message(godot_key, godot_localisation);
return true;
}
|
zaaarf