CMake: add WITH_LINKER_LLD option for unix platforms
[blender-staging.git] / source / blender / python / intern / bpy.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup pythonintern
19  *
20  * This file defines the '_bpy' module which is used by python's 'bpy' package
21  * to access C defined builtin functions.
22  * A script writer should never directly access this module.
23  */
24
25 #include <Python.h>
26
27 #include "BLI_string.h"
28 #include "BLI_utildefines.h"
29
30 #include "BKE_appdir.h"
31 #include "BKE_blender_version.h"
32 #include "BKE_bpath.h"
33 #include "BKE_global.h" /* XXX, G_MAIN only */
34
35 #include "RNA_access.h"
36 #include "RNA_types.h"
37
38 #include "bpy.h"
39 #include "bpy_app.h"
40 #include "bpy_capi_utils.h"
41 #include "bpy_library.h"
42 #include "bpy_operator.h"
43 #include "bpy_props.h"
44 #include "bpy_rna.h"
45 #include "bpy_rna_gizmo.h"
46 #include "bpy_rna_id_collection.h"
47 #include "bpy_utils_previews.h"
48 #include "bpy_utils_units.h"
49
50 #include "../generic/py_capi_utils.h"
51 #include "../generic/python_utildefines.h"
52
53 /* external util modules */
54 #include "../generic/idprop_py_api.h"
55 #include "bpy_msgbus.h"
56
57 #ifdef WITH_FREESTYLE
58 #  include "BPy_Freestyle.h"
59 #endif
60
61 PyObject *bpy_package_py = NULL;
62
63 PyDoc_STRVAR(bpy_script_paths_doc,
64              ".. function:: script_paths()\n"
65              "\n"
66              "   Return 2 paths to blender scripts directories.\n"
67              "\n"
68              "   :return: (system, user) strings will be empty when not found.\n"
69              "   :rtype: tuple of strings\n");
70 static PyObject *bpy_script_paths(PyObject *UNUSED(self))
71 {
72   PyObject *ret = PyTuple_New(2);
73   PyObject *item;
74   const char *path;
75
76   path = BKE_appdir_folder_id(BLENDER_SYSTEM_SCRIPTS, NULL);
77   item = PyC_UnicodeFromByte(path ? path : "");
78   BLI_assert(item != NULL);
79   PyTuple_SET_ITEM(ret, 0, item);
80   path = BKE_appdir_folder_id(BLENDER_USER_SCRIPTS, NULL);
81   item = PyC_UnicodeFromByte(path ? path : "");
82   BLI_assert(item != NULL);
83   PyTuple_SET_ITEM(ret, 1, item);
84
85   return ret;
86 }
87
88 static bool bpy_blend_paths_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src)
89 {
90   PyList_APPEND((PyObject *)userdata, PyC_UnicodeFromByte(path_src));
91   return false; /* never edits the path */
92 }
93
94 PyDoc_STRVAR(bpy_blend_paths_doc,
95              ".. function:: blend_paths(absolute=False, packed=False, local=False)\n"
96              "\n"
97              "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
98              "\n"
99              "   :arg absolute: When true the paths returned are made absolute.\n"
100              "   :type absolute: boolean\n"
101              "   :arg packed: When true skip file paths for packed data.\n"
102              "   :type packed: boolean\n"
103              "   :arg local: When true skip linked library paths.\n"
104              "   :type local: boolean\n"
105              "   :return: path list.\n"
106              "   :rtype: list of strings\n");
107 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
108 {
109   int flag = 0;
110   PyObject *list;
111
112   bool absolute = false;
113   bool packed = false;
114   bool local = false;
115
116   static const char *_keywords[] = {"absolute", "packed", "local", NULL};
117   static _PyArg_Parser _parser = {"|O&O&O&:blend_paths", _keywords, 0};
118   if (!_PyArg_ParseTupleAndKeywordsFast(args,
119                                         kw,
120                                         &_parser,
121                                         PyC_ParseBool,
122                                         &absolute,
123                                         PyC_ParseBool,
124                                         &packed,
125                                         PyC_ParseBool,
126                                         &local)) {
127     return NULL;
128   }
129
130   if (absolute) {
131     flag |= BKE_BPATH_TRAVERSE_ABS;
132   }
133   if (!packed) {
134     flag |= BKE_BPATH_TRAVERSE_SKIP_PACKED;
135   }
136   if (local) {
137     flag |= BKE_BPATH_TRAVERSE_SKIP_LIBRARY;
138   }
139
140   list = PyList_New(0);
141
142   BKE_bpath_traverse_main(G_MAIN, bpy_blend_paths_visit_cb, flag, (void *)list);
143
144   return list;
145 }
146
147 // PyDoc_STRVAR(bpy_user_resource_doc[] = // now in bpy/utils.py
148 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
149 {
150   const struct PyC_StringEnumItems type_items[] = {
151       {BLENDER_USER_DATAFILES, "DATAFILES"},
152       {BLENDER_USER_CONFIG, "CONFIG"},
153       {BLENDER_USER_SCRIPTS, "SCRIPTS"},
154       {BLENDER_USER_AUTOSAVE, "AUTOSAVE"},
155       {0, NULL},
156   };
157   struct PyC_StringEnum type = {type_items};
158
159   const char *subdir = NULL;
160
161   const char *path;
162
163   static const char *_keywords[] = {"type", "subdir", NULL};
164   static _PyArg_Parser _parser = {"O&|s:user_resource", _keywords, 0};
165   if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, PyC_ParseStringEnum, &type, &subdir)) {
166     return NULL;
167   }
168
169   /* same logic as BKE_appdir_folder_id_create(),
170    * but best leave it up to the script author to create */
171   path = BKE_appdir_folder_id_user_notest(type.value_found, subdir);
172
173   return PyC_UnicodeFromByte(path ? path : "");
174 }
175
176 PyDoc_STRVAR(bpy_system_resource_doc,
177              ".. function:: system_resource(type, path=\"\")\n"
178              "\n"
179              "   Return a system resource path.\n"
180              "\n"
181              "   :arg type: string in ['DATAFILES', 'SCRIPTS', 'PYTHON'].\n"
182              "   :type type: string\n"
183              "   :arg path: Optional subdirectory.\n"
184              "   :type path: string\n");
185 static PyObject *bpy_system_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
186 {
187   const struct PyC_StringEnumItems type_items[] = {
188       {BLENDER_SYSTEM_DATAFILES, "DATAFILES"},
189       {BLENDER_SYSTEM_SCRIPTS, "SCRIPTS"},
190       {BLENDER_SYSTEM_PYTHON, "PYTHON"},
191       {0, NULL},
192   };
193   struct PyC_StringEnum type = {type_items};
194
195   const char *subdir = NULL;
196
197   const char *path;
198
199   static const char *_keywords[] = {"type", "path", NULL};
200   static _PyArg_Parser _parser = {"O&|s:system_resource", _keywords, 0};
201   if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, PyC_ParseStringEnum, &type, &subdir)) {
202     return NULL;
203   }
204
205   path = BKE_appdir_folder_id(type.value_found, subdir);
206
207   return PyC_UnicodeFromByte(path ? path : "");
208 }
209
210 PyDoc_STRVAR(
211     bpy_resource_path_doc,
212     ".. function:: resource_path(type, major=bpy.app.version[0], minor=bpy.app.version[1])\n"
213     "\n"
214     "   Return the base path for storing system files.\n"
215     "\n"
216     "   :arg type: string in ['USER', 'LOCAL', 'SYSTEM'].\n"
217     "   :type type: string\n"
218     "   :arg major: major version, defaults to current.\n"
219     "   :type major: int\n"
220     "   :arg minor: minor version, defaults to current.\n"
221     "   :type minor: string\n"
222     "   :return: the resource path (not necessarily existing).\n"
223     "   :rtype: string\n");
224 static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
225 {
226   const struct PyC_StringEnumItems type_items[] = {
227       {BLENDER_RESOURCE_PATH_USER, "USER"},
228       {BLENDER_RESOURCE_PATH_LOCAL, "LOCAL"},
229       {BLENDER_RESOURCE_PATH_SYSTEM, "SYSTEM"},
230       {0, NULL},
231   };
232   struct PyC_StringEnum type = {type_items};
233
234   int major = BLENDER_VERSION / 100, minor = BLENDER_VERSION % 100;
235   const char *path;
236
237   static const char *_keywords[] = {"type", "major", "minor", NULL};
238   static _PyArg_Parser _parser = {"O&|ii:resource_path", _keywords, 0};
239   if (!_PyArg_ParseTupleAndKeywordsFast(
240           args, kw, &_parser, PyC_ParseStringEnum, &type, &major, &minor)) {
241     return NULL;
242   }
243
244   path = BKE_appdir_folder_id_version(type.value_found, (major * 100) + minor, false);
245
246   return PyC_UnicodeFromByte(path ? path : "");
247 }
248
249 PyDoc_STRVAR(bpy_escape_identifier_doc,
250              ".. function:: escape_identifier(string)\n"
251              "\n"
252              "   Simple string escaping function used for animation paths.\n"
253              "\n"
254              "   :arg string: text\n"
255              "   :type string: string\n"
256              "   :return: The escaped string.\n"
257              "   :rtype: string\n");
258 static PyObject *bpy_escape_identifier(PyObject *UNUSED(self), PyObject *value)
259 {
260   const char *value_str;
261   Py_ssize_t value_str_len;
262
263   char *value_escape_str;
264   Py_ssize_t value_escape_str_len;
265   PyObject *value_escape;
266   size_t size;
267
268   value_str = _PyUnicode_AsStringAndSize(value, &value_str_len);
269
270   if (value_str == NULL) {
271     PyErr_SetString(PyExc_TypeError, "expected a string");
272     return NULL;
273   }
274
275   size = (value_str_len * 2) + 1;
276   value_escape_str = PyMem_MALLOC(size);
277   value_escape_str_len = BLI_strescape(value_escape_str, value_str, size);
278
279   if (value_escape_str_len == value_str_len) {
280     Py_INCREF(value);
281     value_escape = value;
282   }
283   else {
284     value_escape = PyUnicode_FromStringAndSize(value_escape_str, value_escape_str_len);
285   }
286
287   PyMem_FREE(value_escape_str);
288
289   return value_escape;
290 }
291
292 static PyMethodDef meth_bpy_script_paths = {
293     "script_paths",
294     (PyCFunction)bpy_script_paths,
295     METH_NOARGS,
296     bpy_script_paths_doc,
297 };
298 static PyMethodDef meth_bpy_blend_paths = {
299     "blend_paths",
300     (PyCFunction)bpy_blend_paths,
301     METH_VARARGS | METH_KEYWORDS,
302     bpy_blend_paths_doc,
303 };
304 static PyMethodDef meth_bpy_user_resource = {
305     "user_resource",
306     (PyCFunction)bpy_user_resource,
307     METH_VARARGS | METH_KEYWORDS,
308     NULL,
309 };
310 static PyMethodDef meth_bpy_system_resource = {
311     "system_resource",
312     (PyCFunction)bpy_system_resource,
313     METH_VARARGS | METH_KEYWORDS,
314     bpy_system_resource_doc,
315 };
316 static PyMethodDef meth_bpy_resource_path = {
317     "resource_path",
318     (PyCFunction)bpy_resource_path,
319     METH_VARARGS | METH_KEYWORDS,
320     bpy_resource_path_doc,
321 };
322 static PyMethodDef meth_bpy_escape_identifier = {
323     "escape_identifier",
324     (PyCFunction)bpy_escape_identifier,
325     METH_O,
326     bpy_escape_identifier_doc,
327 };
328
329 static PyObject *bpy_import_test(const char *modname)
330 {
331   PyObject *mod = PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
332   if (mod) {
333     Py_DECREF(mod);
334   }
335   else {
336     PyErr_Print();
337     PyErr_Clear();
338   }
339
340   return mod;
341 }
342
343 /******************************************************************************
344  * Description: Creates the bpy module and adds it to sys.modules for importing
345  ******************************************************************************/
346 void BPy_init_modules(void)
347 {
348   PointerRNA ctx_ptr;
349   PyObject *mod;
350
351   /* Needs to be first since this dir is needed for future modules */
352   const char *const modpath = BKE_appdir_folder_id(BLENDER_SYSTEM_SCRIPTS, "modules");
353   if (modpath) {
354     // printf("bpy: found module path '%s'.\n", modpath);
355     PyObject *sys_path = PySys_GetObject("path"); /* borrow */
356     PyObject *py_modpath = PyUnicode_FromString(modpath);
357     PyList_Insert(sys_path, 0, py_modpath); /* add first */
358     Py_DECREF(py_modpath);
359   }
360   else {
361     printf("bpy: couldn't find 'scripts/modules', blender probably wont start.\n");
362   }
363   /* stand alone utility modules not related to blender directly */
364   IDProp_Init_Types(); /* not actually a submodule, just types */
365 #ifdef WITH_FREESTYLE
366   Freestyle_Init();
367 #endif
368
369   mod = PyModule_New("_bpy");
370
371   /* add the module so we can import it */
372   PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
373   Py_DECREF(mod);
374
375   /* run first, initializes rna types */
376   BPY_rna_init();
377
378   /* needs to be first so bpy_types can run */
379   PyModule_AddObject(mod, "types", BPY_rna_types());
380
381   /* needs to be first so bpy_types can run */
382   BPY_library_load_module(mod);
383   BPY_library_write_module(mod);
384
385   BPY_rna_id_collection_module(mod);
386
387   BPY_rna_gizmo_module(mod);
388
389   bpy_import_test("bpy_types");
390   PyModule_AddObject(mod, "data", BPY_rna_module()); /* imports bpy_types by running this */
391   bpy_import_test("bpy_types");
392   PyModule_AddObject(mod, "props", BPY_rna_props());
393   /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
394   PyModule_AddObject(mod, "ops", BPY_operator_module());
395   PyModule_AddObject(mod, "app", BPY_app_struct());
396   PyModule_AddObject(mod, "_utils_units", BPY_utils_units());
397   PyModule_AddObject(mod, "_utils_previews", BPY_utils_previews_module());
398   PyModule_AddObject(mod, "msgbus", BPY_msgbus_module());
399
400   /* bpy context */
401   RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
402   bpy_context_module = (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
403   /* odd that this is needed, 1 ref on creation and another for the module
404    * but without we get a crash on exit */
405   Py_INCREF(bpy_context_module);
406
407   PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
408
409   /* register bpy/rna classmethod callbacks */
410   BPY_rna_register_cb();
411
412   /* utility func's that have nowhere else to go */
413   PyModule_AddObject(mod,
414                      meth_bpy_script_paths.ml_name,
415                      (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
416   PyModule_AddObject(
417       mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
418   PyModule_AddObject(mod,
419                      meth_bpy_user_resource.ml_name,
420                      (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
421   PyModule_AddObject(mod,
422                      meth_bpy_system_resource.ml_name,
423                      (PyObject *)PyCFunction_New(&meth_bpy_system_resource, NULL));
424   PyModule_AddObject(mod,
425                      meth_bpy_resource_path.ml_name,
426                      (PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL));
427   PyModule_AddObject(mod,
428                      meth_bpy_escape_identifier.ml_name,
429                      (PyObject *)PyCFunction_New(&meth_bpy_escape_identifier, NULL));
430
431   /* register funcs (bpy_rna.c) */
432   PyModule_AddObject(mod,
433                      meth_bpy_register_class.ml_name,
434                      (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
435   PyModule_AddObject(mod,
436                      meth_bpy_unregister_class.ml_name,
437                      (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
438
439   PyModule_AddObject(mod,
440                      meth_bpy_owner_id_get.ml_name,
441                      (PyObject *)PyCFunction_New(&meth_bpy_owner_id_get, NULL));
442   PyModule_AddObject(mod,
443                      meth_bpy_owner_id_set.ml_name,
444                      (PyObject *)PyCFunction_New(&meth_bpy_owner_id_set, NULL));
445
446   /* add our own modules dir, this is a python package */
447   bpy_package_py = bpy_import_test("bpy");
448 }