Audaspace:
[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
29 #include "bpy_util.h" 
30 #include "bpy_rna.h"
31 #include "bpy_app.h"
32 #include "bpy_props.h"
33 #include "bpy_operator.h"
34
35 #include "BLI_path_util.h"
36 #include "BLI_bpath.h"
37  
38  /* external util modules */
39 #include "../generic/geometry.h"
40 #include "../generic/bgl.h"
41 #include "../generic/blf_api.h"
42 #include "../generic/IDProp.h"
43
44 #ifndef DISABLE_PYTHON
45 #define WITH_PYTHON
46 #endif
47 #include "AUD_C-API.h"
48
49 static char bpy_home_paths_doc[] =
50 ".. function:: home_paths(subfolder)\n"
51 "\n"
52 "   Return 3 paths to blender home directories.\n"
53 "\n"
54 "   :arg subfolder: The name of a subfolder to find within the blenders home directory.\n"
55 "   :type subfolder: string\n"
56 "   :return: (system, local, user) strings will be empty when not found.\n"
57 "   :rtype: tuple of strigs\n";
58
59 PyObject *bpy_home_paths(PyObject *self, PyObject *args)
60 {
61         PyObject *ret= PyTuple_New(3);
62         char *path;
63         char *subfolder= "";
64     
65         if (!PyArg_ParseTuple(args, "|s:blender_homes", &subfolder))
66                 return NULL;
67
68         path= BLI_gethome_folder(subfolder, BLI_GETHOME_SYSTEM);
69         PyTuple_SET_ITEM(ret, 0, PyUnicode_FromString(path?path:""));
70
71         path= BLI_gethome_folder(subfolder, BLI_GETHOME_LOCAL);
72         PyTuple_SET_ITEM(ret, 1, PyUnicode_FromString(path?path:""));
73
74         path= BLI_gethome_folder(subfolder, BLI_GETHOME_USER);
75         PyTuple_SET_ITEM(ret, 2, PyUnicode_FromString(path?path:""));
76     
77         return ret;
78 }
79
80 static char bpy_blend_paths_doc[] =
81 ".. function:: blend_paths(absolute=False)\n"
82 "\n"
83 "   Returns a list of paths associated with this blend file.\n"
84 "\n"
85 "   :arg absolute: When true the paths returned are made absolute.\n"
86 "   :type absolute: boolean\n"
87 "   :return: path list.\n"
88 "   :rtype: list of strigs\n";
89 static PyObject *bpy_blend_paths(PyObject * self, PyObject *args, PyObject *kw)
90 {
91         struct BPathIterator bpi;
92         PyObject *list = PyList_New(0), *st; /* stupidly big string to be safe */
93         /* be sure there is low chance of the path being too short */
94         char filepath_expanded[1024];
95         char *lib;
96
97         int absolute = 0;
98         static char *kwlist[] = {"absolute", NULL};
99
100         if (!PyArg_ParseTupleAndKeywords(args, kw, "|i:blend_paths", kwlist, &absolute))
101                 return NULL;
102
103         for(BLI_bpathIterator_init(&bpi, NULL); !BLI_bpathIterator_isDone(&bpi); BLI_bpathIterator_step(&bpi)) {
104                 /* build the list */
105                 if (absolute) {
106                         BLI_bpathIterator_getPathExpanded(&bpi, filepath_expanded);
107                 }
108                 else {
109                         lib = BLI_bpathIterator_getLib(&bpi);
110                         if (lib && (strcmp(lib, bpi.base_path))) { /* relative path to the library is NOT the same as our blendfile path, return an absolute path */
111                                 BLI_bpathIterator_getPathExpanded(&bpi, filepath_expanded);
112                         }
113                         else {
114                                 BLI_bpathIterator_getPath(&bpi, filepath_expanded);
115                         }
116                 }
117                 st = PyUnicode_FromString(filepath_expanded);
118
119                 PyList_Append(list, st);
120                 Py_DECREF(st);
121         }
122
123         BLI_bpathIterator_free(&bpi);
124
125         return list;
126 }
127
128 static PyMethodDef meth_bpy_home_paths[] = {{ "home_paths", (PyCFunction)bpy_home_paths, METH_VARARGS, bpy_home_paths_doc}};
129 static PyMethodDef meth_bpy_blend_paths[] = {{ "blend_paths", (PyCFunction)bpy_blend_paths, METH_VARARGS|METH_KEYWORDS, bpy_blend_paths_doc}};
130
131 static void bpy_import_test(char *modname)
132 {
133         PyObject *mod= PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
134         if(mod) {
135                 Py_DECREF(mod);
136         }
137         else {
138                 PyErr_Print();
139                 PyErr_Clear();
140         }       
141 }
142
143 /*****************************************************************************
144 * Description: Creates the bpy module and adds it to sys.modules for importing
145 *****************************************************************************/
146 void BPy_init_modules( void )
147 {
148         extern BPy_StructRNA *bpy_context_module;
149         PointerRNA ctx_ptr;
150         PyObject *mod;
151
152         /* Needs to be first since this dir is needed for future modules */
153         char *modpath= BLI_get_folder(BLENDER_SCRIPTS, "modules");
154         if(modpath) {
155                 // printf("bpy: found module path '%s'.\n", modpath);
156                 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
157                 PyObject *py_modpath= PyUnicode_FromString(modpath);
158                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
159                 Py_DECREF(py_modpath);
160         }
161         else {
162                 printf("bpy: couldnt find 'scripts/modules', blender probably wont start.\n");
163         }
164         /* stand alone utility modules not related to blender directly */
165         Geometry_Init();
166         Mathutils_Init();
167         BGL_Init();
168         BLF_Init();
169         IDProp_Init_Types();
170         AUD_initPython();
171
172         mod = PyModule_New("_bpy");
173
174         /* add the module so we can import it */
175         PyDict_SetItemString(PySys_GetObject("modules"), "_bpy", mod);
176         Py_DECREF(mod);
177
178         /* run first, initializes rna types */
179         BPY_rna_init();
180
181         PyModule_AddObject( mod, "types", BPY_rna_types() ); /* needs to be first so bpy_types can run */
182         bpy_import_test("bpy_types");
183         PyModule_AddObject( mod, "data", BPY_rna_module() ); /* imports bpy_types by running this */
184         bpy_import_test("bpy_types");
185         PyModule_AddObject( mod, "props", BPY_rna_props() );
186         PyModule_AddObject( mod, "ops", BPY_operator_module() ); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
187         PyModule_AddObject( mod, "app", BPY_app_struct() );
188
189         /* bpy context */
190         RNA_pointer_create(NULL, &RNA_Context, BPy_GetContext(), &ctx_ptr);
191         bpy_context_module= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ctx_ptr);
192         /* odd that this is needed, 1 ref on creation and another for the module
193          * but without we get a crash on exit */
194         Py_INCREF(bpy_context_module);
195
196         PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
197
198         /* utility func's that have nowhere else to go */
199         PyModule_AddObject(mod, meth_bpy_home_paths->ml_name, (PyObject *)PyCFunction_New(meth_bpy_home_paths, NULL));
200         PyModule_AddObject(mod, meth_bpy_blend_paths->ml_name, (PyObject *)PyCFunction_New(meth_bpy_blend_paths, NULL));
201
202         /* add our own modules dir, this is a python package */
203         bpy_import_test("bpy");
204 }