Merged changes in the trunk up to revision 46045.
[blender-staging.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         PyObject *item;
77         char *path;
78
79         path = BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, NULL);
80         item = PyUnicode_DecodeFSDefault(path ? path : "");
81         BLI_assert(item != NULL);
82         PyTuple_SET_ITEM(ret, 0, item);
83         path = BLI_get_folder(BLENDER_USER_SCRIPTS, NULL);
84         item = PyUnicode_DecodeFSDefault(path ? path : "");
85         BLI_assert(item != NULL);
86         PyTuple_SET_ITEM(ret, 1, item);
87
88         return ret;
89 }
90
91 static int bpy_blend_paths_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src)
92 {
93         PyObject *list = (PyObject *)userdata;
94         PyObject *item = PyUnicode_DecodeFSDefault(path_src);
95         PyList_Append(list, item);
96         Py_DECREF(item);
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         int absolute = FALSE;
120         int packed =   FALSE;
121         int local =    FALSE;
122         static const char *kwlist[] = {"absolute", "packed", "local", NULL};
123
124         if (!PyArg_ParseTupleAndKeywords(args, kw, "|ii:blend_paths",
125                                          (char **)kwlist, &absolute, &packed))
126         {
127                 return NULL;
128         }
129
130         if (absolute) flag |= BPATH_TRAVERSE_ABS;
131         if (!packed)  flag |= BPATH_TRAVERSE_SKIP_PACKED;
132         if (local)    flag |= BPATH_TRAVERSE_SKIP_LIBRARY;
133
134         list = PyList_New(0);
135
136         bpath_traverse_main(G.main, bpy_blend_paths_visit_cb, flag, (void *)list);
137
138         return list;
139 }
140
141
142 // PyDoc_STRVAR(bpy_user_resource_doc[] = // now in bpy/utils.py
143 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
144 {
145         char *type;
146         char *subdir = NULL;
147         int folder_id;
148         static const char *kwlist[] = {"type", "subdir", NULL};
149
150         char *path;
151
152         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", (char **)kwlist, &type, &subdir))
153                 return NULL;
154         
155         /* stupid string compare */
156         if      (!strcmp(type, "DATAFILES")) folder_id = BLENDER_USER_DATAFILES;
157         else if (!strcmp(type, "CONFIG"))    folder_id = BLENDER_USER_CONFIG;
158         else if (!strcmp(type, "SCRIPTS"))   folder_id = BLENDER_USER_SCRIPTS;
159         else if (!strcmp(type, "AUTOSAVE"))  folder_id = BLENDER_USER_AUTOSAVE;
160         else {
161                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
162                 return NULL;
163         }
164         
165         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
166         path = BLI_get_folder(folder_id, subdir);
167
168         if (!path)
169                 path = BLI_get_user_folder_notest(folder_id, subdir);
170
171         return PyUnicode_DecodeFSDefault(path ? path : "");
172 }
173
174 PyDoc_STRVAR(bpy_resource_path_doc,
175 ".. function:: resource_path(type, major=2, minor=57)\n"
176 "\n"
177 "   Return the base path for storing system files.\n"
178 "\n"
179 "   :arg type: string in ['USER', 'LOCAL', 'SYSTEM'].\n"
180 "   :type type: string\n"
181 "   :arg major: major version, defaults to current.\n"
182 "   :type major: int\n"
183 "   :arg minor: minor version, defaults to current.\n"
184 "   :type minor: string\n"
185 "   :return: the resource path (not necessarily existing).\n"
186 "   :rtype: string\n"
187 );
188 static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
189 {
190         char *type;
191         int major = BLENDER_VERSION / 100, minor = BLENDER_VERSION % 100;
192         static const char *kwlist[] = {"type", "major", "minor", NULL};
193         int folder_id;
194         char *path;
195
196         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ii:resource_path", (char **)kwlist, &type, &major, &minor))
197                 return NULL;
198
199         /* stupid string compare */
200         if      (!strcmp(type, "USER"))    folder_id = BLENDER_RESOURCE_PATH_USER;
201         else if (!strcmp(type, "LOCAL"))   folder_id = BLENDER_RESOURCE_PATH_LOCAL;
202         else if (!strcmp(type, "SYSTEM"))  folder_id = BLENDER_RESOURCE_PATH_SYSTEM;
203         else {
204                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
205                 return NULL;
206         }
207
208         path = BLI_get_folder_version(folder_id, (major * 100) + minor, FALSE);
209
210         return PyUnicode_DecodeFSDefault(path ? path : "");
211 }
212
213 static PyMethodDef meth_bpy_script_paths =
214         {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
215 static PyMethodDef meth_bpy_blend_paths =
216         {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS | METH_KEYWORDS, bpy_blend_paths_doc};
217 static PyMethodDef meth_bpy_user_resource =
218         {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS | METH_KEYWORDS, NULL};
219 static PyMethodDef meth_bpy_resource_path =
220         {"resource_path", (PyCFunction)bpy_resource_path, METH_VARARGS | METH_KEYWORDS, bpy_resource_path_doc};
221
222
223 static PyObject *bpy_import_test(const char *modname)
224 {
225         PyObject *mod = PyImport_ImportModuleLevel((char *)modname, NULL, NULL, NULL, 0);
226         if (mod) {
227                 Py_DECREF(mod);
228         }
229         else {
230                 PyErr_Print();
231                 PyErr_Clear();
232         }       
233
234         return mod;
235 }
236
237 /******************************************************************************
238  * Description: Creates the bpy module and adds it to sys.modules for importing
239  ******************************************************************************/
240 void BPy_init_modules(void)
241 {
242         extern BPy_StructRNA *bpy_context_module;
243         extern int bpy_lib_init(PyObject *);
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_lib_init(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 }