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