Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blentranslation / intern / blt_translation.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2011 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup blt
21  *
22  * Manages translation files and provides translation functions.
23  * (which are optional and can be disabled as a preference).
24  */
25
26 #include <stdlib.h>
27 #include <string.h>
28
29 #include "BLT_translation.h"
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_userdef_types.h" /* For user settings. */
34
35 #ifdef WITH_PYTHON
36 #include "BPY_extern.h"
37 #endif
38
39 #ifdef WITH_INTERNATIONAL
40 #  include "BLI_threads.h"
41 #  include "boost_locale_wrapper.h"
42 #endif  /* WITH_INTERNATIONAL */
43
44 bool BLT_is_default_context(const char *msgctxt)
45 {
46         /* We use the "short" test, a more complete one could be:
47          * return (!msgctxt || !msgctxt[0] || STREQ(msgctxt, BLT_I18NCONTEXT_DEFAULT_BPYRNA))
48          */
49         /* Note: trying without the void string check for now, it *should* not be necessary... */
50         return (!msgctxt || msgctxt[0] == BLT_I18NCONTEXT_DEFAULT_BPYRNA[0]);
51 }
52
53 const char *BLT_pgettext(const char *msgctxt, const char *msgid)
54 {
55 #ifdef WITH_INTERNATIONAL
56         const char *ret = msgid;
57
58         if (msgid && msgid[0]) {
59                 if (BLT_is_default_context(msgctxt)) {
60                         msgctxt = BLT_I18NCONTEXT_DEFAULT;
61                 }
62                 ret = bl_locale_pgettext(msgctxt, msgid);
63                 /* We assume if the returned string is the same (memory level) as the msgid, no translation was found,
64                  * and we can try py scripts' ones!
65                  */
66 #ifdef WITH_PYTHON
67                 if (ret == msgid) {
68                         ret = BPY_app_translations_py_pgettext(msgctxt, msgid);
69                 }
70 #endif
71         }
72
73         return ret;
74 #else
75         (void)msgctxt;
76         return msgid;
77 #endif
78 }
79
80 bool BLT_translate(void)
81 {
82 #ifdef WITH_INTERNATIONAL
83         return BLI_thread_is_main() && (U.transopts & USER_DOTRANSLATE);
84 #else
85         return false;
86 #endif
87 }
88
89 bool BLT_translate_iface(void)
90 {
91 #ifdef WITH_INTERNATIONAL
92         return BLT_translate() && (U.transopts & USER_TR_IFACE);
93 #else
94         return false;
95 #endif
96 }
97
98 bool BLT_translate_tooltips(void)
99 {
100 #ifdef WITH_INTERNATIONAL
101         return BLT_translate() && (U.transopts & USER_TR_TOOLTIPS);
102 #else
103         return false;
104 #endif
105 }
106
107 bool BLT_translate_new_dataname(void)
108 {
109 #ifdef WITH_INTERNATIONAL
110         return BLT_translate() && (U.transopts & USER_TR_NEWDATANAME);
111 #else
112         return false;
113 #endif
114 }
115
116 const char *BLT_translate_do(const char *msgctxt, const char *msgid)
117 {
118 #ifdef WITH_INTERNATIONAL
119         if (BLT_translate()) {
120                 return BLT_pgettext(msgctxt, msgid);
121         }
122         else {
123                 return msgid;
124         }
125 #else
126         (void)msgctxt;
127         return msgid;
128 #endif
129 }
130
131 const char *BLT_translate_do_iface(const char *msgctxt, const char *msgid)
132 {
133 #ifdef WITH_INTERNATIONAL
134         if (BLT_translate_iface()) {
135                 return BLT_pgettext(msgctxt, msgid);
136         }
137         else {
138                 return msgid;
139         }
140 #else
141         (void)msgctxt;
142         return msgid;
143 #endif
144 }
145
146 const char *BLT_translate_do_tooltip(const char *msgctxt, const char *msgid)
147 {
148 #ifdef WITH_INTERNATIONAL
149         if (BLT_translate_tooltips()) {
150                 return BLT_pgettext(msgctxt, msgid);
151         }
152         else {
153                 return msgid;
154         }
155 #else
156         (void)msgctxt;
157         return msgid;
158 #endif
159 }
160
161 const char *BLT_translate_do_new_dataname(const char *msgctxt, const char *msgid)
162 {
163 #ifdef WITH_INTERNATIONAL
164         if (BLT_translate_new_dataname()) {
165                 return BLT_pgettext(msgctxt, msgid);
166         }
167         else {
168                 return msgid;
169         }
170 #else
171         (void)msgctxt;
172         return msgid;
173 #endif
174 }