Cleanup: add trailing commas
[blender.git] / source / blender / python / intern / bpy_app_translations.c
index 17a2038b7dc37212d76ef5c13e68ea73f5b64890..acb44f86f75dae66b5b3359a11571fd925e7ab0a 100644 (file)
 
 #include "MEM_guardedalloc.h"
 
-#include "BLF_translation.h"
+#include "BLT_translation.h"
+#include "BLT_lang.h"
 
 #include "RNA_types.h"
 
 #include "../generic/python_utildefines.h"
 
-typedef struct
-{
+typedef struct {
        PyObject_HEAD
        /* The string used to separate context from actual message in PY_TRANSLATE RNA props. */
        const char *context_separator;
@@ -74,7 +74,7 @@ typedef struct 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->msgctxt = BLI_strdup(BLT_is_default_context(msgctxt) ? BLT_I18NCONTEXT_DEFAULT_BPYRNA : msgctxt);
        key->msgid = BLI_strdup(msgid);
        return key;
 }
@@ -134,7 +134,7 @@ static void _build_translations_cache(PyObject *py_messages, const char *locale)
 
        /* 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);
+       BLT_lang_locale_explode(locale, &language, NULL, NULL, &language_country, &language_variant);
 
        /* Clear the cached ghash if needed, and create a new one. */
        _clear_translations_cache();
@@ -181,7 +181,6 @@ static void _build_translations_cache(PyObject *py_messages, const char *locale)
 
                        /* 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;
 
@@ -191,7 +190,7 @@ static void _build_translations_cache(PyObject *py_messages, const char *locale)
                                else {
                                        PyObject *tmp = PyTuple_GET_ITEM(pykey, 0);
                                        if (tmp == Py_None) {
-                                               msgctxt = BLF_I18NCONTEXT_DEFAULT_BPYRNA;
+                                               msgctxt = BLT_I18NCONTEXT_DEFAULT_BPYRNA;
                                        }
                                        else if (PyUnicode_Check(tmp)) {
                                                msgctxt = _PyUnicode_AsString(tmp);
@@ -229,14 +228,11 @@ static void _build_translations_cache(PyObject *py_messages, const char *locale)
                                        continue;
                                }
 
-                               key = _ghashutil_keyalloc(msgctxt, msgid);
-
                                /* Do not overwrite existing keys! */
-                               if (BLI_ghash_lookup(_translations_cache, (void *)key)) {
-                                       continue;
+                               if (BPY_app_translations_py_pgettext(msgctxt, msgid) == msgid) {
+                                       GHashKey *key = _ghashutil_keyalloc(msgctxt, msgid);
+                                       BLI_ghash_insert(_translations_cache, key, BLI_strdup(_PyUnicode_AsString(trans)));
                                }
-
-                               BLI_ghash_insert(_translations_cache, key, BLI_strdup(_PyUnicode_AsString(trans)));
                        }
                }
        }
@@ -251,7 +247,7 @@ const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *ms
 {
 #define STATIC_LOCALE_SIZE 32  /* Should be more than enough! */
 
-       GHashKey *key;
+       GHashKey key;
        static char locale[STATIC_LOCALE_SIZE] = "";
        const char *tmp;
 
@@ -259,7 +255,7 @@ const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *ms
        if (!_translations)
                return msgid;
 
-       tmp = BLF_lang_get();
+       tmp = BLT_lang_get();
        if (!STREQ(tmp, locale) || !_translations_cache) {
                PyGILState_STATE _py_state;
 
@@ -275,11 +271,10 @@ const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *ms
        }
 
        /* 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);
+       key.msgctxt = BLT_is_default_context(msgctxt) ? BLT_I18NCONTEXT_DEFAULT_BPYRNA : msgctxt;
+       key.msgid = msgid;
 
-       _ghashutil_keyfree((void *)key);
+       tmp = BLI_ghash_lookup(_translations_cache, &key);
 
        return tmp ? tmp : msgid;
 
@@ -294,12 +289,12 @@ PyDoc_STRVAR(app_translations_py_messages_register_doc,
 "   Registers an addon's UI translations.\n"
 "\n"
 "   .. note::\n"
-"       Does nothing when Blender is built without internationalization support.\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"
+"      ``{locale: {msg_key: msg_translation, ...}, ...}``\n"
 "   :type translations_dict: dict\n"
 "\n"
 );
@@ -342,7 +337,7 @@ PyDoc_STRVAR(app_translations_py_messages_unregister_doc,
 "   Unregisters an addon's UI translations.\n"
 "\n"
 "   .. note::\n"
-"       Does nothing when Blender is built without internationalization support.\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"
@@ -380,10 +375,10 @@ static PyObject *app_translations_py_messages_unregister(BlenderAppTranslations
 
 static PyTypeObject BlenderAppTranslationsContextsType;
 
-static BLF_i18n_contexts_descriptor _contexts[] = BLF_I18NCONTEXTS_DESC;
+static BLT_i18n_contexts_descriptor _contexts[] = BLT_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!
+ * This allows us to avoid many handwriting, and above all, to keep all context definition stuff in BLT_translation.h!
  */
 static PyStructSequence_Field
 app_translations_contexts_fields[ARRAY_SIZE(_contexts)] = {{NULL}};
@@ -398,7 +393,7 @@ static PyStructSequence_Desc app_translations_contexts_desc = {
 static PyObject *app_translations_contexts_make(void)
 {
        PyObject *translations_contexts;
-       BLF_i18n_contexts_descriptor *ctxt;
+       BLT_i18n_contexts_descriptor *ctxt;
        int pos = 0;
 
        translations_contexts = PyStructSequence_New(&BlenderAppTranslationsContextsType);
@@ -427,11 +422,11 @@ static PyObject *app_translations_contexts_make(void)
 /***** 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"
+"A named tuple containing all pre-defined translation contexts.\n"
+"\n"
+".. warning::\n"
+"   Never use a (new) context starting with \"" BLT_I18NCONTEXT_DEFAULT_BPYRNA "\", it would be internally\n"
+"   assimilated as the default one!\n"
 );
 
 PyDoc_STRVAR(app_translations_contexts_C_to_py_doc,
@@ -447,12 +442,12 @@ static PyMemberDef app_translations_members[] = {
 };
 
 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)."
+"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());
+       return PyUnicode_FromString(BLT_lang_get());
 }
 
 /* Note: defining as getter, as (even if quite unlikely), this *may* change during runtime... */
@@ -460,7 +455,7 @@ PyDoc_STRVAR(app_translations_locales_doc, "All locales currently known by Blend
 static PyObject *app_translations_locales_get(PyObject *UNUSED(self), void *UNUSED(userdata))
 {
        PyObject *ret;
-       EnumPropertyItem *it, *items = BLF_RNA_lang_enum_properties();
+       EnumPropertyItem *it, *items = BLT_lang_RNA_enum_properties();
        int num_locales = 0, pos = 0;
 
        if (items) {
@@ -505,7 +500,7 @@ static PyObject *_py_pgettext(PyObject *args, PyObject *kw, const char *(*_pgett
                return NULL;
        }
 
-       return PyUnicode_FromString((*_pgettext)(msgctxt ? msgctxt : BLF_I18NCONTEXT_DEFAULT, msgid));
+       return PyUnicode_FromString((*_pgettext)(msgctxt ? msgctxt : BLT_I18NCONTEXT_DEFAULT, msgid));
 #else
        PyObject *msgid, *msgctxt;
        (void)_pgettext;
@@ -527,27 +522,27 @@ PyDoc_STRVAR(app_translations_pgettext_doc,
 "   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"
+"      The ``(msgid, msgctxt)`` parameters order has been switched compared to gettext function, to allow\n"
+"      single-parameter calls (context then defaults to BLT_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"
+"      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"
+"      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"
+"   :arg msgctxt: The translation context (defaults to BLT_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);
+       return _py_pgettext(args, kw, BLT_pgettext);
 }
 
 PyDoc_STRVAR(app_translations_pgettext_iface_doc,
@@ -556,18 +551,18 @@ PyDoc_STRVAR(app_translations_pgettext_iface_doc,
 "   Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.\n"
 "\n"
 "   .. note::\n"
-"       See :func:`pgettext` notes.\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"
+"   :arg msgctxt: The translation context (defaults to BLT_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);
+       return _py_pgettext(args, kw, BLT_translate_do_iface);
 }
 
 PyDoc_STRVAR(app_translations_pgettext_tip_doc,
@@ -576,18 +571,18 @@ PyDoc_STRVAR(app_translations_pgettext_tip_doc,
 "   Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.\n"
 "\n"
 "   .. note::\n"
-"       See :func:`pgettext` notes.\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"
+"   :arg msgctxt: The translation context (defaults to BLT_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);
+       return _py_pgettext(args, kw, BLT_translate_do_tooltip);
 }
 
 PyDoc_STRVAR(app_translations_pgettext_data_doc,
@@ -596,18 +591,18 @@ PyDoc_STRVAR(app_translations_pgettext_data_doc,
 "   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"
+"      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"
+"   :arg msgctxt: The translation context (defaults to BLT_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);
+       return _py_pgettext(args, kw, BLT_translate_do_new_dataname);
 }
 
 PyDoc_STRVAR(app_translations_locale_explode_doc,
@@ -636,7 +631,7 @@ static PyObject *app_translations_locale_explode(BlenderAppTranslations *UNUSED(
                return NULL;
        }
 
-       BLF_locale_explode(locale, &language, &country, &variant, &language_country, &language_variant);
+       BLT_lang_locale_explode(locale, &language, &country, &variant, &language_country, &language_variant);
 
        ret_tuple = Py_BuildValue("sssss", language, country, variant, language_country, language_variant);
 
@@ -676,11 +671,11 @@ static PyObject *app_translations_new(PyTypeObject *type, PyObject *UNUSED(args)
                _translations = (BlenderAppTranslations *)type->tp_alloc(type, 0);
                if (_translations) {
                        PyObject *py_ctxts;
-                       BLF_i18n_contexts_descriptor *ctxt;
+                       BLT_i18n_contexts_descriptor *ctxt;
 
                        _translations->contexts = app_translations_contexts_make();
 
-                       py_ctxts = PyDict_New();
+                       py_ctxts = _PyDict_NewPresized(ARRAY_SIZE(_contexts));
                        for (ctxt = _contexts; ctxt->c_id; ctxt++) {
                                PyObject *val = PyUnicode_FromString(ctxt->py_id);
                                PyDict_SetItemString(py_ctxts, ctxt->c_id, val);
@@ -787,7 +782,7 @@ static PyTypeObject BlenderAppTranslationsType = {
        NULL,                       /* PyObject *tp_cache; */
        NULL,                       /* PyObject *tp_subclasses; */
        NULL,                       /* PyObject *tp_weaklist; */
-       NULL
+       NULL,
 };
 
 PyObject *BPY_app_translations_struct(void)
@@ -796,7 +791,7 @@ PyObject *BPY_app_translations_struct(void)
 
        /* Let's finalize our contexts structseq definition! */
        {
-               BLF_i18n_contexts_descriptor *ctxt;
+               BLT_i18n_contexts_descriptor *ctxt;
                PyStructSequence_Field *desc;
 
                /* We really populate the contexts' fields here! */
@@ -821,3 +816,11 @@ PyObject *BPY_app_translations_struct(void)
 
        return ret;
 }
+
+void BPY_app_translations_end(void)
+{
+       /* Incase the object remains in a module's namespace, see T44127. */
+#ifdef WITH_INTERNATIONAL
+       _clear_translations_cache();
+#endif
+}