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 => [], readycode => [] };
35 $self->{res_hdr} .= shift;
42 if ((!($d =~ /^#/))) {
43 $self->{res} .= $self->{tabs};
53 $self->{tabs} .= "\t";
59 $self->{tabs} = substr($self->{tabs}, 0, -1);
62 sub PrettifyTypeName($$)
64 my ($name, $basename) = @_;
66 $name =~ s/^$basename\_//;
78 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
79 $self->register_module_import($_);
85 my ($self, $const) = @_;
86 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
89 sub register_constant($$$$)
91 my ($self, $name, $type, $value) = @_;
93 $self->{constants}->{$name} = [$type, $value];
96 sub EnumAndBitmapConsts($$$)
98 my ($self, $name, $d) = @_;
100 return unless (defined($d->{ELEMENTS}));
102 foreach my $e (@{$d->{ELEMENTS}}) {
103 $e =~ /^([A-Za-z0-9_]+)/;
106 $self->register_constant($cname, $d, $cname);
110 sub FromUnionToPythonFunction($$$$)
112 my ($self, $mem_ctx, $type, $switch, $name) = @_;
114 $self->pidl("PyObject *ret;");
117 $self->pidl("switch ($switch) {");
120 foreach my $e (@{$type->{ELEMENTS}}) {
121 $self->pidl("$e->{CASE}:");
126 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
128 $self->pidl("ret = Py_None;");
129 $self->pidl("Py_INCREF(ret);");
132 $self->pidl("return ret;");
141 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
142 $self->pidl("return NULL;");
145 sub FromPythonToUnionFunction($$$$$)
147 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
151 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
153 $self->pidl("switch ($switch) {");
156 foreach my $e (@{$type->{ELEMENTS}}) {
157 $self->pidl("$e->{CASE}:");
158 if ($e->{CASE} eq "default") { $has_default = 1; }
161 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
163 $self->pidl("break;");
169 $self->pidl("default:");
171 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
172 $self->pidl("talloc_free(ret);");
173 $self->pidl("ret = NULL;");
180 $self->pidl("return ret;");
183 sub PythonStruct($$$$$$)
185 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
187 my $env = GenerateStructEnv($d, "object");
191 my $getsetters = "NULL";
193 if ($#{$d->{ELEMENTS}} > -1) {
194 foreach my $e (@{$d->{ELEMENTS}}) {
195 my $varname = "object->$e->{NAME}";
196 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
199 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(obj);");
200 $self->pidl("PyObject *py_$e->{NAME};");
201 $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
202 $self->pidl("return py_$e->{NAME};");
207 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
210 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
211 my $mem_ctx = "py_talloc_get_mem_ctx(py_obj)";
212 my $l = $e->{LEVELS}[0];
213 my $nl = GetNextLevel($e, $l);
214 if ($l->{TYPE} eq "POINTER" and
215 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
216 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
217 $self->pidl("talloc_free($varname);");
219 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
220 $self->pidl("return 0;");
226 $getsetters = "py_$name\_getsetters";
227 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
229 foreach my $e (@{$d->{ELEMENTS}}) {
230 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
232 $self->pidl("{ NULL }");
238 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
241 $self->pidl("return py_talloc_new($cname, type);");
246 my $py_methods = "NULL";
248 # If the struct is not public there ndr_pull/ndr_push functions will
249 # be static so not callable from here
250 if (has_property($d, "public")) {
251 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
254 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
255 $self->pidl("DATA_BLOB blob;");
256 $self->pidl("enum ndr_err_code err;");
257 $self->pidl("err = ndr_push_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), object, (ndr_push_flags_fn_t)ndr_push_$name);");
258 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
260 $self->pidl("PyErr_SetNdrError(err);");
261 $self->pidl("return NULL;");
265 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
270 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
273 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
274 $self->pidl("DATA_BLOB blob;");
275 $self->pidl("enum ndr_err_code err;");
276 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
277 $self->pidl("\treturn NULL;");
279 $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);");
280 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
282 $self->pidl("PyErr_SetNdrError(err);");
283 $self->pidl("return NULL;");
287 $self->pidl("Py_RETURN_NONE;");
291 $py_methods = "py_$name\_methods";
292 $self->pidl("static PyMethodDef $py_methods\[] = {");
294 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
295 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
296 $self->pidl("{ NULL, NULL, 0, NULL }");
302 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
304 my $docstring = $self->DocString($d, $name);
305 my $typeobject = "$name\_Type";
306 $self->pidl("static PyTypeObject $typeobject = {");
308 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
309 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
310 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
311 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
312 $self->pidl(".tp_getset = $getsetters,");
313 $self->pidl(".tp_repr = py_talloc_default_repr,");
315 $self->pidl(".tp_doc = $docstring,");
317 $self->pidl(".tp_methods = $py_methods,");
318 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
319 $self->pidl(".tp_new = py_$name\_new,");
325 return "&$typeobject";
328 sub get_metadata_var($)
331 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
333 if (has_property($e, "length_is")) {
334 return get_var($e->{PROPERTIES}->{length_is});
335 } elsif (has_property($e, "size_is")) {
336 return get_var($e->{PROPERTIES}->{size_is});
342 sub find_metadata_args($)
345 my $metadata_args = { in => {}, out => {} };
347 # Determine arguments that are metadata for other arguments (size_is/length_is)
348 foreach my $e (@{$fn->{ELEMENTS}}) {
349 foreach my $dir (@{$e->{DIRECTION}}) {
350 my $main = get_metadata_var($e);
352 $metadata_args->{$dir}->{$main} = $e->{NAME};
357 return $metadata_args;
360 sub PythonFunctionUnpackOut($$$)
362 my ($self, $fn, $fnname) = @_;
364 my $outfnname = "unpack_$fnname\_args_out";
367 my $metadata_args = find_metadata_args($fn);
369 my $env = GenerateFunctionOutEnv($fn, "r->");
372 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
375 $self->pidl("PyObject *result;");
376 foreach my $e (@{$fn->{ELEMENTS}}) {
377 next unless (grep(/out/,@{$e->{DIRECTION}}));
378 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
379 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
380 $self->pidl("PyObject *py_$e->{NAME};");
384 if ($fn->{RETURN_TYPE}) {
385 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
390 if ($result_size > 1) {
391 $self->pidl("result = PyTuple_New($result_size);");
393 } elsif ($result_size == 0) {
394 $self->pidl("result = Py_None;");
395 $self->pidl("Py_INCREF(result);");
396 $signature .= "None";
399 foreach my $e (@{$fn->{ELEMENTS}}) {
400 next if ($metadata_args->{out}->{$e->{NAME}});
401 my $py_name = "py_$e->{NAME}";
402 if (grep(/out/,@{$e->{DIRECTION}})) {
403 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
404 if ($result_size > 1) {
405 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
407 $signature .= "$e->{NAME}, ";
409 $self->pidl("result = $py_name;");
410 $signature .= $e->{NAME};
415 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
416 $self->handle_ntstatus("r->out.result", "NULL", undef);
417 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
418 $self->handle_werror("r->out.result", "NULL", undef);
419 } elsif (defined($fn->{RETURN_TYPE})) {
420 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
421 if ($result_size > 1) {
422 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
424 $self->pidl("result = $conv;");
426 $signature .= "result";
429 if (substr($signature, -2) eq ", ") {
430 $signature = substr($signature, 0, -2);
432 if ($result_size > 1) {
436 $self->pidl("return result;");
441 return ($outfnname, $signature);
444 sub PythonFunctionPackIn($$$)
446 my ($self, $fn, $fnname) = @_;
447 my $metadata_args = find_metadata_args($fn);
449 my $infnname = "pack_$fnname\_args_in";
451 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
454 my $args_format = "";
455 my $args_string = "";
459 foreach my $e (@{$fn->{ELEMENTS}}) {
460 next unless (grep(/in/,@{$e->{DIRECTION}}));
461 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
462 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
463 $self->pidl("PyObject *py_$e->{NAME};");
465 $args_string .= ", &py_$e->{NAME}";
466 $args_names .= "\"$e->{NAME}\", ";
467 $signature .= "$e->{NAME}, ";
469 if (substr($signature, -2) eq ", ") {
470 $signature = substr($signature, 0, -2);
472 $self->pidl("const char *kwnames[] = {");
474 $self->pidl($args_names . "NULL");
479 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
481 $self->pidl("return false;");
486 my $env = GenerateFunctionInEnv($fn, "r->");
488 my $fail = "return false;";
489 foreach my $e (@{$fn->{ELEMENTS}}) {
490 next unless (grep(/in/,@{$e->{DIRECTION}}));
491 if ($metadata_args->{in}->{$e->{NAME}}) {
492 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
493 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
494 my $val = "PyList_Size($py_var)";
495 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
496 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
497 $self->pidl("*r->in.$e->{NAME} = $val;");
499 $self->pidl("r->in.$e->{NAME} = $val;");
502 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
505 $self->pidl("return true;");
509 return ($infnname, $signature);
512 sub PythonFunction($$$)
514 my ($self, $fn, $iface, $prettyname) = @_;
516 my $fnname = "py_$fn->{NAME}";
517 my $docstring = $self->DocString($fn, $fn->{NAME});
519 my ($insignature, $outsignature);
522 if (has_property($fn, "todo")) {
523 unless ($docstring) { $docstring = "NULL"; }
527 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
528 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
529 my $signature = "S.$prettyname($insignature) -> $outsignature";
531 $docstring = "\"$signature\\n\\n\"$docstring";
533 $docstring = "\"$signature\"";
537 return ($infn, $outfn, $docstring);
540 sub handle_werror($$$$)
542 my ($self, $var, $retval, $mem_ctx) = @_;
544 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
546 $self->pidl("PyErr_SetWERROR($var);");
547 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
548 $self->pidl("return $retval;");
554 sub handle_ntstatus($$$$)
556 my ($self, $var, $retval, $mem_ctx) = @_;
558 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
560 $self->pidl("PyErr_SetNTSTATUS($var);");
561 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
562 $self->pidl("return $retval;");
570 my ($self, $modulename, $d, $interface, $basename) = @_;
572 my $actual_ctype = $d;
573 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
574 $actual_ctype = $actual_ctype->{DATA};
577 if ($actual_ctype->{TYPE} eq "STRUCT") {
579 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
581 if ($d->{TYPE} eq "STRUCT") {
582 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
584 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
587 $self->register_module_typeobject($fn_name, $typeobject);
590 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
591 $self->EnumAndBitmapConsts($d->{NAME}, $d);
594 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
595 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
598 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
599 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
602 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
607 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
610 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
619 my ($self, $d, $name) = @_;
620 if (has_property($d, "helpstring")) {
621 my $docstring = uc("py_doc_$name");
622 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
631 my($self,$interface,$basename) = @_;
633 if (has_property($interface, "pyhelper")) {
634 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
637 $self->Const($_) foreach (@{$interface->{CONSTS}});
639 foreach my $d (@{$interface->{TYPES}}) {
640 next if has_property($d, "nopython");
642 $self->PythonType($basename, $d, $interface, $basename);
645 if (defined $interface->{PROPERTIES}->{uuid}) {
646 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
651 foreach my $d (@{$interface->{FUNCTIONS}}) {
652 next if not defined($d->{OPNUM});
653 next if has_property($d, "nopython");
654 next if has_property($d, "todo");
656 my $prettyname = $d->{NAME};
658 $prettyname =~ s/^$interface->{NAME}_//;
659 $prettyname =~ s/^$basename\_//;
661 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
663 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
666 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
668 foreach my $d (@fns) {
669 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
670 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
672 $self->pidl("{ NULL }");
677 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
680 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
687 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
689 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
690 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
691 \"credentials should be a credentials.Credentials object.\\n\\n\"";
693 my $docstring = $self->DocString($interface, $interface->{NAME});
696 $docstring = "$signature$docstring";
698 $docstring = $signature;
701 $self->pidl("static PyTypeObject $interface->{NAME}_InterfaceType = {");
703 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
704 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
705 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
706 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
707 $self->pidl(".tp_doc = $docstring,");
708 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
709 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
715 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
716 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
719 $self->pidl_hdr("\n");
722 sub register_module_method($$$$$)
724 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
726 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
729 sub register_module_typeobject($$$)
731 my ($self, $name, $py_name) = @_;
733 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
735 $self->check_ready_type($py_name);
737 $self->register_patch_type_call($name, $py_name);
740 sub check_ready_type($$)
742 my ($self, $py_name) = @_;
743 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
746 sub register_module_import($$)
748 my ($self, $basename) = @_;
750 push (@{$self->{module_imports}}, $basename) unless (grep(/^$basename$/,@{$self->{module_imports}}));
753 sub use_type_variable($$)
755 my ($self, $orig_ctype) = @_;
756 # FIXME: Have a global lookup table for types that look different on the
757 # wire than they are named in C?
758 if ($orig_ctype->{NAME} eq "dom_sid2") {
759 $orig_ctype->{NAME} = "dom_sid";
761 my $ctype = resolveType($orig_ctype);
762 unless (defined($ctype->{BASEFILE})) {
765 # If this is an external type, make sure we do the right imports.
766 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
767 $self->register_module_import($ctype->{BASEFILE});
768 unless (defined($self->{type_imports}->{$ctype->{NAME}})) {
769 $self->{type_imports}->{$ctype->{NAME}} = $ctype->{BASEFILE};
771 return "$ctype->{NAME}_Type";
773 return "&$ctype->{NAME}_Type";
776 sub register_patch_type_call($$$)
778 my ($self, $typename, $cvar) = @_;
780 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
784 sub register_module_readycode($$)
786 my ($self, $code) = @_;
788 push (@{$self->{readycode}}, @$code);
791 sub register_module_object($$$)
793 my ($self, $name, $py_name) = @_;
795 push (@{$self->{module_objects}}, [$name, $py_name])
800 my ($self, $dest, $src) = @_;
801 if ($dest =~ /^\&/ and $src eq "NULL") {
802 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
803 } elsif ($dest =~ /^\&/) {
804 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
806 $self->pidl("$dest = $src;");
810 sub ConvertObjectFromPythonData($$$$$$;$)
812 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
814 fatal($location, "undef type for $cvar") unless(defined($ctype));
816 $ctype = resolveType($ctype);
818 my $actual_ctype = $ctype;
819 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
820 $actual_ctype = $actual_ctype->{DATA};
823 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
824 $actual_ctype->{TYPE} eq "SCALAR" and (
825 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
826 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
827 $self->pidl("$target = PyInt_AsLong($cvar);");
831 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
832 my $ctype_name = $self->use_type_variable($ctype);
833 unless (defined ($ctype_name)) {
834 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
835 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " to Python\");");
838 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
839 $self->assign($target, "(".mapTypeName($ctype)." *)py_talloc_get_ptr($cvar)");
843 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
844 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
848 if ($actual_ctype->{TYPE} eq "SCALAR" and
849 ($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")) {
850 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
854 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
855 $self->pidl("$target = PyString_AsString($cvar);");
860 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
861 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
865 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
866 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
870 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
871 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
875 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
876 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
880 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
884 sub ConvertObjectFromPythonLevel($$$$$$$$)
886 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
887 my $nl = GetNextLevel($e, $l);
889 if ($l->{TYPE} eq "POINTER") {
890 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
891 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
894 if ($l->{POINTER_TYPE} ne "ref") {
895 $self->pidl("if ($py_var == Py_None) {");
897 $self->pidl("$var_name = NULL;");
899 $self->pidl("} else {");
902 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
903 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
904 if ($l->{POINTER_TYPE} ne "ref") {
908 } elsif ($l->{TYPE} eq "ARRAY") {
909 my $pl = GetPrevLevel($e, $l);
910 if ($pl && $pl->{TYPE} eq "POINTER") {
911 $var_name = get_pointer_to($var_name);
914 if (is_charset_array($e, $l)) {
915 $self->pidl("PY_CHECK_TYPE(&PyUnicode_Type, $py_var, $fail);");
916 # FIXME: Use Unix charset setting rather than utf-8
917 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
919 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
920 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
923 $self->pidl("int $counter;");
924 if (ArrayDynamicallyAllocated($e, $l)) {
925 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
927 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
929 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
935 } elsif ($l->{TYPE} eq "DATA") {
937 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
938 $var_name = get_pointer_to($var_name);
940 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
941 } elsif ($l->{TYPE} eq "SWITCH") {
942 $var_name = get_pointer_to($var_name);
943 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
944 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
945 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
946 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
948 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
952 sub ConvertObjectFromPython($$$$$$$)
954 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
956 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
959 sub ConvertScalarToPython($$$)
961 my ($self, $ctypename, $cvar) = @_;
963 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
965 $ctypename = expandAlias($ctypename);
967 if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
968 return "PyLong_FromLongLong($cvar)";
971 if ($ctypename =~ /^(char|u?int[0-9]*|time_t)$/) {
972 return "PyInt_FromLong($cvar)";
975 if ($ctypename eq "DATA_BLOB") {
976 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
979 if ($ctypename eq "NTSTATUS") {
980 return "PyErr_FromNTSTATUS($cvar)";
983 if ($ctypename eq "WERROR") {
984 return "PyErr_FromWERROR($cvar)";
987 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
988 return "PyString_FromString($cvar)";
992 if ($ctypename eq "string_array") { return "PyCObject_FromTallocPtr($cvar)"; }
993 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
994 if ($ctypename eq "pointer") {
995 return "PyCObject_FromTallocPtr($cvar)";
998 die("Unknown scalar type $ctypename");
1001 sub ConvertObjectToPythonData($$$$$;$)
1003 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1005 die("undef type for $cvar") unless(defined($ctype));
1007 $ctype = resolveType($ctype);
1009 my $actual_ctype = $ctype;
1010 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1011 $actual_ctype = $actual_ctype->{DATA};
1014 if ($actual_ctype->{TYPE} eq "ENUM") {
1015 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1016 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1017 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1018 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1019 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1020 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1021 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1022 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1023 my $ctype_name = $self->use_type_variable($ctype);
1024 unless (defined($ctype_name)) {
1025 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1026 return "NULL"; # FIXME!
1028 return "py_talloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1031 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1034 sub fail_on_null($$$)
1036 my ($self, $var, $fail) = @_;
1037 $self->pidl("if ($var == NULL) {");
1044 sub ConvertObjectToPythonLevel($$$$$$)
1046 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1047 my $nl = GetNextLevel($e, $l);
1049 if ($l->{TYPE} eq "POINTER") {
1050 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1051 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1054 if ($l->{POINTER_TYPE} ne "ref") {
1055 $self->pidl("if ($var_name == NULL) {");
1057 $self->pidl("$py_var = Py_None;");
1058 $self->pidl("Py_INCREF($py_var);");
1060 $self->pidl("} else {");
1063 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1064 if ($l->{POINTER_TYPE} ne "ref") {
1068 } elsif ($l->{TYPE} eq "ARRAY") {
1069 my $pl = GetPrevLevel($e, $l);
1070 if ($pl && $pl->{TYPE} eq "POINTER") {
1071 $var_name = get_pointer_to($var_name);
1074 if (is_charset_array($e, $l)) {
1075 # FIXME: Use Unix charset setting rather than utf-8
1076 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1078 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1079 my $length = $l->{SIZE_IS};
1080 if (defined($l->{LENGTH_IS})) {
1081 $length = $l->{LENGTH_IS};
1084 $length = ParseExpr($length, $env, $e);
1085 $self->pidl("$py_var = PyList_New($length);");
1086 $self->fail_on_null($py_var, $fail);
1089 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1090 $self->pidl("int $counter;");
1091 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1093 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1094 $self->pidl("PyObject *$member_var;");
1095 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1096 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1102 } elsif ($l->{TYPE} eq "SWITCH") {
1103 $var_name = get_pointer_to($var_name);
1104 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1105 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1106 $self->fail_on_null($py_var, $fail);
1108 } elsif ($l->{TYPE} eq "DATA") {
1109 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1110 $var_name = get_pointer_to($var_name);
1112 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1113 $self->pidl("$py_var = $conv;");
1114 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1115 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1117 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1121 sub ConvertObjectToPython($$$$$$)
1123 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1125 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1130 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1132 $self->{BASENAME} = $basename;
1135 /* Python wrapper functions auto-generated by pidl */
1137 #include \"includes.h\"
1138 #include \"lib/talloc/pytalloc.h\"
1139 #include \"librpc/rpc/pyrpc.h\"
1141 #include \"$ndr_hdr\"
1145 foreach my $x (@$ndr) {
1146 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1147 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1150 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1152 foreach (@{$self->{module_methods}}) {
1153 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1154 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1157 $self->pidl("{ NULL, NULL, 0, NULL }");
1163 $self->pidl("void init$basename(void)");
1166 $self->pidl("PyObject *m;");
1167 foreach (@{$self->{module_imports}}) {
1168 $self->pidl("PyObject *dep_$_;");
1172 foreach (@{$self->{module_imports}}) {
1173 $self->pidl("dep_$_ = PyImport_ImportModule(\"samba.dcerpc.$_\");");
1174 $self->pidl("if (dep_$_ == NULL)");
1175 $self->pidl("\treturn;");
1179 foreach (keys %{$self->{type_imports}}) {
1180 my $basefile = $self->{type_imports}->{$_};
1181 $self->pidl_hdr("static PyTypeObject *$_\_Type;\n");
1182 my $pretty_name = PrettifyTypeName($_, $basefile);
1183 $self->pidl("$_\_Type = (PyTypeObject *)PyObject_GetAttrString(dep_$basefile, \"$pretty_name\");");
1184 $self->pidl("if ($_\_Type == NULL)");
1185 $self->pidl("\treturn;");
1189 foreach (@{$self->{ready_types}}) {
1190 $self->pidl("if (PyType_Ready($_) < 0)");
1191 $self->pidl("\treturn;");
1194 $self->pidl($_) foreach (@{$self->{readycode}});
1196 foreach (@{$self->{patch_type_calls}}) {
1197 my ($typename, $cvar) = @$_;
1198 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1199 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1200 $self->pidl("#endif");
1205 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1206 $self->pidl("if (m == NULL)");
1207 $self->pidl("\treturn;");
1209 foreach my $name (keys %{$self->{constants}}) {
1211 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1212 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1213 $py_obj = "PyInt_FromLong($cvar)";
1214 } elsif ($cvar =~ /^".*"$/) {
1215 $py_obj = "PyString_FromString($cvar)";
1217 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1220 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1223 foreach (@{$self->{module_objects}}) {
1224 my ($object_name, $c_name) = @$_;
1225 $self->pidl("Py_INCREF($c_name);");
1226 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1229 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1230 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1231 $self->pidl("#endif");
1236 return ($self->{res_hdr} . $self->{res});