Merged changes in the trunk up to revision 51718.
[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 #define WITH_PYTHON /* for AUD_PyInit.h, possibly others */
32
33 #include <Python.h>
34
35 #include "bpy.h" 
36 #include "bpy_util.h" 
37 #include "bpy_rna.h"
38 #include "bpy_app.h"
39 #include "bpy_props.h"
40 #include "bpy_library.h"
41 #include "bpy_operator.h"
42
43 #include "BLI_path_util.h"
44 #include "BLI_string.h"
45 #include "BLI_bpath.h"
46 #include "BLI_utildefines.h"
47
48 #include "BKE_main.h"
49 #include "BKE_global.h" /* XXX, G.main only */
50 #include "BKE_blender.h"
51
52 #include "RNA_access.h"
53
54 #include "MEM_guardedalloc.h"
55
56 /* external util modules */
57 #include "../generic/idprop_py_api.h"
58 #include "../generic/bgl.h"
59 #include "../generic/blf_py_api.h"
60 #include "../mathutils/mathutils.h"
61
62 #include "BPy_Freestyle.h"
63
64 PyObject *bpy_package_py = NULL;
65
66 PyDoc_STRVAR(bpy_script_paths_doc,
67 ".. function:: script_paths()\n"
68 "\n"
69 "   Return 2 paths to blender scripts directories.\n"
70 "\n"
71 "   :return: (system, user) strings will be empty when not found.\n"
72 "   :rtype: tuple of strings\n"
73 );
74 static PyObject *bpy_script_paths(PyObject *UNUSED(self))
75 {
76         PyObject *ret = PyTuple_New(2);
77         PyObject *item;
78         char *path;
79
80         path = BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, NULL);
81         item = PyUnicode_DecodeFSDefault(path ? path : "");
82         BLI_assert(item != NULL);
83         PyTuple_SET_ITEM(ret, 0, item);
84         path = BLI_get_folder(BLENDER_USER_SCRIPTS, NULL);
85         item = PyUnicode_DecodeFSDefault(path ? path : "");
86         BLI_assert(item != NULL);
87         PyTuple_SET_ITEM(ret, 1, item);
88
89         return ret;
90 }
91
92 static int bpy_blend_paths_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src)
93 {
94         PyObject *list = (PyObject *)userdata;
95         PyObject *item = PyUnicode_DecodeFSDefault(path_src);
96         PyList_Append(list, item);
97         Py_DECREF(item);
98         return FALSE; /* never edits the path */
99 }
100
101 PyDoc_STRVAR(bpy_blend_paths_doc,
102 ".. function:: blend_paths(absolute=False, packed=False, local=False)\n"
103 "\n"
104 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
105 "\n"
106 "   :arg absolute: When true the paths returned are made absolute.\n"
107 "   :type absolute: boolean\n"
108 "   :arg packed: When true skip file paths for packed data.\n"
109 "   :type packed: boolean\n"
110 "   :arg local: When true skip linked library paths.\n"
111 "   :type local: boolean\n"
112 "   :return: path list.\n"
113 "   :rtype: list of strings\n"
114 );
115 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
116 {
117         int flag = 0;
118         PyObject *list;
119
120         int absolute = FALSE;
121         int packed   = FALSE;
122         int local    = FALSE;
123         static const char *kwlist[] = {"absolute", "packed", "local", NULL};
124
125         if (!PyArg_ParseTupleAndKeywords(args, kw, "|iii:blend_paths",
126                                          (char **)kwlist, &absolute, &packed, &local))
127         {
128                 return NULL;
129         }
130
131         if (absolute) flag |= BLI_BPATH_TRAVERSE_ABS;
132         if (!packed)  flag |= BLI_BPATH_TRAVERSE_SKIP_PACKED;
133         if (local)    flag |= BLI_BPATH_TRAVERSE_SKIP_LIBRARY;
134
135         list = PyList_New(0);
136
137         BLI_bpath_traverse_main(G.main, bpy_blend_paths_visit_cb, flag, (void *)list);
138
139         return list;
140 }
141
142
143 // PyDoc_STRVAR(bpy_user_resource_doc[] = // now in bpy/utils.py
144 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
145 {
146         char *type;
147         char *subdir = NULL;
148         int folder_id;
149         static const char *kwlist[] = {"type", "subdir", NULL};
150
151         char *path;
152
153         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", (char **)kwlist, &type, &subdir))
154                 return NULL;
155         
156         /* stupid string compare */
157         if      (!strcmp(type, "DATAFILES")) folder_id = BLENDER_USER_DATAFILES;
158         else if (!strcmp(type, "CONFIG"))    folder_id = BLENDER_USER_CONFIG;
159         else if (!strcmp(type, "SCRIPTS"))   folder_id = BLENDER_USER_SCRIPTS;
160         else if (!strcmp(type, "AUTOSAVE"))  folder_id = BLENDER_USER_AUTOSAVE;
161         else {
162                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
163                 return NULL;
164         }
165         
166         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
167         path = BLI_get_folder(folder_id, subdir);
168
169         if (!path)
170                 path = BLI_get_user_folder_notest(folder_id, subdir);
171
172         return PyUnicode_DecodeFSDefault(path ? path : "");
173 }
174
175 PyDoc_STRVAR(bpy_resource_path_doc,
176 ".. function:: resource_path(type, major=bpy.app.version[0], minor=bpy.app.version[1])\n"
177 "\n"
178 "   Return the base path for storing system files.\n"
179 "\n"
180 "   :arg type: string in ['USER', 'LOCAL', 'SYSTEM'].\n"
181 "   :type type: string\n"
182 "   :arg major: major version, defaults to current.\n"
183 "   :type major: int\n"
184 "   :arg minor: minor version, defaults to current.\n"
185 "   :type minor: string\n"
186 "   :return: the resource path (not necessarily existing).\n"
187 "   :rtype: string\n"
188 );
189 static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
190 {
191         char *type;
192         int major = BLENDER_VERSION / 100, minor = BLENDER_VERSION % 100;
193         static const char *kwlist[] = {"type", "major", "minor", NULL};
194         int folder_id;
195         char *path;
196
197         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ii:resource_path", (char **)kwlist, &type, &major, &minor))
198                 return NULL;
199
200         /* stupid string compare */
201         if      (!strcmp(type, "USER"))    folder_id = BLENDER_RESOURCE_PATH_USER;
202         else if (!strcmp(type, "LOCAL"))   folder_id = BLENDER_RESOURCE_PATH_LOCAL;
203         else if (!strcmp(type, "SYSTEM"))  folder_id = BLENDER_RESOURCE_PATH_SYSTEM;
204         else {
205                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
206                 return NULL;
207         }
208
209         path = BLI_get_folder_version(folder_id, (major * 100) + minor, FALSE);
210
211         return PyUnicode_DecodeFSDefault(path ? path : "");
212 }
213
214 static PyMethodDef meth_bpy_script_paths =
215         {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
216 static PyMethodDef meth_bpy_blend_paths =
217         {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS | METH_KEYWORDS, bpy_blend_paths_doc};
218 static PyMethodDef meth_bpy_user_resource =
219         {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS | METH_KEYWORDS, NULL};
220 static PyMethodDef meth_bpy_resource_path =
221         {"resource_path", (PyCFunction)bpy_resource_path, METH_VARARGS | METH_KEYWORDS, bpy_resource_path_doc};
222
223
224 static PyObject *bpy_import_test(const char *modname)
225 {
226         PyObject *mod = PyImport_ImportModuleLevel((char *)modname, NULL, NULL, NULL, 0);
227         if (mod) {
228                 Py_DECREF(mod);
229         }
230         else {
231                 PyErr_Print();
232                 PyErr_Clear();
233         }       
234
235         return mod;
236 }
237
238 /******************************************************************************
239  * Description: Creates the bpy module and adds it to sys.modules for importing
240  ******************************************************************************/
241 void BPy_init_modules(void)
242 {
243         extern BPy_StructRNA *bpy_context_module;
244         PointerRNA ctx_ptr;
245         PyObject *mod;
246
247         /* Needs to be first since this dir is needed for future modules */
248         char *modpath = BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, "modules");
249         if (modpath) {
250                 // printf("bpy: found module path '%s'.\n", modpath);
251                 PyObject *sys_path = PySys_GetObject("path"); /* borrow */
252                 PyObject *py_modpath = PyUnicode_FromString(modpath);
253                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
254                 Py_DECREF(py_modpath);
255         }
256         else {
257                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
258         }
259         /* stand alone utility modules not related to blender directly */
260         IDProp_Init_Types(); /* not actually a submodule, just types */
261         Freestyle_Init();
262
263         mod = PyModule_New("_bpy");
264
265         /* add the module so we can import it */
266         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
267         Py_DECREF(mod);
268
269         /* run first, initializes rna types */
270         BPY_rna_init();
271
272         /* needs to be first so bpy_types can run */
273         PyModule_AddObject(mod, "types", BPY_rna_types());
274
275         /* metaclass for idprop types, bpy_types.py needs access */
276         PyModule_AddObject(mod, "StructMetaPropGroup", (PyObject *)&pyrna_struct_meta_idprop_Type);
277
278         /* needs to be first so bpy_types can run */
279         BPY_library_module(mod);
280
281         bpy_import_test("bpy_types");
282         PyModule_AddObject(mod, "data", BPY_rna_module()); /* imports bpy_types by running this */
283         bpy_import_test("bpy_types");
284         PyModule_AddObject(mod, "props", BPY_rna_props());
285         /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
286         PyModule_AddObject(mod, "ops", BPY_operator_module());
287         PyModule_AddObject(mod, "app", BPY_app_struct());
288
289         /* bpy context */
290         RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
291         bpy_context_module = (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
292         /* odd that this is needed, 1 ref on creation and another for the module
293          * but without we get a crash on exit */
294         Py_INCREF(bpy_context_module);
295
296         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
297
298         /* utility func's that have nowhere else to go */
299         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
300         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
301         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
302         PyModule_AddObject(mod, meth_bpy_resource_path.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL));
303
304         /* register funcs (bpy_rna.c) */
305         PyModule_AddObject(mod, meth_bpy_register_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
306         PyModule_AddObject(mod, meth_bpy_unregister_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
307
308         /* add our own modules dir, this is a python package */
309         bpy_package_py = bpy_import_test("bpy");
310 }