Merge branch 'master' into blender2.8
[blender.git] / source / blender / python / intern / bpy.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.c
24  *  \ingroup pythonintern
25  *
26  * This file defines the '_bpy' module which is used by python's 'bpy' package
27  * to access C defined builtin functions.
28  * A script writer should never directly access this module.
29  */
30
31 #include <Python.h>
32
33 #include "BLI_utildefines.h"
34 #include "BLI_string.h"
35
36 #include "BKE_appdir.h"
37 #include "BKE_global.h" /* XXX, G.main only */
38 #include "BKE_blender_version.h"
39 #include "BKE_bpath.h"
40
41 #include "RNA_types.h"
42 #include "RNA_access.h"
43
44 #include "bpy.h"
45 #include "bpy_capi_utils.h"
46 #include "bpy_rna.h"
47 #include "bpy_app.h"
48 #include "bpy_rna_id_collection.h"
49 #include "bpy_rna_manipulator.h"
50 #include "bpy_props.h"
51 #include "bpy_library.h"
52 #include "bpy_operator.h"
53 #include "bpy_utils_previews.h"
54 #include "bpy_utils_units.h"
55
56 #include "../generic/py_capi_utils.h"
57 #include "../generic/python_utildefines.h"
58
59 /* external util modules */
60 #include "../generic/idprop_py_api.h"
61
62 #ifdef WITH_FREESTYLE
63 #  include "BPy_Freestyle.h"
64 #endif
65
66 PyObject *bpy_package_py = NULL;
67
68 PyDoc_STRVAR(bpy_script_paths_doc,
69 ".. function:: script_paths()\n"
70 "\n"
71 "   Return 2 paths to blender scripts directories.\n"
72 "\n"
73 "   :return: (system, user) strings will be empty when not found.\n"
74 "   :rtype: tuple of strings\n"
75 );
76 static PyObject *bpy_script_paths(PyObject *UNUSED(self))
77 {
78         PyObject *ret = PyTuple_New(2);
79         PyObject *item;
80         const char *path;
81
82         path = BKE_appdir_folder_id(BLENDER_SYSTEM_SCRIPTS, NULL);
83         item = PyC_UnicodeFromByte(path ? path : "");
84         BLI_assert(item != NULL);
85         PyTuple_SET_ITEM(ret, 0, item);
86         path = BKE_appdir_folder_id(BLENDER_USER_SCRIPTS, NULL);
87         item = PyC_UnicodeFromByte(path ? path : "");
88         BLI_assert(item != NULL);
89         PyTuple_SET_ITEM(ret, 1, item);
90
91         return ret;
92 }
93
94 static bool bpy_blend_paths_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src)
95 {
96         PyList_APPEND((PyObject *)userdata, PyC_UnicodeFromByte(path_src));
97         return false; /* never edits the path */
98 }
99
100 PyDoc_STRVAR(bpy_blend_paths_doc,
101 ".. function:: blend_paths(absolute=False, packed=False, local=False)\n"
102 "\n"
103 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
104 "\n"
105 "   :arg absolute: When true the paths returned are made absolute.\n"
106 "   :type absolute: boolean\n"
107 "   :arg packed: When true skip file paths for packed data.\n"
108 "   :type packed: boolean\n"
109 "   :arg local: When true skip linked library paths.\n"
110 "   :type local: boolean\n"
111 "   :return: path list.\n"
112 "   :rtype: list of strings\n"
113 );
114 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
115 {
116         int flag = 0;
117         PyObject *list;
118
119         bool absolute = false;
120         bool packed   = false;
121         bool local    = false;
122
123         static const char *_keywords[] = {"absolute", "packed", "local", NULL};
124         static _PyArg_Parser _parser = {"|O&O&O&:blend_paths", _keywords, 0};
125         if (!_PyArg_ParseTupleAndKeywordsFast(
126                 args, kw, &_parser,
127                 PyC_ParseBool, &absolute,
128                 PyC_ParseBool, &packed,
129                 PyC_ParseBool, &local))
130         {
131                 return NULL;
132         }
133
134         if (absolute) flag |= BKE_BPATH_TRAVERSE_ABS;
135         if (!packed)  flag |= BKE_BPATH_TRAVERSE_SKIP_PACKED;
136         if (local)    flag |= BKE_BPATH_TRAVERSE_SKIP_LIBRARY;
137
138         list = PyList_New(0);
139
140         BKE_bpath_traverse_main(G.main, bpy_blend_paths_visit_cb, flag, (void *)list);
141
142         return list;
143 }
144
145
146 // PyDoc_STRVAR(bpy_user_resource_doc[] = // now in bpy/utils.py
147 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
148 {
149         const char *type;
150         const char *subdir = NULL;
151         int folder_id;
152
153         const char *path;
154
155         static const char *_keywords[] = {"type", "subdir", NULL};
156         static _PyArg_Parser _parser = {"s|s:user_resource", _keywords, 0};
157         if (!_PyArg_ParseTupleAndKeywordsFast(
158                 args, kw, &_parser,
159                 &type, &subdir))
160         {
161                 return NULL;
162         }
163
164         /* stupid string compare */
165         if      (STREQ(type, "DATAFILES")) folder_id = BLENDER_USER_DATAFILES;
166         else if (STREQ(type, "CONFIG"))    folder_id = BLENDER_USER_CONFIG;
167         else if (STREQ(type, "SCRIPTS"))   folder_id = BLENDER_USER_SCRIPTS;
168         else if (STREQ(type, "AUTOSAVE"))  folder_id = BLENDER_USER_AUTOSAVE;
169         else {
170                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
171                 return NULL;
172         }
173         
174         /* same logic as BKE_appdir_folder_id_create(), but best leave it up to the script author to create */
175         path = BKE_appdir_folder_id(folder_id, subdir);
176
177         if (!path)
178                 path = BKE_appdir_folder_id_user_notest(folder_id, subdir);
179
180         return PyC_UnicodeFromByte(path ? path : "");
181 }
182
183 PyDoc_STRVAR(bpy_resource_path_doc,
184 ".. function:: resource_path(type, major=bpy.app.version[0], minor=bpy.app.version[1])\n"
185 "\n"
186 "   Return the base path for storing system files.\n"
187 "\n"
188 "   :arg type: string in ['USER', 'LOCAL', 'SYSTEM'].\n"
189 "   :type type: string\n"
190 "   :arg major: major version, defaults to current.\n"
191 "   :type major: int\n"
192 "   :arg minor: minor version, defaults to current.\n"
193 "   :type minor: string\n"
194 "   :return: the resource path (not necessarily existing).\n"
195 "   :rtype: string\n"
196 );
197 static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
198 {
199         const char *type;
200         int major = BLENDER_VERSION / 100, minor = BLENDER_VERSION % 100;
201         int folder_id;
202         const char *path;
203
204         static const char *_keywords[] = {"type", "major", "minor", NULL};
205         static _PyArg_Parser _parser = {"s|ii:resource_path", _keywords, 0};
206         if (!_PyArg_ParseTupleAndKeywordsFast(
207                 args, kw, &_parser,
208                 &type, &major, &minor))
209         {
210                 return NULL;
211         }
212
213         /* stupid string compare */
214         if      (STREQ(type, "USER"))    folder_id = BLENDER_RESOURCE_PATH_USER;
215         else if (STREQ(type, "LOCAL"))   folder_id = BLENDER_RESOURCE_PATH_LOCAL;
216         else if (STREQ(type, "SYSTEM"))  folder_id = BLENDER_RESOURCE_PATH_SYSTEM;
217         else {
218                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
219                 return NULL;
220         }
221
222         path = BKE_appdir_folder_id_version(folder_id, (major * 100) + minor, false);
223
224         return PyC_UnicodeFromByte(path ? path : "");
225 }
226
227 PyDoc_STRVAR(bpy_escape_identifier_doc,
228 ".. function:: escape_identifier(string)\n"
229 "\n"
230 "   Simple string escaping function used for animation paths.\n"
231 "\n"
232 "   :arg string: text\n"
233 "   :type string: string\n"
234 "   :return: The escaped string.\n"
235 "   :rtype: string\n"
236 );
237 static PyObject *bpy_escape_identifier(PyObject *UNUSED(self), PyObject *value)
238 {
239         const char *value_str;
240         Py_ssize_t  value_str_len;
241
242         char       *value_escape_str;
243         Py_ssize_t  value_escape_str_len;
244         PyObject   *value_escape;
245         size_t size;
246
247         value_str = _PyUnicode_AsStringAndSize(value, &value_str_len);
248
249         if (value_str == NULL) {
250                 PyErr_SetString(PyExc_TypeError, "expected a string");
251                 return NULL;
252         }
253
254         size = (value_str_len * 2) + 1;
255         value_escape_str = PyMem_MALLOC(size);
256         value_escape_str_len = BLI_strescape(value_escape_str, value_str, size);
257
258         if (value_escape_str_len == value_str_len) {
259                 Py_INCREF(value);
260                 value_escape = value;
261         }
262         else {
263                 value_escape = PyUnicode_FromStringAndSize(value_escape_str, value_escape_str_len);
264         }
265
266         PyMem_FREE(value_escape_str);
267
268         return value_escape;
269 }
270
271 static PyMethodDef meth_bpy_script_paths =
272         {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
273 static PyMethodDef meth_bpy_blend_paths =
274         {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS | METH_KEYWORDS, bpy_blend_paths_doc};
275 static PyMethodDef meth_bpy_user_resource =
276         {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS | METH_KEYWORDS, NULL};
277 static PyMethodDef meth_bpy_resource_path =
278         {"resource_path", (PyCFunction)bpy_resource_path, METH_VARARGS | METH_KEYWORDS, bpy_resource_path_doc};
279 static PyMethodDef meth_bpy_escape_identifier =
280         {"escape_identifier", (PyCFunction)bpy_escape_identifier, METH_O, bpy_escape_identifier_doc};
281
282 static PyObject *bpy_import_test(const char *modname)
283 {
284         PyObject *mod = PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
285         if (mod) {
286                 Py_DECREF(mod);
287         }
288         else {
289                 PyErr_Print();
290                 PyErr_Clear();
291         }
292
293         return mod;
294 }
295
296
297 /******************************************************************************
298  * Description: Creates the bpy module and adds it to sys.modules for importing
299  ******************************************************************************/
300 void BPy_init_modules(void)
301 {
302         extern BPy_StructRNA *bpy_context_module;
303         PointerRNA ctx_ptr;
304         PyObject *mod;
305
306         /* Needs to be first since this dir is needed for future modules */
307         const char * const modpath = BKE_appdir_folder_id(BLENDER_SYSTEM_SCRIPTS, "modules");
308         if (modpath) {
309                 // printf("bpy: found module path '%s'.\n", modpath);
310                 PyObject *sys_path = PySys_GetObject("path"); /* borrow */
311                 PyObject *py_modpath = PyUnicode_FromString(modpath);
312                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
313                 Py_DECREF(py_modpath);
314         }
315         else {
316                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
317         }
318         /* stand alone utility modules not related to blender directly */
319         IDProp_Init_Types(); /* not actually a submodule, just types */
320 #ifdef WITH_FREESTYLE
321         Freestyle_Init();
322 #endif
323
324         mod = PyModule_New("_bpy");
325
326         /* add the module so we can import it */
327         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
328         Py_DECREF(mod);
329
330         /* run first, initializes rna types */
331         BPY_rna_init();
332
333         /* needs to be first so bpy_types can run */
334         PyModule_AddObject(mod, "types", BPY_rna_types());
335
336         /* needs to be first so bpy_types can run */
337         BPY_library_load_module(mod);
338         BPY_library_write_module(mod);
339
340         BPY_rna_id_collection_module(mod);
341
342         BPY_rna_manipulator_module(mod);
343
344         bpy_import_test("bpy_types");
345         PyModule_AddObject(mod, "data", BPY_rna_module()); /* imports bpy_types by running this */
346         bpy_import_test("bpy_types");
347         PyModule_AddObject(mod, "props", BPY_rna_props());
348         /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
349         PyModule_AddObject(mod, "ops", BPY_operator_module());
350         PyModule_AddObject(mod, "app", BPY_app_struct());
351         PyModule_AddObject(mod, "_utils_units", BPY_utils_units());
352         PyModule_AddObject(mod, "_utils_previews", BPY_utils_previews_module());
353
354         /* bpy context */
355         RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
356         bpy_context_module = (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
357         /* odd that this is needed, 1 ref on creation and another for the module
358          * but without we get a crash on exit */
359         Py_INCREF(bpy_context_module);
360
361         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
362
363         /* register bpy/rna classmethod callbacks */
364         BPY_rna_register_cb();
365
366         /* utility func's that have nowhere else to go */
367         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
368         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
369         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
370         PyModule_AddObject(mod, meth_bpy_resource_path.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL));
371         PyModule_AddObject(mod, meth_bpy_escape_identifier.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_escape_identifier, NULL));
372
373         /* register funcs (bpy_rna.c) */
374         PyModule_AddObject(mod, meth_bpy_register_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
375         PyModule_AddObject(mod, meth_bpy_unregister_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
376
377         /* add our own modules dir, this is a python package */
378         bpy_package_py = bpy_import_test("bpy");
379 }