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