Merged changes in the trunk up to revision 26856.
[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 #include <Python.h>
29  
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  
37  /* external util modules */
38 #include "../generic/Mathutils.h"
39 #include "../generic/Geometry.h"
40 #include "../generic/BGL.h"
41 #include "../generic/IDProp.h"
42
43 #include "BPy_Freestyle.h"
44  
45 /* todo, make nice syntax for sphinx */
46 static char bpy_home_paths_doc[] = "home_paths(subfolder), return 3 paths to blender home directories (system, local, user), strings will be empty when not found.";
47
48 PyObject *bpy_home_paths(PyObject *self, PyObject *args)
49 {
50     PyObject *ret= PyTuple_New(3);
51     char *path;
52     char *subfolder= "";
53     
54         if (!PyArg_ParseTuple(args, "|s:blender_homes", &subfolder))
55                 return NULL;
56
57     path= BLI_gethome_folder(subfolder, BLI_GETHOME_SYSTEM);
58     PyTuple_SET_ITEM(ret, 0, PyUnicode_FromString(path?path:""));
59
60     path= BLI_gethome_folder(subfolder, BLI_GETHOME_LOCAL);
61     PyTuple_SET_ITEM(ret, 1, PyUnicode_FromString(path?path:""));
62
63     path= BLI_gethome_folder(subfolder, BLI_GETHOME_USER);
64     PyTuple_SET_ITEM(ret, 2, PyUnicode_FromString(path?path:""));
65     
66     return ret;
67 }
68
69 static PyMethodDef meth_bpy_home_paths[] = {{ "home_paths", (PyCFunction)bpy_home_paths, METH_VARARGS, bpy_home_paths_doc}};
70
71 static void bpy_import_test(char *modname)
72 {
73         PyObject *mod= PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
74         if(mod) {
75                 Py_DECREF(mod);
76         }
77         else {
78                 PyErr_Print();
79                 PyErr_Clear();
80         }       
81 }
82
83 /*****************************************************************************
84 * Description: Creates the bpy module and adds it to sys.modules for importing
85 *****************************************************************************/
86 void BPy_init_modules( void )
87 {
88     extern BPy_StructRNA *bpy_context_module;
89         PyObject *mod;
90
91         /* Needs to be first since this dir is needed for future modules */
92         char *modpath= BLI_gethome_folder("scripts/modules", BLI_GETHOME_ALL);
93         if(modpath) {
94                 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
95                 PyObject *py_modpath= PyUnicode_FromString(modpath);
96                 PyList_Insert(sys_path, 0, py_modpath); /* add first */
97                 Py_DECREF(py_modpath);
98         }
99         
100         /* stand alone utility modules not related to blender directly */
101         Geometry_Init();
102         Mathutils_Init();
103         BGL_Init();
104         IDProp_Init_Types();
105         Freestyle_Init();
106
107
108         mod = PyModule_New("_bpy");
109
110         /* add the module so we can import it */
111         PyDict_SetItemString(PySys_GetObject("modules"), "_bpy", mod);
112         Py_DECREF(mod);
113
114         /* run first, initializes rna types */
115         BPY_rna_init();
116
117         PyModule_AddObject( mod, "types", BPY_rna_types() ); /* needs to be first so bpy_types can run */
118         bpy_import_test("bpy_types");
119         PyModule_AddObject( mod, "data", BPY_rna_module() ); /* imports bpy_types by running this */
120         bpy_import_test("bpy_types");
121         PyModule_AddObject( mod, "props", BPY_rna_props() );
122         PyModule_AddObject( mod, "ops", BPY_operator_module() ); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
123         PyModule_AddObject( mod, "app", BPY_app_struct() );
124
125         /* bpy context */
126     bpy_context_module= ( BPy_StructRNA * ) PyObject_NEW( BPy_StructRNA, &pyrna_struct_Type );
127     RNA_pointer_create(NULL, &RNA_Context, NULL, &bpy_context_module->ptr);
128     bpy_context_module->freeptr= 0;
129     PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
130     
131         /* utility func's that have nowhere else to go */
132         PyModule_AddObject(mod, meth_bpy_home_paths->ml_name, (PyObject *)PyCFunction_New(meth_bpy_home_paths, NULL));
133
134         /* add our own modules dir, this is a python package */
135         bpy_import_test("bpy");
136 }