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