Merge with 2.5 -r 21619:21756.
[blender.git] / source / blender / python / intern / bpy_operator.c
index f8dcb1f43a17775dc40dccdada0f071a0b968bd4..240ce2030bae0cb18fb386e06f52920481b091f4 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/* Note, this module is not to be used directly by the user.
+ * its accessed from blender with bpy.__ops__
+ * */
+
 #include "bpy_operator.h"
 #include "bpy_operator_wrap.h"
 #include "bpy_rna.h" /* for setting arg props only - pyrna_py_to_prop() */
 #include "bpy_compat.h"
 #include "bpy_util.h"
 
-//#include "blendef.h"
-#include "BLI_dynstr.h"
-
 #include "WM_api.h"
 #include "WM_types.h"
 
 #include "MEM_guardedalloc.h"
-//#include "BKE_idprop.h"
 #include "BKE_report.h"
 
-extern ListBase global_ops; /* evil, temp use */
-
-
-
-/* This function is only used by operators right now
- * Its used for taking keyword args and filling in property values */
-int PYOP_props_from_dict(PointerRNA *ptr, PyObject *kw)
-{
-       int error_val = 0;
-       int totkw;
-       const char *arg_name= NULL;
-       PyObject *item;
-
-       PropertyRNA *prop, *iterprop;
-       CollectionPropertyIterator iter;
-
-       iterprop= RNA_struct_iterator_property(ptr->type);
-       RNA_property_collection_begin(ptr, iterprop, &iter);
-
-       totkw = kw ? PyDict_Size(kw):0;
-
-       for(; iter.valid; RNA_property_collection_next(&iter)) {
-               prop= iter.ptr.data;
-
-               arg_name= RNA_property_identifier(prop);
-
-               if (strcmp(arg_name, "rna_type")==0) continue;
-
-               if (kw==NULL) {
-                       PyErr_Format( PyExc_AttributeError, "no args, expected \"%s\"", arg_name ? arg_name : "<UNKNOWN>");
-                       error_val= -1;
-                       break;
-               }
-
-               item= PyDict_GetItemString(kw, arg_name);
-
-               if (item == NULL) {
-                       PyErr_Format( PyExc_AttributeError, "argument \"%s\" missing", arg_name ? arg_name : "<UNKNOWN>");
-                       error_val = -1; /* pyrna_py_to_prop sets the error */
-                       break;
-               }
-
-               if (pyrna_py_to_prop(ptr, prop, NULL, item)) {
-                       error_val= -1;
-                       break;
-               }
-
-               totkw--;
-       }
-
-       RNA_property_collection_end(&iter);
-
-       if (error_val==0 && totkw > 0) { /* some keywords were given that were not used :/ */
-               PyObject *key, *value;
-               Py_ssize_t pos = 0;
-
-               while (PyDict_Next(kw, &pos, &key, &value)) {
-                       arg_name= _PyUnicode_AsString(key);
-                       if (RNA_struct_find_property(ptr, arg_name) == NULL) break;
-                       arg_name= NULL;
-               }
-
-               PyErr_Format( PyExc_AttributeError, "argument \"%s\" unrecognized", arg_name ? arg_name : "<UNKNOWN>");
-               error_val = -1;
-       }
-
-       return error_val;
-}
-
-static PyObject *pyop_base_dir(PyObject *self);
-static PyObject *pyop_base_rna(PyObject *self, PyObject *pyname);
-static struct PyMethodDef pyop_base_methods[] = {
-       {"__dir__", (PyCFunction)pyop_base_dir, METH_NOARGS, ""},
-       {"__rna__", (PyCFunction)pyop_base_rna, METH_O, ""},
-       {"add", (PyCFunction)PYOP_wrap_add, METH_O, ""},
-       {"remove", (PyCFunction)PYOP_wrap_remove, METH_O, ""},
-       {NULL, NULL, 0, NULL}
-};
 
 /* 'self' stores the operator string */
-static PyObject *pyop_base_call( PyObject * self, PyObject * args,  PyObject * kw)
+static PyObject *pyop_call( PyObject * self, PyObject * args)
 {
        wmOperatorType *ot;
        int error_val = 0;
        PointerRNA ptr;
        
+       char *opname;
+       PyObject *kw= NULL;
+
        // XXX Todo, work out a better solution for passing on context, could make a tuple from self and pack the name and Context into it...
-       bContext *C = (bContext *)PyCObject_AsVoidPtr(PyDict_GetItemString(PyEval_GetGlobals(), "__bpy_context__"));
+       bContext *C = BPy_GetContext();
        
-       char *opname = _PyUnicode_AsString(self);
 
-       if (PyTuple_Size(args)) {
-               PyErr_SetString( PyExc_AttributeError, "All operator args must be keywords");
+       switch(PyTuple_Size(args)) {
+       case 2:
+               kw = PyTuple_GET_ITEM(args, 1);
+
+               if(!PyDict_Check(kw)) {
+                       PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected second arg to be a dict");
+                       return NULL;
+               }
+               /* pass through */
+       case 1:
+               opname = _PyUnicode_AsString(PyTuple_GET_ITEM(args, 0));
+
+               if(opname==NULL) {
+                       PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected the first arg to be a string");
+                       return NULL;
+               }
+               break;
+       default:
+               PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected a string and optional dict");
                return NULL;
        }
 
-       ot= WM_operatortype_find(opname);
+
+       ot= WM_operatortype_find(opname, 1);
+
        if (ot == NULL) {
-               PyErr_Format( PyExc_SystemError, "Operator \"%s\"could not be found", opname);
+               PyErr_Format( PyExc_SystemError, "bpy.__ops__.call: operator \"%s\"could not be found", opname);
                return NULL;
        }
        
        if(ot->poll && (ot->poll(C) == 0)) {
-               PyErr_SetString( PyExc_SystemError, "Operator poll() function failed, context is incorrect");
+               PyErr_SetString( PyExc_SystemError, "bpy.__ops__.call: operator poll() function failed, context is incorrect");
                return NULL;
        }
        
-       WM_operator_properties_create(&ptr, opname);
+       /* WM_operator_properties_create(&ptr, opname); */
+       /* Save another lookup */
+       RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
        
-       error_val= PYOP_props_from_dict(&ptr, kw);
+       if(kw && PyDict_Size(kw))
+               error_val= pyrna_pydict_to_props(&ptr, kw, "Converting py args to operator properties: ");
+
        
        if (error_val==0) {
                ReportList reports;
@@ -185,89 +132,34 @@ static PyObject *pyop_base_call( PyObject * self, PyObject * args,  PyObject * k
        Py_RETURN_NONE;
 }
 
-static PyMethodDef pyop_base_call_meth[] = {
-       {"__op_call__", (PyCFunction)pyop_base_call, METH_VARARGS|METH_KEYWORDS, "generic operator calling function"}
-};
-
-
-//---------------getattr--------------------------------------------
-static PyObject *pyop_base_getattro( BPy_OperatorBase * self, PyObject *pyname )
-{
-       char *name = _PyUnicode_AsString(pyname);
-       PyObject *ret;
-       wmOperatorType *ot;
-       
-       if ((ot= WM_operatortype_find(name))) {
-               ret = PyCFunction_New( pyop_base_call_meth, pyname); /* set the name string as self, PyCFunction_New incref's self */
-       }
-       else if ((ret = PyObject_GenericGetAttr((PyObject *)self, pyname))) {
-               /* do nothing, this accounts for methoddef's add and remove */
-       }
-       else {
-               PyErr_Format( PyExc_AttributeError, "Operator \"%s\" not found", name);
-               ret= NULL;
-       }
-
-       return ret;
-}
-
-static PyObject *pyop_base_dir(PyObject *self)
+static PyObject *pyop_dir(PyObject *self)
 {
        PyObject *list = PyList_New(0), *name;
        wmOperatorType *ot;
-       PyMethodDef *meth;
        
        for(ot= WM_operatortype_first(); ot; ot= ot->next) {
                name = PyUnicode_FromString(ot->idname);
                PyList_Append(list, name);
                Py_DECREF(name);
        }
-
-       for(meth=pyop_base_methods; meth->ml_name; meth++) {
-               name = PyUnicode_FromString(meth->ml_name);
-               PyList_Append(list, name);
-               Py_DECREF(name);
-       }
        
        return list;
 }
 
-static PyObject *pyop_base_rna(PyObject *self, PyObject *pyname)
+PyObject *BPY_operator_module( void )
 {
-       char *name = _PyUnicode_AsString(pyname);
-       wmOperatorType *ot;
-       
-       if ((ot= WM_operatortype_find(name))) {
-               BPy_StructRNA *pyrna;
-               PointerRNA ptr;
-               
-               /* XXX POINTER - if this 'ot' is python generated, it could be free'd */
-               RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
-               
-               pyrna= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ptr); /* were not really using &ptr, overwite next */
-               //pyrna->freeptr= 1;
-               return (PyObject *)pyrna;
-       }
-       else {
-               PyErr_Format(PyExc_AttributeError, "Operator \"%s\" not found", name);
-               return NULL;
-       }
-}
+       static PyMethodDef pyop_call_meth =             {"call", (PyCFunction) pyop_call, METH_VARARGS, NULL};
+       static PyMethodDef pyop_dir_meth =              {"dir", (PyCFunction) pyop_dir, METH_NOARGS, NULL};
+       static PyMethodDef pyop_add_meth =              {"add", (PyCFunction) PYOP_wrap_add, METH_O, NULL};
+       static PyMethodDef pyop_remove_meth =   {"remove", (PyCFunction) PYOP_wrap_remove, METH_O, NULL};
 
-PyTypeObject pyop_base_Type = {NULL};
+       PyObject *submodule = PyModule_New("bpy.__ops__");
+       PyDict_SetItemString(PySys_GetObject("modules"), "bpy.__ops__", submodule);
 
-PyObject *BPY_operator_module( void )
-{
-       pyop_base_Type.tp_name = "OperatorBase";
-       pyop_base_Type.tp_basicsize = sizeof( BPy_OperatorBase );
-       pyop_base_Type.tp_getattro = ( getattrofunc )pyop_base_getattro;
-       pyop_base_Type.tp_flags = Py_TPFLAGS_DEFAULT;
-       pyop_base_Type.tp_methods = pyop_base_methods;
-       
-       if( PyType_Ready( &pyop_base_Type ) < 0 )
-               return NULL;
+       PyModule_AddObject( submodule, "call",  PyCFunction_New(&pyop_call_meth,        NULL) );
+       PyModule_AddObject( submodule, "dir",           PyCFunction_New(&pyop_dir_meth,         NULL) );
+       PyModule_AddObject( submodule, "add",           PyCFunction_New(&pyop_add_meth,         NULL) );
+       PyModule_AddObject( submodule, "remove",        PyCFunction_New(&pyop_remove_meth,      NULL) );
 
-       //submodule = Py_InitModule3( "operator", M_rna_methods, "rna module" );
-       return (PyObject *)PyObject_NEW( BPy_OperatorBase, &pyop_base_Type );
+       return submodule;
 }
-