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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Contributor(s): Bastien Montagne
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file blender/python/intern/bpy_app_translations.c
* \ingroup pythonintern
*
* This file defines a singleton py object accessed via 'bpy.app.translations',
* which exposes various data and functions useful in i18n work.
* Most notably, it allows to extend main translations with py dicts.
*/
#include <Python.h>
/* XXX Why bloody hell isn't that included in Python.h???? */
#include <structmember.h>
#include "BLI_utildefines.h"
#include "BLI_string.h"
#include "BLI_ghash.h"
#include "BPY_extern.h"
#include "bpy_app_translations.h"
#include "MEM_guardedalloc.h"
#include "BLF_translation.h"
#include "RNA_types.h"
#include "RNA_access.h"
typedef struct
{
PyObject_HEAD
/* The string used to separate context from actual message in PY_TRANSLATE RNA props. */
const char *context_separator;
/* A "named tuple" (StructSequence actually...) containing all C-defined contexts. */
PyObject *contexts;
/* A readonly mapping {C context id: python id} (actually, a MappingProxy). */
PyObject *contexts_C_to_py;
/* A py dict containing all registered py dicts (order is more or less random, first match wins!). */
PyObject *py_messages;
} BlenderAppTranslations;
/* Our singleton instance pointer */
static BlenderAppTranslations *_translations = NULL;
#ifdef WITH_INTERNATIONAL
/***** Helpers for ghash *****/
typedef struct GHashKey {
const char *msgctxt;
const char *msgid;
} GHashKey;
static GHashKey *_ghashutil_keyalloc(const void *msgctxt, const void *msgid)
{
GHashKey *key = MEM_mallocN(sizeof(GHashKey), "Py i18n GHashKey");
key->msgctxt = BLI_strdup(BLF_is_default_context(msgctxt) ? BLF_I18NCONTEXT_DEFAULT_BPYRNA : msgctxt);
key->msgid = BLI_strdup(msgid);
return key;
}
static unsigned int _ghashutil_keyhash(const void *ptr)
{
const GHashKey *key = ptr;
unsigned int hash = BLI_ghashutil_strhash(key->msgctxt);
return hash ^ BLI_ghashutil_strhash(key->msgid);
}
static bool _ghashutil_keycmp(const void *a, const void *b)
{
const GHashKey *A = a;
const GHashKey *B = b;
/* Note: comparing msgid first, most of the time it will be enough! */
int cmp = BLI_ghashutil_strcmp(A->msgid, B->msgid);
if (cmp == 0)
return BLI_ghashutil_strcmp(A->msgctxt, B->msgctxt) == 0;
return false;
}
static void _ghashutil_keyfree(void *ptr)
{
const GHashKey *key = ptr;
/* We assume both msgctxt and msgid were BLI_strdup'ed! */
MEM_freeN((void *)key->msgctxt);
MEM_freeN((void *)key->msgid);
MEM_freeN((void *)key);
}
#define _ghashutil_valfree MEM_freeN
/***** Python's messages cache *****/
/* We cache all messages available for a given locale from all py dicts into a single ghash.
* Changing of locale is not so common, while looking for a message translation is, so let's try to optimize
* the later as much as we can!
* Note changing of locale, as well as (un)registering a message dict, invalidate that cache.
*/
static GHash *_translations_cache = NULL;
static void _clear_translations_cache(void)
{
if (_translations_cache) {
BLI_ghash_free(_translations_cache, _ghashutil_keyfree, _ghashutil_valfree);
}
_translations_cache = NULL;
}
static void _build_translations_cache(PyObject *py_messages, const char *locale)
{
PyObject *uuid, *uuid_dict;
Py_ssize_t pos = 0;
char *language = NULL, *language_country = NULL, *language_variant = NULL;
/* For each py dict, we'll search for full locale, then language+country, then language+variant,
* then only language keys... */
BLF_locale_explode(locale, &language, NULL, NULL, &language_country, &language_variant);
/* Clear the cached ghash if needed, and create a new one. */
_clear_translations_cache();
_translations_cache = BLI_ghash_new(_ghashutil_keyhash, _ghashutil_keycmp, __func__);
/* Iterate over all py dicts. */
while (PyDict_Next(py_messages, &pos, &uuid, &uuid_dict)) {
PyObject *lang_dict;
#if 0
PyObject_Print(uuid_dict, stdout, 0);
printf("\n");
#endif
/* Try to get first complete locale, then language+country, then language+variant, then only language */
lang_dict = PyDict_GetItemString(uuid_dict, locale);
if (!lang_dict && language_country) {
lang_dict = PyDict_GetItemString(uuid_dict, language_country);
locale = language_country;
}
if (!lang_dict && language_variant) {
lang_dict = PyDict_GetItemString(uuid_dict, language_variant);
locale = language_variant;
}
if (!lang_dict && language) {
lang_dict = PyDict_GetItemString(uuid_dict, language);
locale = language;
}
if (lang_dict) {
PyObject *pykey, *trans;
Py_ssize_t ppos = 0;
if (!PyDict_Check(lang_dict)) {
printf("WARNING! In translations' dict of \"");
PyObject_Print(uuid, stdout, Py_PRINT_RAW);
printf("\":\n");
printf(" Each language key must have a dictionary as value, \"%s\" is not valid, skipping: ",
locale);
PyObject_Print(lang_dict, stdout, Py_PRINT_RAW);
printf("\n");
continue;
}
/* Iterate over all translations of the found language dict, and populate our ghash cache. */
while (PyDict_Next(lang_dict, &ppos, &pykey, &trans)) {
GHashKey *key;
const char *msgctxt = NULL, *msgid = NULL;
bool invalid_key = false;
if ((PyTuple_CheckExact(pykey) == false) || (PyTuple_GET_SIZE(pykey) != 2)) {
invalid_key = true;
}
else {
PyObject *tmp = PyTuple_GET_ITEM(pykey, 0);
if (tmp == Py_None) {
msgctxt = BLF_I18NCONTEXT_DEFAULT_BPYRNA;
}
else if (PyUnicode_Check(tmp)) {
msgctxt = _PyUnicode_AsString(tmp);
}
else {
invalid_key = true;
}
tmp = PyTuple_GET_ITEM(pykey, 1);
if (PyUnicode_Check(tmp)) {
msgid = _PyUnicode_AsString(tmp);
}
else {
invalid_key = true;
}
}
if (invalid_key) {
printf("WARNING! In translations' dict of \"");
PyObject_Print(uuid, stdout, Py_PRINT_RAW);
printf("\", %s language:\n", locale);
printf(" Keys must be tuples of (msgctxt [string or None], msgid [string]), "
"this one is not valid, skipping: ");
PyObject_Print(pykey, stdout, Py_PRINT_RAW);
printf("\n");
continue;
}
if (PyUnicode_Check(trans) == false) {
printf("WARNING! In translations' dict of \"");
PyObject_Print(uuid, stdout, Py_PRINT_RAW);
printf("\":\n");
printf(" Values must be strings, this one is not valid, skipping: ");
PyObject_Print(trans, stdout, Py_PRINT_RAW);
printf("\n");
continue;
}
key = _ghashutil_keyalloc(msgctxt, msgid);
/* Do not overwrite existing keys! */
if (BLI_ghash_lookup(_translations_cache, (void *)key)) {
continue;
}
BLI_ghash_insert(_translations_cache, key, BLI_strdup(_PyUnicode_AsString(trans)));
}
}
}
/* Clean up! */
if (language)
MEM_freeN(language);
if (language_country)
MEM_freeN(language_country);
if (language_variant)
MEM_freeN(language_variant);
}
const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *msgid)
{
#define STATIC_LOCALE_SIZE 32 /* Should be more than enough! */
GHashKey *key;
static char locale[STATIC_LOCALE_SIZE] = "";
const char *tmp;
/* Just in case, should never happen! */
if (!_translations)
return msgid;
tmp = BLF_lang_get();
if (strcmp(tmp, locale) || !_translations_cache) {
PyGILState_STATE _py_state;
BLI_strncpy(locale, tmp, STATIC_LOCALE_SIZE);
/* Locale changed or cache does not exist, refresh the whole cache! */
/* This func may be called from C (i.e. outside of python interpreter 'context'). */
_py_state = PyGILState_Ensure();
_build_translations_cache(_translations->py_messages, locale);
PyGILState_Release(_py_state);
}
/* And now, simply create the key (context, messageid) and find it in the cached dict! */
key = _ghashutil_keyalloc(msgctxt, msgid);
tmp = BLI_ghash_lookup(_translations_cache, key);
_ghashutil_keyfree((void *)key);
return tmp ? tmp : msgid;
#undef STATIC_LOCALE_SIZE
}
#endif /* WITH_INTERNATIONAL */
PyDoc_STRVAR(app_translations_py_messages_register_doc,
".. method:: register(module_name, translations_dict)\n"
"\n"
" Registers an addon's UI translations.\n"
"\n"
" .. note::\n"
" Does nothing when Blender is built without internationalization support.\n"
"\n"
" :arg module_name: The name identifying the addon.\n"
" :type module_name: string\n"
" :arg translations_dict: A dictionary built like that:\n"
" ``{locale: {msg_key: msg_translation, ...}, ...}``\n"
" :type translations_dict: dict\n"
"\n"
);
static PyObject *app_translations_py_messages_register(BlenderAppTranslations *self, PyObject *args, PyObject *kw)
{
#ifdef WITH_INTERNATIONAL
static const char *kwlist[] = {"module_name", "translations_dict", NULL};
PyObject *module_name, *uuid_dict;
if (!PyArg_ParseTupleAndKeywords(args, kw, "O!O!:bpy.app.translations.register", (char **)kwlist, &PyUnicode_Type,
&module_name, &PyDict_Type, &uuid_dict))
{
return NULL;
}
if (PyDict_Contains(self->py_messages, module_name)) {
PyErr_Format(PyExc_ValueError,
"bpy.app.translations.register: translations message cache already contains some data for "
"addon '%s'", (const char *)_PyUnicode_AsString(module_name));
return NULL;
}
PyDict_SetItem(self->py_messages, module_name, uuid_dict);
/* Clear cached messages dict! */
_clear_translations_cache();
#else
(void)self;
(void)args;
(void)kw;
#endif
/* And we are done! */
Py_RETURN_NONE;
}
PyDoc_STRVAR(app_translations_py_messages_unregister_doc,
".. method:: unregister(module_name)\n"
"\n"
" Unregisters an addon's UI translations.\n"
"\n"
" .. note::\n"
" Does nothing when Blender is built without internationalization support.\n"
"\n"
" :arg module_name: The name identifying the addon.\n"
" :type module_name: string\n"
"\n"
);
static PyObject *app_translations_py_messages_unregister(BlenderAppTranslations *self, PyObject *args, PyObject *kw)
{
#ifdef WITH_INTERNATIONAL
static const char *kwlist[] = {"module_name", NULL};
PyObject *module_name;
if (!PyArg_ParseTupleAndKeywords(args, kw, "O!:bpy.app.translations.unregister", (char **)kwlist, &PyUnicode_Type,
&module_name))
{
return NULL;
}
if (PyDict_Contains(self->py_messages, module_name)) {
PyDict_DelItem(self->py_messages, module_name);
/* Clear cached messages ghash! */
_clear_translations_cache();
}
#else
(void)self;
(void)args;
(void)kw;
#endif
/* And we are done! */
Py_RETURN_NONE;
}
/***** C-defined contexts *****/
/* This is always available (even when WITH_INTERNATIONAL is not defined). */
static PyTypeObject BlenderAppTranslationsContextsType;
static BLF_i18n_contexts_descriptor _contexts[] = BLF_I18NCONTEXTS_DESC;
/* These fields are just empty placeholders, actual values get set in app_translations_struct().
* This allows us to avoid many handwriting, and above all, to keep all context definition stuff in BLF_translation.h!
*/
static PyStructSequence_Field
app_translations_contexts_fields[ARRAY_SIZE(_contexts)] = {{NULL}};
static PyStructSequence_Desc app_translations_contexts_desc = {
(char *)"bpy.app.translations.contexts", /* name */
(char *)"This named tuple contains all pre-defined translation contexts", /* doc */
app_translations_contexts_fields, /* fields */
ARRAY_SIZE(app_translations_contexts_fields) - 1
};
static PyObject *app_translations_contexts_make(void)
{
PyObject *translations_contexts;
BLF_i18n_contexts_descriptor *ctxt;
int pos = 0;
translations_contexts = PyStructSequence_New(&BlenderAppTranslationsContextsType);
if (translations_contexts == NULL) {
return NULL;
}
#define SetObjString(item) PyStructSequence_SET_ITEM(translations_contexts, pos++, PyUnicode_FromString((item)))
#define SetObjNone() Py_INCREF(Py_None); PyStructSequence_SET_ITEM(translations_contexts, pos++, Py_None)
for (ctxt = _contexts; ctxt->c_id; ctxt++) {
if (ctxt->value) {
SetObjString(ctxt->value);
}
else {
SetObjNone();
}
}
#undef SetObjString
#undef SetObjNone
return translations_contexts;
}
/***** Main BlenderAppTranslations Py object definition *****/
PyDoc_STRVAR(app_translations_contexts_doc,
"A named tuple containing all pre-defined translation contexts.\n"
"\n"
".. warning::\n"
" Never use a (new) context starting with \"" BLF_I18NCONTEXT_DEFAULT_BPYRNA "\", it would be internally \n"
" assimilated as the default one!\n"
);
PyDoc_STRVAR(app_translations_contexts_C_to_py_doc,
"A readonly dict mapping contexts' C-identifiers to their py-identifiers."
);
static PyMemberDef app_translations_members[] = {
{(char *)"contexts", T_OBJECT_EX, offsetof(BlenderAppTranslations, contexts), READONLY,
app_translations_contexts_doc},
{(char *)"contexts_C_to_py", T_OBJECT_EX, offsetof(BlenderAppTranslations, contexts_C_to_py), READONLY,
app_translations_contexts_C_to_py_doc},
{NULL}
};
PyDoc_STRVAR(app_translations_locale_doc,
"The actual locale currently in use (will always return a void string when Blender is built without "
"internationalization support)."
);
static PyObject *app_translations_locale_get(PyObject *UNUSED(self), void *UNUSED(userdata))
{
return PyUnicode_FromString(BLF_lang_get());
}
/* Note: defining as getter, as (even if quite unlikely), this *may* change during runtime... */
PyDoc_STRVAR(app_translations_locales_doc, "All locales currently known by Blender (i.e. available as translations).");
static PyObject *app_translations_locales_get(PyObject *UNUSED(self), void *UNUSED(userdata))
{
PyObject *ret;
EnumPropertyItem *it, *items = BLF_RNA_lang_enum_properties();
int num_locales = 0, pos = 0;
if (items) {
/* This is not elegant, but simple! */
for (it = items; it->identifier; it++) {
if (it->value)
num_locales++;
}
}
ret = PyTuple_New(num_locales);
if (items) {
for (it = items; it->identifier; it++) {
if (it->value)
PyTuple_SET_ITEM(ret, pos++, PyUnicode_FromString(it->description));
}
}
return ret;
}
static PyGetSetDef app_translations_getseters[] = {
/* {name, getter, setter, doc, userdata} */
{(char *)"locale", (getter)app_translations_locale_get, NULL, app_translations_locale_doc, NULL},
{(char *)"locales", (getter)app_translations_locales_get, NULL, app_translations_locales_doc, NULL},
{NULL}
};
/* pgettext helper. */
static PyObject *_py_pgettext(PyObject *args, PyObject *kw, const char *(*_pgettext)(const char *, const char *))
{
static const char *kwlist[] = {"msgid", "msgctxt", NULL};
#ifdef WITH_INTERNATIONAL
char *msgid, *msgctxt = NULL;
if (!PyArg_ParseTupleAndKeywords(args, kw,
"s|z:bpy.app.translations.pgettext",
(char **)kwlist, &msgid, &msgctxt))
{
return NULL;
}
return PyUnicode_FromString((*_pgettext)(msgctxt ? msgctxt : BLF_I18NCONTEXT_DEFAULT, msgid));
#else
PyObject *msgid, *msgctxt;
(void)_pgettext;
if (!PyArg_ParseTupleAndKeywords(args, kw,
"O|O:bpy.app.translations.pgettext",
(char **)kwlist, &msgid, &msgctxt))
{
return NULL;
}
Py_INCREF(msgid);
return msgid;
#endif
}
PyDoc_STRVAR(app_translations_pgettext_doc,
".. method:: pgettext(msgid, msgctxt)\n"
"\n"
" Try to translate the given msgid (with optional msgctxt).\n"
"\n"
" .. note::\n"
" The ``(msgid, msgctxt)`` parameters order has been switched compared to gettext function, to allow\n"
" single-parameter calls (context then defaults to BLF_I18NCONTEXT_DEFAULT).\n"
"\n"
" .. note::\n"
" You should really rarely need to use this function in regular addon code, as all translation should be\n"
" handled by Blender internal code. The only exception are string containing formatting (like \"File: %r\"),\n"
" but you should rather use :func:`pgettext_iface`/:func:`pgettext_tip` in those cases!\n"
"\n"
" .. note::\n"
" Does nothing when Blender is built without internationalization support (hence always returns ``msgid``).\n"
"\n"
" :arg msgid: The string to translate.\n"
" :type msgid: string\n"
" :arg msgctxt: The translation context (defaults to BLF_I18NCONTEXT_DEFAULT).\n"
" :type msgctxt: string or None\n"
" :return: The translated string (or msgid if no translation was found).\n"
"\n"
);
static PyObject *app_translations_pgettext(BlenderAppTranslations *UNUSED(self), PyObject *args, PyObject *kw)
{
return _py_pgettext(args, kw, BLF_pgettext);
}
PyDoc_STRVAR(app_translations_pgettext_iface_doc,
".. method:: pgettext_iface(msgid, msgctxt)\n"
"\n"
" Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.\n"
"\n"
" .. note::\n"
" See :func:`pgettext` notes.\n"
"\n"
" :arg msgid: The string to translate.\n"
" :type msgid: string\n"
" :arg msgctxt: The translation context (defaults to BLF_I18NCONTEXT_DEFAULT).\n"
" :type msgctxt: string or None\n"
" :return: The translated string (or msgid if no translation was found).\n"
"\n"
);
static PyObject *app_translations_pgettext_iface(BlenderAppTranslations *UNUSED(self), PyObject *args, PyObject *kw)
{
return _py_pgettext(args, kw, BLF_translate_do_iface);
}
PyDoc_STRVAR(app_translations_pgettext_tip_doc,
".. method:: pgettext_tip(msgid, msgctxt)\n"
"\n"
" Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.\n"
"\n"
" .. note::\n"
" See :func:`pgettext` notes.\n"
"\n"
" :arg msgid: The string to translate.\n"
" :type msgid: string\n"
" :arg msgctxt: The translation context (defaults to BLF_I18NCONTEXT_DEFAULT).\n"
" :type msgctxt: string or None\n"
" :return: The translated string (or msgid if no translation was found).\n"
"\n"
);
static PyObject *app_translations_pgettext_tip(BlenderAppTranslations *UNUSED(self), PyObject *args, PyObject *kw)
{
return _py_pgettext(args, kw, BLF_translate_do_tooltip);
}
PyDoc_STRVAR(app_translations_pgettext_data_doc,
".. method:: pgettext_data(msgid, msgctxt)\n"
"\n"
" Try to translate the given msgid (with optional msgctxt), if new data name's translation is enabled.\n"
"\n"
" .. note::\n"
" See :func:`pgettext` notes.\n"
"\n"
" :arg msgid: The string to translate.\n"
" :type msgid: string\n"
" :arg msgctxt: The translation context (defaults to BLF_I18NCONTEXT_DEFAULT).\n"
" :type msgctxt: string or None\n"
" :return: The translated string (or ``msgid`` if no translation was found).\n"
"\n"
);
static PyObject *app_translations_pgettext_data(BlenderAppTranslations *UNUSED(self), PyObject *args, PyObject *kw)
{
return _py_pgettext(args, kw, BLF_translate_do_new_dataname);
}
PyDoc_STRVAR(app_translations_locale_explode_doc,
".. method:: locale_explode(locale)\n"
"\n"
" Return all components and their combinations of the given ISO locale string.\n"
"\n"
" >>> bpy.app.translations.locale_explode(\"sr_RS@latin\")\n"
" (\"sr\", \"RS\", \"latin\", \"sr_RS\", \"sr@latin\")\n"
"\n"
" For non-complete locales, missing elements will be None.\n"
"\n"
" :arg locale: The ISO locale string to explode.\n"
" :type msgid: string\n"
" :return: A tuple ``(language, country, variant, language_country, language@variant)``.\n"
"\n"
);
static PyObject *app_translations_locale_explode(BlenderAppTranslations *UNUSED(self), PyObject *args, PyObject *kw)
{
static const char *kwlist[] = {"locale", NULL};
const char *locale;
char *language, *country, *variant, *language_country, *language_variant;
if (!PyArg_ParseTupleAndKeywords(args, kw, "s:bpy.app.translations.locale_explode", (char **)kwlist, &locale)) {
return NULL;
}
BLF_locale_explode(locale, &language, &country, &variant, &language_country, &language_variant);
return Py_BuildValue("sssss", language, country, variant, language_country, language_variant);
}
static PyMethodDef app_translations_methods[] = {
/* Can't use METH_KEYWORDS alone, see http://bugs.python.org/issue11587 */
{"register", (PyCFunction)app_translations_py_messages_register, METH_VARARGS | METH_KEYWORDS,
app_translations_py_messages_register_doc},
{"unregister", (PyCFunction)app_translations_py_messages_unregister, METH_VARARGS | METH_KEYWORDS,
app_translations_py_messages_unregister_doc},
{"pgettext", (PyCFunction)app_translations_pgettext, METH_VARARGS | METH_KEYWORDS | METH_STATIC,
app_translations_pgettext_doc},
{"pgettext_iface", (PyCFunction)app_translations_pgettext_iface, METH_VARARGS | METH_KEYWORDS | METH_STATIC,
app_translations_pgettext_iface_doc},
{"pgettext_tip", (PyCFunction)app_translations_pgettext_tip, METH_VARARGS | METH_KEYWORDS | METH_STATIC,
app_translations_pgettext_tip_doc},
{"pgettext_data", (PyCFunction)app_translations_pgettext_data, METH_VARARGS | METH_KEYWORDS | METH_STATIC,
app_translations_pgettext_data_doc},
{"locale_explode", (PyCFunction)app_translations_locale_explode, METH_VARARGS | METH_KEYWORDS | METH_STATIC,
app_translations_locale_explode_doc},
{NULL}
};
static PyObject *app_translations_new(PyTypeObject *type, PyObject *UNUSED(args), PyObject *UNUSED(kw))
{
/* printf("%s (%p)\n", __func__, _translations); */
if (!_translations) {
_translations = (BlenderAppTranslations *)type->tp_alloc(type, 0);
if (_translations) {
PyObject *py_ctxts;
BLF_i18n_contexts_descriptor *ctxt;
_translations->contexts = app_translations_contexts_make();
py_ctxts = PyDict_New();
for (ctxt = _contexts; ctxt->c_id; ctxt++) {
PyObject *val = PyUnicode_FromString(ctxt->py_id);
PyDict_SetItemString(py_ctxts, ctxt->c_id, val);
Py_DECREF(val);
}
_translations->contexts_C_to_py = PyDictProxy_New(py_ctxts);
Py_DECREF(py_ctxts); /* The actual dict is only owned by its proxy */
_translations->py_messages = PyDict_New();
}
}
return (PyObject *)_translations;
}
static void app_translations_free(void *obj)
{
PyObject_Del(obj);
#ifdef WITH_INTERNATIONAL
_clear_translations_cache();
#endif
}
PyDoc_STRVAR(app_translations_doc,
"This object contains some data/methods regarding internationalization in Blender, and allows every py script\n"
"to feature translations for its own UI messages.\n"
"\n"
);
static PyTypeObject BlenderAppTranslationsType = {
PyVarObject_HEAD_INIT(NULL, 0)
/* tp_name */
"bpy.app._translations_type",
/* tp_basicsize */
sizeof(BlenderAppTranslations),
0, /* tp_itemsize */
/* methods */
/* No destructor, this is a singleton! */
NULL, /* tp_dealloc */
NULL, /* printfunc tp_print; */
NULL, /* getattrfunc tp_getattr; */
NULL, /* setattrfunc tp_setattr; */
NULL, /* tp_compare */ /* DEPRECATED in python 3.0! */
NULL, /* tp_repr */
/* Method suites for standard classes */
NULL, /* PyNumberMethods *tp_as_number; */
NULL, /* PySequenceMethods *tp_as_sequence; */
NULL, /* PyMappingMethods *tp_as_mapping; */
/* More standard operations (here for binary compatibility) */
NULL, /* hashfunc tp_hash; */
NULL, /* ternaryfunc tp_call; */
NULL, /* reprfunc tp_str; */
NULL, /* getattrofunc tp_getattro; */
NULL, /* setattrofunc tp_setattro; */
/* Functions to access object as input/output buffer */
NULL, /* PyBufferProcs *tp_as_buffer; */
/*** Flags to define presence of optional/expanded features ***/
Py_TPFLAGS_DEFAULT, /* long tp_flags; */
app_translations_doc, /* char *tp_doc; Documentation string */
/*** Assigned meaning in release 2.0 ***/
/* call function for all accessible objects */
NULL, /* traverseproc tp_traverse; */
/* delete references to contained objects */
NULL, /* inquiry tp_clear; */
/*** Assigned meaning in release 2.1 ***/
/*** rich comparisons ***/
NULL, /* richcmpfunc tp_richcompare; */
/*** weak reference enabler ***/
0, /* long tp_weaklistoffset */
/*** Added in release 2.2 ***/
/* Iterators */
NULL, /* getiterfunc tp_iter; */
NULL, /* iternextfunc tp_iternext; */
/*** Attribute descriptor and subclassing stuff ***/
app_translations_methods, /* struct PyMethodDef *tp_methods; */
app_translations_members, /* struct PyMemberDef *tp_members; */
app_translations_getseters, /* struct PyGetSetDef *tp_getset; */
NULL, /* struct _typeobject *tp_base; */
NULL, /* PyObject *tp_dict; */
NULL, /* descrgetfunc tp_descr_get; */
NULL, /* descrsetfunc tp_descr_set; */
0, /* long tp_dictoffset; */
NULL, /* initproc tp_init; */
NULL, /* allocfunc tp_alloc; */
/* newfunc tp_new; */
(newfunc)app_translations_new,
/* Low-level free-memory routine */
app_translations_free, /* freefunc tp_free; */
/* For PyObject_IS_GC */
NULL, /* inquiry tp_is_gc; */
NULL, /* PyObject *tp_bases; */
/* method resolution order */
NULL, /* PyObject *tp_mro; */
NULL, /* PyObject *tp_cache; */
NULL, /* PyObject *tp_subclasses; */
NULL, /* PyObject *tp_weaklist; */
NULL
};
PyObject *BPY_app_translations_struct(void)
{
PyObject *ret;
/* Let's finalize our contexts structseq definition! */
{
BLF_i18n_contexts_descriptor *ctxt;
PyStructSequence_Field *desc;
/* We really populate the contexts' fields here! */
for (ctxt = _contexts, desc = app_translations_contexts_desc.fields; ctxt->c_id; ctxt++, desc++) {
desc->name = (char *)ctxt->py_id;
desc->doc = NULL;
}
desc->name = desc->doc = NULL; /* End sentinel! */
PyStructSequence_InitType(&BlenderAppTranslationsContextsType, &app_translations_contexts_desc);
}
if (PyType_Ready(&BlenderAppTranslationsType) < 0)
return NULL;
ret = PyObject_CallObject((PyObject *)&BlenderAppTranslationsType, NULL);
/* prevent user from creating new instances */
BlenderAppTranslationsType.tp_new = NULL;
/* without this we can't do set(sys.modules) [#29635] */
BlenderAppTranslationsType.tp_hash = (hashfunc)_Py_HashPointer;
return ret;
}
|