0832907d1d92abe998ef43dc9db16a164a29ff29
[blender.git] / source / blender / blenfont / BLF_translation.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2011 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation,
23  *                 Sergey Sharybin
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenfont/BLF_translation.h
29  *  \ingroup blf
30  */
31
32
33 #ifndef __BLF_TRANSLATION_H__
34 #define __BLF_TRANSLATION_H__
35
36 #define TEXT_DOMAIN_NAME "blender"
37
38 /* blf_lang.c */
39
40 /* Search the path directory to the locale files, this try all
41  * the case for Linux, Win and Mac.
42  * Also dynamically builds locales and locales' menu from "languages" text file.
43  */
44 void BLF_lang_init(void);
45
46 /* Free languages and locales_menu arrays created by BLF_lang_init. */
47 void BLF_lang_free(void);
48
49 /* Set the current locale. */
50 void BLF_lang_set(const char *);
51 /* Get the current locale (short code, e.g. es_ES). */
52 const char *BLF_lang_get(void);
53
54 /* Get EnumPropertyItem's for translations menu. */
55 struct EnumPropertyItem *BLF_RNA_lang_enum_properties(void);
56
57 /* blf_translation.c  */
58
59 #ifdef WITH_INTERNATIONAL
60 unsigned char *BLF_get_unifont(int *unifont_size);
61 void BLF_free_unifont(void);
62 #endif
63
64 const char *BLF_pgettext(const char *msgctxt, const char *msgid);
65
66 /* translation */
67 int BLF_translate_iface(void);
68 int BLF_translate_tooltips(void);
69 const char *BLF_translate_do_iface(const char *msgctxt, const char *msgid);
70 const char *BLF_translate_do_tooltip(const char *msgctxt, const char *msgid);
71
72
73 /* The "translation-marker" macro. */
74 #define N_(msgid) msgid
75 #define CTX_N_(context, msgid) msgid
76
77 /* Those macros should be used everywhere in UI code. */
78 #ifdef WITH_INTERNATIONAL
79 /*      #define _(msgid) BLF_gettext(msgid) */
80         #define IFACE_(msgid) BLF_translate_do_iface(NULL, msgid)
81         #define TIP_(msgid) BLF_translate_do_tooltip(NULL, msgid)
82         #define CTX_IFACE_(context, msgid) BLF_translate_do_iface(context, msgid)
83         #define CTX_TIP_(context, msgid) BLF_translate_do_tooltip(context, msgid)
84 #else
85 /*      #define _(msgid) msgid */
86         #define IFACE_(msgid) msgid
87         #define TIP_(msgid) msgid
88         #define CTX_IFACE_(context, msgid) msgid
89         #define CTX_TIP_(context, msgid)   msgid
90 #endif
91
92 /* Helper macro, when we want to define a same msgid for multiple msgctxt...
93  * Does nothing in C, but is "parsed" by our i18n py tools.
94  * XXX Currently limited to at most 16 contexts at most
95  *     (but you can call it several times with the same msgid, should you need more contexts!).
96  */
97 #define BLF_I18N_MSGID_MULTI_CTXT(msgid, ...)
98
99 /******************************************************************************
100  * All i18n contexts must be defined here.
101  * This is a nice way to be sure not to use a context twice for different
102  * things, and limit the number of existing contexts!
103  */
104
105 /* Default, void context. Just in case... */
106 #define BLF_I18NCONTEXT_DEFAULT ""
107
108 /* Default context for operator names/labels. */
109 #define BLF_I18NCONTEXT_OPERATOR_DEFAULT "Operator"
110
111 /* ID-types contexts. */
112 /* WARNING! Keep it in sync with idtypes in blenkernel/intern/idcode.c */
113 #define BLF_I18NCONTEXT_ID_ACTION               "Action"
114 #define BLF_I18NCONTEXT_ID_ARMATURE             "Armature"
115 #define BLF_I18NCONTEXT_ID_BRUSH                "Brush"
116 #define BLF_I18NCONTEXT_ID_CAMERA               "Camera"
117 #define BLF_I18NCONTEXT_ID_CURVE                "Curve"
118 #define BLF_I18NCONTEXT_ID_GPENCIL              "GPencil"
119 #define BLF_I18NCONTEXT_ID_GROUP                "Group"
120 #define BLF_I18NCONTEXT_ID_ID                   "ID"
121 #define BLF_I18NCONTEXT_ID_IMAGE                "Image"
122 /*#define BLF_I18NCONTEXT_ID_IPO                  "Ipo"*/ /* Deprecated */
123 #define BLF_I18NCONTEXT_ID_SHAPEKEY             "Key"
124 #define BLF_I18NCONTEXT_ID_LAMP                 "Lamp"
125 #define BLF_I18NCONTEXT_ID_LIBRARY              "Library"
126 #define BLF_I18NCONTEXT_ID_LATTICE              "Lattice"
127 #define BLF_I18NCONTEXT_ID_MATERIAL             "Material"
128 #define BLF_I18NCONTEXT_ID_METABALL             "Metaball"
129 #define BLF_I18NCONTEXT_ID_MESH                 "Mesh"
130 #define BLF_I18NCONTEXT_ID_NODETREE             "NodeTree"
131 #define BLF_I18NCONTEXT_ID_OBJECT               "Object"
132 #define BLF_I18NCONTEXT_ID_PARTICLESETTINGS     "ParticleSettings"
133 #define BLF_I18NCONTEXT_ID_SCENE                "Scene"
134 #define BLF_I18NCONTEXT_ID_SCREEN               "Screen"
135 #define BLF_I18NCONTEXT_ID_SEQUENCE             "Sequence"
136 #define BLF_I18NCONTEXT_ID_SPEAKER              "Speaker"
137 #define BLF_I18NCONTEXT_ID_SOUND                "Sound"
138 #define BLF_I18NCONTEXT_ID_TEXTURE              "Texture"
139 #define BLF_I18NCONTEXT_ID_TEXT                 "Text"
140 #define BLF_I18NCONTEXT_ID_VFONT                "VFont"
141 #define BLF_I18NCONTEXT_ID_WORLD                "World"
142 #define BLF_I18NCONTEXT_ID_WINDOWMANAGER        "WindowManager"
143 #define BLF_I18NCONTEXT_ID_MOVIECLIP            "MovieClip"
144 #define BLF_I18NCONTEXT_ID_MASK                 "Mask"
145
146 #endif /* __BLF_TRANSLATION_H__ */