Merged changes in the trunk up to revision 34996.
[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 /* This file defines the '_bpy' module which is used by python's 'bpy' package.
26  * a script writer should never directly access this module */
27  
28 #define WITH_PYTHON /* for AUD_PyInit.h, possibly others */
29
30 #include <Python.h>
31
32 #include "bpy.h" 
33 #include "bpy_util.h" 
34 #include "bpy_rna.h"
35 #include "bpy_app.h"
36 #include "bpy_props.h"
37 #include "bpy_operator.h"
38
39 #include "BLI_path_util.h"
40 #include "BLI_bpath.h"
41 #include "BLI_utildefines.h"
42
43
44 #include "BKE_global.h" /* XXX, G.main only */
45
46 #include "MEM_guardedalloc.h"
47
48  /* external util modules */
49 #include "../generic/mathutils.h"
50 #include "../generic/bgl.h"
51 #include "../generic/blf_py_api.h"
52 #include "../generic/IDProp.h"
53
54 #include "AUD_PyInit.h"
55
56 #include "BPy_Freestyle.h"
57
58 static char bpy_script_paths_doc[] =
59 ".. function:: script_paths()\n"
60 "\n"
61 "   Return 2 paths to blender scripts directories.\n"
62 "\n"
63 "   :return: (system, user) strings will be empty when not found.\n"
64 "   :rtype: tuple of strigs\n";
65
66 static PyObject *bpy_script_paths(PyObject *UNUSED(self))
67 {
68         PyObject *ret= PyTuple_New(2);
69         char *path;
70     
71         path= BLI_get_folder(BLENDER_USER_SCRIPTS, NULL);
72         PyTuple_SET_ITEM(ret, 0, PyUnicode_FromString(path?path:""));
73         path= BLI_get_folder(BLENDER_SYSTEM_SCRIPTS, NULL);
74         PyTuple_SET_ITEM(ret, 1, PyUnicode_FromString(path?path:""));
75     
76         return ret;
77 }
78
79 static char bpy_blend_paths_doc[] =
80 ".. function:: blend_paths(absolute=False)\n"
81 "\n"
82 "   Returns a list of paths to external files referenced by the loaded .blend file.\n"
83 "\n"
84 "   :arg absolute: When true the paths returned are made absolute.\n"
85 "   :type absolute: boolean\n"
86 "   :return: path list.\n"
87 "   :rtype: list of strigs\n";
88 static PyObject *bpy_blend_paths(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
89 {
90         struct BPathIterator *bpi;
91         PyObject *list, *st; /* stupidly big string to be safe */
92         /* be sure there is low chance of the path being too short */
93         char filepath_expanded[1024];
94         const char *lib;
95
96         int absolute = 0;
97         static const char *kwlist[] = {"absolute", NULL};
98
99         if (!PyArg_ParseTupleAndKeywords(args, kw, "|i:blend_paths", (char **)kwlist, &absolute))
100                 return NULL;
101
102         list= PyList_New(0);
103
104         for(BLI_bpathIterator_init(&bpi, G.main, NULL, 0); !BLI_bpathIterator_isDone(bpi); BLI_bpathIterator_step(bpi)) {
105                 /* build the list */
106                 if (absolute) {
107                         BLI_bpathIterator_getPathExpanded(bpi, filepath_expanded);
108                 }
109                 else {
110                         lib = BLI_bpathIterator_getLib(bpi);
111                         if (lib && (strcmp(lib, BLI_bpathIterator_getBasePath(bpi)))) { /* relative path to the library is NOT the same as our blendfile path, return an absolute path */
112                                 BLI_bpathIterator_getPathExpanded(bpi, filepath_expanded);
113                         }
114                         else {
115                                 BLI_bpathIterator_getPath(bpi, filepath_expanded);
116                         }
117                 }
118                 st= PyUnicode_DecodeFSDefault(filepath_expanded);
119
120                 PyList_Append(list, st);
121                 Py_DECREF(st);
122         }
123
124         BLI_bpathIterator_free(bpi);
125
126         return list;
127 }
128
129
130 // static char bpy_user_resource_doc[] = // now in bpy/utils.py
131 static PyObject *bpy_user_resource(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
132 {
133         char *type;
134         char *subdir= NULL;
135         int folder_id;
136         static const char *kwlist[] = {"type", "subdir", NULL};
137
138         char *path;
139
140         if (!PyArg_ParseTupleAndKeywords(args, kw, "s|s:user_resource", (char **)kwlist, &type, &subdir))
141                 return NULL;
142         
143         /* stupid string compare */
144         if     (!strcmp(type, "DATAFILES"))     folder_id= BLENDER_USER_DATAFILES;
145         else if(!strcmp(type, "CONFIG"))        folder_id= BLENDER_USER_CONFIG;
146         else if(!strcmp(type, "SCRIPTS"))       folder_id= BLENDER_USER_SCRIPTS;
147         else if(!strcmp(type, "AUTOSAVE"))      folder_id= BLENDER_USER_AUTOSAVE;
148         else {
149                 PyErr_SetString(PyExc_ValueError, "invalid resource argument");
150                 return NULL;
151         }
152         
153         /* same logic as BLI_get_folder_create(), but best leave it up to the script author to create */
154         path= BLI_get_folder(folder_id, subdir);
155
156         if (!path)
157                 path = BLI_get_user_folder_notest(folder_id, subdir);
158
159         return PyUnicode_FromString(path ? path : "");
160 }
161
162 static PyMethodDef meth_bpy_script_paths = {"script_paths", (PyCFunction)bpy_script_paths, METH_NOARGS, bpy_script_paths_doc};
163 static PyMethodDef meth_bpy_blend_paths = {"blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS|METH_KEYWORDS, bpy_blend_paths_doc};
164 static PyMethodDef meth_bpy_user_resource = {"user_resource", (PyCFunction)bpy_user_resource, METH_VARARGS|METH_KEYWORDS, NULL};
165
166 static void bpy_import_test(const char *modname)
167 {
168         PyObject *mod= PyImport_ImportModuleLevel((char *)modname, NULL, NULL, NULL, 0);
169         if(mod) {
170                 Py_DECREF(mod);
171         }
172         else {
173                 PyErr_Print();
174                 PyErr_Clear();
175         }       
176 }
177
178 /*****************************************************************************
179 * Description: Creates the bpy module and adds it to sys.modules for importing
180 *****************************************************************************/
181 void BPy_init_modules( void )
182 {
183         extern BPy_StructRNA *bpy_context_module;
184         PointerRNA ctx_ptr;
185         PyObject *mod;
186
187         /* Needs to be first since this dir is needed for future modules */
188         char *modpath= BLI_get_folder(BLENDER_SCRIPTS, "modules");
189         if(modpath) {
190                 // printf("bpy: found module path '%s'.\n", modpath);
191                 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
192                 PyObject *py_modpath= PyUnicode_FromString(modpath);
193                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
194                 Py_DECREF(py_modpath);
195         }
196         else {
197                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
198         }
199         /* stand alone utility modules not related to blender directly */
200         IDProp_Init_Types(); /* not actually a submodule, just types */
201         Freestyle_Init();
202
203         mod = PyModule_New("_bpy");
204
205         /* add the module so we can import it */
206         PyDict_SetItemString(PyImport_GetModuleDict(), "_bpy", mod);
207         Py_DECREF(mod);
208
209         /* run first, initializes rna types */
210         BPY_rna_init();
211
212         PyModule_AddObject( mod, "types", BPY_rna_types() ); /* needs to be first so bpy_types can run */
213         PyModule_AddObject(mod, "StructMetaPropGroup", (PyObject *)&pyrna_struct_meta_idprop_Type); /* metaclass for idprop types, bpy_types.py needs access */
214                         
215         bpy_import_test("bpy_types");
216         PyModule_AddObject( mod, "data", BPY_rna_module() ); /* imports bpy_types by running this */
217         bpy_import_test("bpy_types");
218         PyModule_AddObject( mod, "props", BPY_rna_props() );
219         PyModule_AddObject( mod, "ops", BPY_operator_module() ); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
220         PyModule_AddObject( mod, "app", BPY_app_struct() );
221
222         /* bpy context */
223         RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);
224         bpy_context_module= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
225         /* odd that this is needed, 1 ref on creation and another for the module
226          * but without we get a crash on exit */
227         Py_INCREF(bpy_context_module);
228
229         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
230
231         /* utility func's that have nowhere else to go */
232         PyModule_AddObject(mod, meth_bpy_script_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_script_paths, NULL));
233         PyModule_AddObject(mod, meth_bpy_blend_paths.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_blend_paths, NULL));
234         PyModule_AddObject(mod, meth_bpy_user_resource.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_user_resource, NULL));
235
236         /* register funcs (bpy_rna.c) */
237         PyModule_AddObject(mod, meth_bpy_register_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_register_class, NULL));
238         PyModule_AddObject(mod, meth_bpy_unregister_class.ml_name, (PyObject *)PyCFunction_New(&meth_bpy_unregister_class, NULL));
239
240         /* add our own modules dir, this is a python package */
241         bpy_import_test("bpy");
242 }