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