Bugfixes:
[blender-staging.git] / source / blender / python / intern / bpy_interface.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Michel Selten, Willian P. Germano, Stephen Swaney,
21  * Chris Keith, Chris Want, Ken Hughes, Campbell Barton
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25  
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/stat.h>
30
31
32 /* grr, python redefines */
33 #ifdef _POSIX_C_SOURCE
34 #undef _POSIX_C_SOURCE
35 #endif
36
37 #include <Python.h>
38 #include "compile.h"            /* for the PyCodeObject */
39 #include "eval.h"               /* for PyEval_EvalCode */
40
41 #include "bpy_rna.h"
42 #include "bpy_operator.h"
43 #include "bpy_ui.h"
44 #include "bpy_util.h"
45
46 #ifndef WIN32
47 #include <dirent.h>
48 #else
49 #include "BLI_winstuff.h"
50 #endif
51
52 #include "DNA_anim_types.h"
53 #include "DNA_space_types.h"
54 #include "DNA_text_types.h"
55
56 #include "MEM_guardedalloc.h"
57
58 #include "BLI_util.h"
59 #include "BLI_storage.h"
60 #include "BLI_fileops.h"
61 #include "BLI_string.h"
62
63 #include "BKE_context.h"
64 #include "BKE_fcurve.h"
65 #include "BKE_text.h"
66
67 #include "BPY_extern.h"
68
69 #include "../generic/bpy_internal_import.h" // our own imports
70 /* external util modules */
71
72 #include "../generic/Mathutils.h"
73 #include "../generic/Geometry.h"
74 #include "../generic/BGL.h"
75
76
77 /* for internal use, when starting and ending python scripts */
78
79 /* incase a python script triggers another python call, stop bpy_context_clear from invalidating */
80 static int py_call_level= 0;
81
82
83 // only for tests
84 #define TIME_PY_RUN
85
86 #ifdef TIME_PY_RUN
87 #include "PIL_time.h"
88 static int              bpy_timer_count = 0;
89 static double   bpy_timer; /* time since python starts */
90 static double   bpy_timer_run; /* time for each python script run */
91 static double   bpy_timer_run_tot; /* accumulate python runs */
92 #endif
93
94 void bpy_context_set(bContext *C, PyGILState_STATE *gilstate)
95 {
96         py_call_level++;
97
98         if(gilstate)
99                 *gilstate = PyGILState_Ensure();
100
101         if(py_call_level==1) {
102
103                 BPY_update_modules(); /* can give really bad results if this isnt here */
104
105                 if(C) { // XXX - should always be true.
106                         BPy_SetContext(C);
107                         bpy_import_main_set(CTX_data_main(C));
108                 }
109                 else {
110                         fprintf(stderr, "ERROR: Python context called with a NULL Context. this should not happen!\n");
111                 }
112
113 #ifdef TIME_PY_RUN
114                 if(bpy_timer_count==0) {
115                         /* record time from the beginning */
116                         bpy_timer= PIL_check_seconds_timer();
117                         bpy_timer_run = bpy_timer_run_tot = 0.0;
118                 }
119                 bpy_timer_run= PIL_check_seconds_timer();
120
121
122                 bpy_timer_count++;
123 #endif
124         }
125 }
126
127 void bpy_context_clear(bContext *C, PyGILState_STATE *gilstate)
128 {
129         py_call_level--;
130
131         if(gilstate)
132                 PyGILState_Release(*gilstate);
133
134         if(py_call_level < 0) {
135                 fprintf(stderr, "ERROR: Python context internal state bug. this should not happen!\n");
136         }
137         else if(py_call_level==0) {
138                 // XXX - Calling classes currently wont store the context :\, cant set NULL because of this. but this is very flakey still.
139                 //BPy_SetContext(NULL);
140                 //bpy_import_main_set(NULL);
141
142 #ifdef TIME_PY_RUN
143                 bpy_timer_run_tot += PIL_check_seconds_timer() - bpy_timer_run;
144                 bpy_timer_count++;
145 #endif
146
147         }
148 }
149
150 static void bpy_import_test(char *modname)
151 {
152         PyObject *mod= PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
153         if(mod) {
154                 Py_DECREF(mod);
155         }
156         else {
157                 PyErr_Print();
158                 PyErr_Clear();
159         }       
160 }
161
162 void BPY_free_compiled_text( struct Text *text )
163 {
164         if( text->compiled ) {
165                 Py_DECREF( ( PyObject * ) text->compiled );
166                 text->compiled = NULL;
167         }
168 }
169
170 /*****************************************************************************
171 * Description: Creates the bpy module and adds it to sys.modules for importing
172 *****************************************************************************/
173 static void bpy_init_modules( void )
174 {
175         PyObject *mod;
176         
177         mod = PyModule_New("bpy");
178         
179         PyModule_AddObject( mod, "data", BPY_rna_module() );
180         /* PyModule_AddObject( mod, "doc", BPY_rna_doc() ); */
181         PyModule_AddObject( mod, "types", BPY_rna_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, "ui", BPY_ui_module() ); // XXX very experimental, consider this a test, especially PyCObject is not meant to be permanent
185         
186         /* add the module so we can import it */
187         PyDict_SetItemString(PySys_GetObject("modules"), "bpy", mod);
188         Py_DECREF(mod);
189
190         /* add our own modules dir */
191         {
192                 char *modpath= BLI_gethome_folder("scripts/modules", BLI_GETHOME_ALL);
193                 
194                 if(modpath) {
195                         PyObject *sys_path= PySys_GetObject("path"); /* borrow */
196                         PyObject *py_modpath= PyUnicode_FromString(modpath);
197                         PyList_Insert(sys_path, 0, py_modpath); /* add first */
198                         Py_DECREF(py_modpath);
199                 }
200                 
201                 bpy_import_test("bpy_ops"); /* adds its self to bpy.ops */
202                 bpy_import_test("bpy_sys"); /* adds its self to bpy.sys */
203         }
204         
205         /* stand alone utility modules not related to blender directly */
206         Geometry_Init();
207         Mathutils_Init();
208         BGL_Init();
209 }
210
211 void BPY_update_modules( void )
212 {
213 #if 0 // slow, this runs all the time poll, draw etc 100's of time a sec.
214         PyObject *mod= PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
215         PyModule_AddObject( mod, "data", BPY_rna_module() );
216         PyModule_AddObject( mod, "types", BPY_rna_types() ); // atm this does not need updating
217 #endif
218
219         /* refreshes the main struct */
220         BPY_update_rna_module();
221
222 }
223
224 /*****************************************************************************
225 * Description: This function creates a new Python dictionary object.
226 *****************************************************************************/
227 static PyObject *CreateGlobalDictionary( bContext *C )
228 {
229         PyObject *mod;
230         PyObject *dict = PyDict_New(  );
231         PyObject *item = PyUnicode_FromString( "__main__" );
232         PyDict_SetItemString( dict, "__builtins__", PyEval_GetBuiltins(  ) );
233         PyDict_SetItemString( dict, "__name__", item );
234         Py_DECREF(item);
235         
236         // XXX - put somewhere more logical
237         {
238                 PyMethodDef *ml;
239                 static PyMethodDef bpy_prop_meths[] = {
240                         {"FloatProperty", (PyCFunction)BPy_FloatProperty, METH_VARARGS|METH_KEYWORDS, ""},
241                         {"IntProperty", (PyCFunction)BPy_IntProperty, METH_VARARGS|METH_KEYWORDS, ""},
242                         {"BoolProperty", (PyCFunction)BPy_BoolProperty, METH_VARARGS|METH_KEYWORDS, ""},
243                         {"StringProperty", (PyCFunction)BPy_StringProperty, METH_VARARGS|METH_KEYWORDS, ""},
244                         {"EnumProperty", (PyCFunction)BPy_EnumProperty, METH_VARARGS|METH_KEYWORDS, ""},
245                         {"PointerProperty", (PyCFunction)BPy_PointerProperty, METH_VARARGS|METH_KEYWORDS, ""},
246                         {"CollectionProperty", (PyCFunction)BPy_CollectionProperty, METH_VARARGS|METH_KEYWORDS, ""},
247                         {NULL, NULL, 0, NULL}
248                 };
249                 
250                 for(ml = bpy_prop_meths; ml->ml_name; ml++) {
251                         PyDict_SetItemString( dict, ml->ml_name, PyCFunction_New(ml, NULL));
252                 }
253         }
254         
255         /* add bpy to global namespace */
256         mod= PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
257         PyDict_SetItemString( dict, "bpy", mod );
258         Py_DECREF(mod);
259         
260         return dict;
261 }
262
263 /* must be called before Py_Initialize */
264 void BPY_start_python_path(void)
265 {
266         char *py_path_bundle= BLI_gethome_folder("python", BLI_GETHOME_ALL);
267
268         if(py_path_bundle==NULL)
269                 return;
270
271         /* set the environment path */
272         printf("found bundled python: %s\n", py_path_bundle);
273
274 #if 0
275         BLI_setenv("PYTHONHOME", py_path_bundle);
276         BLI_setenv("PYTHONPATH", py_path_bundle);
277 #endif
278
279         {
280                 static wchar_t py_path_bundle_wchar[FILE_MAXDIR];
281
282                 mbstowcs(py_path_bundle_wchar, py_path_bundle, FILE_MAXDIR);
283                 Py_SetPythonHome(py_path_bundle_wchar);
284         }
285 }
286
287
288 void BPY_start_python( int argc, char **argv )
289 {
290         PyThreadState *py_tstate = NULL;
291         
292         BPY_start_python_path(); /* allow to use our own included python */
293
294         Py_Initialize(  );
295         
296         // PySys_SetArgv( argc, argv); // broken in py3, not a huge deal
297         /* sigh, why do python guys not have a char** version anymore? :( */
298         {
299                 int i;
300                 PyObject *py_argv= PyList_New(argc);
301
302                 for (i=0; i<argc; i++)
303                         PyList_SET_ITEM(py_argv, i, PyUnicode_FromString(argv[i]));
304
305                 PySys_SetObject("argv", py_argv);
306                 Py_DECREF(py_argv);
307         }
308         
309         /* Initialize thread support (also acquires lock) */
310         PyEval_InitThreads();
311         
312         
313         /* bpy.* and lets us import it */
314         bpy_init_modules(); 
315
316         { /* our own import and reload functions */
317                 PyObject *item;
318                 //PyObject *m = PyImport_AddModule("__builtin__");
319                 //PyObject *d = PyModule_GetDict(m);
320                 PyObject *d = PyEval_GetBuiltins(  );
321                 PyDict_SetItemString(d, "reload",               item=PyCFunction_New(bpy_reload_meth, NULL));   Py_DECREF(item);
322                 PyDict_SetItemString(d, "__import__",   item=PyCFunction_New(bpy_import_meth, NULL));   Py_DECREF(item);
323                 
324                 /* a bit nasty but this prevents help() and input() from locking blender
325                  * Ideally we could have some way for the console to replace sys.stdin but
326                  * python would lock blender while waiting for a return value, not easy :| */
327                 PySys_SetObject("stdin", Py_None);
328         }
329         
330         pyrna_alloc_types();
331
332         py_tstate = PyGILState_GetThisThreadState();
333         PyEval_ReleaseThread(py_tstate);
334 }
335
336 void BPY_end_python( void )
337 {
338         // fprintf(stderr, "Ending Python!\n");
339
340         PyGILState_Ensure(); /* finalizing, no need to grab the state */
341         
342         // free other python data.
343         pyrna_free_types();
344
345         /* clear all python data from structs */
346         
347         Py_Finalize(  );
348         
349 #ifdef TIME_PY_RUN
350         // measure time since py started
351         bpy_timer = PIL_check_seconds_timer() - bpy_timer;
352
353         printf("*bpy stats* - ");
354         printf("tot exec: %d,  ", bpy_timer_count);
355         printf("tot run: %.4fsec,  ", bpy_timer_run_tot);
356         if(bpy_timer_count>0)
357                 printf("average run: %.6fsec,  ", (bpy_timer_run_tot/bpy_timer_count));
358
359         if(bpy_timer>0.0)
360                 printf("tot usage %.4f%%", (bpy_timer_run_tot/bpy_timer)*100.0);
361
362         printf("\n");
363
364         // fprintf(stderr, "Ending Python Done!\n");
365
366 #endif
367
368 }
369
370 /* Can run a file or text block */
371 int BPY_run_python_script( bContext *C, const char *fn, struct Text *text, struct ReportList *reports)
372 {
373         PyObject *py_dict, *py_result= NULL;
374         PyGILState_STATE gilstate;
375         
376         if (fn==NULL && text==NULL) {
377                 return 0;
378         }
379         
380         bpy_context_set(C, &gilstate);
381         
382         py_dict = CreateGlobalDictionary(C);
383
384         if (text) {
385                 
386                 if( !text->compiled ) { /* if it wasn't already compiled, do it now */
387                         char *buf = txt_to_buf( text );
388
389                         text->compiled =
390                                 Py_CompileString( buf, text->id.name+2, Py_file_input );
391
392                         MEM_freeN( buf );
393
394                         if( PyErr_Occurred(  ) ) {
395                                 BPY_free_compiled_text( text );
396                         }
397                 }
398                 if(text->compiled)
399                         py_result =  PyEval_EvalCode( text->compiled, py_dict, py_dict );
400                 
401         } else {
402 #if 0
403                 char *pystring;
404                 pystring= malloc(strlen(fn) + 32);
405                 pystring[0]= '\0';
406                 sprintf(pystring, "exec(open(r'%s').read())", fn);
407                 py_result = PyRun_String( pystring, Py_file_input, py_dict, py_dict );
408                 free(pystring);
409 #else
410                 FILE *fp= fopen(fn, "r");               
411                 if(fp) {
412                         py_result = PyRun_File(fp, fn, Py_file_input, py_dict, py_dict);
413                         fclose(fp);
414                 }
415                 else {
416                         PyErr_Format(PyExc_SystemError, "Python file \"%s\" could not be opened: %s", fn, strerror(errno));
417                         py_result= NULL;
418                 }
419 #endif
420         }
421         
422         if (!py_result) {
423                 BPy_errors_to_report(reports);
424         } else {
425                 Py_DECREF( py_result );
426         }
427         
428         Py_DECREF(py_dict);
429         
430         bpy_context_clear(C, &gilstate);
431
432         return py_result ? 1:0;
433 }
434
435
436 /* TODO - move into bpy_space.c ? */
437 /* GUI interface routines */
438
439 /* Copied from Draw.c */
440 static void exit_pydraw( SpaceScript * sc, short err )
441 {
442         Script *script = NULL;
443
444         if( !sc || !sc->script )
445                 return;
446
447         script = sc->script;
448
449         if( err ) {
450                 BPy_errors_to_report(NULL); // TODO, reports
451                 script->flags = 0;      /* mark script struct for deletion */
452                 SCRIPT_SET_NULL(script);
453                 script->scriptname[0] = '\0';
454                 script->scriptarg[0] = '\0';
455 // XXX 2.5              error_pyscript();
456 // XXX 2.5              scrarea_queue_redraw( sc->area );
457         }
458
459 #if 0 // XXX 2.5
460         BPy_Set_DrawButtonsList(sc->but_refs);
461         BPy_Free_DrawButtonsList(); /*clear all temp button references*/
462 #endif
463
464         sc->but_refs = NULL;
465         
466         Py_XDECREF( ( PyObject * ) script->py_draw );
467         Py_XDECREF( ( PyObject * ) script->py_event );
468         Py_XDECREF( ( PyObject * ) script->py_button );
469
470         script->py_draw = script->py_event = script->py_button = NULL;
471 }
472
473 static int bpy_run_script_init(bContext *C, SpaceScript * sc)
474 {
475         if (sc->script==NULL) 
476                 return 0;
477         
478         if (sc->script->py_draw==NULL && sc->script->scriptname[0] != '\0')
479                 BPY_run_python_script(C, sc->script->scriptname, NULL, NULL);
480                 
481         if (sc->script->py_draw==NULL)
482                 return 0;
483         
484         return 1;
485 }
486
487 int BPY_run_script_space_draw(const struct bContext *C, SpaceScript * sc)
488 {
489         if (bpy_run_script_init( (bContext *)C, sc)) {
490                 PyGILState_STATE gilstate = PyGILState_Ensure();
491                 PyObject *result = PyObject_CallObject( sc->script->py_draw, NULL );
492                 
493                 if (result==NULL)
494                         exit_pydraw(sc, 1);
495                         
496                 PyGILState_Release(gilstate);
497         }
498         return 1;
499 }
500
501 // XXX - not used yet, listeners dont get a context
502 int BPY_run_script_space_listener(bContext *C, SpaceScript * sc)
503 {
504         if (bpy_run_script_init(C, sc)) {
505                 PyGILState_STATE gilstate = PyGILState_Ensure();
506                 
507                 PyObject *result = PyObject_CallObject( sc->script->py_draw, NULL );
508                 
509                 if (result==NULL)
510                         exit_pydraw(sc, 1);
511                         
512                 PyGILState_Release(gilstate);
513         }
514         return 1;
515 }
516
517 void BPY_DECREF(void *pyob_ptr)
518 {
519         Py_DECREF((PyObject *)pyob_ptr);
520 }
521
522 #if 0
523 /* called from the the scripts window, assume context is ok */
524 int BPY_run_python_script_space(const char *modulename, const char *func)
525 {
526         PyObject *py_dict, *py_result= NULL;
527         char pystring[512];
528         PyGILState_STATE gilstate;
529         
530         /* for calling the module function */
531         PyObject *py_func, 
532         
533         gilstate = PyGILState_Ensure();
534         
535         py_dict = CreateGlobalDictionary(C);
536         
537         PyObject *module = PyImport_ImportModule(scpt->script.filename);
538         if (module==NULL) {
539                 PyErr_SetFormat(PyExc_SystemError, "could not import '%s'", scpt->script.filename);
540         }
541         else {
542                 py_func = PyObject_GetAttrString(modulename, func);
543                 if (py_func==NULL) {
544                         PyErr_SetFormat(PyExc_SystemError, "module has no function '%s.%s'\n", scpt->script.filename, func);
545                 }
546                 else {
547                         Py_DECREF(py_func);
548                         if (!PyCallable_Check(py_func)) {
549                                 PyErr_SetFormat(PyExc_SystemError, "module item is not callable '%s.%s'\n", scpt->script.filename, func);
550                         }
551                         else {
552                                 py_result= PyObject_CallObject(py_func, NULL); // XXX will need args eventually
553                         }
554                 }
555         }
556         
557         if (!py_result) {
558                 BPy_errors_to_report(NULL); // TODO - reports
559         } else
560                 Py_DECREF( py_result );
561         
562         Py_XDECREF(module);
563         
564         Py_DECREF(py_dict);
565         
566         PyGILState_Release(gilstate);
567         return 1;
568 }
569 #endif
570
571 // #define TIME_REGISTRATION
572
573 #ifdef TIME_REGISTRATION
574 #include "PIL_time.h"
575 #endif
576
577 /* for use by BPY_run_ui_scripts only */
578 static int bpy_import_module(char *modname, int reload)
579 {
580         PyObject *mod= PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
581         if (mod) {
582                 if (reload) {
583                         PyObject *mod_orig= mod;
584                         mod= PyImport_ReloadModule(mod);
585                         Py_DECREF(mod_orig);
586                 }
587         }
588
589         if(mod) {
590                 Py_DECREF(mod); /* could be NULL from reloading */
591                 return 0;
592         } else {
593                 return -1;
594         }
595 }
596
597 /* XXX this is temporary, need a proper script registration system for 2.5 */
598 void BPY_run_ui_scripts(bContext *C, int reload)
599 {
600 #ifdef TIME_REGISTRATION
601         double time = PIL_check_seconds_timer();
602 #endif
603         DIR *dir; 
604         struct dirent *de;
605         char *file_extension;
606         char *dirname;
607         char path[FILE_MAX];
608         char *dirs[] = {"scripts/ui", "scripts/io", NULL};
609         int path_flags[] = {BLI_GETHOME_LOCAL|BLI_GETHOME_SYSTEM, BLI_GETHOME_USER}; /* SYSTEM / NON-SYSTEM */
610         int a, err, flag_iter;
611         
612         PyGILState_STATE gilstate;
613         PyObject *sys_path;
614
615         bpy_context_set(C, &gilstate);
616
617         sys_path= PySys_GetObject("path"); /* borrow */
618         PyList_Insert(sys_path, 0, Py_None); /* place holder, resizes the list */
619
620         /* Scan system scripts first, then local/user */
621         for(flag_iter=0; flag_iter < sizeof(path_flags)/sizeof(int); flag_iter++) {
622                 
623                 for(a=0; dirs[a]; a++) {
624                         dirname= BLI_gethome_folder(dirs[a], path_flags[flag_iter]);
625
626                         if(!dirname)
627                                 continue;
628
629                         dir = opendir(dirname);
630
631                         if(!dir)
632                                 continue;
633                         
634                         /* set the first dir in the sys.path for fast importing of modules */
635                         PyList_SetItem(sys_path, 0, PyUnicode_FromString(dirname)); /* steals the ref */
636                                 
637                         while((de = readdir(dir)) != NULL) {
638                                 /* We could stat the file but easier just to let python
639                                  * import it and complain if theres a problem */
640                                 err = 0;
641
642                                 if (de->d_name[0] == '.') {
643                                         /* do nothing, probably .svn */
644                                 }
645                                 else if ((file_extension = strstr(de->d_name, ".py"))) {
646                                         /* normal py files? */
647                                         if(file_extension && file_extension[3] == '\0') {
648                                                 de->d_name[(file_extension - de->d_name)] = '\0';
649                                                 err= bpy_import_module(de->d_name, reload);
650                                         }
651                                 }
652 #ifndef __linux__
653                                 else if( BLI_join_dirfile(path, dirname, de->d_name), S_ISDIR(BLI_exist(path))) {
654 #else
655                                 else if(de->d_type==DT_DIR) {
656                                         BLI_join_dirfile(path, dirname, de->d_name);
657 #endif
658                                         /* support packages */
659                                         BLI_join_dirfile(path, path, "__init__.py");
660
661                                         if(BLI_exists(path)) {
662                                                 err= bpy_import_module(de->d_name, reload);
663                                         }
664                                 }
665
666                                 if(err==-1) {
667                                         BPy_errors_to_report(NULL);
668                                         fprintf(stderr, "unable to import %s/%s\n", dirname, de->d_name);
669                                 }
670                         }
671
672                         closedir(dir);
673                 }
674         }
675         
676         PyList_SetSlice(sys_path, 0, 1, NULL); /* remove the first item */
677
678         bpy_context_clear(C, &gilstate);
679         
680 #ifdef TIME_REGISTRATION
681         printf("script time %f\n", (PIL_check_seconds_timer()-time));
682 #endif
683
684         /* reset the timer so as not to take loading into the stats */
685         bpy_timer_count = 0;
686 }
687
688 /* ****************************************** */
689 /* Drivers - PyExpression Evaluation */
690
691 /* for pydrivers (drivers using one-line Python expressions to express relationships between targets) */
692 PyObject *bpy_pydriver_Dict = NULL;
693
694 /* For faster execution we keep a special dictionary for pydrivers, with
695  * the needed modules and aliases. 
696  */
697 static int bpy_pydriver_create_dict(void)
698 {
699         PyObject *d, *mod;
700         
701         /* validate namespace for driver evaluation */
702         if (bpy_pydriver_Dict) return -1;
703
704         d = PyDict_New();
705         if (d == NULL) 
706                 return -1;
707         else
708                 bpy_pydriver_Dict = d;
709
710         /* import some modules: builtins, bpy, math, (Blender.noise )*/
711         PyDict_SetItemString(d, "__builtins__", PyEval_GetBuiltins());
712
713         mod = PyImport_ImportModule("math");
714         if (mod) {
715                 PyDict_Merge(d, PyModule_GetDict(mod), 0); /* 0 - dont overwrite existing values */
716                 
717                 /* Only keep for backwards compat! - just import all math into root, they are standard */
718                 PyDict_SetItemString(d, "math", mod);
719                 PyDict_SetItemString(d, "m", mod);
720                 Py_DECREF(mod);
721         } 
722         
723         /* add bpy to global namespace */
724         mod= PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
725         if (mod) {
726                 PyDict_SetItemString(bpy_pydriver_Dict, "bpy", mod);
727                 Py_DECREF(mod);
728         }
729         
730         
731 #if 0 // non existant yet
732         mod = PyImport_ImportModule("Blender.Noise");
733         if (mod) {
734                 PyDict_SetItemString(d, "noise", mod);
735                 PyDict_SetItemString(d, "n", mod);
736                 Py_DECREF(mod);
737         } else {
738                 PyErr_Clear();
739         }
740         
741         /* If there's a Blender text called pydrivers.py, import it.
742          * Users can add their own functions to this module. 
743          */
744         if (G.f & G_DOSCRIPTLINKS) {
745                 mod = importText("pydrivers"); /* can also use PyImport_Import() */
746                 if (mod) {
747                         PyDict_SetItemString(d, "pydrivers", mod);
748                         PyDict_SetItemString(d, "p", mod);
749                         Py_DECREF(mod);
750                 } else {
751                         PyErr_Clear();
752                 }
753         }
754 #endif // non existant yet
755         
756         return 0;
757 }
758
759 /* Update function, it gets rid of pydrivers global dictionary, forcing
760  * BPY_pydriver_eval to recreate it. This function is used to force
761  * reloading the Blender text module "pydrivers.py", if available, so
762  * updates in it reach pydriver evaluation. 
763  */
764 void BPY_pydriver_update(void)
765 {
766         PyGILState_STATE gilstate = PyGILState_Ensure();
767
768         if (bpy_pydriver_Dict) { /* free the global dict used by pydrivers */
769                 PyDict_Clear(bpy_pydriver_Dict);
770                 Py_DECREF(bpy_pydriver_Dict);
771                 bpy_pydriver_Dict = NULL;
772         }
773
774         PyGILState_Release(gilstate);
775
776         return;
777 }
778
779 /* error return function for BPY_eval_pydriver */
780 static float pydriver_error(ChannelDriver *driver) 
781 {
782         if (bpy_pydriver_Dict) { /* free the global dict used by pydrivers */
783                 PyDict_Clear(bpy_pydriver_Dict);
784                 Py_DECREF(bpy_pydriver_Dict);
785                 bpy_pydriver_Dict = NULL;
786         }
787
788         driver->flag |= DRIVER_FLAG_INVALID; /* py expression failed */
789         fprintf(stderr, "\nError in Driver: The following Python expression failed:\n\t'%s'\n\n", driver->expression);
790         
791         BPy_errors_to_report(NULL); // TODO - reports
792
793         return 0.0f;
794 }
795
796 /* This evals py driver expressions, 'expr' is a Python expression that
797  * should evaluate to a float number, which is returned. 
798  */
799 float BPY_pydriver_eval (ChannelDriver *driver)
800 {
801         PyObject *driver_vars=NULL;
802         PyObject *retval;
803         PyGILState_STATE gilstate;
804         
805         DriverTarget *dtar;
806         float result = 0.0f; /* default return */
807         char *expr = NULL;
808         short targets_ok= 1;
809         
810         /* sanity checks - should driver be executed? */
811         if ((driver == NULL) /*|| (G.f & G_DOSCRIPTLINKS)==0*/) 
812                 return result;
813         
814         /* get the py expression to be evaluated */
815         expr = driver->expression; 
816         if ((expr == NULL) || (expr[0]=='\0')) 
817                 return result;
818
819         gilstate = PyGILState_Ensure();
820         
821         /* init global dictionary for py-driver evaluation settings */
822         if (!bpy_pydriver_Dict) {
823                 if (bpy_pydriver_create_dict() != 0) {
824                         fprintf(stderr, "Pydriver error: couldn't create Python dictionary");
825                         PyGILState_Release(gilstate);
826                         return result;
827                 }
828         }
829         
830         /* add target values to a dict that will be used as '__locals__' dict */
831         driver_vars = PyDict_New(); // XXX do we need to decref this?
832         for (dtar= driver->targets.first; dtar; dtar= dtar->next) {
833                 PyObject *driver_arg = NULL;
834                 float tval = 0.0f;
835                 
836                 /* try to get variable value */
837                 tval= driver_get_target_value(driver, dtar);
838                 driver_arg= PyFloat_FromDouble((double)tval);
839                 
840                 /* try to add to dictionary */
841                 if (PyDict_SetItemString(driver_vars, dtar->name, driver_arg)) {
842                         /* this target failed - bad name */
843                         if (targets_ok) {
844                                 /* first one - print some extra info for easier identification */
845                                 fprintf(stderr, "\nBPY_pydriver_eval() - Error while evaluating PyDriver:\n");
846                                 targets_ok= 0;
847                         }
848                         
849                         fprintf(stderr, "\tBPY_pydriver_eval() - couldn't add variable '%s' to namespace \n", dtar->name);
850                         BPy_errors_to_report(NULL); // TODO - reports
851                 }
852         }
853         
854         /* execute expression to get a value */
855         retval = PyRun_String(expr, Py_eval_input, bpy_pydriver_Dict, driver_vars);
856         
857         /* decref the driver vars first...  */
858         Py_DECREF(driver_vars);
859         
860         /* process the result */
861         if (retval == NULL) {
862                 result = pydriver_error(driver);
863                 PyGILState_Release(gilstate);
864                 return result;
865         }
866
867         result = (float)PyFloat_AsDouble(retval);
868         Py_DECREF(retval);
869         
870         if ((result == -1) && PyErr_Occurred()) {
871                 result = pydriver_error(driver);
872                 PyGILState_Release(gilstate);
873                 return result;
874         }
875         
876         /* all fine, make sure the "invalid expression" flag is cleared */
877         driver->flag &= ~DRIVER_FLAG_INVALID;
878
879         PyGILState_Release(gilstate);
880
881         return result;
882 }
883
884 int BPY_button_eval(bContext *C, char *expr, double *value)
885 {
886         PyGILState_STATE gilstate;
887         PyObject *dict, *mod, *retval;
888         int error_ret = 0;
889         
890         if (!value || !expr || expr[0]=='\0') return -1;
891         
892         bpy_context_set(C, &gilstate);
893         
894         dict= CreateGlobalDictionary(C);
895         
896         /* import some modules: builtins,math*/
897         PyDict_SetItemString(dict, "__builtins__", PyEval_GetBuiltins());
898
899         mod = PyImport_ImportModule("math");
900         if (mod) {
901                 PyDict_Merge(dict, PyModule_GetDict(mod), 0); /* 0 - dont overwrite existing values */
902                 
903                 /* Only keep for backwards compat! - just import all math into root, they are standard */
904                 PyDict_SetItemString(dict, "math", mod);
905                 PyDict_SetItemString(dict, "m", mod);
906                 Py_DECREF(mod);
907         } 
908         
909         retval = PyRun_String(expr, Py_eval_input, dict, dict);
910         
911         if (retval == NULL) {
912                 error_ret= -1;
913         }
914         else {
915                 double val;
916
917                 if(PyTuple_Check(retval)) {
918                         /* Users my have typed in 10km, 2m
919                          * add up all values */
920                         int i;
921                         val= 0.0;
922
923                         for(i=0; i<PyTuple_GET_SIZE(retval); i++) {
924                                 val+= PyFloat_AsDouble(PyTuple_GET_ITEM(retval, i));
925                         }
926                 }
927                 else {
928                         val = PyFloat_AsDouble(retval);
929                 }
930                 Py_DECREF(retval);
931                 
932                 if(val==-1 && PyErr_Occurred()) {
933                         error_ret= -1;
934                 }
935                 else {
936                         *value= val;
937                 }
938         }
939         
940         if(error_ret) {
941                 BPy_errors_to_report(CTX_wm_reports(C));
942         }
943         
944         Py_DECREF(dict);
945         bpy_context_clear(C, &gilstate);
946         
947         return error_ret;
948 }
949