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