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