Python i18n API. Many thanks to Campbell and Brecht for the reviews and suggestions!
[blender.git] / source / blender / python / intern / bpy_app.c
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  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/intern/bpy_app.c
24  *  \ingroup pythonintern
25  *
26  * This file defines a 'PyStructSequence' accessed via 'bpy.app', mostly
27  * exposing static applications variables such as version and buildinfo
28  * however some writable variables have been added such as 'debug' and 'tempdir'
29  */
30
31
32 #include <Python.h>
33
34 #include "bpy_app.h"
35
36 #include "bpy_app_ffmpeg.h"
37 #include "bpy_app_build_options.h"
38
39 #ifdef WITH_INTERNATIONAL
40 #  include "bpy_app_translations.h"
41 #endif
42
43 #include "bpy_app_handlers.h"
44 #include "bpy_driver.h"
45
46 #include "BLI_path_util.h"
47 #include "BLI_utildefines.h"
48
49
50 #include "BKE_blender.h"
51 #include "BKE_global.h"
52 #include "structseq.h"
53
54 #include "../generic/py_capi_utils.h"
55
56 #ifdef BUILD_DATE
57 extern char build_date[];
58 extern char build_time[];
59 extern char build_rev[];
60 extern char build_platform[];
61 extern char build_type[];
62 extern char build_cflags[];
63 extern char build_cxxflags[];
64 extern char build_linkflags[];
65 extern char build_system[];
66 #endif
67
68 static PyTypeObject BlenderAppType;
69
70 static PyStructSequence_Field app_info_fields[] = {
71         {(char *)"version", (char *)"The Blender version as a tuple of 3 numbers. eg. (2, 50, 11)"},
72         {(char *)"version_string", (char *)"The Blender version formatted as a string"},
73         {(char *)"version_char", (char *)"The Blender version character (for minor releases)"},
74         {(char *)"version_cycle", (char *)"The release status of this build alpha/beta/rc/release"},
75         {(char *)"binary_path", (char *)"The location of blenders executable, useful for utilities that spawn new instances"},
76         {(char *)"background", (char *)"Boolean, True when blender is running without a user interface (started with -b)"},
77
78         /* buildinfo */
79         {(char *)"build_date", (char *)"The date this blender instance was built"},
80         {(char *)"build_time", (char *)"The time this blender instance was built"},
81         {(char *)"build_revision", (char *)"The subversion revision this blender instance was built with"},
82         {(char *)"build_platform", (char *)"The platform this blender instance was built for"},
83         {(char *)"build_type", (char *)"The type of build (Release, Debug)"},
84         {(char *)"build_cflags", (char *)"C compiler flags"},
85         {(char *)"build_cxxflags", (char *)"C++ compiler flags"},
86         {(char *)"build_linkflags", (char *)"Binary linking flags"},
87         {(char *)"build_system", (char *)"Build system used"},
88
89         /* submodules */
90         {(char *)"ffmpeg", (char *)"FFmpeg library information backend"},
91         {(char *)"build_options", (char *)"A set containing most important enabled optional build features"},
92         {(char *)"handlers", (char *)"Application handler callbacks"},
93 #ifdef WITH_INTERNATIONAL
94         {(char *)"translations", (char *)"Application and addons internationalization API"},
95 #endif
96         {NULL},
97 };
98
99 static PyStructSequence_Desc app_info_desc = {
100         (char *)"bpy.app",     /* name */
101         (char *)"This module contains application values that remain unchanged during runtime.",    /* doc */
102         app_info_fields,    /* fields */
103         (sizeof(app_info_fields) / sizeof(PyStructSequence_Field)) - 1
104 };
105
106 static PyObject *make_app_info(void)
107 {
108         PyObject *app_info;
109         int pos = 0;
110
111         app_info = PyStructSequence_New(&BlenderAppType);
112         if (app_info == NULL) {
113                 return NULL;
114         }
115
116 #define SetIntItem(flag) \
117         PyStructSequence_SET_ITEM(app_info, pos++, PyLong_FromLong(flag))
118 #define SetStrItem(str) \
119         PyStructSequence_SET_ITEM(app_info, pos++, PyUnicode_FromString(str))
120 #define SetBytesItem(str) \
121         PyStructSequence_SET_ITEM(app_info, pos++, PyBytes_FromString(str))
122 #define SetObjItem(obj) \
123         PyStructSequence_SET_ITEM(app_info, pos++, obj)
124
125         SetObjItem(Py_BuildValue("(iii)",
126                                  BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION));
127         SetObjItem(PyUnicode_FromFormat("%d.%02d (sub %d)",
128                                         BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION));
129
130         SetStrItem(STRINGIFY(BLENDER_VERSION_CHAR));
131         SetStrItem(STRINGIFY(BLENDER_VERSION_CYCLE));
132         SetStrItem(BLI_program_path());
133         SetObjItem(PyBool_FromLong(G.background));
134
135         /* build info, use bytes since we can't assume _any_ encoding:
136          * see patch [#30154] for issue */
137 #ifdef BUILD_DATE
138         SetBytesItem(build_date);
139         SetBytesItem(build_time);
140         SetBytesItem(build_rev);
141         SetBytesItem(build_platform);
142         SetBytesItem(build_type);
143         SetBytesItem(build_cflags);
144         SetBytesItem(build_cxxflags);
145         SetBytesItem(build_linkflags);
146         SetBytesItem(build_system);
147 #else
148         SetBytesItem("Unknown");
149         SetBytesItem("Unknown");
150         SetBytesItem("Unknown");
151         SetBytesItem("Unknown");
152         SetBytesItem("Unknown");
153         SetBytesItem("Unknown");
154         SetBytesItem("Unknown");
155         SetBytesItem("Unknown");
156         SetBytesItem("Unknown");
157 #endif
158
159         SetObjItem(BPY_app_ffmpeg_struct());
160         SetObjItem(BPY_app_build_options_struct());
161         SetObjItem(BPY_app_handlers_struct());
162 #ifdef WITH_INTERNATIONAL
163         SetObjItem(BPY_app_translations_struct());
164 #endif
165
166 #undef SetIntItem
167 #undef SetStrItem
168 #undef SetBytesItem
169 #undef SetObjItem
170
171         if (PyErr_Occurred()) {
172                 Py_CLEAR(app_info);
173                 return NULL;
174         }
175         return app_info;
176 }
177
178 /* a few getsets because it makes sense for them to be in bpy.app even though
179  * they are not static */
180
181 PyDoc_STRVAR(bpy_app_debug_doc,
182 "Boolean, for debug info (started with --debug / --debug_* matching this attribute name)"
183 );
184 static PyObject *bpy_app_debug_get(PyObject *UNUSED(self), void *closure)
185 {
186         const int flag = GET_INT_FROM_POINTER(closure);
187         return PyBool_FromLong(G.debug & flag);
188 }
189
190 static int bpy_app_debug_set(PyObject *UNUSED(self), PyObject *value, void *closure)
191 {
192         const int flag = GET_INT_FROM_POINTER(closure);
193         const int param = PyObject_IsTrue(value);
194
195         if (param == -1) {
196                 PyErr_SetString(PyExc_TypeError, "bpy.app.debug can only be True/False");
197                 return -1;
198         }
199         
200         if (param)  G.debug |=  flag;
201         else        G.debug &= ~flag;
202         
203         return 0;
204 }
205
206 PyDoc_STRVAR(bpy_app_debug_value_doc,
207 "Int, number which can be set to non-zero values for testing purposes"
208 );
209 static PyObject *bpy_app_debug_value_get(PyObject *UNUSED(self), void *UNUSED(closure))
210 {
211         return PyLong_FromLong(G.debug_value);
212 }
213
214 static int bpy_app_debug_value_set(PyObject *UNUSED(self), PyObject *value, void *UNUSED(closure))
215 {
216         int param = PyLong_AsLong(value);
217
218         if (param == -1 && PyErr_Occurred()) {
219                 PyErr_SetString(PyExc_TypeError, "bpy.app.debug_value can only be set to a whole number");
220                 return -1;
221         }
222         
223         G.debug_value = param;
224
225         return 0;
226 }
227
228 PyDoc_STRVAR(bpy_app_tempdir_doc,
229 "String, the temp directory used by blender (read-only)"
230 );
231 static PyObject *bpy_app_tempdir_get(PyObject *UNUSED(self), void *UNUSED(closure))
232 {
233         return PyC_UnicodeFromByte(BLI_temporary_dir());
234 }
235
236 PyDoc_STRVAR(bpy_app_driver_dict_doc,
237 "Dictionary for drivers namespace, editable in-place, reset on file load (read-only)"
238 );
239 static PyObject *bpy_app_driver_dict_get(PyObject *UNUSED(self), void *UNUSED(closure))
240 {
241         if (bpy_pydriver_Dict == NULL) {
242                 if (bpy_pydriver_create_dict() != 0) {
243                         PyErr_SetString(PyExc_RuntimeError, "bpy.app.driver_namespace failed to create dictionary");
244                         return NULL;
245                 }
246         }
247
248         Py_INCREF(bpy_pydriver_Dict);
249         return bpy_pydriver_Dict;
250 }
251
252
253 static PyGetSetDef bpy_app_getsets[] = {
254         {(char *)"debug",        bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG},
255         {(char *)"debug_ffmpeg", bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_FFMPEG},
256         {(char *)"debug_python", bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_PYTHON},
257         {(char *)"debug_events", bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_EVENTS},
258         {(char *)"debug_handlers", bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_HANDLERS},
259         {(char *)"debug_wm",     bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_WM},
260
261         {(char *)"debug_value", bpy_app_debug_value_get, bpy_app_debug_value_set, (char *)bpy_app_debug_value_doc, NULL},
262         {(char *)"tempdir", bpy_app_tempdir_get, NULL, (char *)bpy_app_tempdir_doc, NULL},
263         {(char *)"driver_namespace", bpy_app_driver_dict_get, NULL, (char *)bpy_app_driver_dict_doc, NULL},
264         {NULL, NULL, NULL, NULL, NULL}
265 };
266
267 static void py_struct_seq_getset_init(void)
268 {
269         /* tricky dynamic members, not to py-spec! */
270         PyGetSetDef *getset;
271
272         for (getset = bpy_app_getsets; getset->name; getset++) {
273                 PyDict_SetItemString(BlenderAppType.tp_dict, getset->name, PyDescr_NewGetSet(&BlenderAppType, getset));
274         }
275 }
276 /* end dynamic bpy.app */
277
278
279 PyObject *BPY_app_struct(void)
280 {
281         PyObject *ret;
282         
283         PyStructSequence_InitType(&BlenderAppType, &app_info_desc);
284
285         ret = make_app_info();
286
287         /* prevent user from creating new instances */
288         BlenderAppType.tp_init = NULL;
289         BlenderAppType.tp_new = NULL;
290         BlenderAppType.tp_hash = (hashfunc)_Py_HashPointer; /* without this we can't do set(sys.modules) [#29635] */
291
292         /* kindof a hack ontop of PyStructSequence */
293         py_struct_seq_getset_init();
294
295         return ret;
296 }