Freestyle Python API improvements - part 6.

Fix for PyGetSetDef and proper handling of keyword arguments were done in
Function0D and Function1D classes.  Additional code clean-up was also made.

1 files changed, 75 insertions, 99 deletions

diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp
index 07fb48dd9a8..180f39c5e59 100644
--- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp
+++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp
@@ -28,84 +28,84 @@ extern "C" {
 
 //-------------------MODULE INITIALIZATION--------------------------------
 
-int UnaryFunction1DDouble_Init( PyObject *module ) {
-
-	if( module == NULL )
+int UnaryFunction1DDouble_Init(PyObject *module)
+{
+	if (module == NULL)
 		return -1;
 
-	if( PyType_Ready( &UnaryFunction1DDouble_Type ) < 0 )
+	if (PyType_Ready(&UnaryFunction1DDouble_Type) < 0)
 		return -1;
-	Py_INCREF( &UnaryFunction1DDouble_Type );
+	Py_INCREF(&UnaryFunction1DDouble_Type);
 	PyModule_AddObject(module, "UnaryFunction1DDouble", (PyObject *)&UnaryFunction1DDouble_Type);
 
-	if( PyType_Ready( &DensityF1D_Type ) < 0 )
+	if (PyType_Ready(&DensityF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &DensityF1D_Type );
+	Py_INCREF(&DensityF1D_Type);
 	PyModule_AddObject(module, "DensityF1D", (PyObject *)&DensityF1D_Type);
 
-	if( PyType_Ready( &Curvature2DAngleF1D_Type ) < 0 )
+	if (PyType_Ready(&Curvature2DAngleF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &Curvature2DAngleF1D_Type );
+	Py_INCREF(&Curvature2DAngleF1D_Type);
 	PyModule_AddObject(module, "Curvature2DAngleF1D", (PyObject *)&Curvature2DAngleF1D_Type);
 
-	if( PyType_Ready( &GetCompleteViewMapDensityF1D_Type ) < 0 )
+	if (PyType_Ready(&GetCompleteViewMapDensityF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetCompleteViewMapDensityF1D_Type );
+	Py_INCREF(&GetCompleteViewMapDensityF1D_Type);
 	PyModule_AddObject(module, "GetCompleteViewMapDensityF1D", (PyObject *)&GetCompleteViewMapDensityF1D_Type);
 
-	if( PyType_Ready( &GetDirectionalViewMapDensityF1D_Type ) < 0 )
+	if (PyType_Ready(&GetDirectionalViewMapDensityF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetDirectionalViewMapDensityF1D_Type );
+	Py_INCREF(&GetDirectionalViewMapDensityF1D_Type);
 	PyModule_AddObject(module, "GetDirectionalViewMapDensityF1D", (PyObject *)&GetDirectionalViewMapDensityF1D_Type);
 
-	if( PyType_Ready( &GetProjectedXF1D_Type ) < 0 )
+	if (PyType_Ready(&GetProjectedXF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetProjectedXF1D_Type );
+	Py_INCREF(&GetProjectedXF1D_Type);
 	PyModule_AddObject(module, "GetProjectedXF1D", (PyObject *)&GetProjectedXF1D_Type);
 
-	if( PyType_Ready( &GetProjectedYF1D_Type ) < 0 )
+	if (PyType_Ready(&GetProjectedYF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetProjectedYF1D_Type );
+	Py_INCREF(&GetProjectedYF1D_Type);
 	PyModule_AddObject(module, "GetProjectedYF1D", (PyObject *)&GetProjectedYF1D_Type);
 	
-	if( PyType_Ready( &GetProjectedZF1D_Type ) < 0 )
+	if (PyType_Ready(&GetProjectedZF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetProjectedZF1D_Type );
+	Py_INCREF(&GetProjectedZF1D_Type);
 	PyModule_AddObject(module, "GetProjectedZF1D", (PyObject *)&GetProjectedZF1D_Type);
 
-	if( PyType_Ready( &GetSteerableViewMapDensityF1D_Type ) < 0 )
+	if (PyType_Ready(&GetSteerableViewMapDensityF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetSteerableViewMapDensityF1D_Type );
+	Py_INCREF(&GetSteerableViewMapDensityF1D_Type);
 	PyModule_AddObject(module, "GetSteerableViewMapDensityF1D", (PyObject *)&GetSteerableViewMapDensityF1D_Type);
 
-	if( PyType_Ready( &GetViewMapGradientNormF1D_Type ) < 0 )
+	if (PyType_Ready(&GetViewMapGradientNormF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetViewMapGradientNormF1D_Type );
+	Py_INCREF(&GetViewMapGradientNormF1D_Type);
 	PyModule_AddObject(module, "GetViewMapGradientNormF1D", (PyObject *)&GetViewMapGradientNormF1D_Type);
 
-	if( PyType_Ready( &GetXF1D_Type ) < 0 )
+	if (PyType_Ready(&GetXF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetXF1D_Type );
+	Py_INCREF(&GetXF1D_Type);
 	PyModule_AddObject(module, "GetXF1D", (PyObject *)&GetXF1D_Type);
 
-	if( PyType_Ready( &GetYF1D_Type ) < 0 )
+	if (PyType_Ready(&GetYF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetYF1D_Type );
+	Py_INCREF(&GetYF1D_Type);
 	PyModule_AddObject(module, "GetYF1D", (PyObject *)&GetYF1D_Type);
 
-	if( PyType_Ready( &GetZF1D_Type ) < 0 )
+	if (PyType_Ready(&GetZF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &GetZF1D_Type );
+	Py_INCREF(&GetZF1D_Type);
 	PyModule_AddObject(module, "GetZF1D", (PyObject *)&GetZF1D_Type);
 
-	if( PyType_Ready( &LocalAverageDepthF1D_Type ) < 0 )
+	if (PyType_Ready(&LocalAverageDepthF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &LocalAverageDepthF1D_Type );
+	Py_INCREF(&LocalAverageDepthF1D_Type);
 	PyModule_AddObject(module, "LocalAverageDepthF1D", (PyObject *)&LocalAverageDepthF1D_Type);
 
-	if( PyType_Ready( &ZDiscontinuityF1D_Type ) < 0 )
+	if (PyType_Ready(&ZDiscontinuityF1D_Type) < 0)
 		return -1;
-	Py_INCREF( &ZDiscontinuityF1D_Type );
+	Py_INCREF(&ZDiscontinuityF1D_Type);
 	PyModule_AddObject(module, "ZDiscontinuityF1D", (PyObject *)&ZDiscontinuityF1D_Type);
 
 	return 0;
@@ -123,25 +123,26 @@ static char UnaryFunction1DDouble___doc__[] =
 "\n"
 "   Default constructor.\n"
 "\n"
-".. method:: __init__(integration)\n"
+".. method:: __init__(integration_type)\n"
 "\n"
 "   Builds a unary 1D function using the integration method given as\n"
 "   argument.\n"
 "\n"
-"   :arg integration: An integration method.\n"
-"   :type integration: :class:`IntegrationType`\n";
+"   :arg integration_type: An integration method.\n"
+"   :type integration_type: :class:`IntegrationType`\n";
 
-static int UnaryFunction1DDouble___init__(BPy_UnaryFunction1DDouble* self, PyObject *args)
+static int UnaryFunction1DDouble___init__(BPy_UnaryFunction1DDouble* self, PyObject *args, PyObject *kwds)
 {
+	static const char *kwlist[] = {"integration", NULL};
 	PyObject *obj = 0;
 
-	if( !PyArg_ParseTuple(args, "|O!", &IntegrationType_Type, &obj) ) 	
+	if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O!", (char **)kwlist, &IntegrationType_Type, &obj))
 		return -1;
 	
-	if( !obj )
+	if (!obj)
 		self->uf1D_double = new UnaryFunction1D<double>();
 	else {
-		self->uf1D_double = new UnaryFunction1D<double>( IntegrationType_from_BPy_IntegrationType(obj) );
+		self->uf1D_double = new UnaryFunction1D<double>(IntegrationType_from_BPy_IntegrationType(obj));
 	}
 	
 	self->uf1D_double->py_uf1D = (PyObject *)self;
@@ -158,85 +159,60 @@ static void UnaryFunction1DDouble___dealloc__(BPy_UnaryFunction1DDouble* self)
 
 static PyObject * UnaryFunction1DDouble___repr__(BPy_UnaryFunction1DDouble* self)
 {
-	return PyUnicode_FromFormat("type: %s - address: %p", self->uf1D_double->getName().c_str(), self->uf1D_double );
-}
-
-static char UnaryFunction1DDouble_getName___doc__[] =
-".. method:: getName()\n"
-"\n"
-"   Returns the name of the unary 1D function.\n"
-"\n"
-"   :return: The name of the unary 1D function.\n"
-"   :rtype: str\n";
-
-static PyObject * UnaryFunction1DDouble_getName( BPy_UnaryFunction1DDouble *self )
-{
-	return PyUnicode_FromString( self->uf1D_double->getName().c_str() );
+	return PyUnicode_FromFormat("type: %s - address: %p", self->uf1D_double->getName().c_str(), self->uf1D_double);
 }
 
-static PyObject * UnaryFunction1DDouble___call__( BPy_UnaryFunction1DDouble *self, PyObject *args, PyObject *kwds)
+static PyObject * UnaryFunction1DDouble___call__(BPy_UnaryFunction1DDouble *self, PyObject *args, PyObject *kwds)
 {
-	PyObject *obj;
+	static const char *kwlist[] = {"inter", NULL};
+	PyObject *obj = 0;
 
-	if( kwds != NULL ) {
-		PyErr_SetString(PyExc_TypeError, "keyword argument(s) not supported");
-		return NULL;
-	}
-	if( !PyArg_ParseTuple(args, "O!", &Interface1D_Type, &obj) )
+	if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!", (char **)kwlist, &Interface1D_Type, &obj))
 		return NULL;
-	
-	if( typeid(*(self->uf1D_double)) == typeid(UnaryFunction1D<double>) ) {
+
+	if (typeid(*(self->uf1D_double)) == typeid(UnaryFunction1D<double>)) {
 		PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
 		return NULL;
 	}
-	if (self->uf1D_double->operator()(*( ((BPy_Interface1D *) obj)->if1D )) < 0) {
+	if (self->uf1D_double->operator()(*(((BPy_Interface1D *) obj)->if1D)) < 0) {
 		if (!PyErr_Occurred()) {
-			string msg(self->uf1D_double->getName() + " __call__ method failed");
-			PyErr_SetString(PyExc_RuntimeError, msg.c_str());
+			string class_name(Py_TYPE(self)->tp_name);
+			PyErr_SetString(PyExc_RuntimeError, (class_name + " __call__ method failed").c_str());
 		}
 		return NULL;
 	}
-	return PyFloat_FromDouble( self->uf1D_double->result );
-
+	return PyFloat_FromDouble(self->uf1D_double->result);
 }
 
-static char UnaryFunction1DDouble_setIntegrationType___doc__[] =
-".. method:: setIntegrationType(integration)\n"
-"\n"
-"   Sets the integration method.\n"
+static PyMethodDef BPy_UnaryFunction1DDouble_methods[] = {
+	{NULL, NULL, 0, NULL}
+};
+
+/*----------------------UnaryFunction1DDouble get/setters ----------------------------*/
+
+PyDoc_STRVAR(integration_type_doc,
+"The integration method.\n"
 "\n"
-"   :arg integration: An integration method.\n"
-"   :type integration: :class:`IntegrationType`\n";
+":type: :class:`IntegrationType`");
 
-static PyObject * UnaryFunction1DDouble_setIntegrationType(BPy_UnaryFunction1DDouble* self, PyObject *args)
+static PyObject *integration_type_get(BPy_UnaryFunction1DDouble *self, void *UNUSED(closure))
 {
-	PyObject *obj;
-
-	if( !PyArg_ParseTuple(args, "O!", &IntegrationType_Type, &obj) )
-		return NULL;
-	
-	self->uf1D_double->setIntegrationType( IntegrationType_from_BPy_IntegrationType(obj) );
-	Py_RETURN_NONE;
+	return BPy_IntegrationType_from_IntegrationType(self->uf1D_double->getIntegrationType());
 }
 
-static char UnaryFunction1DDouble_getIntegrationType___doc__[] =
-".. method:: getIntegrationType(integration)\n"
-"\n"
-"   Returns the integration method.\n"
-"\n"
-"   :return: The integration method.\n"
-"   :rtype: :class:`IntegrationType`\n";
-
-static PyObject * UnaryFunction1DDouble_getIntegrationType(BPy_UnaryFunction1DDouble* self) {
-	return BPy_IntegrationType_from_IntegrationType( self->uf1D_double->getIntegrationType() );
+static int integration_type_set(BPy_UnaryFunction1DDouble *self, PyObject *value, void *UNUSED(closure))
+{
+	if (!BPy_IntegrationType_Check(value)) {
+		PyErr_SetString(PyExc_TypeError, "value must be an IntegrationType");
+		return -1;
+	}
+	self->uf1D_double->setIntegrationType(IntegrationType_from_BPy_IntegrationType(value));
+	return 0;
 }
 
-/*----------------------UnaryFunction1DDouble instance definitions ----------------------------*/
-static PyMethodDef BPy_UnaryFunction1DDouble_methods[] = {
-	{"getName", ( PyCFunction ) UnaryFunction1DDouble_getName, METH_NOARGS, UnaryFunction1DDouble_getName___doc__},
-	{"setIntegrationType", ( PyCFunction ) UnaryFunction1DDouble_setIntegrationType, METH_VARARGS, UnaryFunction1DDouble_setIntegrationType___doc__},
-	{"getIntegrationType", ( PyCFunction ) UnaryFunction1DDouble_getIntegrationType, METH_NOARGS, UnaryFunction1DDouble_getIntegrationType___doc__},
-	{NULL, NULL, 0, NULL}
+static PyGetSetDef BPy_UnaryFunction1DDouble_getseters[] = {
+	{(char *)"integration_type", (getter)integration_type_get, (setter)integration_type_set, (char *)integration_type_doc, NULL},
+	{NULL, NULL, NULL, NULL, NULL}  /* Sentinel */
 };
 
 /*-----------------------BPy_UnaryFunction1DDouble type definition ------------------------------*/
@@ -271,7 +247,7 @@ PyTypeObject UnaryFunction1DDouble_Type = {
 	0,                              /* tp_iternext */
 	BPy_UnaryFunction1DDouble_methods, /* tp_methods */
 	0,                              /* tp_members */
-	0,                              /* tp_getset */
+	BPy_UnaryFunction1DDouble_getseters, /* tp_getset */
 	&UnaryFunction1D_Type,          /* tp_base */
 	0,                              /* tp_dict */
 	0,                              /* tp_descr_get */