pidl-python: fixed the docstrings for ndr_print, ndr_pack and ndr_unpack
[samba.git] / pidl / lib / Parse / Pidl / Samba4 / Python.pm
index 6099fe5caefeb9ebff05a77fccd82261f41bee71..6adc60c5541ff426e9e064288a8d8869f82abaab 100644 (file)
@@ -126,6 +126,7 @@ sub FromUnionToPythonFunction($$$$)
                        $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
                } else {
                        $self->pidl("ret = Py_None;");
+                       $self->pidl("Py_INCREF(ret);");
                }
 
                $self->pidl("return ret;");
@@ -253,7 +254,7 @@ sub PythonStruct($$$$$$)
                $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
                $self->pidl("DATA_BLOB blob;");
                $self->pidl("enum ndr_err_code err;");
-               $self->pidl("err = ndr_push_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), NULL, object, (ndr_push_flags_fn_t)ndr_push_$name);");
+               $self->pidl("err = ndr_push_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), object, (ndr_push_flags_fn_t)ndr_push_$name);");
                $self->pidl("if (err != NDR_ERR_SUCCESS) {");
                $self->indent;
                $self->pidl("PyErr_SetNdrError(err);");
@@ -275,24 +276,7 @@ sub PythonStruct($$$$$$)
                $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
                $self->pidl("\treturn NULL;");
                $self->pidl("");
-
-               # This disgusting hack works around the fact that ndr_pull_struct_blob_all will always fail on structures with relative pointers.  
-                # So, map ndr_unpack to ndr_pull_struct_blob_all only if we don't have any relative pointers in this
-               my $got_relative = 0;
-               if ($#{$d->{ELEMENTS}} > -1) {
-                       foreach my $e (@{$d->{ELEMENTS}}) {
-                               my $l = $e->{LEVELS}[0];
-                               if ($l->{TYPE} eq "POINTER" and ($l->{POINTER_TYPE} eq "relative")) {
-                                       $got_relative = 1;
-                                       last;
-                               }
-                       }
-               }
-               if ($got_relative == 0) {
-                       $self->pidl("err = ndr_pull_struct_blob_all(&blob, py_talloc_get_mem_ctx(py_obj), NULL, object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
-               } else {
-                       $self->pidl("err = ndr_pull_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), NULL, object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
-               }
+               $self->pidl("err = ndr_pull_struct_blob_all(&blob, py_talloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
                $self->pidl("if (err != NDR_ERR_SUCCESS) {");
                $self->indent;
                $self->pidl("PyErr_SetNdrError(err);");
@@ -304,11 +288,24 @@ sub PythonStruct($$$$$$)
                $self->deindent;
                $self->pidl("}");
                $self->pidl("");
+
+               $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
+               $self->pidl("{");
+               $self->indent;
+               $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
+               $self->pidl("char *retstr;");
+               $self->pidl("retstr = ndr_print_struct_string(py_talloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
+               $self->pidl("return PyString_FromString(retstr);");
+               $self->deindent;
+               $self->pidl("}");
+               $self->pidl("");
+
                $py_methods = "py_$name\_methods";
                $self->pidl("static PyMethodDef $py_methods\[] = {");
                $self->indent;
-               $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
-               $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
+               $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
+               $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.ndr_unpack(class, blob) -> None\\nNDR unpack\" },");
+               $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
                $self->pidl("{ NULL, NULL, 0, NULL }");
                $self->deindent;
                $self->pidl("};");
@@ -388,7 +385,7 @@ sub PythonFunctionUnpackOut($$$)
        $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
        $self->pidl("{");
        $self->indent;
-       $self->pidl("PyObject *result = Py_None;");
+       $self->pidl("PyObject *result;");
        foreach my $e (@{$fn->{ELEMENTS}}) {
                next unless (grep(/out/,@{$e->{DIRECTION}}));
                next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or 
@@ -407,6 +404,8 @@ sub PythonFunctionUnpackOut($$$)
                $self->pidl("result = PyTuple_New($result_size);");
                $signature .= "(";
        } elsif ($result_size == 0) {
+               $self->pidl("result = Py_None;");
+               $self->pidl("Py_INCREF(result);");
                $signature .= "None";
        }
 
@@ -431,7 +430,7 @@ sub PythonFunctionUnpackOut($$$)
        } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
                $self->handle_werror("r->out.result", "NULL", undef);
        } elsif (defined($fn->{RETURN_TYPE})) {
-               my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result");
+               my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
                if ($result_size > 1) {
                        $self->pidl("PyTuple_SetItem(result, $i, $conv);");
                } else {
@@ -665,6 +664,7 @@ sub Interface($$$)
                foreach my $d (@{$interface->{FUNCTIONS}}) {
                        next if not defined($d->{OPNUM});
                        next if has_property($d, "nopython");
+                       next if has_property($d, "todo");
 
                        my $prettyname = $d->{NAME};
 
@@ -673,14 +673,14 @@ sub Interface($$$)
 
                        my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
 
-                       push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}", $prettyname, $fndocstring, $d->{OPNUM}]);
+                       push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
                }
 
                $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
                $self->indent;
                foreach my $d (@fns) {
                        my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
-                       $self->pidl("{ \"$prettyname\", $docstring, (dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
+                       $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
                }
                $self->pidl("{ NULL }");
                $self->deindent;
@@ -743,7 +743,7 @@ sub register_module_typeobject($$$)
 {
        my ($self, $name, $py_name) = @_;
 
-       $self->register_module_object($name, "(PyObject *)$py_name");
+       $self->register_module_object($name, "(PyObject *)(void *)$py_name");
 
        $self->check_ready_type($py_name);
 
@@ -766,6 +766,11 @@ sub register_module_import($$)
 sub use_type_variable($$)
 {
        my ($self, $orig_ctype) = @_;
+       # FIXME: Have a global lookup table for types that look different on the 
+       # wire than they are named in C?
+       if ($orig_ctype->{NAME} eq "dom_sid2") {
+               $orig_ctype->{NAME} = "dom_sid";
+       }
        my $ctype = resolveType($orig_ctype);
        unless (defined($ctype->{BASEFILE})) {
                return undef;
@@ -815,11 +820,11 @@ sub assign($$$)
        }
 }
 
-sub ConvertObjectFromPythonData($$$$$$)
+sub ConvertObjectFromPythonData($$$$$$;$)
 {
-       my ($self, $mem_ctx, $cvar, $ctype, $target, $fail) = @_;
+       my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
 
-       die("undef type for $cvar") unless(defined($ctype));
+       fatal($location, "undef type for $cvar") unless(defined($ctype));
 
        $ctype = resolveType($ctype);
 
@@ -828,24 +833,50 @@ sub ConvertObjectFromPythonData($$$$$$)
                $actual_ctype = $actual_ctype->{DATA};
        }
 
-       if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or 
-               $actual_ctype->{TYPE} eq "SCALAR" and (
-               expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
+       if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
                $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
                $self->pidl("$target = PyInt_AsLong($cvar);");
                return;
        }
+       if ($actual_ctype->{TYPE} eq "SCALAR" ) {
+               if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
+                       $self->pidl("if (PyObject_TypeCheck($cvar, &PyLong_Type)) {");
+                       $self->indent;
+                       $self->pidl("$target = PyLong_AsLongLong($cvar);");
+                       $self->deindent;
+                       $self->pidl("} else {");
+                       $self->indent;
+                       $self->pidl("if (PyObject_TypeCheck($cvar, &PyInt_Type)) {");
+                       $self->indent;
+                       $self->pidl("$target = PyInt_AsLong($cvar);");
+                       $self->deindent;
+                       $self->pidl("} else {");
+                       $self->indent;
+                       $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
+                       $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
+                       $self->pidl($fail);
+                       $self->deindent;
+                       $self->pidl("}");
+                       $self->deindent;
+                       $self->pidl("}");
+                       return;
+               }
+               if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t)$/) {
+                       $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
+                       $self->pidl("$target = PyInt_AsLong($cvar);");
+                       return;
+               }
+       }
 
        if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
                my $ctype_name = $self->use_type_variable($ctype);
                unless (defined ($ctype_name)) {
-                       error(undef, "Unable to determine origin of type " . mapTypeName($ctype));
-                       $self->assign($target, "NULL");
-                       # FIXME:
+                       error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
+                       $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " to Python\");");
                        return;
                }
                $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
-               $self->assign($target, "talloc_ptrtype(py_talloc_get_ptr($cvar), $target)");
+               $self->assign($target, "(".mapTypeName($ctype)." *)py_talloc_get_ptr($cvar)");
                return;
        }
 
@@ -865,6 +896,11 @@ sub ConvertObjectFromPythonData($$$$$$)
                return;
                }
 
+       if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
+               $self->pidl("$target = PyString_AsString($cvar);");
+               return;
+               }
+
 
        if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
                $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
@@ -886,7 +922,7 @@ sub ConvertObjectFromPythonData($$$$$$)
                return;
        }
 
-       fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
+       fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
 
 }
 
@@ -946,15 +982,23 @@ sub ConvertObjectFromPythonLevel($$$$$$$$)
                if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
                        $var_name = get_pointer_to($var_name);
                }
-               $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail);
+               $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
        } elsif ($l->{TYPE} eq "SWITCH") {
                $var_name = get_pointer_to($var_name);
                my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
-               $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
+               my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
+               $self->pidl("{");
+               $self->indent;
+               $self->pidl("void *$switch_ptr;");
+               $self->pidl("$switch_ptr = py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
+               $self->pidl("if ($switch_ptr == NULL) { $fail }");
+               $self->assign($var_name, "$switch_ptr");
+               $self->deindent;
+               $self->pidl("}");
        } elsif ($l->{TYPE} eq "SUBCONTEXT") {
                $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
        } else {
-               die("unknown level type $l->{TYPE}");
+               fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
        }
 }
 
@@ -973,7 +1017,11 @@ sub ConvertScalarToPython($$$)
 
        $ctypename = expandAlias($ctypename);
 
-       if ($ctypename =~ /^(char|u?int[0-9]*|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
+       if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
+               return "PyLong_FromLongLong($cvar)";
+       }
+
+       if ($ctypename =~ /^(char|u?int[0-9]*|time_t)$/) {
                return "PyInt_FromLong($cvar)";
        }
 
@@ -994,18 +1042,19 @@ sub ConvertScalarToPython($$$)
        }
 
        # Not yet supported
-       if ($ctypename eq "string_array") { return "PyCObject_FromVoidPtr($cvar)"; }
+       if ($ctypename eq "string_array") { return "PyCObject_FromTallocPtr($cvar)"; }
        if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
+       if ($ctypename eq "dnsp_name") { return "PyString_FromString($cvar)"; }
        if ($ctypename eq "pointer") {
-               return "PyCObject_FromVoidPtr($cvar, talloc_free)";
+               return "PyCObject_FromTallocPtr($cvar)";
        }
 
        die("Unknown scalar type $ctypename");
 }
 
-sub ConvertObjectToPythonData($$$$$)
+sub ConvertObjectToPythonData($$$$$;$)
 {
-       my ($self, $mem_ctx, $ctype, $cvar) = @_;
+       my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
 
        die("undef type for $cvar") unless(defined($ctype));
 
@@ -1027,13 +1076,13 @@ sub ConvertObjectToPythonData($$$$$)
        } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
                my $ctype_name = $self->use_type_variable($ctype);
                unless (defined($ctype_name)) {
-                       error(undef, "Unable to determine origin of type " . mapTypeName($ctype));
+                       error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
                        return "NULL"; # FIXME!
                }
-               return "py_talloc_import_ex($ctype_name, $mem_ctx, $cvar)";
+               return "py_talloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
        }
 
-       fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
+       fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
 }
 
 sub fail_on_null($$$)
@@ -1060,6 +1109,7 @@ sub ConvertObjectToPythonLevel($$$$$$)
                        $self->pidl("if ($var_name == NULL) {");
                        $self->indent;
                        $self->pidl("$py_var = Py_None;");
+                       $self->pidl("Py_INCREF($py_var);");
                        $self->deindent;
                        $self->pidl("} else {");
                        $self->indent;
@@ -1113,12 +1163,12 @@ sub ConvertObjectToPythonLevel($$$$$$)
                if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
                        $var_name = get_pointer_to($var_name);
                }
-               my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name);
+               my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
                $self->pidl("$py_var = $conv;");
        } elsif ($l->{TYPE} eq "SUBCONTEXT") {
                $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
        } else {
-               die("Unknown level type $l->{TYPE} $var_name");
+               fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
        }
 }
 
@@ -1137,18 +1187,13 @@ sub Parse($$$$$)
 
     $self->pidl_hdr("
 /* Python wrapper functions auto-generated by pidl */
-#include \"includes.h\"
 #include <Python.h>
-#include \"librpc/rpc/dcerpc.h\"
+#include \"includes.h\"
 #include \"lib/talloc/pytalloc.h\"
 #include \"librpc/rpc/pyrpc.h\"
 #include \"$hdr\"
 #include \"$ndr_hdr\"
 
-#ifndef Py_RETURN_NONE
-#define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
-#endif
-
 ");
 
        foreach my $x (@$ndr) {
@@ -1223,7 +1268,7 @@ sub Parse($$$$$)
                } elsif ($cvar =~ /^".*"$/) {
                        $py_obj = "PyString_FromString($cvar)";
                } else {
-                       $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar);
+                       $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
                }
 
                $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");