merge from trunk 38379
[blender.git] / source / blender / python / intern / bpy.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/python/intern/bpy.c
26  *  \ingroup pythonintern
27  */
28
29  
30 /* This file defines the '_bpy' module which is used by python's 'bpy' package.
31  * a script writer should never directly access this module */
32  
33 #define WITH_PYTHON /* for AUD_PyInit.h, possibly others */
34
35 #include <Python.h>
36
37 #include "bpy.h" 
38 #include "bpy_util.h" 
39 #include "bpy_rna.h"
40 #include "bpy_app.h"
41 #include "bpy_props.h"
42 #include "bpy_operator.h"
43
44 #include "BLI_path_util.h"
45 #include "BLI_string.h"
46 #include "BLI_bpath.h"
47 #include "BLI_utildefines.h"
48
49 #include "BKE_main.h"
50 #include "BKE_global.h" /* XXX, G.main only */
51 #include "BKE_blender.h"
52
53 #include "RNA_access.h"
54
55 #include "MEM_guardedalloc.h"
56
57  /* external util modules */
58 #include "../generic/mathutils.h"
59 #include "../generic/bgl.h"
60 #include "../generic/blf_py_api.h"
61 #include "../generic/IDProp.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 PyDoc_STRVAR(bpy_blend_paths_doc,
87 ".. function:: blend_paths(absolute=False)\n"
88 "\n"
89 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
90 "\n"
91 "   :arg absolute: When true the paths returned are made absolute.\n"
92 "   :type absolute: boolean\n"
93 "   :return: path list.\n"
94 "   :rtype: list of strings\n"
95 );
96 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
97 {
98         struct BPathIterator *bpi;
99         PyObject *list, *st; /* stupidly big string to be safe */
100         /* be sure there is low chance of the path being too short */
101         char filepath_expanded[1024];
102         const char *lib;
103
104         int absolute= 0;
105         static const char *kwlist[]= {"absolute", NULL};
106
107         if (!PyArg_ParseTupleAndKeywords(args, kw, "|i:blend_paths", (char **)kwlist, &absolute))
108                 return NULL;
109
110         list= PyList_New(0);
111
112         for(BLI_bpathIterator_init(&bpi, G.main, G.main->name, 0); !BLI_bpathIterator_isDone(bpi); BLI_bpathIterator_step(bpi)) {
113                 /* build the list */
114                 if (absolute) {
115                         BLI_bpathIterator_getPathExpanded(bpi, filepath_expanded);
116                 }
117                 else {
118                         lib= BLI_bpathIterator_getLib(bpi);
119                         if (lib && (BLI_path_cmp(lib, BLI_bpathIterator_getBasePath(bpi)))) { /* relative path to the library is NOT the same as our blendfile path, return an absolute path */
120                                 BLI_bpathIterator_getPathExpanded(bpi, filepath_expanded);
121                         }
122                         else {
123                                 BLI_bpathIterator_getPath(bpi, filepath_expanded);
124                         }
125                 }
126                 st= PyUnicode_DecodeFSDefault(filepath_expanded);
127
128                 PyList_Append(list, st);
129                 Py_DECREF(st);
130         }
131
132         BLI_bpathIterator_free(bpi);
133
134         return list;
135 }
136
137
138 // PyDoc_STRVAR(bpy_user_resource_doc[]= // now in bpy/utils.py
139 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
140 {
141         char *type;
142         char *subdir= NULL;
143         int folder_id;
144         static const char *kwlist[]= {"type", "subdir", NULL};
145
146         char *path;
147
148         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", (char **)kwlist, &type, &subdir))
149                 return NULL;
150         
151         /* stupid string compare */
152         if     (!strcmp(type, "DATAFILES"))     folder_id= BLENDER_USER_DATAFILES;
153         else if(!strcmp(type, "CONFIG"))        folder_id= BLENDER_USER_CONFIG;
154         else if(!strcmp(type, "SCRIPTS"))       folder_id= BLENDER_USER_SCRIPTS;
155         else if(!strcmp(type, "AUTOSAVE"))      folder_id= BLENDER_USER_AUTOSAVE;
156         else {
157                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
158                 return NULL;
159         }
160         
161         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
162         path= BLI_get_folder(folder_id, subdir);
163
164         if (!path)
165                 path= BLI_get_user_folder_notest(folder_id, subdir);
166
167         return PyUnicode_DecodeFSDefault(path ? path : "");
168 }
169
170 PyDoc_STRVAR(bpy_resource_path_doc,
171 ".. function:: resource_path(type, major=2, minor=57)\n"
172 "\n"
173 "   Return the base path for storing system files.\n"
174 "\n"
175 "   :arg type: string in ['USER', 'LOCAL', 'SYSTEM'].\n"
176 "   :type type: string\n"
177 "   :arg major: major version, defaults to current.\n"
178 "   :type major: int\n"
179 "   :arg minor: minor version, defaults to current.\n"
180 "   :type minor: string\n"
181 "   :return: the resource path (not necessarily existing).\n"
182 "   :rtype: string\n"
183 );
184 static PyObject *bpy_resource_path(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
185 {
186         char *type;
187         int major= BLENDER_VERSION/100, minor= BLENDER_VERSION%100;
188         static const char *kwlist[]= {"type", "major", "minor", NULL};
189         int folder_id;
190         char *path;
191
192         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|ii:resource_path", (char **)kwlist, &type, &major, &minor))
193                 return NULL;
194
195         /* stupid string compare */
196         if     (!strcmp(type, "USER"))          folder_id= BLENDER_RESOURCE_PATH_USER;
197         else if(!strcmp(type, "LOCAL"))         folder_id= BLENDER_RESOURCE_PATH_LOCAL;
198         else if(!strcmp(type, "SYSTEM"))        folder_id= BLENDER_RESOURCE_PATH_SYSTEM;
199         else {
200                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
201                 return NULL;
202         }
203
204         path= BLI_get_folder_version(folder_id, (major * 100) + minor, FALSE);
205
206         return PyUnicode_DecodeFSDefault(path);
207 }
208
209 static PyMethodDef meth_bpy_script_paths= {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
210 static PyMethodDef meth_bpy_blend_paths= {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS|METH_KEYWORDS, bpy_blend_paths_doc};
211 static PyMethodDef meth_bpy_user_resource= {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS|METH_KEYWORDS, NULL};
212 static PyMethodDef meth_bpy_resource_path= {"resource_path", (PyCFunction)bpy_resource_path, METH_VARARGS|METH_KEYWORDS, bpy_resource_path_doc};
213
214
215 static PyObject *bpy_import_test(const char *modname)
216 {
217         PyObject *mod= PyImport_ImportModuleLevel((char *)modname, NULL, NULL, NULL, 0);
218         if(mod) {
219                 Py_DECREF(mod);
220         }
221         else {
222                 PyErr_Print();
223                 PyErr_Clear();
224         }
225
226         return mod;
227 }
228
229 /*****************************************************************************
230 * Description: Creates the bpy module and adds it to sys.modules for importing
231 *****************************************************************************/
232 void BPy_init_modules(void)
233 {
234         extern BPy_StructRNA *bpy_context_module;
235         extern int bpy_lib_init(PyObject *);
236         PointerRNA ctx_ptr;
237         PyObject *mod;
238
239         /* Needs to be first since this dir is needed for future modules */
240         char *modpath= BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, "modules");
241         if(modpath) {
242                 // printf("bpy: found module path '%s'.\n", modpath);
243                 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
244                 PyObject *py_modpath= PyUnicode_FromString(modpath);
245                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
246                 Py_DECREF(py_modpath);
247         }
248         else {
249                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
250         }
251         /* stand alone utility modules not related to blender directly */
252         IDProp_Init_Types(); /* not actually a submodule, just types */
253
254         mod= PyModule_New("_bpy");
255
256         /* add the module so we can import it */
257         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
258         Py_DECREF(mod);
259
260         /* run first, initializes rna types */
261         BPY_rna_init();
262
263         PyModule_AddObject(mod, "types", BPY_rna_types()); /* needs to be first so bpy_types can run */
264         PyModule_AddObject(mod, "StructMetaPropGroup", (PyObject *)&pyrna_struct_meta_idprop_Type); /* metaclass for idprop types, bpy_types.py needs access */
265
266         bpy_lib_init(mod); /* adds '_bpy._library_load', must be called before 'bpy_types' which uses it */
267
268         bpy_import_test("bpy_types");
269         PyModule_AddObject(mod, "data", BPY_rna_module()); /* imports bpy_types by running this */
270         bpy_import_test("bpy_types");
271         PyModule_AddObject(mod, "props", BPY_rna_props());
272         PyModule_AddObject(mod, "ops", BPY_operator_module()); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
273         PyModule_AddObject(mod, "app", BPY_app_struct());
274
275         /* bpy context */
276         RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
277         bpy_context_module= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
278         /* odd that this is needed, 1 ref on creation and another for the module
279          * but without we get a crash on exit */
280         Py_INCREF(bpy_context_module);
281
282         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
283
284         /* utility func's that have nowhere else to go */
285         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
286         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
287         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
288         PyModule_AddObject(mod, meth_bpy_resource_path.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_resource_path, NULL));
289
290         /* register funcs (bpy_rna.c) */
291         PyModule_AddObject(mod, meth_bpy_register_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
292         PyModule_AddObject(mod, meth_bpy_unregister_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
293
294         /* add our own modules dir, this is a python package */
295         bpy_package_py= bpy_import_test("bpy");
296 }