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