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