1 ###################################################
2 # Python function wrapper generator
3 # Copyright jelmer@samba.org 2007-2008
4 # released under the GNU GPL
6 package Parse::Pidl::Samba4::Python;
12 use Parse::Pidl::Typelist qw(hasType getType mapTypeName expandAlias);
13 use Parse::Pidl::Util qw(has_property ParseExpr);
14 use Parse::Pidl::CUtil qw(get_value_of get_pointer_to);
16 use vars qw($VERSION);
21 my $self = { res => "", res_hdr => "", tabs => "", constants => {},
22 module_methods => []};
29 $self->{res_hdr} .= shift;
36 $self->{res} .= $self->{tabs};
45 $self->{tabs} .= "\t";
51 $self->{tabs} = substr($self->{tabs}, 0, -1);
61 $self->pidl_hdr("#include \"librpc/gen_ndr/py_$_\.h\"\n");
67 my ($self, $const) = @_;
68 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
71 sub register_constant($$$$)
73 my ($self, $name, $type, $value) = @_;
75 $self->{constants}->{$name} = [$type, $value];
78 sub EnumAndBitmapConsts($$$)
80 my ($self, $name, $d) = @_;
82 return unless (defined($d->{ELEMENTS}));
84 foreach my $e (@{$d->{ELEMENTS}}) {
85 $e =~ /^([A-Za-z0-9_]+)=(.*)$/;
88 $self->register_constant($cname, $d, $cname);
92 sub FromUnionToPythonFunction($$$)
94 my ($self, $type, $switch, $name) = @_;
96 $self->pidl("switch ($switch) {");
99 foreach my $e (@{$type->{ELEMENTS}}) {
103 $conv = $self->ConvertObjectToPython($e->{TYPE}, "$name->$e->{NAME}");
107 if (defined($e->{CASE})) {
108 $self->pidl("$e->{CASE}: return $conv;");
110 $self->pidl("default: return $conv;");
117 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
118 $self->pidl("return NULL;");
121 sub FromPythonToUnionFunction($$$$$)
123 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
127 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
129 $self->pidl("switch ($switch) {");
132 foreach my $e (@{$type->{ELEMENTS}}) {
133 if (defined($e->{CASE})) {
134 $self->pidl("$e->{CASE}:");
137 $self->pidl("default:");
141 $self->ConvertObjectFromPython($mem_ctx, $e->{TYPE}, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
143 $self->pidl("break;");
149 $self->pidl("default:");
151 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
152 $self->pidl("talloc_free(ret);");
153 $self->pidl("ret = NULL;");
160 $self->pidl("return ret;");
163 sub PythonStruct($$$$)
165 my ($self, $name, $cname, $d) = @_;
169 $self->pidl("static PyObject *py_$name\_getattr(PyObject *obj, char *name)");
172 $self->pidl("$cname *object = py_talloc_get_type(obj, $cname);");
173 foreach my $e (@{$d->{ELEMENTS}}) {
174 $self->pidl("if (!strcmp(name, \"$e->{NAME}\")) {");
175 my $varname = "object->$e->{NAME}";
177 $self->pidl("return ".$self->ConvertObjectToPython($e->{TYPE}, $varname) . ";");
181 $self->pidl("PyErr_SetString(PyExc_AttributeError, \"no such attribute\");");
182 $self->pidl("return NULL;");
187 $self->pidl("static int py_$name\_setattr(PyObject *py_obj, char *name, PyObject *value)");
190 $self->pidl("$cname *object = py_talloc_get_type(py_obj, $cname);");
191 $self->pidl("TALLOC_CTX *mem_ctx = py_talloc_get_mem_ctx(py_obj);");
192 foreach my $e (@{$d->{ELEMENTS}}) {
193 $self->pidl("if (!strcmp(name, \"$e->{NAME}\")) {");
194 my $varname = "object->$e->{NAME}";
196 if ($e->{ORIGINAL}->{POINTERS} > 0) {
197 $self->pidl("talloc_free($varname);");
199 $self->ConvertObjectFromPython("mem_ctx", $e->{TYPE}, "value", $varname, "talloc_free(mem_ctx); return -1;");
200 $self->pidl("return 0;");
204 $self->pidl("PyErr_SetString(PyExc_AttributeError, \"no such attribute\");");
205 $self->pidl("return -1;");
210 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $name\_Type;\n");
211 $self->pidl_hdr("#define $name\_Check(op) PyObject_TypeCheck(op, &$name\_Type)\n");
212 $self->pidl_hdr("#define $name\_CheckExact(op) ((op)->ob_type == &$name\_Type)\n");
213 $self->pidl_hdr("\n");
214 $self->pidl("PyTypeObject $name\_Type = {");
216 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
217 $self->pidl(".tp_name = \"$name\",");
218 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
219 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
220 $self->pidl(".tp_getattr = py_$name\_getattr,");
221 $self->pidl(".tp_setattr = py_$name\_setattr,");
222 $self->pidl(".tp_repr = py_talloc_default_repr,");
228 my $py_fnname = "py_$name";
229 $self->pidl("static PyObject *$py_fnname(PyObject *self, PyObject *args)");
232 $self->pidl("$cname *ret = talloc_zero(NULL, $cname);");
233 $self->pidl("return py_talloc_import(&$name\_Type, ret);");
241 sub PythonFunction($$$)
243 my ($self, $fn, $iface) = @_;
245 $self->pidl("static PyObject *py_$fn->{NAME}(PyObject *self, PyObject *args)");
248 $self->pidl("$iface\_InterfaceObject *iface = ($iface\_InterfaceObject *)self;");
249 $self->pidl("NTSTATUS status;");
250 $self->pidl("TALLOC_CTX *mem_ctx = talloc_new(NULL);");
251 $self->pidl("struct $fn->{NAME} r;");
252 $self->pidl("PyObject *result;");
255 foreach my $e (@{$fn->{ELEMENTS}}) {
256 if (grep(/in/,@{$e->{DIRECTION}})) {
257 $self->pidl("PyObject *py_$e->{NAME};");
259 if (grep(/out/,@{$e->{DIRECTION}})) {
263 if ($result_size > 0) {
265 $self->pidl("ZERO_STRUCT(r.out);");
267 if ($fn->{RETURN_TYPE}) {
271 foreach my $e (@{$fn->{ELEMENTS}}) {
272 if (grep(/in/,@{$e->{DIRECTION}})) {
273 $self->ConvertObjectFromPython("mem_ctx", $e->{TYPE}, "py_$e->{NAME}", "r.in.$e->{NAME}", "talloc_free(mem_ctx); return NULL;");
276 $self->pidl("status = dcerpc_$fn->{NAME}(iface->pipe, mem_ctx, &r);");
277 $self->handle_ntstatus("status", "NULL", "mem_ctx");
279 $self->pidl("result = PyTuple_New($result_size);");
283 foreach my $e (@{$fn->{ELEMENTS}}) {
284 if (grep(/out/,@{$e->{DIRECTION}})) {
285 $self->pidl("PyTuple_SetItem(result, $i, " . $self->ConvertObjectToPython($e->{TYPE}, "r.out.$e->{NAME}") . ");");
291 if (defined($fn->{RETURN_TYPE})) {
292 $self->pidl("PyTuple_SetItem(result, $i, " . $self->ConvertObjectToPython($fn->{RETURN_TYPE}, "r.out.result") . ");");
295 $self->pidl("talloc_free(mem_ctx);");
296 $self->pidl("return result;");
302 sub handle_ntstatus($$$$)
304 my ($self, $var, $retval, $mem_ctx) = @_;
306 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
308 $self->pidl("PyErr_SetString(PyExc_RuntimeError, nt_errstr($var));");
309 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
310 $self->pidl("return $retval;");
318 my ($self, $d, $interface, $basename) = @_;
320 my $actual_ctype = $d;
321 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
322 $actual_ctype = $actual_ctype->{DATA};
325 if ($actual_ctype->{TYPE} eq "STRUCT") {
327 if ($d->{TYPE} eq "STRUCT") {
328 $py_fnname = $self->PythonStruct($d->{NAME}, mapTypeName($d), $d);
330 $py_fnname = $self->PythonStruct($d->{NAME}, mapTypeName($d), $d->{DATA});
333 my $fn_name = $d->{NAME};
335 $fn_name =~ s/^$interface->{NAME}_//;
336 $fn_name =~ s/^$basename\_//;
338 $self->register_module_method($fn_name, $py_fnname, "METH_NOARGS", "NULL");
341 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
342 $self->EnumAndBitmapConsts($d->{NAME}, $d);
345 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
346 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
349 if ($actual_ctype->{TYPE} eq "UNION") {
350 $self->pidl("PyObject *py_import_$d->{NAME}(int level, " .mapTypeName($d) . " *in)");
353 $self->FromUnionToPythonFunction($actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
358 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
361 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
370 my($self,$interface,$basename) = @_;
372 $self->pidl_hdr("#ifndef _HEADER_PYTHON_$interface->{NAME}\n");
373 $self->pidl_hdr("#define _HEADER_PYTHON_$interface->{NAME}\n\n");
375 $self->pidl_hdr("\n");
377 $self->Const($_) foreach (@{$interface->{CONSTS}});
379 foreach my $d (@{$interface->{TYPES}}) {
380 next if has_property($d, "nopython");
382 $self->PythonType($d, $interface, $basename);
385 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $interface->{NAME}_InterfaceType;\n");
386 $self->pidl("typedef struct {");
388 $self->pidl("PyObject_HEAD");
389 $self->pidl("struct dcerpc_pipe *pipe;");
391 $self->pidl("} $interface->{NAME}_InterfaceObject;");
395 foreach my $d (@{$interface->{FUNCTIONS}}) {
396 next if not defined($d->{OPNUM});
397 next if has_property($d, "nopython");
399 $self->PythonFunction($d, $interface->{NAME});
402 $self->pidl("static PyMethodDef interface_$interface->{NAME}\_methods[] = {");
404 foreach my $d (@{$interface->{FUNCTIONS}}) {
405 next if not defined($d->{OPNUM});
406 next if has_property($d, "nopython");
408 my $fn_name = $d->{NAME};
410 $fn_name =~ s/^$interface->{NAME}_//;
412 $self->pidl("{ \"$fn_name\", (PyCFunction)py_$d->{NAME}, METH_VARARGS|METH_KEYWORDS, NULL },");
414 $self->pidl("{ NULL, NULL, 0, NULL }");
419 $self->pidl("static void interface_$interface->{NAME}_dealloc(PyObject* self)");
422 $self->pidl("$interface->{NAME}_InterfaceObject *interface = ($interface->{NAME}_InterfaceObject *)self;");
423 $self->pidl("talloc_free(interface->pipe);");
424 $self->pidl("PyObject_Del(self);");
429 $self->pidl("static PyObject *interface_$interface->{NAME}_getattr(PyObject *obj, char *name)");
432 $self->pidl("return Py_FindMethod(interface_$interface->{NAME}\_methods, obj, name);");
438 $self->pidl("PyTypeObject $interface->{NAME}_InterfaceType = {");
440 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
441 $self->pidl(".tp_name = \"$interface->{NAME}\",");
442 $self->pidl(".tp_basicsize = sizeof($interface->{NAME}_InterfaceObject),");
443 $self->pidl(".tp_dealloc = interface_$interface->{NAME}_dealloc,");
444 $self->pidl(".tp_getattr = interface_$interface->{NAME}_getattr,");
450 $self->register_module_method($interface->{NAME}, "interface_$interface->{NAME}", "METH_VARARGS|METH_KEYWORDS", "NULL");
451 $self->pidl("static PyObject *interface_$interface->{NAME}(PyObject *self, PyObject *args)");
454 $self->pidl("$interface->{NAME}_InterfaceObject *ret;");
455 $self->pidl("const char *binding_string;");
456 $self->pidl("struct cli_credentials *credentials;");
457 $self->pidl("struct loadparm_context *lp_ctx;");
458 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
459 $self->pidl("NTSTATUS status;");
462 # FIXME: Arguments: binding string, credentials, loadparm context
463 $self->pidl("ret = PyObject_New($interface->{NAME}_InterfaceObject, &$interface->{NAME}_InterfaceType);");
466 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
467 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, NULL, lp_ctx);");
468 $self->handle_ntstatus("status", "NULL", "mem_ctx");
470 $self->pidl("return (PyObject *)ret;");
476 $self->pidl_hdr("\n");
477 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */\n");
480 sub register_module_method($$$$$)
482 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
484 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
487 sub ConvertObjectFromPython($$$$$$)
489 my ($self, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
491 die("undef type for $cvar") unless(defined($ctype));
493 if (ref($ctype) ne "HASH") {
494 $ctype = getType($ctype);
497 if (ref($ctype) ne "HASH") {
498 $self->pidl("$target = FIXME($cvar);");
502 my $actual_ctype = $ctype;
503 if ($ctype->{TYPE} eq "TYPEDEF") {
504 $actual_ctype = $ctype->{DATA};
507 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
508 $actual_ctype->{TYPE} eq "SCALAR" and (
509 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]+|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
510 $self->pidl("PY_CHECK_TYPE(PyInt, $cvar, $fail);");
511 $self->pidl("$target = PyInt_AsLong($cvar);");
515 if ($actual_ctype->{TYPE} eq "STRUCT") {
516 $self->pidl("PY_CHECK_TYPE($ctype->{NAME}, $cvar, $fail);");
517 $self->pidl("$target = py_talloc_get_ptr($cvar);");
521 if ($actual_ctype->{TYPE} eq "UNION") {
522 $self->pidl("$target = py_export_$ctype->{NAME}($cvar);");
526 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
527 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
531 if ($actual_ctype->{TYPE} eq "SCALAR" and
532 ($actual_ctype->{NAME} eq "string" or $actual_ctype->{NAME} eq "nbt_string" or $actual_ctype->{NAME} eq "nbt_name" or $actual_ctype->{NAME} eq "wrepl_nbt_name")) {
533 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
537 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
538 $self->pidl("$target = FIXME($cvar);");
543 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
544 $self->pidl("$target = PyInt_AsLong($cvar);");
548 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
549 $self->pidl("$target = PyInt_AsLong($cvar);");
553 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
554 $self->pidl("$target = FIXME($cvar);");
558 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
559 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
563 die("unknown type ".mapTypeName($ctype) . ": $cvar");
566 sub ConvertScalarToPython($$$)
568 my ($self, $ctypename, $cvar) = @_;
570 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
572 $ctypename = expandAlias($ctypename);
574 if ($ctypename =~ /^(int|long|char|u?int[0-9]+|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
575 return "PyInt_FromLong($cvar)";
578 if ($ctypename eq "DATA_BLOB") {
579 return "PyString_FromStringAndSize($cvar->data, $cvar->length)";
582 if ($ctypename eq "NTSTATUS") {
583 return "PyInt_FromLong(NT_STATUS_V($cvar))";
586 if ($ctypename eq "WERROR") {
587 return "PyInt_FromLong(W_ERROR_V($cvar))";
590 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
591 return "PyString_FromString($cvar)";
594 if ($ctypename eq "string_array") { return "FIXME($cvar)"; }
596 if ($ctypename eq "ipv4address") { return "FIXME($cvar)"; }
597 if ($ctypename eq "pointer") {
598 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
601 die("Unknown scalar type $ctypename");
604 sub ConvertObjectToPython($$$)
606 my ($self, $ctype, $cvar) = @_;
608 die("undef type for $cvar") unless(defined($ctype));
610 if (ref($ctype) ne "HASH") {
611 if (not hasType($ctype)) {
612 if (ref($ctype) eq "HASH") {
613 return "py_import_$ctype->{TYPE}_$ctype->{NAME}($cvar)";
615 return "py_import_$ctype($cvar)"; # best bet
619 $ctype = getType($ctype);
622 my $actual_ctype = $ctype;
623 if ($ctype->{TYPE} eq "TYPEDEF") {
624 $actual_ctype = $ctype->{DATA};
627 if ($actual_ctype->{TYPE} eq "ENUM") {
628 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
631 if ($actual_ctype->{TYPE} eq "BITMAP") {
632 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
635 if ($actual_ctype->{TYPE} eq "SCALAR") {
636 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
639 if ($actual_ctype->{TYPE} eq "UNION") {
640 return "py_import_$ctype->{NAME}($cvar)";
643 if ($actual_ctype->{TYPE} eq "STRUCT") {
644 # FIXME: if $cvar is not a pointer, do a talloc_dup()
645 return "py_talloc_import(&$ctype->{NAME}_Type, $cvar)";
648 die("unknown type ".mapTypeName($ctype) . ": $cvar");
653 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
656 $py_hdr =~ s/ndr_([^\/]+)$/py_$1/g;
658 $self->pidl_hdr("/* header auto-generated by pidl */\n\n");
661 /* Python wrapper functions auto-generated by pidl */
662 #include \"includes.h\"
664 #include \"librpc/rpc/dcerpc.h\"
665 #include \"scripting/python/pytalloc.h\"
667 #include \"$ndr_hdr\"
670 #define PY_CHECK_TYPE(type, var, fail) \\
671 if (!type ## _Check(var)) {\\
672 PyErr_Format(PyExc_TypeError, \"Expected type %s\", type ## _Type.tp_name); \\
677 foreach my $x (@$ndr) {
678 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
679 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
682 $self->pidl("static PyMethodDef $basename\_methods[] = {");
684 foreach (@{$self->{module_methods}}) {
685 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
686 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
689 $self->pidl("{ NULL, NULL, 0, NULL }");
695 $self->pidl("void init$basename(void)");
698 $self->pidl("PyObject *m;");
699 $self->pidl("m = Py_InitModule(\"$basename\", $basename\_methods);");
700 foreach my $name (keys %{$self->{constants}}) {
702 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
703 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
704 $py_obj = "PyInt_FromLong($cvar)";
705 } elsif ($cvar =~ /^".*"$/) {
706 $py_obj = "PyString_FromString($cvar)";
708 $py_obj = $self->ConvertObjectToPython($ctype, $cvar);
711 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
715 return ($self->{res_hdr}, $self->{res});