Blender V5.3
blt_translation.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
11
12#include <cstdlib>
13#include <cstring>
14#include <optional>
15
16#include "BLT_translation.hh"
17
18#include "DNA_userdef_types.h" /* For user settings. */
19
20#ifdef WITH_PYTHON
21# include "BPY_extern.hh"
22#endif
23
24#ifdef WITH_INTERNATIONAL
25# include "BLI_threads.hh"
26# include "messages.hh"
27#endif /* WITH_INTERNATIONAL */
28
29namespace blender {
30
32{
33 /* We use the "short" test, a more complete one could be:
34 * return (!msgctxt || !msgctxt[0] || STREQ(msgctxt, BLT_I18NCONTEXT_DEFAULT_BPYRNA))
35 */
36 /* NOTE: trying without the void string check for now, it *should* not be necessary... */
37 return (msgctxt.is_empty() || msgctxt[0] == BLT_I18NCONTEXT_DEFAULT_BPYRNA[0]);
38}
39
40static std::optional<StringRefNull> pgettext(StringRef msgctxt, const StringRef msgid)
41{
42#ifdef WITH_INTERNATIONAL
43 if (msgid.is_empty()) {
44 return std::nullopt;
45 }
46 if (BLT_is_default_context(msgctxt)) {
48 }
49 if (const std::optional<StringRefNull> translation = locale::translate(0, msgctxt, msgid)) {
50 return translation;
51 }
52# ifdef WITH_PYTHON
53 return BPY_app_translations_py_pgettext(msgctxt, msgid);
54# else
55 return std::nullopt;
56# endif
57#else
58 UNUSED_VARS(msgctxt, msgid);
59 return std::nullopt;
60#endif
61}
62
63const char *BLT_pgettext(const char *msgctxt, const char *msgid)
64{
65 const std::optional<StringRefNull> translation = pgettext(msgctxt, msgid);
66 if (!translation) {
67 return msgid;
68 }
69 return translation->c_str();
70}
71
73{
74 const std::optional<StringRefNull> translation = pgettext(msgctxt, msgid);
75 if (!translation) {
76 return msgid;
77 }
78 return *translation;
79}
80
82{
83#ifdef WITH_INTERNATIONAL
84 return BLI_thread_is_main();
85#else
86 return false;
87#endif
88}
89
91{
92#ifdef WITH_INTERNATIONAL
93 return BLT_translate() && (U.transopts & USER_TR_IFACE);
94#else
95 return false;
96#endif
97}
98
100{
101#ifdef WITH_INTERNATIONAL
102 return BLT_translate() && (U.transopts & USER_TR_TOOLTIPS);
103#else
104 return false;
105#endif
106}
107
109{
110#ifdef WITH_INTERNATIONAL
111 return BLT_translate() && (U.transopts & USER_TR_REPORTS);
112#else
113 return false;
114#endif
115}
116
118{
119#ifdef WITH_INTERNATIONAL
120 return BLT_translate() && (U.transopts & USER_TR_NEWDATANAME);
121#else
122 return false;
123#endif
124}
125
126template<typename StringT> StringT translate_do(StringT msgctxt, StringT msgid)
127{
128#ifdef WITH_INTERNATIONAL
129 if (BLT_translate()) {
130 return BLT_pgettext(msgctxt, msgid);
131 }
132
133 return msgid;
134
135#else
136 (void)msgctxt;
137 return msgid;
138#endif
139}
140
141const char *BLT_translate_do(const char *msgctxt, const char *msgid)
142{
143 return translate_do(msgctxt, msgid);
144}
145
147{
148 return translate_do(msgctxt, msgid);
149}
150
151template<typename StringT> StringT translate_do_iface(StringT msgctxt, StringT msgid)
152{
153#ifdef WITH_INTERNATIONAL
154 if (BLT_translate_iface()) {
155 return BLT_pgettext(msgctxt, msgid);
156 }
157
158 return msgid;
159
160#else
161 (void)msgctxt;
162 return msgid;
163#endif
164}
165
166const char *BLT_translate_do_iface(const char *msgctxt, const char *msgid)
167{
168 return translate_do_iface(msgctxt, msgid);
169}
170
172{
173 return translate_do_iface(msgctxt, msgid);
174}
175
176template<typename StringT> StringT translate_do_tooltip(StringT msgctxt, StringT msgid)
177{
178#ifdef WITH_INTERNATIONAL
180 return BLT_pgettext(msgctxt, msgid);
181 }
182
183 return msgid;
184
185#else
186 (void)msgctxt;
187 return msgid;
188#endif
189}
190
191const char *BLT_translate_do_tooltip(const char *msgctxt, const char *msgid)
192{
193 return translate_do_tooltip(msgctxt, msgid);
194}
195
197{
198 return translate_do_tooltip(msgctxt, msgid);
199}
200
201template<typename StringT> StringT translate_do_report(StringT msgctxt, StringT msgid)
202{
203#ifdef WITH_INTERNATIONAL
204 if (BLT_translate_reports()) {
205 return BLT_pgettext(msgctxt, msgid);
206 }
207
208 return msgid;
209
210#else
211 (void)msgctxt;
212 return msgid;
213#endif
214}
215
216const char *BLT_translate_do_report(const char *msgctxt, const char *msgid)
217{
218 return translate_do_report(msgctxt, msgid);
219}
220
222{
223 return translate_do_report(msgctxt, msgid);
224}
225
226template<typename StringT> StringT translate_do_new_dataname(StringT msgctxt, StringT msgid)
227{
228#ifdef WITH_INTERNATIONAL
230 return BLT_pgettext(msgctxt, msgid);
231 }
232
233 return msgid;
234
235#else
236 (void)msgctxt;
237 return msgid;
238#endif
239}
240
241const char *BLT_translate_do_new_dataname(const char *msgctxt, const char *msgid)
242{
243 return translate_do_new_dataname(msgctxt, msgid);
244}
245
247{
248 return translate_do_new_dataname(msgctxt, msgid);
249}
250
251} // namespace blender
#define BLT_I18NCONTEXT_DEFAULT
#define BLT_I18NCONTEXT_DEFAULT_BPYRNA
#define UNUSED_VARS(...)
constexpr bool is_empty() const
std::optional< StringRefNull > translate(const int domain, const StringRef context, const StringRef key)
Definition messages.cc:627
BMesh Iterators.
UserDef U
Definition blender.cc:58
StringT translate_do_report(StringT msgctxt, StringT msgid)
StringT translate_do_tooltip(StringT msgctxt, StringT msgid)
bool BLT_translate_tooltips()
StringT translate_do_iface(StringT msgctxt, StringT msgid)
StringT translate_do_new_dataname(StringT msgctxt, StringT msgid)
bool BLT_is_default_context(StringRef msgctxt)
bool BLT_translate_new_dataname()
const char * BLT_pgettext(const char *msgctxt, const char *msgid)
const char * BLT_translate_do(const char *msgctxt, const char *msgid)
const char * BLT_translate_do_report(const char *msgctxt, const char *msgid)
int BLI_thread_is_main()
Definition threads.cc:184
StringT translate_do(StringT msgctxt, StringT msgid)
bool BLT_translate()
const char * BLT_translate_do_iface(const char *msgctxt, const char *msgid)
bool BLT_translate_reports()
static std::optional< StringRefNull > pgettext(StringRef msgctxt, const StringRef msgid)
bool BLT_translate_iface()
const char * BLT_translate_do_new_dataname(const char *msgctxt, const char *msgid)
const char * BLT_translate_do_tooltip(const char *msgctxt, const char *msgid)