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}");
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) = @_;
167 $self->pidl("staticforward PyTypeObject $name\_ObjectType;");
171 $self->pidl("static PyObject *py_$name\_getattr(PyObject *obj, char *name)");
174 $self->pidl("$cname *object = py_talloc_get_type(obj, $cname);");
175 foreach my $e (@{$d->{ELEMENTS}}) {
176 $self->pidl("if (!strcmp(name, \"$e->{NAME}\")) {");
177 my $varname = "object->$e->{NAME}";
179 $self->pidl("return ".$self->ConvertObjectToPython($e->{TYPE}, $varname) . ";");
183 $self->pidl("PyErr_SetString(PyExc_AttributeError, \"no such attribute\");");
184 $self->pidl("return NULL;");
189 $self->pidl("static int py_$name\_setattr(PyObject *py_obj, char *name, PyObject *value)");
192 $self->pidl("$cname *object = py_talloc_get_type(py_obj, $cname);");
193 foreach my $e (@{$d->{ELEMENTS}}) {
194 $self->pidl("if (!strcmp(name, \"$e->{NAME}\")) {");
195 my $varname = "object->$e->{NAME}";
197 $self->pidl("/* FIXME: talloc_free($varname) if necessary */");
198 $self->ConvertObjectFromPython("mem_ctx", $e->{TYPE}, "value", $varname);
199 $self->pidl("return 0;");
203 $self->pidl("PyErr_SetString(PyExc_AttributeError, \"no such attribute\");");
204 $self->pidl("return -1;");
209 $self->pidl("static PyTypeObject $name\_ObjectType = {");
211 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
212 $self->pidl(".tp_name = \"$name\",");
213 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
214 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
215 $self->pidl(".tp_getattr = py_$name\_getattr,");
216 $self->pidl(".tp_setattr = py_$name\_setattr,");
217 $self->pidl(".tp_repr = py_talloc_default_repr,");
223 my $py_fnname = "py_$name";
224 $self->pidl("static PyObject *$py_fnname(PyObject *self, PyObject *args)");
227 $self->pidl("$cname *ret = talloc_zero(NULL, $cname);");
228 $self->pidl("return py_talloc_import(&$name\_ObjectType, ret);");
236 sub PythonFunction($$$)
238 my ($self, $fn, $iface) = @_;
240 $self->pidl("static PyObject *py_$fn->{NAME}(PyObject *self, PyObject *args)");
243 $self->pidl("$iface\_InterfaceObject *iface = ($iface\_InterfaceObject *)self;");
244 $self->pidl("NTSTATUS status;");
245 $self->pidl("TALLOC_CTX *mem_ctx = talloc_new(NULL);");
246 $self->pidl("struct $fn->{NAME} r;");
247 $self->pidl("PyObject *result;");
250 foreach my $e (@{$fn->{ELEMENTS}}) {
251 if (grep(/in/,@{$e->{DIRECTION}})) {
252 $self->pidl("PyObject *py_$e->{NAME};");
254 if (grep(/out/,@{$e->{DIRECTION}})) {
258 if ($result_size > 0) {
260 $self->pidl("ZERO_STRUCT(r.out);");
262 if ($fn->{RETURN_TYPE}) {
266 foreach my $e (@{$fn->{ELEMENTS}}) {
267 if (grep(/in/,@{$e->{DIRECTION}})) {
268 $self->ConvertObjectFromPython("mem_ctx", $e->{TYPE}, "py_$e->{NAME}", "r.in.$e->{NAME}");
271 $self->pidl("status = dcerpc_$fn->{NAME}(iface->pipe, mem_ctx, &r);");
272 $self->handle_ntstatus("status", "NULL", "mem_ctx");
274 $self->pidl("result = PyTuple_New($result_size);");
278 foreach my $e (@{$fn->{ELEMENTS}}) {
279 if (grep(/out/,@{$e->{DIRECTION}})) {
280 $self->pidl("PyTuple_SetItem(result, $i, " . $self->ConvertObjectToPython($e->{TYPE}, "r.out.$e->{NAME}") . ");");
286 if (defined($fn->{RETURN_TYPE})) {
287 $self->pidl("PyTuple_SetItem(result, $i, " . $self->ConvertObjectToPython($fn->{RETURN_TYPE}, "r.out.result") . ");");
290 $self->pidl("talloc_free(mem_ctx);");
291 $self->pidl("return result;");
297 sub handle_ntstatus($$$$)
299 my ($self, $var, $retval, $mem_ctx) = @_;
301 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
303 $self->pidl("PyErr_SetString(PyExc_RuntimeError, nt_errstr($var));");
304 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
305 $self->pidl("return $retval;");
313 my ($self, $d, $interface, $basename) = @_;
315 my $actual_ctype = $d;
316 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
317 $actual_ctype = $actual_ctype->{DATA};
320 if ($actual_ctype->{TYPE} eq "STRUCT") {
322 if ($d->{TYPE} eq "STRUCT") {
323 $py_fnname = $self->PythonStruct($d->{NAME}, mapTypeName($d), $d);
325 $py_fnname = $self->PythonStruct($d->{NAME}, mapTypeName($d), $d->{DATA});
328 my $fn_name = $d->{NAME};
330 $fn_name =~ s/^$interface->{NAME}_//;
331 $fn_name =~ s/^$basename\_//;
333 $self->register_module_method($fn_name, $py_fnname, "METH_NOARGS", "NULL");
336 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
337 $self->EnumAndBitmapConsts($d->{NAME}, $d);
340 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
341 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
344 if ($actual_ctype->{TYPE} eq "UNION") {
345 $self->pidl("PyObject *py_import_$d->{NAME}(int level, " .mapTypeName($d) . " *in)");
348 $self->FromUnionToPythonFunction($actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
353 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
356 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
365 my($self,$interface,$basename) = @_;
367 $self->pidl_hdr("#ifndef _HEADER_PYTHON_$interface->{NAME}\n");
368 $self->pidl_hdr("#define _HEADER_PYTHON_$interface->{NAME}\n\n");
370 $self->pidl_hdr("\n");
372 $self->Const($_) foreach (@{$interface->{CONSTS}});
374 foreach my $d (@{$interface->{TYPES}}) {
375 next if has_property($d, "nopython");
377 $self->PythonType($d, $interface, $basename);
380 $self->pidl("staticforward PyTypeObject $interface->{NAME}_InterfaceType;");
381 $self->pidl("typedef struct {");
383 $self->pidl("PyObject_HEAD");
384 $self->pidl("struct dcerpc_pipe *pipe;");
386 $self->pidl("} $interface->{NAME}_InterfaceObject;");
390 foreach my $d (@{$interface->{FUNCTIONS}}) {
391 next if not defined($d->{OPNUM});
392 next if has_property($d, "nopython");
394 $self->PythonFunction($d, $interface->{NAME});
397 $self->pidl("static PyMethodDef interface_$interface->{NAME}\_methods[] = {");
399 foreach my $d (@{$interface->{FUNCTIONS}}) {
400 next if not defined($d->{OPNUM});
401 next if has_property($d, "nopython");
403 my $fn_name = $d->{NAME};
405 $fn_name =~ s/^$interface->{NAME}_//;
407 $self->pidl("{ \"$fn_name\", (PyCFunction)py_$d->{NAME}, METH_VARARGS|METH_KEYWORDS, NULL },");
409 $self->pidl("{ NULL, NULL, 0, NULL }");
414 $self->pidl("static void interface_$interface->{NAME}_dealloc(PyObject* self)");
417 $self->pidl("$interface->{NAME}_InterfaceObject *interface = ($interface->{NAME}_InterfaceObject *)self;");
418 $self->pidl("talloc_free(interface->pipe);");
419 $self->pidl("PyObject_Del(self);");
424 $self->pidl("static PyObject *interface_$interface->{NAME}_getattr(PyObject *obj, char *name)");
427 $self->pidl("return Py_FindMethod(interface_$interface->{NAME}\_methods, obj, name);");
433 $self->pidl("static PyTypeObject $interface->{NAME}_InterfaceType = {");
435 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
436 $self->pidl(".tp_name = \"$interface->{NAME}\",");
437 $self->pidl(".tp_basicsize = sizeof($interface->{NAME}_InterfaceObject),");
438 $self->pidl(".tp_dealloc = (destructor)interface_$interface->{NAME}_dealloc,");
439 $self->pidl(".tp_getattr = (getattrfunc)interface_$interface->{NAME}_getattr,");
445 $self->register_module_method($interface->{NAME}, "interface_$interface->{NAME}", "METH_VARARGS|METH_KEYWORDS", "NULL");
446 $self->pidl("static PyObject *interface_$interface->{NAME}(PyObject *self, PyObject *args)");
449 $self->pidl("$interface->{NAME}_InterfaceObject *ret;");
450 $self->pidl("const char *binding_string;");
451 $self->pidl("struct cli_credentials *credentials;");
452 $self->pidl("struct loadparm_context *lp_ctx;");
453 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
454 $self->pidl("NTSTATUS status;");
457 # FIXME: Arguments: binding string, credentials, loadparm context
458 $self->pidl("ret = PyObject_New($interface->{NAME}_InterfaceObject, &$interface->{NAME}_InterfaceType);");
461 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
462 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, NULL, lp_ctx);");
463 $self->handle_ntstatus("status", "NULL", "mem_ctx");
465 $self->pidl("return (PyObject *)ret;");
471 $self->pidl_hdr("\n");
472 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */\n");
475 sub register_module_method($$$$$)
477 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
479 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
482 sub ConvertObjectFromPython($$$$$)
484 my ($self, $mem_ctx, $ctype, $cvar, $target) = @_;
486 die("undef type for $cvar") unless(defined($ctype));
488 if (ref($ctype) ne "HASH") {
489 $ctype = getType($ctype);
492 if (ref($ctype) ne "HASH") {
493 $self->pidl("$target = FIXME($cvar);");
497 my $actual_ctype = $ctype;
498 if ($ctype->{TYPE} eq "TYPEDEF") {
499 $actual_ctype = $ctype->{DATA};
502 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
503 $actual_ctype->{TYPE} eq "SCALAR" and (
504 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]+|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
505 $self->pidl("$target = PyInt_AsLong($cvar);");
509 if ($actual_ctype->{TYPE} eq "STRUCT") {
510 $self->pidl("$target = py_talloc_get_type($cvar, " . mapTypeName($ctype) . ");");
514 if ($actual_ctype->{TYPE} eq "UNION") {
515 $self->pidl("$target = py_export_$ctype->{NAME}($cvar);");
519 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
520 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
524 if ($actual_ctype->{TYPE} eq "SCALAR" and
525 ($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")) {
526 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
530 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
531 $self->pidl("$target = FIXME($cvar);");
536 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
537 $self->pidl("$target = PyInt_AsLong($cvar);");
541 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
542 $self->pidl("$target = PyInt_AsLong($cvar);");
546 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
547 $self->pidl("$target = FIXME($cvar);");
551 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
552 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
556 die("unknown type ".mapTypeName($ctype) . ": $cvar");
559 sub ConvertScalarToPython($$$)
561 my ($self, $ctypename, $cvar) = @_;
563 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
565 $ctypename = expandAlias($ctypename);
567 if ($ctypename =~ /^(int|long|char|u?int[0-9]+|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
568 return "PyInt_FromLong($cvar)";
571 if ($ctypename eq "DATA_BLOB") {
572 return "PyString_FromStringAndSize($cvar->data, $cvar->length)";
575 if ($ctypename eq "NTSTATUS") {
576 return "PyInt_FromLong(NT_STATUS_V($cvar))";
579 if ($ctypename eq "WERROR") {
580 return "PyInt_FromLong(W_ERROR_V($cvar))";
583 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
584 return "PyString_FromString($cvar)";
587 if ($ctypename eq "string_array") { return "FIXME($cvar)"; }
589 if ($ctypename eq "ipv4address") { return "FIXME($cvar)"; }
590 if ($ctypename eq "pointer") {
591 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
594 die("Unknown scalar type $ctypename");
597 sub ConvertObjectToPython($$$)
599 my ($self, $ctype, $cvar) = @_;
601 die("undef type for $cvar") unless(defined($ctype));
603 if (ref($ctype) ne "HASH") {
604 if (not hasType($ctype)) {
605 if (ref($ctype) eq "HASH") {
606 return "py_import_$ctype->{TYPE}_$ctype->{NAME}($cvar)";
608 return "py_import_$ctype($cvar)"; # best bet
612 $ctype = getType($ctype);
615 my $actual_ctype = $ctype;
616 if ($ctype->{TYPE} eq "TYPEDEF") {
617 $actual_ctype = $ctype->{DATA};
620 if ($actual_ctype->{TYPE} eq "ENUM") {
621 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
624 if ($actual_ctype->{TYPE} eq "BITMAP") {
625 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
628 if ($actual_ctype->{TYPE} eq "SCALAR") {
629 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
632 if ($actual_ctype->{TYPE} eq "UNION") {
633 return "py_import_$ctype->{NAME}($cvar)";
636 if ($actual_ctype->{TYPE} eq "STRUCT") {
637 # FIXME: if $cvar is not a pointer, do a talloc_dup()
638 return "py_talloc_import(&$ctype->{NAME}_ObjectType, $cvar)";
641 die("unknown type ".mapTypeName($ctype) . ": $cvar");
646 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
649 $py_hdr =~ s/ndr_([^\/]+)$/py_$1/g;
651 $self->pidl_hdr("/* header auto-generated by pidl */\n\n");
654 /* Python wrapper functions auto-generated by pidl */
655 #include \"includes.h\"
657 #include \"librpc/rpc/dcerpc.h\"
658 #include \"scripting/python/pytalloc.h\"
660 #include \"$ndr_hdr\"
665 foreach my $x (@$ndr) {
666 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
667 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
670 $self->pidl("static PyMethodDef $basename\_methods[] = {");
672 foreach (@{$self->{module_methods}}) {
673 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
674 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
677 $self->pidl("{ NULL, NULL, 0, NULL }");
683 $self->pidl("void init$basename(void)");
686 $self->pidl("PyObject *m;");
687 $self->pidl("m = Py_InitModule(\"$basename\", $basename\_methods);");
688 foreach my $name (keys %{$self->{constants}}) {
690 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
691 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
692 $py_obj = "PyInt_FromLong($cvar)";
693 } elsif ($cvar =~ /^".*"$/) {
694 $py_obj = "PyString_FromString($cvar)";
696 $py_obj = $self->ConvertObjectToPython($ctype, $cvar);
699 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
703 return ($self->{res_hdr}, $self->{res});