style cleanup, brackets in else/if, some indentation.
[blender.git] / source / blender / python / intern / bpy_operator.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/python/intern/bpy_operator.c
24  *  \ingroup pythonintern
25  *
26  * This file defines '_bpy.ops', an internal python module which gives python
27  * the ability to inspect and call both C and Python defined operators.
28  *
29  * \note
30  * This module is exposed to the user via 'release/scripts/modules/bpy/ops.py'
31  * which fakes exposing operators as modules/functions using its own classes.
32  */
33
34 #include <Python.h>
35
36 #include "RNA_types.h"
37
38 #include "BPY_extern.h"
39 #include "bpy_operator.h"
40 #include "bpy_operator_wrap.h"
41 #include "bpy_rna.h" /* for setting arg props only - pyrna_py_to_prop() */
42 #include "bpy_util.h"
43 #include "../generic/bpy_internal_import.h"
44
45 #include "BLI_utildefines.h"
46 #include "BLI_string.h"
47
48 #include "RNA_access.h"
49 #include "RNA_enum_types.h"
50
51 #include "WM_api.h"
52 #include "WM_types.h"
53
54 #include "MEM_guardedalloc.h"
55
56 #include "BLI_ghash.h"
57
58 #include "BKE_report.h"
59 #include "BKE_context.h"
60
61 /* so operators called can spawn threads which aquire the GIL */
62 #define BPY_RELEASE_GIL
63
64
65 static PyObject *pyop_poll(PyObject *UNUSED(self), PyObject *args)
66 {
67         wmOperatorType *ot;
68         char            *opname;
69         PyObject        *context_dict = NULL; /* optional args */
70         PyObject        *context_dict_back;
71         char            *context_str = NULL;
72         PyObject        *ret;
73
74         int context = WM_OP_EXEC_DEFAULT;
75
76         /* XXX Todo, work out a better solution for passing on context,
77          * could make a tuple from self and pack the name and Context into it... */
78         bContext *C = (bContext *)BPy_GetContext();
79         
80         if (C == NULL) {
81                 PyErr_SetString(PyExc_RuntimeError, "Context is None, cant poll any operators");
82                 return NULL;
83         }
84
85         if (!PyArg_ParseTuple(args, "s|Os:_bpy.ops.poll", &opname, &context_dict, &context_str))
86                 return NULL;
87         
88         ot = WM_operatortype_find(opname, TRUE);
89
90         if (ot == NULL) {
91                 PyErr_Format(PyExc_AttributeError,
92                              "Polling operator \"bpy.ops.%s\" error, "
93                              "could not be found", opname);
94                 return NULL;
95         }
96
97         if (context_str) {
98                 if (RNA_enum_value_from_id(operator_context_items, context_str, &context) == 0) {
99                         char *enum_str = BPy_enum_as_string(operator_context_items);
100                         PyErr_Format(PyExc_TypeError,
101                                      "Calling operator \"bpy.ops.%s.poll\" error, "
102                                      "expected a string enum in (%.200s)",
103                                      opname, enum_str);
104                         MEM_freeN(enum_str);
105                         return NULL;
106                 }
107         }
108         
109         if (context_dict == NULL || context_dict == Py_None) {
110                 context_dict = NULL;
111         }
112         else if (!PyDict_Check(context_dict)) {
113                 PyErr_Format(PyExc_TypeError,
114                              "Calling operator \"bpy.ops.%s.poll\" error, "
115                              "custom context expected a dict or None, got a %.200s",
116                              opname, Py_TYPE(context_dict)->tp_name);
117                 return NULL;
118         }
119
120         context_dict_back = CTX_py_dict_get(C);
121         CTX_py_dict_set(C, (void *)context_dict);
122         Py_XINCREF(context_dict); /* so we done loose it */
123         
124         /* main purpose of thsi function */
125         ret = WM_operator_poll_context((bContext *)C, ot, context) ? Py_True : Py_False;
126         
127         /* restore with original context dict, probably NULL but need this for nested operator calls */
128         Py_XDECREF(context_dict);
129         CTX_py_dict_set(C, (void *)context_dict_back);
130         
131         Py_INCREF(ret);
132         return ret;
133 }
134
135 static PyObject *pyop_call(PyObject *UNUSED(self), PyObject *args)
136 {
137         wmOperatorType *ot;
138         int error_val = 0;
139         PointerRNA ptr;
140         int operator_ret = OPERATOR_CANCELLED;
141
142         char            *opname;
143         char            *context_str = NULL;
144         PyObject        *kw = NULL; /* optional args */
145         PyObject        *context_dict = NULL; /* optional args */
146         PyObject        *context_dict_back;
147
148         /* note that context is an int, python does the conversion in this case */
149         int context = WM_OP_EXEC_DEFAULT;
150
151         /* XXX Todo, work out a better solution for passing on context,
152          * could make a tuple from self and pack the name and Context into it... */
153         bContext *C = (bContext *)BPy_GetContext();
154         
155         if (C == NULL) {
156                 PyErr_SetString(PyExc_RuntimeError, "Context is None, cant poll any operators");
157                 return NULL;
158         }
159         
160         if (!PyArg_ParseTuple(args, "sO|O!s:_bpy.ops.call", &opname, &context_dict, &PyDict_Type, &kw, &context_str))
161                 return NULL;
162
163         ot = WM_operatortype_find(opname, TRUE);
164
165         if (ot == NULL) {
166                 PyErr_Format(PyExc_AttributeError,
167                              "Calling operator \"bpy.ops.%s\" error, "
168                              "could not be found", opname);
169                 return NULL;
170         }
171         
172         if (!pyrna_write_check()) {
173                 PyErr_Format(PyExc_RuntimeError,
174                              "Calling operator \"bpy.ops.%s\" error, "
175                              "can't modify blend data in this state (drawing/rendering)",
176                              opname);
177                 return NULL;
178         }
179
180         if (context_str) {
181                 if (RNA_enum_value_from_id(operator_context_items, context_str, &context) == 0) {
182                         char *enum_str = BPy_enum_as_string(operator_context_items);
183                         PyErr_Format(PyExc_TypeError,
184                                      "Calling operator \"bpy.ops.%s\" error, "
185                                      "expected a string enum in (%.200s)",
186                                      opname, enum_str);
187                         MEM_freeN(enum_str);
188                         return NULL;
189                 }
190         }
191
192         if (context_dict == NULL || context_dict == Py_None) {
193                 context_dict = NULL;
194         }
195         else if (!PyDict_Check(context_dict)) {
196                 PyErr_Format(PyExc_TypeError,
197                              "Calling operator \"bpy.ops.%s\" error, "
198                              "custom context expected a dict or None, got a %.200s",
199                              opname, Py_TYPE(context_dict)->tp_name);
200                 return NULL;
201         }
202
203         context_dict_back = CTX_py_dict_get(C);
204
205         CTX_py_dict_set(C, (void *)context_dict);
206         Py_XINCREF(context_dict); /* so we done loose it */
207
208         if (WM_operator_poll_context((bContext *)C, ot, context) == FALSE) {
209                 const char *msg = CTX_wm_operator_poll_msg_get(C);
210                 PyErr_Format(PyExc_RuntimeError,
211                              "Operator bpy.ops.%.200s.poll() %.200s",
212                              opname, msg ? msg : "failed, context is incorrect");
213                 CTX_wm_operator_poll_msg_set(C, NULL); /* better set to NULL else it could be used again */
214                 error_val = -1;
215         }
216         else {
217                 WM_operator_properties_create_ptr(&ptr, ot);
218                 WM_operator_properties_sanitize(&ptr, 0);
219
220                 if (kw && PyDict_Size(kw))
221                         error_val = pyrna_pydict_to_props(&ptr, kw, 0, "Converting py args to operator properties: ");
222
223
224                 if (error_val == 0) {
225                         ReportList *reports;
226
227                         reports = MEM_mallocN(sizeof(ReportList), "wmOperatorReportList");
228                         BKE_reports_init(reports, RPT_STORE | RPT_OP_HOLD); /* own so these dont move into global reports */
229
230 #ifdef BPY_RELEASE_GIL
231                         /* release GIL, since a thread could be started from an operator
232                          * that updates a driver */
233                         /* note: I havve not seen any examples of code that does this
234                          * so it may not be officially supported but seems to work ok. */
235                         {
236                                 PyThreadState *ts = PyEval_SaveThread();
237 #endif
238
239                                 operator_ret = WM_operator_call_py(C, ot, context, &ptr, reports);
240
241 #ifdef BPY_RELEASE_GIL
242                                 /* regain GIL */
243                                 PyEval_RestoreThread(ts);
244                         }
245 #endif
246
247                         error_val = BPy_reports_to_error(reports, PyExc_RuntimeError, FALSE);
248
249                         /* operator output is nice to have in the terminal/console too */
250                         if (reports->list.first) {
251                                 char *report_str = BKE_reports_string(reports, 0); /* all reports */
252         
253                                 if (report_str) {
254                                         PySys_WriteStdout("%s\n", report_str);
255                                         MEM_freeN(report_str);
256                                 }
257                         }
258         
259                         BKE_reports_clear(reports);
260                         if ((reports->flag & RPT_FREE) == 0) {
261                                 MEM_freeN(reports);
262                         }
263                 }
264
265                 WM_operator_properties_free(&ptr);
266
267 #if 0
268                 /* if there is some way to know an operator takes args we should use this */
269                 {
270                         /* no props */
271                         if (kw != NULL) {
272                                 PyErr_Format(PyExc_AttributeError,
273                                              "Operator \"%s\" does not take any args",
274                                              opname);
275                                 return NULL;
276                         }
277
278                         WM_operator_name_call(C, opname, WM_OP_EXEC_DEFAULT, NULL);
279                 }
280 #endif
281         }
282
283         /* restore with original context dict, probably NULL but need this for nested operator calls */
284         Py_XDECREF(context_dict);
285         CTX_py_dict_set(C, (void *)context_dict_back);
286
287         if (error_val == -1) {
288                 return NULL;
289         }
290
291         /* when calling  bpy.ops.wm.read_factory_settings() bpy.data's main pointer is freed by clear_globals(),
292          * further access will crash blender. setting context is not needed in this case, only calling because this
293          * function corrects bpy.data (internal Main pointer) */
294         BPY_modules_update(C);
295
296         /* needed for when WM_OT_read_factory_settings us called from within a script */
297         bpy_import_main_set(CTX_data_main(C));
298
299         /* return operator_ret as a bpy enum */
300         return pyrna_enum_bitfield_to_py(operator_return_items, operator_ret);
301
302 }
303
304 static PyObject *pyop_as_string(PyObject *UNUSED(self), PyObject *args)
305 {
306         wmOperatorType *ot;
307         PointerRNA ptr;
308
309         char            *opname;
310         PyObject        *kw = NULL; /* optional args */
311         int all_args = 1;
312         int error_val = 0;
313
314         char *buf = NULL;
315         PyObject *pybuf;
316
317         bContext *C = (bContext *)BPy_GetContext();
318
319         if (C == NULL) {
320                 PyErr_SetString(PyExc_RuntimeError, "Context is None, cant get the string representation of this object.");
321                 return NULL;
322         }
323         
324         if (!PyArg_ParseTuple(args, "s|O!i:_bpy.ops.as_string", &opname, &PyDict_Type, &kw, &all_args))
325                 return NULL;
326
327         ot = WM_operatortype_find(opname, TRUE);
328
329         if (ot == NULL) {
330                 PyErr_Format(PyExc_AttributeError,
331                              "_bpy.ops.as_string: operator \"%.200s\" "
332                              "could not be found", opname);
333                 return NULL;
334         }
335
336         /* WM_operator_properties_create(&ptr, opname); */
337         /* Save another lookup */
338         RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
339
340         if (kw && PyDict_Size(kw))
341                 error_val = pyrna_pydict_to_props(&ptr, kw, 0, "Converting py args to operator properties: ");
342
343         if (error_val == 0)
344                 buf = WM_operator_pystring(C, ot, &ptr, all_args);
345
346         WM_operator_properties_free(&ptr);
347
348         if (error_val == -1) {
349                 return NULL;
350         }
351
352         if (buf) {
353                 pybuf = PyUnicode_FromString(buf);
354                 MEM_freeN(buf);
355         }
356         else {
357                 pybuf = PyUnicode_FromString("");
358         }
359
360         return pybuf;
361 }
362
363 static PyObject *pyop_dir(PyObject *UNUSED(self))
364 {
365         GHashIterator *iter = WM_operatortype_iter();
366         PyObject *list = PyList_New(0), *name;
367
368         for ( ; !BLI_ghashIterator_isDone(iter); BLI_ghashIterator_step(iter)) {
369                 wmOperatorType *ot = BLI_ghashIterator_getValue(iter);
370
371                 name = PyUnicode_FromString(ot->idname);
372                 PyList_Append(list, name);
373                 Py_DECREF(name);
374         }
375         BLI_ghashIterator_free(iter);
376
377         return list;
378 }
379
380 static PyObject *pyop_getrna(PyObject *UNUSED(self), PyObject *value)
381 {
382         wmOperatorType *ot;
383         PointerRNA ptr;
384         const char *opname = _PyUnicode_AsString(value);
385         BPy_StructRNA *pyrna = NULL;
386         
387         if (opname == NULL) {
388                 PyErr_SetString(PyExc_TypeError, "_bpy.ops.get_rna() expects a string argument");
389                 return NULL;
390         }
391         ot = WM_operatortype_find(opname, TRUE);
392         if (ot  == NULL) {
393                 PyErr_Format(PyExc_KeyError, "_bpy.ops.get_rna(\"%s\") not found", opname);
394                 return NULL;
395         }
396         
397         /* type */
398         //RNA_pointer_create(NULL, &RNA_Struct, ot->srna, &ptr);
399
400         /* XXX - should call WM_operator_properties_free */
401         WM_operator_properties_create_ptr(&ptr, ot);
402         WM_operator_properties_sanitize(&ptr, 0);
403
404         
405         pyrna = (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ptr);
406 #ifdef PYRNA_FREE_SUPPORT
407         pyrna->freeptr = TRUE;
408 #endif
409         return (PyObject *)pyrna;
410 }
411
412 static PyObject *pyop_getinstance(PyObject *UNUSED(self), PyObject *value)
413 {
414         wmOperatorType *ot;
415         wmOperator *op;
416         PointerRNA ptr;
417         const char *opname = _PyUnicode_AsString(value);
418         BPy_StructRNA *pyrna = NULL;
419
420         if (opname == NULL) {
421                 PyErr_SetString(PyExc_TypeError, "_bpy.ops.get_instance() expects a string argument");
422                 return NULL;
423         }
424         ot = WM_operatortype_find(opname, TRUE);
425         if (ot == NULL) {
426                 PyErr_Format(PyExc_KeyError, "_bpy.ops.get_instance(\"%s\") not found", opname);
427                 return NULL;
428         }
429
430 #ifdef PYRNA_FREE_SUPPORT
431         op = MEM_callocN(sizeof(wmOperator), __func__);
432 #else
433         op = PyMem_MALLOC(sizeof(wmOperator));
434         memset(op, 0, sizeof(wmOperator));
435 #endif
436         BLI_strncpy(op->idname, op->idname, sizeof(op->idname)); /* incase its needed */
437         op->type = ot;
438
439         RNA_pointer_create(NULL, &RNA_Operator, op, &ptr);
440
441         pyrna = (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ptr);
442 #ifdef PYRNA_FREE_SUPPORT
443         pyrna->freeptr = TRUE;
444 #endif
445         op->ptr = &pyrna->ptr;
446
447         return (PyObject *)pyrna;
448 }
449
450 static struct PyMethodDef bpy_ops_methods[] = {
451         {"poll", (PyCFunction) pyop_poll, METH_VARARGS, NULL},
452         {"call", (PyCFunction) pyop_call, METH_VARARGS, NULL},
453         {"as_string", (PyCFunction) pyop_as_string, METH_VARARGS, NULL},
454         {"dir", (PyCFunction) pyop_dir, METH_NOARGS, NULL},
455         {"get_rna", (PyCFunction) pyop_getrna, METH_O, NULL},           /* only for introspection, leaks memory */
456         {"get_instance", (PyCFunction) pyop_getinstance, METH_O, NULL}, /* only for introspection, leaks memory */
457         {"macro_define", (PyCFunction) PYOP_wrap_macro_define, METH_VARARGS, NULL},
458         {NULL, NULL, 0, NULL}
459 };
460
461 static struct PyModuleDef bpy_ops_module = {
462         PyModuleDef_HEAD_INIT,
463         "_bpy.ops",
464         NULL,
465         -1,/* multiple "initialization" just copies the module dict. */
466         bpy_ops_methods,
467         NULL, NULL, NULL, NULL
468 };
469
470 PyObject *BPY_operator_module(void)
471 {
472         PyObject *submodule;
473
474         submodule = PyModule_Create(&bpy_ops_module);
475
476         return submodule;
477 }