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