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