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