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 qw(warning fatal error);
13 use Parse::Pidl::Typelist qw(hasType resolveType getType mapTypeName expandAlias);
14 use Parse::Pidl::Util qw(has_property ParseExpr unmake_str);
15 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred is_charset_array);
16 use Parse::Pidl::CUtil qw(get_value_of get_pointer_to);
17 use Parse::Pidl::Samba4 qw(ArrayDynamicallyAllocated);
18 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
20 use vars qw($VERSION);
25 my $self = { res => "", res_hdr => "", tabs => "", constants => {},
26 module_methods => [], module_objects => [], ready_types => [],
27 module_imports => [], type_imports => {},
28 patch_type_calls => [], prereadycode => [],
36 $self->{res_hdr} .= shift;
43 if ((!($d =~ /^#/))) {
44 $self->{res} .= $self->{tabs};
54 $self->{tabs} .= "\t";
60 $self->{tabs} = substr($self->{tabs}, 0, -1);
63 sub PrettifyTypeName($$)
65 my ($name, $basename) = @_;
67 $name =~ s/^$basename\_//;
79 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
80 $self->register_module_import($_);
86 my ($self, $const) = @_;
87 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
90 sub register_constant($$$$)
92 my ($self, $name, $type, $value) = @_;
94 $self->{constants}->{$name} = [$type, $value];
97 sub EnumAndBitmapConsts($$$)
99 my ($self, $name, $d) = @_;
101 return unless (defined($d->{ELEMENTS}));
103 foreach my $e (@{$d->{ELEMENTS}}) {
104 $e =~ /^([A-Za-z0-9_]+)/;
107 $self->register_constant($cname, $d, $cname);
111 sub FromUnionToPythonFunction($$$$)
113 my ($self, $mem_ctx, $type, $switch, $name) = @_;
115 $self->pidl("PyObject *ret;");
118 $self->pidl("switch ($switch) {");
121 foreach my $e (@{$type->{ELEMENTS}}) {
122 $self->pidl("$e->{CASE}:");
127 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
129 $self->pidl("ret = Py_None;");
130 $self->pidl("Py_INCREF(ret);");
133 $self->pidl("return ret;");
142 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
143 $self->pidl("return NULL;");
146 sub FromPythonToUnionFunction($$$$$)
148 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
152 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
154 $self->pidl("switch ($switch) {");
157 foreach my $e (@{$type->{ELEMENTS}}) {
158 $self->pidl("$e->{CASE}:");
159 if ($e->{CASE} eq "default") { $has_default = 1; }
162 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
164 $self->pidl("break;");
170 $self->pidl("default:");
172 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
173 $self->pidl("talloc_free(ret);");
174 $self->pidl("ret = NULL;");
181 $self->pidl("return ret;");
184 sub PythonStruct($$$$$$)
186 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
188 my $env = GenerateStructEnv($d, "object");
192 my $getsetters = "NULL";
194 if ($#{$d->{ELEMENTS}} > -1) {
195 foreach my $e (@{$d->{ELEMENTS}}) {
196 my $varname = "object->$e->{NAME}";
197 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
200 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(obj);");
201 $self->pidl("PyObject *py_$e->{NAME};");
202 $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
203 $self->pidl("return py_$e->{NAME};");
208 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
211 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
212 my $mem_ctx = "py_talloc_get_mem_ctx(py_obj)";
213 my $l = $e->{LEVELS}[0];
214 my $nl = GetNextLevel($e, $l);
215 if ($l->{TYPE} eq "POINTER" and
216 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
217 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
218 $self->pidl("talloc_unlink(py_talloc_get_mem_ctx(py_obj), $varname);");
220 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
221 $self->pidl("return 0;");
227 $getsetters = "py_$name\_getsetters";
228 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
230 foreach my $e (@{$d->{ELEMENTS}}) {
231 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
233 $self->pidl("{ NULL }");
239 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
242 $self->pidl("return py_talloc_new($cname, type);");
247 my $py_methods = "NULL";
249 # If the struct is not public there ndr_pull/ndr_push functions will
250 # be static so not callable from here
251 if (has_property($d, "public")) {
252 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
255 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
256 $self->pidl("DATA_BLOB blob;");
257 $self->pidl("enum ndr_err_code err;");
258 $self->pidl("err = ndr_push_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), object, (ndr_push_flags_fn_t)ndr_push_$name);");
259 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
261 $self->pidl("PyErr_SetNdrError(err);");
262 $self->pidl("return NULL;");
266 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
271 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
274 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
275 $self->pidl("DATA_BLOB blob;");
276 $self->pidl("enum ndr_err_code err;");
277 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
278 $self->pidl("\treturn NULL;");
280 $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);");
281 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
283 $self->pidl("PyErr_SetNdrError(err);");
284 $self->pidl("return NULL;");
288 $self->pidl("Py_RETURN_NONE;");
293 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
296 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
297 $self->pidl("char *retstr;");
298 $self->pidl("retstr = ndr_print_struct_string(py_talloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
299 $self->pidl("return PyString_FromString(retstr);");
304 $py_methods = "py_$name\_methods";
305 $self->pidl("static PyMethodDef $py_methods\[] = {");
307 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
308 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.ndr_unpack(class, blob) -> None\\nNDR unpack\" },");
309 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
310 $self->pidl("{ NULL, NULL, 0, NULL }");
316 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
318 my $docstring = $self->DocString($d, $name);
319 my $typeobject = "$name\_Type";
320 $self->pidl("static PyTypeObject $typeobject = {");
322 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
323 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
324 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
325 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
326 $self->pidl(".tp_getset = $getsetters,");
327 $self->pidl(".tp_repr = py_talloc_default_repr,");
328 $self->pidl(".tp_compare = py_talloc_default_cmp,");
330 $self->pidl(".tp_doc = $docstring,");
332 $self->pidl(".tp_methods = $py_methods,");
333 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
334 $self->pidl(".tp_new = py_$name\_new,");
340 return "&$typeobject";
343 sub get_metadata_var($)
346 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
348 if (has_property($e, "length_is")) {
349 return get_var($e->{PROPERTIES}->{length_is});
350 } elsif (has_property($e, "size_is")) {
351 return get_var($e->{PROPERTIES}->{size_is});
357 sub find_metadata_args($)
360 my $metadata_args = { in => {}, out => {} };
362 # Determine arguments that are metadata for other arguments (size_is/length_is)
363 foreach my $e (@{$fn->{ELEMENTS}}) {
364 foreach my $dir (@{$e->{DIRECTION}}) {
365 my $main = get_metadata_var($e);
367 $metadata_args->{$dir}->{$main} = $e->{NAME};
372 return $metadata_args;
375 sub PythonFunctionUnpackOut($$$)
377 my ($self, $fn, $fnname) = @_;
379 my $outfnname = "unpack_$fnname\_args_out";
382 my $metadata_args = find_metadata_args($fn);
384 my $env = GenerateFunctionOutEnv($fn, "r->");
387 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
390 $self->pidl("PyObject *result;");
391 foreach my $e (@{$fn->{ELEMENTS}}) {
392 next unless (grep(/out/,@{$e->{DIRECTION}}));
393 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
394 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
395 $self->pidl("PyObject *py_$e->{NAME};");
399 if ($fn->{RETURN_TYPE}) {
400 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
405 if ($result_size > 1) {
406 $self->pidl("result = PyTuple_New($result_size);");
408 } elsif ($result_size == 0) {
409 $self->pidl("result = Py_None;");
410 $self->pidl("Py_INCREF(result);");
411 $signature .= "None";
414 foreach my $e (@{$fn->{ELEMENTS}}) {
415 next if ($metadata_args->{out}->{$e->{NAME}});
416 my $py_name = "py_$e->{NAME}";
417 if (grep(/out/,@{$e->{DIRECTION}})) {
418 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
419 if ($result_size > 1) {
420 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
422 $signature .= "$e->{NAME}, ";
424 $self->pidl("result = $py_name;");
425 $signature .= $e->{NAME};
430 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
431 $self->handle_ntstatus("r->out.result", "NULL", undef);
432 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
433 $self->handle_werror("r->out.result", "NULL", undef);
434 } elsif (defined($fn->{RETURN_TYPE})) {
435 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
436 if ($result_size > 1) {
437 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
439 $self->pidl("result = $conv;");
441 $signature .= "result";
444 if (substr($signature, -2) eq ", ") {
445 $signature = substr($signature, 0, -2);
447 if ($result_size > 1) {
451 $self->pidl("return result;");
456 return ($outfnname, $signature);
459 sub PythonFunctionPackIn($$$)
461 my ($self, $fn, $fnname) = @_;
462 my $metadata_args = find_metadata_args($fn);
464 my $infnname = "pack_$fnname\_args_in";
466 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
469 my $args_format = "";
470 my $args_string = "";
474 foreach my $e (@{$fn->{ELEMENTS}}) {
475 next unless (grep(/in/,@{$e->{DIRECTION}}));
476 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
477 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
478 $self->pidl("PyObject *py_$e->{NAME};");
480 $args_string .= ", &py_$e->{NAME}";
481 $args_names .= "\"$e->{NAME}\", ";
482 $signature .= "$e->{NAME}, ";
484 if (substr($signature, -2) eq ", ") {
485 $signature = substr($signature, 0, -2);
487 $self->pidl("const char *kwnames[] = {");
489 $self->pidl($args_names . "NULL");
494 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
496 $self->pidl("return false;");
501 my $env = GenerateFunctionInEnv($fn, "r->");
503 my $fail = "return false;";
504 foreach my $e (@{$fn->{ELEMENTS}}) {
505 next unless (grep(/in/,@{$e->{DIRECTION}}));
506 if ($metadata_args->{in}->{$e->{NAME}}) {
507 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
508 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
509 my $val = "PyList_GET_SIZE($py_var)";
510 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
511 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
512 $self->pidl("*r->in.$e->{NAME} = $val;");
514 $self->pidl("r->in.$e->{NAME} = $val;");
517 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
520 $self->pidl("return true;");
524 return ($infnname, $signature);
527 sub PythonFunction($$$)
529 my ($self, $fn, $iface, $prettyname) = @_;
531 my $fnname = "py_$fn->{NAME}";
532 my $docstring = $self->DocString($fn, $fn->{NAME});
534 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
535 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
536 my $signature = "S.$prettyname($insignature) -> $outsignature";
538 $docstring = "\"$signature\\n\\n\"$docstring";
540 $docstring = "\"$signature\"";
543 return ($infn, $outfn, $docstring);
546 sub handle_werror($$$$)
548 my ($self, $var, $retval, $mem_ctx) = @_;
550 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
552 $self->pidl("PyErr_SetWERROR($var);");
553 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
554 $self->pidl("return $retval;");
560 sub handle_ntstatus($$$$)
562 my ($self, $var, $retval, $mem_ctx) = @_;
564 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
566 $self->pidl("PyErr_SetNTSTATUS($var);");
567 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
568 $self->pidl("return $retval;");
576 my ($self, $modulename, $d, $interface, $basename) = @_;
578 my $actual_ctype = $d;
579 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
580 $actual_ctype = $actual_ctype->{DATA};
583 if ($actual_ctype->{TYPE} eq "STRUCT") {
585 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
587 if ($d->{TYPE} eq "STRUCT") {
588 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
590 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
593 $self->register_module_typeobject($fn_name, $typeobject);
596 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
597 $self->EnumAndBitmapConsts($d->{NAME}, $d);
600 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
601 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
604 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
605 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
608 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
613 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
616 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
625 my ($self, $d, $name) = @_;
626 if (has_property($d, "helpstring")) {
627 my $docstring = uc("py_doc_$name");
628 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
637 my($self,$interface,$basename) = @_;
639 if (has_property($interface, "pyhelper")) {
640 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
643 $self->Const($_) foreach (@{$interface->{CONSTS}});
645 foreach my $d (@{$interface->{TYPES}}) {
646 next if has_property($d, "nopython");
648 $self->PythonType($basename, $d, $interface, $basename);
651 if (defined $interface->{PROPERTIES}->{uuid}) {
652 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
657 foreach my $d (@{$interface->{FUNCTIONS}}) {
658 next if has_property($d, "noopnum");
659 next if has_property($d, "nopython");
660 next if has_property($d, "todo");
662 my $prettyname = $d->{NAME};
664 $prettyname =~ s/^$interface->{NAME}_//;
665 $prettyname =~ s/^$basename\_//;
667 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
669 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
672 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
674 foreach my $d (@fns) {
675 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
676 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
678 $self->pidl("{ NULL }");
683 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
686 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
693 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
695 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
696 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
697 \"credentials should be a credentials.Credentials object.\\n\\n\"";
699 my $docstring = $self->DocString($interface, $interface->{NAME});
702 $docstring = "$signature$docstring";
704 $docstring = $signature;
707 my $if_typename = "$interface->{NAME}_InterfaceType";
709 $self->pidl("static PyTypeObject $if_typename = {");
711 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
712 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
713 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
714 $self->pidl(".tp_doc = $docstring,");
715 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
716 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
722 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
723 my $dcerpc_typename = $self->import_type_variable("base", "ClientConnection");
724 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
725 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
728 $self->pidl_hdr("\n");
731 sub register_module_method($$$$$)
733 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
735 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
738 sub register_module_typeobject($$$)
740 my ($self, $name, $py_name) = @_;
742 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
744 $self->check_ready_type($py_name);
746 $self->register_patch_type_call($name, $py_name);
749 sub check_ready_type($$)
751 my ($self, $py_name) = @_;
752 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
755 sub register_module_import($$)
757 my ($self, $basename) = @_;
759 push (@{$self->{module_imports}}, $basename) unless (grep(/^$basename$/,@{$self->{module_imports}}));
762 sub import_type_variable($$$)
764 my ($self, $module, $name) = @_;
766 $self->register_module_import($module);
767 unless (defined($self->{type_imports}->{$name})) {
768 $self->{type_imports}->{$name} = $module;
770 return "$name\_Type";
773 sub use_type_variable($$)
775 my ($self, $orig_ctype) = @_;
776 # FIXME: Have a global lookup table for types that look different on the
777 # wire than they are named in C?
778 if ($orig_ctype->{NAME} eq "dom_sid2" or $orig_ctype->{NAME} eq "dom_sid28") {
779 $orig_ctype->{NAME} = "dom_sid";
781 my $ctype = resolveType($orig_ctype);
782 unless (defined($ctype->{BASEFILE})) {
785 # If this is an external type, make sure we do the right imports.
786 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
787 return $self->import_type_variable($ctype->{BASEFILE}, $ctype->{NAME});
789 return "&$ctype->{NAME}_Type";
792 sub register_patch_type_call($$$)
794 my ($self, $typename, $cvar) = @_;
796 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
800 sub register_module_prereadycode($$)
802 my ($self, $code) = @_;
804 push (@{$self->{prereadycode}}, @$code);
807 sub register_module_postreadycode($$)
809 my ($self, $code) = @_;
811 push (@{$self->{postreadycode}}, @$code);
814 sub register_module_object($$$)
816 my ($self, $name, $py_name) = @_;
818 push (@{$self->{module_objects}}, [$name, $py_name])
823 my ($self, $dest, $src) = @_;
824 if ($dest =~ /^\&/ and $src eq "NULL") {
825 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
826 } elsif ($dest =~ /^\&/) {
827 $self->pidl("memmove($dest, $src, sizeof(" . get_value_of($dest) . "));");
829 $self->pidl("$dest = $src;");
833 sub ConvertObjectFromPythonData($$$$$$;$)
835 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
837 fatal($location, "undef type for $cvar") unless(defined($ctype));
839 $ctype = resolveType($ctype);
841 my $actual_ctype = $ctype;
842 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
843 $actual_ctype = $actual_ctype->{DATA};
846 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
847 $self->pidl("if (PyLong_Check($cvar)) {");
849 $self->pidl("$target = PyLong_AsLongLong($cvar);");
851 $self->pidl("} else if (PyInt_Check($cvar)) {");
853 $self->pidl("$target = PyInt_AsLong($cvar);");
855 $self->pidl("} else {");
857 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
858 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
864 if ($actual_ctype->{TYPE} eq "SCALAR" ) {
865 if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
866 $self->pidl("if (PyLong_Check($cvar)) {");
868 $self->pidl("$target = PyLong_AsLongLong($cvar);");
870 $self->pidl("} else if (PyInt_Check($cvar)) {");
872 $self->pidl("$target = PyInt_AsLong($cvar);");
874 $self->pidl("} else {");
876 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
877 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
883 if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t)$/) {
884 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
885 $self->pidl("$target = PyInt_AsLong($cvar);");
890 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
891 my $ctype_name = $self->use_type_variable($ctype);
892 unless (defined ($ctype_name)) {
893 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
894 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
897 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
898 $self->pidl("if (talloc_reference($mem_ctx, py_talloc_get_mem_ctx($cvar)) == NULL) {");
900 $self->pidl("PyErr_NoMemory();");
901 $self->pidl("$fail");
904 $self->assign($target, "(".mapTypeName($ctype)." *)py_talloc_get_ptr($cvar)");
908 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
909 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
913 if ($actual_ctype->{TYPE} eq "SCALAR" and
914 ($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")) {
915 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
919 if ($actual_ctype->{TYPE} eq "SCALAR" and ($actual_ctype->{NAME} eq "dns_string" or $actual_ctype->{NAME} eq "dns_name")) {
920 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
924 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
925 $self->pidl("$target = PyString_AS_STRING($cvar);");
929 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv6address") {
930 $self->pidl("$target = PyString_AsString($cvar);");
934 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
935 $self->pidl("$target = PyString_AS_STRING($cvar);");
939 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_string") {
940 $self->pidl("$target = PyString_AS_STRING($cvar);");
944 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
945 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
949 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
950 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
954 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
955 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
959 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
960 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
964 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
968 sub ConvertObjectFromPythonLevel($$$$$$$$)
970 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
971 my $nl = GetNextLevel($e, $l);
973 if ($l->{TYPE} eq "POINTER") {
974 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
975 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
978 if ($l->{POINTER_TYPE} ne "ref") {
979 $self->pidl("if ($py_var == Py_None) {");
981 $self->pidl("$var_name = NULL;");
983 $self->pidl("} else {");
986 # if we want to handle more than one level of pointer in python interfaces
987 # then this is where we would need to allocate it
988 if ($l->{POINTER_TYPE} eq "ref") {
989 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
991 $self->pidl("$var_name = NULL;");
993 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
994 if ($l->{POINTER_TYPE} ne "ref") {
998 } elsif ($l->{TYPE} eq "ARRAY") {
999 my $pl = GetPrevLevel($e, $l);
1000 if ($pl && $pl->{TYPE} eq "POINTER") {
1001 $var_name = get_pointer_to($var_name);
1004 if (is_charset_array($e, $l)) {
1005 $self->pidl("if (PyUnicode_Check($py_var)) {");
1007 # FIXME: Use Unix charset setting rather than utf-8
1008 $self->pidl($var_name . " = PyString_AS_STRING(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
1010 $self->pidl("} else if (PyString_Check($py_var)) {");
1012 $self->pidl($var_name . " = PyString_AS_STRING($py_var);");
1014 $self->pidl("} else {");
1016 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1017 $self->pidl("$fail;");
1021 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1022 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1025 $self->pidl("int $counter;");
1026 if (ArrayDynamicallyAllocated($e, $l)) {
1027 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1028 $self->pidl("if (!$var_name) { $fail; }");
1029 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1031 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1033 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
1039 } elsif ($l->{TYPE} eq "DATA") {
1040 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1041 $var_name = get_pointer_to($var_name);
1043 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1044 } elsif ($l->{TYPE} eq "SWITCH") {
1045 $var_name = get_pointer_to($var_name);
1046 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1047 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1050 $self->pidl("void *$switch_ptr;");
1051 $self->pidl("$switch_ptr = py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1052 $self->pidl("if ($switch_ptr == NULL) { $fail }");
1053 $self->assign($var_name, "$switch_ptr");
1056 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1057 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
1059 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1063 sub ConvertObjectFromPython($$$$$$$)
1065 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1067 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1070 sub ConvertScalarToPython($$$)
1072 my ($self, $ctypename, $cvar) = @_;
1074 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1076 $ctypename = expandAlias($ctypename);
1078 if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1079 return "PyLong_FromLongLong($cvar)";
1082 if ($ctypename =~ /^(char|u?int[0-9]*|time_t)$/) {
1083 return "PyInt_FromLong($cvar)";
1086 if ($ctypename eq "DATA_BLOB") {
1087 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1090 if ($ctypename eq "NTSTATUS") {
1091 return "PyErr_FromNTSTATUS($cvar)";
1094 if ($ctypename eq "WERROR") {
1095 return "PyErr_FromWERROR($cvar)";
1098 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1099 return "PyString_FromString_check_null($cvar)";
1102 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1103 return "PyString_FromString_check_null($cvar)";
1107 if ($ctypename eq "string_array") { return "PyCObject_FromTallocPtr($cvar)"; }
1108 if ($ctypename eq "ipv4address") { return "PyString_FromString_check_null($cvar)"; }
1109 if ($ctypename eq "ipv6address") { return "PyString_FromString_check_null($cvar)"; }
1110 if ($ctypename eq "dnsp_name") { return "PyString_FromString_check_null($cvar)"; }
1111 if ($ctypename eq "dnsp_string") { return "PyString_FromString_check_null($cvar)"; }
1112 if ($ctypename eq "pointer") {
1113 return "PyCObject_FromTallocPtr($cvar)";
1116 die("Unknown scalar type $ctypename");
1119 sub ConvertObjectToPythonData($$$$$;$)
1121 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1123 die("undef type for $cvar") unless(defined($ctype));
1125 $ctype = resolveType($ctype);
1127 my $actual_ctype = $ctype;
1128 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1129 $actual_ctype = $actual_ctype->{DATA};
1132 if ($actual_ctype->{TYPE} eq "ENUM") {
1133 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1134 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1135 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1136 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1137 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1138 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1139 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1140 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1141 my $ctype_name = $self->use_type_variable($ctype);
1142 unless (defined($ctype_name)) {
1143 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1144 return "NULL"; # FIXME!
1146 return "py_talloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1149 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1152 sub fail_on_null($$$)
1154 my ($self, $var, $fail) = @_;
1155 $self->pidl("if ($var == NULL) {");
1162 sub ConvertObjectToPythonLevel($$$$$$)
1164 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1165 my $nl = GetNextLevel($e, $l);
1167 if ($l->{TYPE} eq "POINTER") {
1168 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1169 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1172 if ($l->{POINTER_TYPE} ne "ref") {
1173 $self->pidl("if ($var_name == NULL) {");
1175 $self->pidl("$py_var = Py_None;");
1176 $self->pidl("Py_INCREF($py_var);");
1178 $self->pidl("} else {");
1181 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1182 if ($l->{POINTER_TYPE} ne "ref") {
1186 } elsif ($l->{TYPE} eq "ARRAY") {
1187 my $pl = GetPrevLevel($e, $l);
1188 if ($pl && $pl->{TYPE} eq "POINTER") {
1189 $var_name = get_pointer_to($var_name);
1192 if (is_charset_array($e, $l)) {
1193 # FIXME: Use Unix charset setting rather than utf-8
1194 $self->pidl("if ($var_name == NULL) {");
1196 $self->pidl("$py_var = Py_None;");
1197 $self->pidl("Py_INCREF($py_var);");
1199 $self->pidl("} else {");
1201 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1205 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1206 my $length = $l->{SIZE_IS};
1207 if (defined($l->{LENGTH_IS})) {
1208 $length = $l->{LENGTH_IS};
1211 $length = ParseExpr($length, $env, $e);
1212 $self->pidl("$py_var = PyList_New($length);");
1213 $self->fail_on_null($py_var, $fail);
1216 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1217 $self->pidl("int $counter;");
1218 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1220 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1221 $self->pidl("PyObject *$member_var;");
1222 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1223 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1229 } elsif ($l->{TYPE} eq "SWITCH") {
1230 $var_name = get_pointer_to($var_name);
1231 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1232 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1233 $self->fail_on_null($py_var, $fail);
1235 } elsif ($l->{TYPE} eq "DATA") {
1236 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1237 $var_name = get_pointer_to($var_name);
1239 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1240 $self->pidl("$py_var = $conv;");
1241 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1242 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1244 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1248 sub ConvertObjectToPython($$$$$$)
1250 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1252 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1257 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1259 $self->{BASENAME} = $basename;
1262 /* Python wrapper functions auto-generated by pidl */
1264 #include \"includes.h\"
1265 #include \"lib/talloc/pytalloc.h\"
1266 #include \"librpc/rpc/pyrpc.h\"
1267 #include \"librpc/rpc/pyrpc_util.h\"
1269 #include \"$ndr_hdr\"
1273 foreach my $x (@$ndr) {
1274 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1275 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1278 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1280 foreach (@{$self->{module_methods}}) {
1281 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1282 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1285 $self->pidl("{ NULL, NULL, 0, NULL }");
1291 $self->pidl("void init$basename(void)");
1294 $self->pidl("PyObject *m;");
1295 foreach (@{$self->{module_imports}}) {
1296 $self->pidl("PyObject *dep_$_;");
1300 foreach (@{$self->{module_imports}}) {
1301 $self->pidl("dep_$_ = PyImport_ImportModule(\"samba.dcerpc.$_\");");
1302 $self->pidl("if (dep_$_ == NULL)");
1303 $self->pidl("\treturn;");
1307 foreach (keys %{$self->{type_imports}}) {
1308 my $basefile = $self->{type_imports}->{$_};
1309 $self->pidl_hdr("static PyTypeObject *$_\_Type;\n");
1310 my $pretty_name = PrettifyTypeName($_, $basefile);
1311 $self->pidl("$_\_Type = (PyTypeObject *)PyObject_GetAttrString(dep_$basefile, \"$pretty_name\");");
1312 $self->pidl("if ($_\_Type == NULL)");
1313 $self->pidl("\treturn;");
1317 $self->pidl($_) foreach (@{$self->{prereadycode}});
1319 foreach (@{$self->{ready_types}}) {
1320 $self->pidl("if (PyType_Ready($_) < 0)");
1321 $self->pidl("\treturn;");
1324 $self->pidl($_) foreach (@{$self->{postreadycode}});
1326 foreach (@{$self->{patch_type_calls}}) {
1327 my ($typename, $cvar) = @$_;
1328 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1329 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1330 $self->pidl("#endif");
1335 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1336 $self->pidl("if (m == NULL)");
1337 $self->pidl("\treturn;");
1339 foreach my $name (keys %{$self->{constants}}) {
1341 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1342 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1343 $py_obj = "PyInt_FromLong($cvar)";
1344 } elsif ($cvar =~ /^".*"$/) {
1345 $py_obj = "PyString_FromString($cvar)";
1347 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1350 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1353 foreach (@{$self->{module_objects}}) {
1354 my ($object_name, $c_name) = @$_;
1355 $self->pidl("Py_INCREF($c_name);");
1356 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1359 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1360 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1361 $self->pidl("#endif");
1366 return ($self->{res_hdr} . $self->{res});