Merge with 2.5 -r 21619:21756.
[blender.git] / source / blender / python / intern / bpy_operator.c
index a05456cfe9bec3b2cfb2810c23a26ade9e652e26..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_opwrapper.h"
+#include "bpy_operator_wrap.h"
 #include "bpy_rna.h" /* for setting arg props only - pyrna_py_to_prop() */
 #include "bpy_compat.h"
-
-//#include "blendef.h"
-#include "BLI_dynstr.h"
+#include "bpy_util.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)
+/* 'self' stores the operator string */
+static PyObject *pyop_call( PyObject * self, PyObject * args)
 {
+       wmOperatorType *ot;
        int error_val = 0;
-       int totkw;
-       const char *arg_name= NULL;
-       PyObject *item;
-
-       PropertyRNA *prop, *iterprop;
-       CollectionPropertyIterator iter;
-
-       iterprop= RNA_struct_iterator_property(ptr);
-       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(&iter.ptr, 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, 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 int pyop_func_compare( BPy_OperatorFunc * a, BPy_OperatorFunc * b )
-{
-       return (strcmp(a->name, b->name)==0) ? 0 : -1;
-}
-
-/* For some reason python3 needs these :/ */
-static PyObject *pyop_func_richcmp(BPy_OperatorFunc * a, BPy_OperatorFunc * b, int op)
-{
-       int cmp_result= -1; /* assume false */
-       if (BPy_OperatorFunc_Check(a) && BPy_OperatorFunc_Check(b)) {
-               cmp_result= pyop_func_compare(a, b);
-       }
-
-       return Py_CmpToRich(op, cmp_result);
-}
-
-
-/*----------------------repr--------------------------------------------*/
-static PyObject *pyop_base_repr( BPy_OperatorBase * self )
-{
-       return PyUnicode_FromFormat( "[BPy_OperatorBase]");
-}
-
-static PyObject *pyop_func_repr( BPy_OperatorFunc * self )
-{
-       return PyUnicode_FromFormat( "[BPy_OperatorFunc \"%s\"]", self->name);
-}
-
-static struct PyMethodDef pyop_base_methods[] = {
-       {"add", (PyCFunction)PYOP_wrap_add, METH_VARARGS, ""},
-       {"remove", (PyCFunction)PYOP_wrap_remove, METH_VARARGS, ""},
-       {NULL, NULL, 0, NULL}
-};
+       PointerRNA ptr;
+       
+       char *opname;
+       PyObject *kw= NULL;
 
-//---------------getattr--------------------------------------------
-static PyObject *pyop_base_getattro( BPy_OperatorBase * self, PyObject *pyname )
-{
-       char *name = _PyUnicode_AsString(pyname);
-       PyObject *ret;
-       wmOperatorType *ot;
+       // 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 = BPy_GetContext();
+       
 
-       if ((ot = WM_operatortype_find(name))) {
-               ret= pyop_func_CreatePyObject(self->C, name);
-       }
-       else if (strcmp(name, "__dict__")==0) {
-               ret = PyDict_New();
+       switch(PyTuple_Size(args)) {
+       case 2:
+               kw = PyTuple_GET_ITEM(args, 1);
 
-               wmOperatorType *ot;
-               PyMethodDef *meth;
-               
-               for(ot= WM_operatortype_first(); ot; ot= ot->next) {
-                       PyDict_SetItemString(ret, ot->idname, Py_None);
+               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));
 
-               for(meth=pyop_base_methods; meth->ml_name; meth++) {
-                       PyDict_SetItemString(ret, meth->ml_name, Py_None);
+               if(opname==NULL) {
+                       PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected the first arg to be a string");
+                       return NULL;
                }
-       }
-       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;
-}
-
-/* getseter's */
-PyObject *pyop_func_get_rna(BPy_OperatorFunc *self)
-{
-       BPy_StructRNA *pyrna;
-       PointerRNA ptr;
-       wmOperatorType *ot;
-
-       ot= WM_operatortype_find(self->name);
-       if (ot == NULL) {
-               PyErr_SetString( PyExc_SystemError, "Operator could not be found");
+               break;
+       default:
+               PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected a string and optional dict");
                return NULL;
        }
 
-       pyrna= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ptr); /* were not really using &ptr, overwite next */
 
-       /* XXX POINTER - if this 'ot' is python generated, it could be free'd */
-       RNA_pointer_create(NULL, ot->srna, NULL, &pyrna->ptr);
-       pyrna->freeptr= 1;
+       ot= WM_operatortype_find(opname, 1);
 
-       return (PyObject *)pyrna;
-}
-
-static PyGetSetDef pyop_func_getseters[] = {
-       {"rna", (getter)pyop_func_get_rna, (setter)NULL, "Operator RNA properties", NULL},
-       {NULL,NULL,NULL,NULL,NULL}  /* Sentinel */
-};
-
-static PyObject * pyop_func_call(BPy_OperatorFunc * self, PyObject *args, PyObject *kw)
-{
-       wmOperatorType *ot;
-
-       int error_val = 0;
-       PointerRNA ptr;
-       char *report_str= NULL;
-
-       if (PyTuple_Size(args)) {
-               PyErr_SetString( PyExc_AttributeError, "All operator args must be keywords");
-               return NULL;
-       }
-
-       ot= WM_operatortype_find(self->name);
        if (ot == NULL) {
-               PyErr_SetString( PyExc_SystemError, "Operator could not be found");
+               PyErr_Format( PyExc_SystemError, "bpy.__ops__.call: operator \"%s\"could not be found", opname);
                return NULL;
        }
        
-       if(ot->poll && (ot->poll(self->C) == 0)) {
-               PyErr_SetString( PyExc_SystemError, "Operator poll() function failed, context is incorrect");
+       if(ot->poll && (ot->poll(C) == 0)) {
+               PyErr_SetString( PyExc_SystemError, "bpy.__ops__.call: operator poll() function failed, context is incorrect");
                return NULL;
        }
        
-       WM_operator_properties_create(&ptr, self->name);
+       /* 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;
 
                BKE_reports_init(&reports, RPT_STORE);
 
-               WM_operator_call_py(self->C, ot, &ptr, &reports);
+               WM_operator_call_py(C, ot, &ptr, &reports);
 
-               report_str= BKE_reports_string(&reports, RPT_ERROR);
-
-               if (report_str) {
-                       PyErr_SetString(PyExc_SystemError, report_str);
-                       MEM_freeN(report_str);
+               if(BPy_reports_to_error(&reports))
                        error_val = -1;
-               }
 
-               if (reports.list.first)
-                       BKE_reports_clear(&reports);
+               BKE_reports_clear(&reports);
        }
 
        WM_operator_properties_free(&ptr);
@@ -260,11 +117,11 @@ static PyObject * pyop_func_call(BPy_OperatorFunc * self, PyObject *args, PyObje
        {
                /* no props */
                if (kw != NULL) {
-                       PyErr_Format(PyExc_AttributeError, "Operator \"%s\" does not take any args", self->name);
+                       PyErr_Format(PyExc_AttributeError, "Operator \"%s\" does not take any args", opname);
                        return NULL;
                }
 
-               WM_operator_name_call(self->C, self->name, WM_OP_EXEC_DEFAULT, NULL);
+               WM_operator_name_call(C, opname, WM_OP_EXEC_DEFAULT, NULL);
        }
 #endif
 
@@ -275,222 +132,34 @@ static PyObject * pyop_func_call(BPy_OperatorFunc * self, PyObject *args, PyObje
        Py_RETURN_NONE;
 }
 
-/*-----------------------BPy_OperatorBase method def------------------------------*/
-PyTypeObject pyop_base_Type = {
-#if (PY_VERSION_HEX >= 0x02060000)
-       PyVarObject_HEAD_INIT(NULL, 0)
-#else
-       /* python 2.5 and below */
-       PyObject_HEAD_INIT( NULL )  /* required py macro */
-       0,                          /* ob_size */
-#endif
-
-       "Operator",             /* tp_name */
-       sizeof( BPy_OperatorBase ),                     /* tp_basicsize */
-       0,                      /* tp_itemsize */
-       /* methods */
-       NULL,                                           /* tp_dealloc */
-       NULL,                       /* printfunc tp_print; */
-       NULL,                                           /* getattrfunc tp_getattr; */
-       NULL,                       /* setattrfunc tp_setattr; */
-       NULL,                                           /* tp_compare */
-       ( reprfunc ) pyop_base_repr,    /* tp_repr */
-
-       /* Method suites for standard classes */
-
-       NULL,                       /* PyNumberMethods *tp_as_number; */
-       NULL,                                           /* PySequenceMethods *tp_as_sequence; */
-       NULL,                                           /* PyMappingMethods *tp_as_mapping; */
-
-       /* More standard operations (here for binary compatibility) */
-
-       NULL,                                           /* hashfunc tp_hash; */
-       NULL,                       /* ternaryfunc tp_call; */
-       NULL,                       /* reprfunc tp_str; */
-       ( getattrofunc )pyop_base_getattro, /*PyObject_GenericGetAttr - MINGW Complains, assign later */        /* getattrofunc tp_getattro; */
-       NULL, /*PyObject_GenericSetAttr - MINGW Complains, assign later */      /* setattrofunc tp_setattro; */
-
-       /* Functions to access object as input/output buffer */
-       NULL,                       /* PyBufferProcs *tp_as_buffer; */
-
-  /*** Flags to define presence of optional/expanded features ***/
-       Py_TPFLAGS_DEFAULT,         /* long tp_flags; */
-
-       NULL,                                           /*  char *tp_doc;  Documentation string */
-  /*** Assigned meaning in release 2.0 ***/
-       /* call function for all accessible objects */
-       NULL,                       /* traverseproc tp_traverse; */
-
-       /* delete references to contained objects */
-       NULL,                       /* inquiry tp_clear; */
-
-  /***  Assigned meaning in release 2.1 ***/
-  /*** rich comparisons ***/
-       NULL,                       /* richcmpfunc tp_richcompare; */
-
-  /***  weak reference enabler ***/
-       0,                          /* long tp_weaklistoffset; */
-
-  /*** Added in release 2.2 ***/
-       /*   Iterators */
-       NULL,                                           /* getiterfunc tp_iter; */
-       NULL,                       /* iternextfunc tp_iternext; */
-
-  /*** Attribute descriptor and subclassing stuff ***/
-       pyop_base_methods,                                              /* struct PyMethodDef *tp_methods; */
-       NULL,                       /* struct PyMemberDef *tp_members; */
-       NULL,           /* struct PyGetSetDef *tp_getset; */
-       NULL,                       /* struct _typeobject *tp_base; */
-       NULL,                       /* PyObject *tp_dict; */
-       NULL,                       /* descrgetfunc tp_descr_get; */
-       NULL,                       /* descrsetfunc tp_descr_set; */
-       0,                          /* long tp_dictoffset; */
-       NULL,                       /* initproc tp_init; */
-       NULL,                       /* allocfunc tp_alloc; */
-       NULL,                                           /* newfunc tp_new; */
-       /*  Low-level free-memory routine */
-       NULL,                       /* freefunc tp_free;  */
-       /* For PyObject_IS_GC */
-       NULL,                       /* inquiry tp_is_gc;  */
-       NULL,                       /* PyObject *tp_bases; */
-       /* method resolution order */
-       NULL,                       /* PyObject *tp_mro;  */
-       NULL,                       /* PyObject *tp_cache; */
-       NULL,                       /* PyObject *tp_subclasses; */
-       NULL,                       /* PyObject *tp_weaklist; */
-       NULL
-};
-
-/*-----------------------BPy_OperatorBase method def------------------------------*/
-PyTypeObject pyop_func_Type = {
-#if (PY_VERSION_HEX >= 0x02060000)
-       PyVarObject_HEAD_INIT(NULL, 0)
-#else
-       /* python 2.5 and below */
-       PyObject_HEAD_INIT( NULL )  /* required py macro */
-       0,                          /* ob_size */
-#endif
-
-       "OperatorFunc",         /* tp_name */
-       sizeof( BPy_OperatorFunc ),                     /* tp_basicsize */
-       0,                      /* tp_itemsize */
-       /* methods */
-       NULL,                                           /* tp_dealloc */
-       NULL,                       /* printfunc tp_print; */
-       NULL,                                           /* getattrfunc tp_getattr; */
-       NULL,                       /* setattrfunc tp_setattr; */
-       NULL,                                           /* tp_compare */ /* DEPRECATED in python 3.0! */
-       ( reprfunc ) pyop_func_repr,    /* tp_repr */
-
-       /* Method suites for standard classes */
-
-       NULL,                       /* PyNumberMethods *tp_as_number; */
-       NULL,                                           /* PySequenceMethods *tp_as_sequence; */
-       NULL,                                           /* PyMappingMethods *tp_as_mapping; */
-
-       /* More standard operations (here for binary compatibility) */
-
-       NULL,                                           /* hashfunc tp_hash; */
-       (ternaryfunc)pyop_func_call,                       /* ternaryfunc tp_call; */
-       NULL,                       /* reprfunc tp_str; */
-       NULL,                                           /* getattrofunc tp_getattro; */
-       NULL, /*PyObject_GenericSetAttr - MINGW Complains, assign later */      /* setattrofunc tp_setattro; */
-
-       /* Functions to access object as input/output buffer */
-       NULL,                       /* PyBufferProcs *tp_as_buffer; */
-
-  /*** Flags to define presence of optional/expanded features ***/
-       Py_TPFLAGS_DEFAULT,         /* long tp_flags; */
-
-       NULL,                                           /*  char *tp_doc;  Documentation string */
-  /*** Assigned meaning in release 2.0 ***/
-       /* call function for all accessible objects */
-       NULL,                       /* traverseproc tp_traverse; */
-
-       /* delete references to contained objects */
-       NULL,                       /* inquiry tp_clear; */
-
-  /***  Assigned meaning in release 2.1 ***/
-  /*** rich comparisons ***/
-       (richcmpfunc)pyop_func_richcmp, /* richcmpfunc tp_richcompare; */
-
-  /***  weak reference enabler ***/
-       0,                          /* long tp_weaklistoffset; */
-
-  /*** Added in release 2.2 ***/
-       /*   Iterators */
-       NULL,                                           /* getiterfunc tp_iter; */
-       NULL,                       /* iternextfunc tp_iternext; */
-
-  /*** Attribute descriptor and subclassing stuff ***/
-       NULL,                                           /* struct PyMethodDef *tp_methods; */
-       NULL,                       /* struct PyMemberDef *tp_members; */
-       pyop_func_getseters,            /* struct PyGetSetDef *tp_getset; */
-       NULL,                       /* struct _typeobject *tp_base; */
-       NULL,                       /* PyObject *tp_dict; */
-       NULL,                       /* descrgetfunc tp_descr_get; */
-       NULL,                       /* descrsetfunc tp_descr_set; */
-       0,                          /* long tp_dictoffset; */
-       NULL,                       /* initproc tp_init; */
-       NULL,                       /* allocfunc tp_alloc; */
-       NULL,                                           /* newfunc tp_new; */
-       /*  Low-level free-memory routine */
-       NULL,                       /* freefunc tp_free;  */
-       /* For PyObject_IS_GC */
-       NULL,                       /* inquiry tp_is_gc;  */
-       NULL,                       /* PyObject *tp_bases; */
-       /* method resolution order */
-       NULL,                       /* PyObject *tp_mro;  */
-       NULL,                       /* PyObject *tp_cache; */
-       NULL,                       /* PyObject *tp_subclasses; */
-       NULL,                       /* PyObject *tp_weaklist; */
-       NULL
-};
-
-PyObject *pyop_base_CreatePyObject( bContext *C )
+static PyObject *pyop_dir(PyObject *self)
 {
-       BPy_OperatorBase *pyop;
-
-       pyop = ( BPy_OperatorBase * ) PyObject_NEW( BPy_OperatorBase, &pyop_base_Type );
-
-       if( !pyop ) {
-               PyErr_SetString( PyExc_MemoryError, "couldn't create BPy_OperatorBase object" );
-               return NULL;
+       PyObject *list = PyList_New(0), *name;
+       wmOperatorType *ot;
+       
+       for(ot= WM_operatortype_first(); ot; ot= ot->next) {
+               name = PyUnicode_FromString(ot->idname);
+               PyList_Append(list, name);
+               Py_DECREF(name);
        }
-
-       pyop->C = C; /* TODO - copy this? */
-
-       return ( PyObject * ) pyop;
+       
+       return list;
 }
 
-PyObject *pyop_func_CreatePyObject( bContext *C, char *name )
+PyObject *BPY_operator_module( void )
 {
-       BPy_OperatorFunc *pyop;
-
-       pyop = ( BPy_OperatorFunc * ) PyObject_NEW( BPy_OperatorFunc, &pyop_func_Type );
-
-       if( !pyop ) {
-               PyErr_SetString( PyExc_MemoryError, "couldn't create BPy_OperatorFunc object" );
-               return NULL;
-       }
-
-       strcpy(pyop->name, name);
-       pyop->C= C; /* TODO - how should contexts be dealt with? */
+       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};
 
-       return ( PyObject * ) pyop;
-}
-
-PyObject *BPY_operator_module( bContext *C )
-{
-       if( PyType_Ready( &pyop_base_Type ) < 0 )
-               return NULL;
+       PyObject *submodule = PyModule_New("bpy.__ops__");
+       PyDict_SetItemString(PySys_GetObject("modules"), "bpy.__ops__", submodule);
 
-       if( PyType_Ready( &pyop_func_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 pyop_base_CreatePyObject(C);
+       return submodule;
 }
-
-
-