/** * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software Foundation, * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * Contributor(s): Campbell Barton * * ***** END GPL LICENSE BLOCK ***** */ #include "bpy_opwrapper.h" #include "BLI_listbase.h" #include "BKE_context.h" #include "BKE_report.h" #include "DNA_windowmanager_types.h" #include "MEM_guardedalloc.h" #include "WM_api.h" #include "WM_types.h" #include "ED_screen.h" #include "RNA_define.h" #include "bpy_rna.h" #include "bpy_compat.h" #include "bpy_util.h" typedef struct PyOperatorType { void *next, *prev; char idname[OP_MAX_TYPENAME]; char name[OP_MAX_TYPENAME]; PyObject *py_invoke; PyObject *py_exec; } PyOperatorType; static PyObject *pyop_kwargs_from_operator(wmOperator *op) { PyObject *dict = PyDict_New(); PyObject *item; PropertyRNA *prop, *iterprop; CollectionPropertyIterator iter; const char *arg_name; iterprop= RNA_struct_iterator_property(op->ptr); RNA_property_collection_begin(op->ptr, iterprop, &iter); for(; iter.valid; RNA_property_collection_next(&iter)) { prop= iter.ptr.data; arg_name= RNA_property_identifier(&iter.ptr, prop); if (strcmp(arg_name, "rna_type")==0) continue; item = pyrna_prop_to_py(op->ptr, prop); PyDict_SetItemString(dict, arg_name, item); Py_DECREF(item); } RNA_property_collection_end(&iter); return dict; } static PyObject *pyop_dict_from_event(wmEvent *event) { PyObject *dict= PyDict_New(); PyObject *item; char *cstring, ascii[2]; /* type */ item= PyUnicode_FromString(WM_key_event_string(event->type)); PyDict_SetItemString(dict, "type", item); Py_DECREF(item); /* val */ switch(event->val) { case KM_ANY: cstring = "ANY"; break; case KM_RELEASE: cstring = "RELEASE"; break; case KM_PRESS: cstring = "PRESS"; break; default: cstring = "UNKNOWN"; break; } item= PyUnicode_FromString(cstring); PyDict_SetItemString(dict, "val", item); Py_DECREF(item); /* x, y (mouse) */ item= PyLong_FromLong(event->x); PyDict_SetItemString(dict, "x", item); Py_DECREF(item); item= PyLong_FromLong(event->y); PyDict_SetItemString(dict, "y", item); Py_DECREF(item); item= PyLong_FromLong(event->prevx); PyDict_SetItemString(dict, "prevx", item); Py_DECREF(item); item= PyLong_FromLong(event->prevy); PyDict_SetItemString(dict, "prevy", item); Py_DECREF(item); /* ascii */ ascii[0]= event->ascii; ascii[1]= '\0'; item= PyUnicode_FromString(ascii); PyDict_SetItemString(dict, "ascii", item); Py_DECREF(item); /* modifier keys */ item= PyLong_FromLong(event->shift); PyDict_SetItemString(dict, "shift", item); Py_DECREF(item); item= PyLong_FromLong(event->ctrl); PyDict_SetItemString(dict, "ctrl", item); Py_DECREF(item); item= PyLong_FromLong(event->alt); PyDict_SetItemString(dict, "alt", item); Py_DECREF(item); item= PyLong_FromLong(event->oskey); PyDict_SetItemString(dict, "oskey", item); Py_DECREF(item); /* modifier */ #if 0 item= PyTuple_New(0); if(event->keymodifier & KM_SHIFT) { _PyTuple_Resize(&item, size+1); PyTuple_SET_ITEM(item, size, _PyUnicode_AsString("SHIFT")); size++; } if(event->keymodifier & KM_CTRL) { _PyTuple_Resize(&item, size+1); PyTuple_SET_ITEM(item, size, _PyUnicode_AsString("CTRL")); size++; } if(event->keymodifier & KM_ALT) { _PyTuple_Resize(&item, size+1); PyTuple_SET_ITEM(item, size, _PyUnicode_AsString("ALT")); size++; } if(event->keymodifier & KM_OSKEY) { _PyTuple_Resize(&item, size+1); PyTuple_SET_ITEM(item, size, _PyUnicode_AsString("OSKEY")); size++; } PyDict_SetItemString(dict, "keymodifier", item); Py_DECREF(item); #endif return dict; } /* TODO - a whole traceback would be ideal */ static void pyop_error_report(ReportList *reports) { PyObject *exception, *v, *tb; PyErr_Fetch(&exception, &v, &tb); if (exception == NULL) return; /* Now we know v != NULL too */ BKE_report(reports, RPT_ERROR, _PyUnicode_AsString(v)); PyErr_Print(); } static struct BPY_flag_def pyop_ret_flags[] = { {"RUNNING_MODAL", OPERATOR_RUNNING_MODAL}, {"CANCELLED", OPERATOR_CANCELLED}, {"FINISHED", OPERATOR_FINISHED}, {"PASS_THROUGH", OPERATOR_PASS_THROUGH}, {NULL, 0} }; /* exec only - no user input */ static int PYTHON_OT_exec(bContext *C, wmOperator *op) { PyOperatorType *pyot = op->type->pyop_data; PyObject *args= PyTuple_New(0); PyObject *kw= pyop_kwargs_from_operator(op); PyObject *ret; int ret_flag; ret = PyObject_Call(pyot->py_exec, args, kw); if (ret == NULL) { pyop_error_report(op->reports); } else { if (BPY_flag_from_seq(pyop_ret_flags, ret, &ret_flag) == -1) { /* the returned value could not be converted into a flag */ pyop_error_report(op->reports); } } Py_DECREF(args); Py_DECREF(kw); return ret_flag; } /* This invoke function can take events and * * It is up to the pyot->py_invoke() python func to run pyot->py_exec() * the invoke function gets the keyword props as a dict, but can parse them * to py_exec like this... * * def op_exec(x=-1, y=-1, text=""): * ... * * def op_invoke(event, prop_defs): * prop_defs['x'] = event['x'] * ... * op_exec(**prop_defs) * * when there is no invoke function, C calls exec and sets the props. */ static int PYTHON_OT_invoke(bContext *C, wmOperator *op, wmEvent *event) { PyOperatorType *pyot = op->type->pyop_data; PyObject *args= PyTuple_New(2); PyObject *ret; int ret_flag; PyTuple_SET_ITEM(args, 0, pyop_dict_from_event(event)); PyTuple_SET_ITEM(args, 1, pyop_kwargs_from_operator(op)); ret = PyObject_Call(pyot->py_invoke, args, NULL); if (ret == NULL) { pyop_error_report(op->reports); } else { if (BPY_flag_from_seq(pyop_ret_flags, ret, &ret_flag) == -1) { /* the returned value could not be converted into a flag */ pyop_error_report(op->reports); } /* there is no need to copy the py keyword dict modified by * pyot->py_invoke(), back to the operator props since they are just * thrown away anyway * * If we ever want to do this and use the props again, * it can be done with - PYOP_props_from_dict(op->ptr, kw) */ } Py_DECREF(args); /* also decref's kw */ return ret_flag; } void PYTHON_OT_wrapper(wmOperatorType *ot, void *userdata) { PyOperatorType *pyot = (PyOperatorType *)userdata; /* identifiers */ ot->name= pyot->name; ot->idname= pyot->idname; /* api callbacks */ if (pyot->py_invoke != Py_None) ot->invoke= PYTHON_OT_invoke; ot->exec= PYTHON_OT_exec; ot->poll= ED_operator_screenactive; /* how should this work?? */ /* ot->flag= OPTYPE_REGISTER; */ ot->pyop_data= userdata; /* inspect function keyword args to get properties */ { PropertyRNA *prop; PyObject *var_names= PyObject_GetAttrString(PyFunction_GET_CODE(pyot->py_exec), "co_varnames"); PyObject *var_vals = PyFunction_GET_DEFAULTS(pyot->py_exec); PyObject *py_val, *py_name; int i; char *name; if (PyTuple_Size(var_names) != PyTuple_Size(var_vals)) { printf("All args must be keywords"); } for(i=0; isrna, name, PROP_BOOLEAN, PROP_NONE); RNA_def_property_boolean_default(prop, PyObject_IsTrue(py_val)); } else if (PyLong_Check(py_val)) { prop = RNA_def_property(ot->srna, name, PROP_INT, PROP_NONE); RNA_def_property_int_default(prop, (int)PyLong_AsSsize_t(py_val)); } else if (PyFloat_Check(py_val)) { prop = RNA_def_property(ot->srna, name, PROP_FLOAT, PROP_NONE); RNA_def_property_float_default(prop, (float)PyFloat_AsDouble(py_val)); } else if (PyUnicode_Check(py_val)) { /* WARNING - holding a reference to the string from py_val is * not ideal since we rely on python keeping it, * however we're also keeping a reference to this function * so it should be OK!. just be careful with changes */ prop = RNA_def_property(ot->srna, name, PROP_STRING, PROP_NONE); RNA_def_property_string_default(prop, _PyUnicode_AsString(py_val)); } else { printf("error, python function arg \"%s\" was not a bool, int, float or string type\n", name); } } } } /* pyOperators - Operators defined IN Python */ PyObject *PYOP_wrap_add(PyObject *self, PyObject *args) { PyOperatorType *pyot; char *idname= NULL; char *name= NULL; PyObject *invoke= NULL; PyObject *exec= NULL; if (!PyArg_ParseTuple(args, "ssOO", &idname, &name, &invoke, &exec)) { PyErr_SetString( PyExc_AttributeError, "expected 2 strings and 2 function objects"); return NULL; } if (WM_operatortype_find(idname)) { PyErr_Format( PyExc_AttributeError, "First argument \"%s\" operator alredy exists with this name", idname); return NULL; } if (((PyFunction_Check(invoke) || invoke==Py_None) && PyFunction_Check(exec)) == 0) { PyErr_SetString( PyExc_AttributeError, "the 2nd arg must be a function or None, the secons must be a function"); return NULL; } pyot= MEM_callocN(sizeof(PyOperatorType), "PyOperatorType"); strcpy(pyot->idname, idname); strcpy(pyot->name, name); pyot->py_invoke= invoke; pyot->py_exec= exec; Py_INCREF(invoke); Py_INCREF(exec); WM_operatortype_append_ptr(PYTHON_OT_wrapper, pyot); Py_RETURN_NONE; } PyObject *PYOP_wrap_remove(PyObject *self, PyObject *args) { char *idname= NULL; wmOperatorType *ot; PyOperatorType *pyot; if (!PyArg_ParseTuple(args, "s", &idname)) return NULL; if (!(ot= WM_operatortype_find(idname))) { PyErr_Format( PyExc_AttributeError, "Operator \"%s\" does not exists, cant remove", idname); return NULL; } if (!(pyot= (PyOperatorType *)ot->pyop_data)) { PyErr_Format( PyExc_AttributeError, "Operator \"%s\" was not created by python", idname); return NULL; } Py_XDECREF(pyot->py_invoke); Py_XDECREF(pyot->py_exec); MEM_freeN(pyot); WM_operatortype_remove(idname); Py_RETURN_NONE; }