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