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