93c97d48bac27e86835f4d31d96fcd58a19e307b
[blender-staging.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_ocio.h"
38 #include "bpy_app_oiio.h"
39 #include "bpy_app_openvdb.h"
40 #include "bpy_app_sdl.h"
41 #include "bpy_app_build_options.h"
42
43 #include "bpy_app_translations.h"
44
45 #include "bpy_app_handlers.h"
46 #include "bpy_driver.h"
47
48 #include "BLI_utildefines.h"
49
50 #include "BKE_appdir.h"
51 #include "BKE_blender_version.h"
52 #include "BKE_global.h"
53
54 #include "DNA_ID.h"
55
56 #include "UI_interface_icons.h"
57
58 /* for notifiers */
59 #include "WM_api.h"
60 #include "WM_types.h"
61
62 #include "../generic/py_capi_utils.h"
63 #include "../generic/python_utildefines.h"
64
65 #ifdef BUILD_DATE
66 extern char build_date[];
67 extern char build_time[];
68 extern unsigned long build_commit_timestamp;
69 extern char build_commit_date[];
70 extern char build_commit_time[];
71 extern char build_hash[];
72 extern char build_branch[];
73 extern char build_platform[];
74 extern char build_type[];
75 extern char build_cflags[];
76 extern char build_cxxflags[];
77 extern char build_linkflags[];
78 extern char build_system[];
79 #endif
80
81 static PyTypeObject BlenderAppType;
82
83 static PyStructSequence_Field app_info_fields[] = {
84         {(char *)"version", (char *)"The Blender version as a tuple of 3 numbers. eg. (2, 50, 11)"},
85         {(char *)"version_string", (char *)"The Blender version formatted as a string"},
86         {(char *)"version_char", (char *)"The Blender version character (for minor releases)"},
87         {(char *)"version_cycle", (char *)"The release status of this build alpha/beta/rc/release"},
88         {(char *)"binary_path", (char *)"The location of blenders executable, useful for utilities that spawn new instances"},
89         {(char *)"background", (char *)"Boolean, True when blender is running without a user interface (started with -b)"},
90
91         /* buildinfo */
92         {(char *)"build_date", (char *)"The date this blender instance was built"},
93         {(char *)"build_time", (char *)"The time this blender instance was built"},
94         {(char *)"build_commit_timestamp", (char *)"The unix timestamp of commit this blender instance was built"},
95         {(char *)"build_commit_date", (char *)"The date of commit this blender instance was built"},
96         {(char *)"build_commit_time", (char *)"The time of commit this blender instance was built"},
97         {(char *)"build_hash", (char *)"The commit hash this blender instance was built with"},
98         {(char *)"build_branch", (char *)"The branch this blender instance was built from"},
99         {(char *)"build_platform", (char *)"The platform this blender instance was built for"},
100         {(char *)"build_type", (char *)"The type of build (Release, Debug)"},
101         {(char *)"build_cflags", (char *)"C compiler flags"},
102         {(char *)"build_cxxflags", (char *)"C++ compiler flags"},
103         {(char *)"build_linkflags", (char *)"Binary linking flags"},
104         {(char *)"build_system", (char *)"Build system used"},
105
106         /* submodules */
107         {(char *)"ffmpeg", (char *)"FFmpeg library information backend"},
108         {(char *)"ocio", (char *)"OpenColorIO library information backend"},
109         {(char *)"oiio", (char *)"OpenImageIO library information backend"},
110         {(char *)"openvdb", (char *)"OpenVDB library information backend"},
111         {(char *)"sdl", (char *)"SDL library information backend"},
112         {(char *)"build_options", (char *)"A set containing most important enabled optional build features"},
113         {(char *)"handlers", (char *)"Application handler callbacks"},
114         {(char *)"translations", (char *)"Application and addons internationalization API"},
115         {NULL},
116 };
117
118 static PyStructSequence_Desc app_info_desc = {
119         (char *)"bpy.app",     /* name */
120         (char *)"This module contains application values that remain unchanged during runtime.",    /* doc */
121         app_info_fields,    /* fields */
122         ARRAY_SIZE(app_info_fields) - 1
123 };
124
125 static PyObject *make_app_info(void)
126 {
127         PyObject *app_info;
128         int pos = 0;
129
130         app_info = PyStructSequence_New(&BlenderAppType);
131         if (app_info == NULL) {
132                 return NULL;
133         }
134 #define SetIntItem(flag) \
135         PyStructSequence_SET_ITEM(app_info, pos++, PyLong_FromLong(flag))
136 #define SetStrItem(str) \
137         PyStructSequence_SET_ITEM(app_info, pos++, PyUnicode_FromString(str))
138 #define SetBytesItem(str) \
139         PyStructSequence_SET_ITEM(app_info, pos++, PyBytes_FromString(str))
140 #define SetObjItem(obj) \
141         PyStructSequence_SET_ITEM(app_info, pos++, obj)
142
143         SetObjItem(Py_BuildValue("(iii)",
144                                  BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION));
145         SetObjItem(PyUnicode_FromFormat("%d.%02d (sub %d)",
146                                         BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION));
147
148         SetStrItem(STRINGIFY(BLENDER_VERSION_CHAR));
149         SetStrItem(STRINGIFY(BLENDER_VERSION_CYCLE));
150         SetStrItem(BKE_appdir_program_path());
151         SetObjItem(PyBool_FromLong(G.background));
152
153         /* build info, use bytes since we can't assume _any_ encoding:
154          * see patch [#30154] for issue */
155 #ifdef BUILD_DATE
156         SetBytesItem(build_date);
157         SetBytesItem(build_time);
158         SetIntItem(build_commit_timestamp);
159         SetBytesItem(build_commit_date);
160         SetBytesItem(build_commit_time);
161         SetBytesItem(build_hash);
162         SetBytesItem(build_branch);
163         SetBytesItem(build_platform);
164         SetBytesItem(build_type);
165         SetBytesItem(build_cflags);
166         SetBytesItem(build_cxxflags);
167         SetBytesItem(build_linkflags);
168         SetBytesItem(build_system);
169 #else
170         SetBytesItem("Unknown");
171         SetBytesItem("Unknown");
172         SetIntItem(0);
173         SetBytesItem("Unknown");
174         SetBytesItem("Unknown");
175         SetBytesItem("Unknown");
176         SetBytesItem("Unknown");
177         SetBytesItem("Unknown");
178         SetBytesItem("Unknown");
179         SetBytesItem("Unknown");
180         SetBytesItem("Unknown");
181         SetBytesItem("Unknown");
182         SetBytesItem("Unknown");
183 #endif
184
185         SetObjItem(BPY_app_ffmpeg_struct());
186         SetObjItem(BPY_app_ocio_struct());
187         SetObjItem(BPY_app_oiio_struct());
188         SetObjItem(BPY_app_openvdb_struct());
189         SetObjItem(BPY_app_sdl_struct());
190         SetObjItem(BPY_app_build_options_struct());
191         SetObjItem(BPY_app_handlers_struct());
192         SetObjItem(BPY_app_translations_struct());
193
194 #undef SetIntItem
195 #undef SetStrItem
196 #undef SetBytesItem
197 #undef SetObjItem
198
199         if (PyErr_Occurred()) {
200                 Py_CLEAR(app_info);
201                 return NULL;
202         }
203         return app_info;
204 }
205
206 /* a few getsets because it makes sense for them to be in bpy.app even though
207  * they are not static */
208
209 PyDoc_STRVAR(bpy_app_debug_doc,
210 "Boolean, for debug info (started with --debug / --debug_* matching this attribute name)"
211 );
212 static PyObject *bpy_app_debug_get(PyObject *UNUSED(self), void *closure)
213 {
214         const int flag = GET_INT_FROM_POINTER(closure);
215         return PyBool_FromLong(G.debug & flag);
216 }
217
218 static int bpy_app_debug_set(PyObject *UNUSED(self), PyObject *value, void *closure)
219 {
220         const int flag = GET_INT_FROM_POINTER(closure);
221         const int param = PyObject_IsTrue(value);
222
223         if (param == -1) {
224                 PyErr_SetString(PyExc_TypeError, "bpy.app.debug can only be True/False");
225                 return -1;
226         }
227         
228         if (param)  G.debug |=  flag;
229         else        G.debug &= ~flag;
230         
231         return 0;
232 }
233
234
235
236 PyDoc_STRVAR(bpy_app_binary_path_python_doc,
237 "String, the path to the python executable (read-only)"
238 );
239 static PyObject *bpy_app_binary_path_python_get(PyObject *UNUSED(self), void *UNUSED(closure))
240 {
241         /* refcount is held in BlenderAppType.tp_dict */
242         static PyObject *ret = NULL;
243
244         if (ret == NULL) {
245                 /* only run once */
246                 char fullpath[1024];
247                 BKE_appdir_program_python_search(
248                         fullpath, sizeof(fullpath),
249                         PY_MAJOR_VERSION, PY_MINOR_VERSION);
250                 ret = PyC_UnicodeFromByte(fullpath);
251                 PyDict_SetItemString(BlenderAppType.tp_dict, "binary_path_python", ret);
252         }
253         else {
254                 Py_INCREF(ret);
255         }
256
257         return ret;
258
259 }
260
261 PyDoc_STRVAR(bpy_app_debug_value_doc,
262 "Int, number which can be set to non-zero values for testing purposes"
263 );
264 static PyObject *bpy_app_debug_value_get(PyObject *UNUSED(self), void *UNUSED(closure))
265 {
266         return PyLong_FromLong(G.debug_value);
267 }
268
269 static int bpy_app_debug_value_set(PyObject *UNUSED(self), PyObject *value, void *UNUSED(closure))
270 {
271         int param = PyLong_AsLong(value);
272
273         if (param == -1 && PyErr_Occurred()) {
274                 PyErr_SetString(PyExc_TypeError, "bpy.app.debug_value can only be set to a whole number");
275                 return -1;
276         }
277         
278         G.debug_value = param;
279
280         WM_main_add_notifier(NC_WINDOW, NULL);
281
282         return 0;
283 }
284
285 static PyObject *bpy_app_global_flag_get(PyObject *UNUSED(self), void *closure)
286 {
287         const int flag = GET_INT_FROM_POINTER(closure);
288         return PyBool_FromLong(G.f & flag);
289 }
290
291 PyDoc_STRVAR(bpy_app_tempdir_doc,
292 "String, the temp directory used by blender (read-only)"
293 );
294 static PyObject *bpy_app_tempdir_get(PyObject *UNUSED(self), void *UNUSED(closure))
295 {
296         return PyC_UnicodeFromByte(BKE_tempdir_session());
297 }
298
299 PyDoc_STRVAR(bpy_app_driver_dict_doc,
300 "Dictionary for drivers namespace, editable in-place, reset on file load (read-only)"
301 );
302 static PyObject *bpy_app_driver_dict_get(PyObject *UNUSED(self), void *UNUSED(closure))
303 {
304         if (bpy_pydriver_Dict == NULL) {
305                 if (bpy_pydriver_create_dict() != 0) {
306                         PyErr_SetString(PyExc_RuntimeError, "bpy.app.driver_namespace failed to create dictionary");
307                         return NULL;
308                 }
309         }
310
311         return Py_INCREF_RET(bpy_pydriver_Dict);
312 }
313
314 PyDoc_STRVAR(bpy_app_preview_render_size_doc,
315 "Reference size for icon/preview renders (read-only)"
316 );
317 static PyObject *bpy_app_preview_render_size_get(PyObject *UNUSED(self), void *closure)
318 {
319         return PyLong_FromLong((long)UI_preview_render_size(GET_INT_FROM_POINTER(closure)));
320 }
321
322 static PyObject *bpy_app_autoexec_fail_message_get(PyObject *UNUSED(self), void *UNUSED(closure))
323 {
324         return PyC_UnicodeFromByte(G.autoexec_fail);
325 }
326
327
328 static PyGetSetDef bpy_app_getsets[] = {
329         {(char *)"debug",           bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG},
330         {(char *)"debug_ffmpeg",    bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_FFMPEG},
331         {(char *)"debug_freestyle", bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_FREESTYLE},
332         {(char *)"debug_python",    bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_PYTHON},
333         {(char *)"debug_events",    bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_EVENTS},
334         {(char *)"debug_handlers",  bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_HANDLERS},
335         {(char *)"debug_wm",        bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_WM},
336         {(char *)"debug_depsgraph", bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_DEPSGRAPH},
337         {(char *)"debug_simdata",   bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_SIMDATA},
338         {(char *)"debug_gpumem",    bpy_app_debug_get, bpy_app_debug_set, (char *)bpy_app_debug_doc, (void *)G_DEBUG_GPU_MEM},
339
340         {(char *)"binary_path_python", bpy_app_binary_path_python_get, NULL, (char *)bpy_app_binary_path_python_doc, NULL},
341
342         {(char *)"debug_value", bpy_app_debug_value_get, bpy_app_debug_value_set, (char *)bpy_app_debug_value_doc, NULL},
343         {(char *)"tempdir", bpy_app_tempdir_get, NULL, (char *)bpy_app_tempdir_doc, NULL},
344         {(char *)"driver_namespace", bpy_app_driver_dict_get, NULL, (char *)bpy_app_driver_dict_doc, NULL},
345
346         {(char *)"render_icon_size", bpy_app_preview_render_size_get, NULL, (char *)bpy_app_preview_render_size_doc, (void *)ICON_SIZE_ICON},
347         {(char *)"render_preview_size", bpy_app_preview_render_size_get, NULL, (char *)bpy_app_preview_render_size_doc, (void *)ICON_SIZE_PREVIEW},
348
349         /* security */
350         {(char *)"autoexec_fail", bpy_app_global_flag_get, NULL, NULL, (void *)G_SCRIPT_AUTOEXEC_FAIL},
351         {(char *)"autoexec_fail_quiet", bpy_app_global_flag_get, NULL, NULL, (void *)G_SCRIPT_AUTOEXEC_FAIL_QUIET},
352         {(char *)"autoexec_fail_message", bpy_app_autoexec_fail_message_get, NULL, NULL, NULL},
353         {NULL, NULL, NULL, NULL, NULL}
354 };
355
356 static void py_struct_seq_getset_init(void)
357 {
358         /* tricky dynamic members, not to py-spec! */
359         for (PyGetSetDef *getset = bpy_app_getsets; getset->name; getset++) {
360                 PyObject *item = PyDescr_NewGetSet(&BlenderAppType, getset);
361                 PyDict_SetItemString(BlenderAppType.tp_dict, getset->name, item);
362                 Py_DECREF(item);
363         }
364 }
365 /* end dynamic bpy.app */
366
367
368 PyObject *BPY_app_struct(void)
369 {
370         PyObject *ret;
371         
372         PyStructSequence_InitType(&BlenderAppType, &app_info_desc);
373
374         ret = make_app_info();
375
376         /* prevent user from creating new instances */
377         BlenderAppType.tp_init = NULL;
378         BlenderAppType.tp_new = NULL;
379         BlenderAppType.tp_hash = (hashfunc)_Py_HashPointer; /* without this we can't do set(sys.modules) [#29635] */
380
381         /* kindof a hack ontop of PyStructSequence */
382         py_struct_seq_getset_init();
383
384         return ret;
385 }