bpy_app_translations.cc File Reference

#include <Python.h>
#include <structmember.h>
#include "BLI_utildefines.h"
#include "BPY_extern.hh"
#include "bpy_app_translations.hh"
#include "MEM_guardedalloc.h"
#include "BLT_lang.hh"
#include "BLT_translation.hh"
#include "RNA_types.hh"
#include "../generic/python_utildefines.hh"

Go to the source code of this file.

Classes
struct	BlenderAppTranslations

Macros
#define	SetObjString(item)    PyStructSequence_SET_ITEM(translations_contexts, pos++, PyUnicode_FromString(item))
#define	SetObjNone()   PyStructSequence_SET_ITEM(translations_contexts, pos++, Py_NewRef(Py_None))

Functions
Helpers for GHash
	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: str\n" " :arg translations_dict: A dictionary built like that:\n" " ``{locale: {msg_key: msg_translation, ...}, ...}``\n" " :type translations_dict: dict[str, dict[str, str]]\n" "\n")
static PyObject *	app_translations_py_messages_register (BlenderAppTranslations *self, PyObject *args, PyObject *kw)
	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: str\n" "\n")
static PyObject *	app_translations_py_messages_unregister (BlenderAppTranslations *self, PyObject *args, PyObject *kw)

Variables
Local Struct to Store Translation
static BlenderAppTranslations *	_translations = nullptr

C-defined Contexts
static PyTypeObject	BlenderAppTranslationsContextsType
static BLT_i18n_contexts_descriptor	_contexts [] = BLT_I18NCONTEXTS_DESC
static PyStructSequence_Field	app_translations_contexts_fields [ARRAY_SIZE(_contexts)]
static PyStructSequence_Desc	app_translations_contexts_desc
static PyObject *	app_translations_contexts_make ()

Main #BlenderAppTranslations #PyObject Definition
static PyMemberDef	app_translations_members []
static PyGetSetDef	app_translations_getseters []
static PyMethodDef	app_translations_methods []
static PyTypeObject	BlenderAppTranslationsType
	PyDoc_STRVAR (app_translations_contexts_doc, "A named tuple containing all predefined 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, "A readonly dict mapping contexts' C-identifiers to their py-identifiers.")
	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 *, void *)
	PyDoc_STRVAR (app_translations_locales_doc, "All locales currently known by Blender (i.e. available as translations).")
static PyObject *	app_translations_locales_get (PyObject *, void *)
static PyObject *	_py_pgettext (PyObject *args, PyObject *kw, const char *(*_pgettext)(const char *, const char *))
	PyDoc_STRVAR (app_translations_pgettext_doc, ".. method:: pgettext(msgid, msgctxt=None)\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 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" "\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: str\n" " :arg msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt: str | None\n" " :return: The translated string (or msgid if no translation was found).\n" "\n")
static PyObject *	app_translations_pgettext (BlenderAppTranslations *, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (app_translations_pgettext_n_doc, ".. method:: pgettext_n(msgid, msgctxt=None)\n" "\n" " Extract the given msgid to translation files. This is a no-op function that will " "only mark the string to extract, but not perform the actual translation.\n" "\n" " .. note::\n" " See :func:`pgettext` notes.\n" "\n" " :arg msgid: The string to extract.\n" " :type msgid: str\n" " :arg msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt: str | None\n" " :return: The original string.\n" "\n")
static PyObject *	app_translations_pgettext_n (BlenderAppTranslations *, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (app_translations_pgettext_iface_doc, ".. method:: pgettext_iface(msgid, msgctxt=None)\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: str\n" " :arg msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt: str | None\n" " :return: The translated string (or msgid if no translation was found).\n" "\n")
static PyObject *	app_translations_pgettext_iface (BlenderAppTranslations *, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (app_translations_pgettext_tip_doc, ".. method:: pgettext_tip(msgid, msgctxt=None)\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: str\n" " :arg msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt: str | None\n" " :return: The translated string (or msgid if no translation was found).\n" "\n")
static PyObject *	app_translations_pgettext_tip (BlenderAppTranslations *, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (app_translations_pgettext_rpt_doc, ".. method:: pgettext_rpt(msgid, msgctxt=None)\n" "\n" " Try to translate the given msgid (with optional msgctxt), if reports' translation " "is enabled.\n" "\n" " .. note::\n" " See :func:`pgettext` notes.\n" "\n" " :arg msgid: The string to translate.\n" " :type msgid: str\n" " :arg msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt: str | None\n" " :return: The translated string (or msgid if no translation was found).\n" "\n")
static PyObject *	app_translations_pgettext_rpt (BlenderAppTranslations *, PyObject *args, PyObject *kw)
	PyDoc_STRVAR (app_translations_pgettext_data_doc, ".. method:: pgettext_data(msgid, msgctxt=None)\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: str\n" " :arg msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt: str | None\n" " :return: The translated string (or ``msgid`` if no translation was found).\n" "\n")
static PyObject *	app_translations_pgettext_data (BlenderAppTranslations *, PyObject *args, PyObject *kw)
	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: str\n" " :return: A tuple ``(language, country, variant, language_country, language@variant)``.\n" "\n")
static PyObject *	app_translations_locale_explode (BlenderAppTranslations *, PyObject *args, PyObject *kw)
static PyObject *	app_translations_new (PyTypeObject *type, PyObject *, PyObject *)
static void	app_translations_free (BlenderAppTranslations *self)
	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")
PyObject *	BPY_app_translations_struct ()
void	BPY_app_translations_end ()

Detailed Description

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 Python dictionaries.

Definition in file bpy_app_translations.cc.

Macro Definition Documentation

SetObjNone

#define SetObjNone

(

)

PyStructSequence_SET_ITEM(translations_contexts, pos++, Py_NewRef(Py_None))

Referenced by app_translations_contexts_make().

SetObjString

#define SetObjString

(

item

)

PyStructSequence_SET_ITEM(translations_contexts, pos++, PyUnicode_FromString(item))

Referenced by app_translations_contexts_make().

Function Documentation

_py_pgettext()

static PyObject * _py_pgettext ( PyObject * args, PyObject * kw, const char *(* _pgettext )(const char *, const char *) )

static

Definition at line 551 of file bpy_app_translations.cc.

References BLT_I18NCONTEXT_DEFAULT.

Referenced by app_translations_pgettext(), app_translations_pgettext_data(), app_translations_pgettext_iface(), app_translations_pgettext_rpt(), and app_translations_pgettext_tip().

app_translations_contexts_make()

static PyObject * app_translations_contexts_make ( )

static

Definition at line 430 of file bpy_app_translations.cc.

References _contexts, BlenderAppTranslationsContextsType, BLT_i18n_contexts_descriptor::c_id, pos, SetObjNone, SetObjString, and BLT_i18n_contexts_descriptor::value.

Referenced by app_translations_new().

app_translations_free()

static void app_translations_free ( BlenderAppTranslations * self )

static

Definition at line 869 of file bpy_app_translations.cc.

References self.

app_translations_locale_explode()

static PyObject * app_translations_locale_explode ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 761 of file bpy_app_translations.cc.

References BLT_lang_locale_explode(), and MEM_SAFE_FREE.

app_translations_locale_get()

static PyObject * app_translations_locale_get ( PyObject * , void *  )

static

Definition at line 501 of file bpy_app_translations.cc.

References BLT_lang_get().

app_translations_locales_get()

static PyObject * app_translations_locales_get ( PyObject * , void *  )

static

Definition at line 511 of file bpy_app_translations.cc.

References BLT_lang_RNA_enum_properties(), EnumPropertyItem::identifier, pos, and ret.

app_translations_new()

static PyObject * app_translations_new ( PyTypeObject * type, PyObject * , PyObject *  )

static

Definition at line 841 of file bpy_app_translations.cc.

References _contexts, _translations, app_translations_contexts_make(), ARRAY_SIZE, BLT_i18n_contexts_descriptor::c_id, BlenderAppTranslations::contexts, BlenderAppTranslations::contexts_C_to_py, BLT_i18n_contexts_descriptor::py_id, and BlenderAppTranslations::py_messages.

app_translations_pgettext()

static PyObject * app_translations_pgettext ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 610 of file bpy_app_translations.cc.

References _py_pgettext(), and BLT_pgettext().

app_translations_pgettext_data()

static PyObject * app_translations_pgettext_data ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 738 of file bpy_app_translations.cc.

References _py_pgettext(), and BLT_translate_do_new_dataname().

app_translations_pgettext_iface()

static PyObject * app_translations_pgettext_iface ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 666 of file bpy_app_translations.cc.

References _py_pgettext(), and BLT_translate_do_iface().

app_translations_pgettext_n()

static PyObject * app_translations_pgettext_n ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 632 of file bpy_app_translations.cc.

app_translations_pgettext_rpt()

static PyObject * app_translations_pgettext_rpt ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 714 of file bpy_app_translations.cc.

References _py_pgettext(), and BLT_translate_do_report().

app_translations_pgettext_tip()

static PyObject * app_translations_pgettext_tip ( BlenderAppTranslations * , PyObject * args, PyObject * kw )

static

Definition at line 690 of file bpy_app_translations.cc.

References _py_pgettext(), and BLT_translate_do_tooltip().

app_translations_py_messages_register()

static PyObject * app_translations_py_messages_register ( BlenderAppTranslations * self, PyObject * args, PyObject * kw )

static

Definition at line 316 of file bpy_app_translations.cc.

References self.

app_translations_py_messages_unregister()

static PyObject * app_translations_py_messages_unregister ( BlenderAppTranslations * self, PyObject * args, PyObject * kw )

static

Definition at line 372 of file bpy_app_translations.cc.

References self.

BPY_app_translations_end()

void BPY_app_translations_end

(

)

Definition at line 976 of file bpy_app_translations.cc.

Referenced by BPY_python_end().

BPY_app_translations_struct()

PyObject * BPY_app_translations_struct

(

)

Definition at line 940 of file bpy_app_translations.cc.

References _contexts, app_translations_contexts_desc, BlenderAppTranslationsContextsType, BlenderAppTranslationsType, BLT_i18n_contexts_descriptor::c_id, BLT_i18n_contexts_descriptor::py_id, and ret.

Referenced by make_app_info().

PyDoc_STRVAR() [1/14]

PyDoc_STRVAR	(	app_translations_contexts_C_to_py_doc	,
		"A readonly dict mapping contexts' C-identifiers to their py-identifiers."	)

PyDoc_STRVAR() [2/14]

PyDoc_STRVAR	(	app_translations_contexts_doc	,
		"A named tuple containing all predefined 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() [3/14]

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"	)

PyDoc_STRVAR() [4/14]

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)."	)

PyDoc_STRVAR() [5/14]

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:str\n" " :return:A tuple ``(language, country, variant, language_country, language @variant)``.\n" "\n"	)

PyDoc_STRVAR() [6/14]

PyDoc_STRVAR	(	app_translations_locales_doc	,
		"All locales currently known by Blender (i.e. available as translations)."	)

PyDoc_STRVAR() [7/14]

PyDoc_STRVAR	(	app_translations_pgettext_data_doc	,
		".. method::	pgettext_datamsgid, msgctxt=None)\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:str\n" " :arg msgctxt:The translation context(defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt:str|None\n" " :return:The translated string(or ``msgid`` if no translation was found).\n" "\n"	)

PyDoc_STRVAR() [8/14]

PyDoc_STRVAR	(	app_translations_pgettext_doc	,
		".. method:: pgettext(msgid, msgctxt=None)\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 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" "\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:str\n" " :arg msgctxt:The translation context(defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt:str|None\n" " :return:The translated string(or msgid if no translation was found).\n" "\n"	)

PyDoc_STRVAR() [9/14]

PyDoc_STRVAR	(	app_translations_pgettext_iface_doc	,
		".. method::	pgettext_ifacemsgid, msgctxt=None)\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:str\n" " :arg msgctxt:The translation context(defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt:str|None\n" " :return:The translated string(or msgid if no translation was found).\n" "\n"	)

PyDoc_STRVAR() [10/14]

PyDoc_STRVAR	(	app_translations_pgettext_n_doc	,
		".. method:: pgettext_n(msgid, msgctxt=None)\n" "\n" " Extract the given msgid to translation files. This is a no-op function that will " "only mark the string to	extract,
		but not perform the actual translation.\n" "\n" " .. note::\n" " See :func:`pgettext` notes.\n" "\n" " :arg msgid:The string to extract.\n" " :type msgid:str\n" " :arg msgctxt:The translation context(defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt:str|None\n" " :return:The original string.\n" "\n"	)

PyDoc_STRVAR() [11/14]

PyDoc_STRVAR	(	app_translations_pgettext_rpt_doc	,
		".. method::	pgettext_rptmsgid, msgctxt=None)\n" "\n" " Try to translate the given msgid (with optional msgctxt,
		if reports' translation " "is enabled.\n" "\n" " .. note::\n" " See :func:`pgettext` notes.\n" "\n" " :arg msgid:The string to translate.\n" " :type msgid:str\n" " :arg msgctxt:The translation context(defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt:str|None\n" " :return:The translated string(or msgid if no translation was found).\n" "\n"	)

PyDoc_STRVAR() [12/14]

PyDoc_STRVAR	(	app_translations_pgettext_tip_doc	,
		".. method::	pgettext_tipmsgid, msgctxt=None)\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:str\n" " :arg msgctxt:The translation context(defaults to BLT_I18NCONTEXT_DEFAULT).\n" " :type msgctxt:str|None\n" " :return:The translated string(or msgid if no translation was found).\n" "\n"	)

PyDoc_STRVAR() [13/14]

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: str\n" " :arg translations_dict: A dictionary built like that:\n" " ``{locale: {msg_key: msg_translation, ...}, ...}``\n" " :type translations_dict: dict]\n" "\n"	[str, dict[str, str] )

PyDoc_STRVAR() [14/14]

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: str\n" "\n"	)

Variable Documentation

_contexts

BLT_i18n_contexts_descriptor _contexts[] = BLT_I18NCONTEXTS_DESC

static

Definition at line 415 of file bpy_app_translations.cc.

Referenced by app_translations_contexts_make(), app_translations_new(), and BPY_app_translations_struct().

_translations

BlenderAppTranslations* _translations = nullptr

static

Definition at line 56 of file bpy_app_translations.cc.

Referenced by app_translations_new().

app_translations_contexts_desc

PyStructSequence_Desc app_translations_contexts_desc

static

Initial value:

= {
     "bpy.app.translations.contexts",
     "This named tuple contains all predefined translation contexts",
     app_translations_contexts_fields,
     ARRAY_SIZE(app_translations_contexts_fields) - 1,
}

Definition at line 423 of file bpy_app_translations.cc.

Referenced by BPY_app_translations_struct().

app_translations_contexts_fields

PyStructSequence_Field app_translations_contexts_fields[ARRAY_SIZE(_contexts)]

static

Initial value:

= {
    {nullptr}}

Definition at line 420 of file bpy_app_translations.cc.

app_translations_getseters

PyGetSetDef app_translations_getseters[]

static

Initial value:

= {
    
    {"locale", (getter)app_translations_locale_get, nullptr, app_translations_locale_doc, nullptr},
    {"locales",
     (getter)app_translations_locales_get,
     nullptr,
     app_translations_locales_doc,
     nullptr},
    {nullptr},
}

Definition at line 539 of file bpy_app_translations.cc.

app_translations_members

PyMemberDef app_translations_members[]

static

Initial value:

= {
    {"contexts",
     T_OBJECT_EX,
     offsetof(BlenderAppTranslations, contexts),
     READONLY,
     app_translations_contexts_doc},
    {"contexts_C_to_py",
     T_OBJECT_EX,
     offsetof(BlenderAppTranslations, contexts_C_to_py),
     READONLY,
     app_translations_contexts_C_to_py_doc},
    {nullptr},
}

Definition at line 481 of file bpy_app_translations.cc.

app_translations_methods

PyMethodDef app_translations_methods[]

static

Definition at line 796 of file bpy_app_translations.cc.

BlenderAppTranslationsContextsType

PyTypeObject BlenderAppTranslationsContextsType

static

Definition at line 413 of file bpy_app_translations.cc.

Referenced by app_translations_contexts_make(), and BPY_app_translations_struct().

BlenderAppTranslationsType

PyTypeObject BlenderAppTranslationsType

static

Definition at line 888 of file bpy_app_translations.cc.

Referenced by BPY_app_translations_struct().