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