7ca7604e9389858b9bee39bc0d69cc303fd64052
[blender.git] / source / blender / python / intern / bpy_driver.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): Willian P. Germano, Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24 /* ****************************************** */
25 /* Drivers - PyExpression Evaluation */
26
27 #include <Python.h>
28
29 #include "DNA_anim_types.h"
30
31 #include "BLI_listbase.h"
32 #include "BLI_math_base.h"
33
34 #include "BKE_fcurve.h"
35 #include "BKE_global.h"
36
37 /* for pydrivers (drivers using one-line Python expressions to express relationships between targets) */
38 PyObject *bpy_pydriver_Dict = NULL;
39
40 /* For faster execution we keep a special dictionary for pydrivers, with
41  * the needed modules and aliases.
42  */
43 int bpy_pydriver_create_dict(void)
44 {
45         PyObject *d, *mod;
46
47         /* validate namespace for driver evaluation */
48         if (bpy_pydriver_Dict) return -1;
49
50         d = PyDict_New();
51         if (d == NULL)
52                 return -1;
53         else
54                 bpy_pydriver_Dict = d;
55
56         /* import some modules: builtins, bpy, math, (Blender.noise )*/
57         PyDict_SetItemString(d, "__builtins__", PyEval_GetBuiltins());
58
59         mod = PyImport_ImportModule("math");
60         if (mod) {
61                 PyDict_Merge(d, PyModule_GetDict(mod), 0); /* 0 - dont overwrite existing values */
62                 Py_DECREF(mod);
63         }
64
65         /* add bpy to global namespace */
66         mod= PyImport_ImportModuleLevel((char *)"bpy", NULL, NULL, NULL, 0);
67         if (mod) {
68                 PyDict_SetItemString(bpy_pydriver_Dict, "bpy", mod);
69                 Py_DECREF(mod);
70         }
71
72
73 #if 0 // non existant yet
74         mod = PyImport_ImportModule("Blender.Noise");
75         if (mod) {
76                 PyDict_SetItemString(d, "noise", mod);
77                 PyDict_SetItemString(d, "n", mod);
78                 Py_DECREF(mod);
79         } else {
80                 PyErr_Clear();
81         }
82
83         /* If there's a Blender text called pydrivers.py, import it.
84          * Users can add their own functions to this module.
85          */
86         if (G.f & G_SCRIPT_AUTOEXEC) {
87                 mod = importText("pydrivers"); /* can also use PyImport_Import() */
88                 if (mod) {
89                         PyDict_SetItemString(d, "pydrivers", mod);
90                         PyDict_SetItemString(d, "p", mod);
91                         Py_DECREF(mod);
92                 } else {
93                         PyErr_Clear();
94                 }
95         }
96 #endif // non existant yet
97
98         return 0;
99 }
100
101 /* Update function, it gets rid of pydrivers global dictionary, forcing
102  * BPY_eval_driver to recreate it. This function is used to force
103  * reloading the Blender text module "pydrivers.py", if available, so
104  * updates in it reach pydriver evaluation.
105  */
106 void BPY_reset_driver(void)
107 {
108         PyGILState_STATE gilstate;
109         int use_gil= 1; // (PyThreadState_Get()==NULL);
110
111         if(use_gil)
112                 gilstate = PyGILState_Ensure();
113
114         if (bpy_pydriver_Dict) { /* free the global dict used by pydrivers */
115                 PyDict_Clear(bpy_pydriver_Dict);
116                 Py_DECREF(bpy_pydriver_Dict);
117                 bpy_pydriver_Dict = NULL;
118         }
119
120         if(use_gil)
121                 PyGILState_Release(gilstate);
122
123         return;
124 }
125
126 /* error return function for BPY_eval_pydriver */
127 static void pydriver_error(ChannelDriver *driver)
128 {
129         driver->flag |= DRIVER_FLAG_INVALID; /* py expression failed */
130         fprintf(stderr, "\nError in Driver: The following Python expression failed:\n\t'%s'\n\n", driver->expression);
131
132         // BPy_errors_to_report(NULL); // TODO - reports
133         PyErr_Print();
134         PyErr_Clear();
135 }
136
137 /* This evals py driver expressions, 'expr' is a Python expression that
138  * should evaluate to a float number, which is returned.
139  *
140  * note: PyGILState_Ensure() isnt always called because python can call the
141  * bake operator which intern starts a thread which calls scene update which
142  * does a driver update. to avoid a deadlock check PyThreadState_Get() if PyGILState_Ensure() is needed.
143  */
144 float BPY_eval_driver (ChannelDriver *driver)
145 {
146         PyObject *driver_vars=NULL;
147         PyObject *retval= NULL;
148         PyObject *expr_vars; /* speed up by pre-hashing string & avoids re-converting unicode strings for every execution */
149         PyObject *expr_code;
150         PyGILState_STATE gilstate;
151         int use_gil;
152
153         DriverVar *dvar;
154         double result = 0.0; /* default return */
155         char *expr = NULL;
156         short targets_ok= 1;
157         int i;
158
159         /* get the py expression to be evaluated */
160         expr = driver->expression;
161         if ((expr == NULL) || (expr[0]=='\0'))
162                 return 0.0f;
163
164         if(!(G.f & G_SCRIPT_AUTOEXEC)) {
165                 printf("skipping driver '%s', automatic scripts are disabled\n", driver->expression);
166                 return 0.0f;
167         }
168
169         use_gil= 1; //(PyThreadState_Get()==NULL);
170
171         if(use_gil)
172                 gilstate = PyGILState_Ensure();
173
174         /* init global dictionary for py-driver evaluation settings */
175         if (!bpy_pydriver_Dict) {
176                 if (bpy_pydriver_create_dict() != 0) {
177                         fprintf(stderr, "Pydriver error: couldn't create Python dictionary");
178                         if(use_gil)
179                                 PyGILState_Release(gilstate);
180                         return 0.0f;
181                 }
182         }
183
184         if(driver->expr_comp==NULL)
185                 driver->flag |= DRIVER_FLAG_RECOMPILE;
186
187         /* compile the expression first if it hasn't been compiled or needs to be rebuilt */
188         if(driver->flag & DRIVER_FLAG_RECOMPILE) {
189                 Py_XDECREF(driver->expr_comp);
190                 driver->expr_comp= PyTuple_New(2);
191
192                 expr_code= Py_CompileString(expr, "<bpy driver>", Py_eval_input);
193                 PyTuple_SET_ITEM(((PyObject *)driver->expr_comp), 0, expr_code);
194
195                 driver->flag &= ~DRIVER_FLAG_RECOMPILE;
196                 driver->flag |= DRIVER_FLAG_RENAMEVAR; /* maybe this can be removed but for now best keep until were sure */
197         }
198         else {
199                 expr_code= PyTuple_GET_ITEM(((PyObject *)driver->expr_comp), 0);
200         }
201
202         if(driver->flag & DRIVER_FLAG_RENAMEVAR) {
203                 /* may not be set */
204                 expr_vars= PyTuple_GET_ITEM(((PyObject *)driver->expr_comp), 1);
205                 Py_XDECREF(expr_vars);
206
207                 /* intern the arg names so creating the namespace for every run is faster */
208                 expr_vars= PyTuple_New(BLI_countlist(&driver->variables));
209                 PyTuple_SET_ITEM(((PyObject *)driver->expr_comp), 1, expr_vars);
210
211                 for (dvar= driver->variables.first, i=0; dvar; dvar= dvar->next) {
212                         PyTuple_SET_ITEM(expr_vars, i++, PyUnicode_InternFromString(dvar->name));
213                 }
214                 
215                 driver->flag &= ~DRIVER_FLAG_RENAMEVAR;
216         }
217         else {
218                 expr_vars= PyTuple_GET_ITEM(((PyObject *)driver->expr_comp), 1);
219         }
220
221         /* add target values to a dict that will be used as '__locals__' dict */
222         driver_vars = PyDict_New(); // XXX do we need to decref this?
223         for (dvar= driver->variables.first, i=0; dvar; dvar= dvar->next) {
224                 PyObject *driver_arg = NULL;
225                 float tval = 0.0f;
226                 
227                 /* try to get variable value */
228                 tval= driver_get_variable_value(driver, dvar);
229                 driver_arg= PyFloat_FromDouble((double)tval);
230                 
231                 /* try to add to dictionary */
232                 /* if (PyDict_SetItemString(driver_vars, dvar->name, driver_arg)) { */
233                 if (PyDict_SetItem(driver_vars, PyTuple_GET_ITEM(expr_vars, i++), driver_arg) < 0) { /* use string interning for faster namespace creation */
234                         /* this target failed - bad name */
235                         if (targets_ok) {
236                                 /* first one - print some extra info for easier identification */
237                                 fprintf(stderr, "\nBPY_eval_driver() - Error while evaluating PyDriver:\n");
238                                 targets_ok= 0;
239                         }
240                         
241                         fprintf(stderr, "\tBPY_eval_driver() - couldn't add variable '%s' to namespace\n", dvar->name);
242                         // BPy_errors_to_report(NULL); // TODO - reports
243                         PyErr_Print();
244                         PyErr_Clear();
245                 }
246         }
247
248 #if 0 // slow, with this can avoid all Py_CompileString above.
249         /* execute expression to get a value */
250         retval = PyRun_String(expr, Py_eval_input, bpy_pydriver_Dict, driver_vars);
251 #else
252         /* evaluate the compiled expression */
253         if (expr_code)
254                 retval= PyEval_EvalCode((PyCodeObject *)expr_code, bpy_pydriver_Dict, driver_vars);
255 #endif
256
257         /* decref the driver vars first...  */
258         Py_DECREF(driver_vars);
259
260         /* process the result */
261         if (retval == NULL) {
262                 pydriver_error(driver);
263         } else if((result= PyFloat_AsDouble(retval)) == -1.0 && PyErr_Occurred()) {
264                 pydriver_error(driver);
265                 Py_DECREF(retval);
266                 result = 0.0;
267         }
268         else {
269                 /* all fine, make sure the "invalid expression" flag is cleared */
270                 driver->flag &= ~DRIVER_FLAG_INVALID;
271                 Py_DECREF(retval);
272         }
273
274         if(use_gil)
275                 PyGILState_Release(gilstate);
276     
277         if(finite(result)) {
278                 return (float)result;
279         }
280         else {
281                 fprintf(stderr, "\tBPY_eval_driver() - driver '%s' evaluates to '%f'\n", dvar->name, result);
282                 return 0.0f;
283         }
284 }