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;");
292 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
295 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
296 $self->pidl("char *retstr;");
297 $self->pidl("retstr = ndr_print_struct_string(py_talloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
298 $self->pidl("return PyString_FromString(retstr);");
303 $py_methods = "py_$name\_methods";
304 $self->pidl("static PyMethodDef $py_methods\[] = {");
306 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
307 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
308 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.print(blob) -> None\\nNDR print\" },");
309 $self->pidl("{ NULL, NULL, 0, NULL }");
315 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
317 my $docstring = $self->DocString($d, $name);
318 my $typeobject = "$name\_Type";
319 $self->pidl("static PyTypeObject $typeobject = {");
321 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
322 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
323 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
324 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
325 $self->pidl(".tp_getset = $getsetters,");
326 $self->pidl(".tp_repr = py_talloc_default_repr,");
328 $self->pidl(".tp_doc = $docstring,");
330 $self->pidl(".tp_methods = $py_methods,");
331 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
332 $self->pidl(".tp_new = py_$name\_new,");
338 return "&$typeobject";
341 sub get_metadata_var($)
344 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
346 if (has_property($e, "length_is")) {
347 return get_var($e->{PROPERTIES}->{length_is});
348 } elsif (has_property($e, "size_is")) {
349 return get_var($e->{PROPERTIES}->{size_is});
355 sub find_metadata_args($)
358 my $metadata_args = { in => {}, out => {} };
360 # Determine arguments that are metadata for other arguments (size_is/length_is)
361 foreach my $e (@{$fn->{ELEMENTS}}) {
362 foreach my $dir (@{$e->{DIRECTION}}) {
363 my $main = get_metadata_var($e);
365 $metadata_args->{$dir}->{$main} = $e->{NAME};
370 return $metadata_args;
373 sub PythonFunctionUnpackOut($$$)
375 my ($self, $fn, $fnname) = @_;
377 my $outfnname = "unpack_$fnname\_args_out";
380 my $metadata_args = find_metadata_args($fn);
382 my $env = GenerateFunctionOutEnv($fn, "r->");
385 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
388 $self->pidl("PyObject *result;");
389 foreach my $e (@{$fn->{ELEMENTS}}) {
390 next unless (grep(/out/,@{$e->{DIRECTION}}));
391 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
392 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
393 $self->pidl("PyObject *py_$e->{NAME};");
397 if ($fn->{RETURN_TYPE}) {
398 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
403 if ($result_size > 1) {
404 $self->pidl("result = PyTuple_New($result_size);");
406 } elsif ($result_size == 0) {
407 $self->pidl("result = Py_None;");
408 $self->pidl("Py_INCREF(result);");
409 $signature .= "None";
412 foreach my $e (@{$fn->{ELEMENTS}}) {
413 next if ($metadata_args->{out}->{$e->{NAME}});
414 my $py_name = "py_$e->{NAME}";
415 if (grep(/out/,@{$e->{DIRECTION}})) {
416 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
417 if ($result_size > 1) {
418 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
420 $signature .= "$e->{NAME}, ";
422 $self->pidl("result = $py_name;");
423 $signature .= $e->{NAME};
428 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
429 $self->handle_ntstatus("r->out.result", "NULL", undef);
430 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
431 $self->handle_werror("r->out.result", "NULL", undef);
432 } elsif (defined($fn->{RETURN_TYPE})) {
433 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
434 if ($result_size > 1) {
435 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
437 $self->pidl("result = $conv;");
439 $signature .= "result";
442 if (substr($signature, -2) eq ", ") {
443 $signature = substr($signature, 0, -2);
445 if ($result_size > 1) {
449 $self->pidl("return result;");
454 return ($outfnname, $signature);
457 sub PythonFunctionPackIn($$$)
459 my ($self, $fn, $fnname) = @_;
460 my $metadata_args = find_metadata_args($fn);
462 my $infnname = "pack_$fnname\_args_in";
464 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
467 my $args_format = "";
468 my $args_string = "";
472 foreach my $e (@{$fn->{ELEMENTS}}) {
473 next unless (grep(/in/,@{$e->{DIRECTION}}));
474 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
475 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
476 $self->pidl("PyObject *py_$e->{NAME};");
478 $args_string .= ", &py_$e->{NAME}";
479 $args_names .= "\"$e->{NAME}\", ";
480 $signature .= "$e->{NAME}, ";
482 if (substr($signature, -2) eq ", ") {
483 $signature = substr($signature, 0, -2);
485 $self->pidl("const char *kwnames[] = {");
487 $self->pidl($args_names . "NULL");
492 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
494 $self->pidl("return false;");
499 my $env = GenerateFunctionInEnv($fn, "r->");
501 my $fail = "return false;";
502 foreach my $e (@{$fn->{ELEMENTS}}) {
503 next unless (grep(/in/,@{$e->{DIRECTION}}));
504 if ($metadata_args->{in}->{$e->{NAME}}) {
505 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
506 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
507 my $val = "PyList_Size($py_var)";
508 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
509 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
510 $self->pidl("*r->in.$e->{NAME} = $val;");
512 $self->pidl("r->in.$e->{NAME} = $val;");
515 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
518 $self->pidl("return true;");
522 return ($infnname, $signature);
525 sub PythonFunction($$$)
527 my ($self, $fn, $iface, $prettyname) = @_;
529 my $fnname = "py_$fn->{NAME}";
530 my $docstring = $self->DocString($fn, $fn->{NAME});
532 my ($insignature, $outsignature);
535 if (has_property($fn, "todo")) {
536 unless ($docstring) { $docstring = "NULL"; }
540 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
541 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
542 my $signature = "S.$prettyname($insignature) -> $outsignature";
544 $docstring = "\"$signature\\n\\n\"$docstring";
546 $docstring = "\"$signature\"";
550 return ($infn, $outfn, $docstring);
553 sub handle_werror($$$$)
555 my ($self, $var, $retval, $mem_ctx) = @_;
557 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
559 $self->pidl("PyErr_SetWERROR($var);");
560 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
561 $self->pidl("return $retval;");
567 sub handle_ntstatus($$$$)
569 my ($self, $var, $retval, $mem_ctx) = @_;
571 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
573 $self->pidl("PyErr_SetNTSTATUS($var);");
574 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
575 $self->pidl("return $retval;");
583 my ($self, $modulename, $d, $interface, $basename) = @_;
585 my $actual_ctype = $d;
586 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
587 $actual_ctype = $actual_ctype->{DATA};
590 if ($actual_ctype->{TYPE} eq "STRUCT") {
592 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
594 if ($d->{TYPE} eq "STRUCT") {
595 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
597 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
600 $self->register_module_typeobject($fn_name, $typeobject);
603 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
604 $self->EnumAndBitmapConsts($d->{NAME}, $d);
607 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
608 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
611 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
612 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
615 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
620 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
623 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
632 my ($self, $d, $name) = @_;
633 if (has_property($d, "helpstring")) {
634 my $docstring = uc("py_doc_$name");
635 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
644 my($self,$interface,$basename) = @_;
646 if (has_property($interface, "pyhelper")) {
647 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
650 $self->Const($_) foreach (@{$interface->{CONSTS}});
652 foreach my $d (@{$interface->{TYPES}}) {
653 next if has_property($d, "nopython");
655 $self->PythonType($basename, $d, $interface, $basename);
658 if (defined $interface->{PROPERTIES}->{uuid}) {
659 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
664 foreach my $d (@{$interface->{FUNCTIONS}}) {
665 next if not defined($d->{OPNUM});
666 next if has_property($d, "nopython");
667 next if has_property($d, "todo");
669 my $prettyname = $d->{NAME};
671 $prettyname =~ s/^$interface->{NAME}_//;
672 $prettyname =~ s/^$basename\_//;
674 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
676 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
679 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
681 foreach my $d (@fns) {
682 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
683 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
685 $self->pidl("{ NULL }");
690 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
693 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
700 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
702 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
703 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
704 \"credentials should be a credentials.Credentials object.\\n\\n\"";
706 my $docstring = $self->DocString($interface, $interface->{NAME});
709 $docstring = "$signature$docstring";
711 $docstring = $signature;
714 $self->pidl("static PyTypeObject $interface->{NAME}_InterfaceType = {");
716 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
717 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
718 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
719 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
720 $self->pidl(".tp_doc = $docstring,");
721 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
722 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
728 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
729 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
732 $self->pidl_hdr("\n");
735 sub register_module_method($$$$$)
737 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
739 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
742 sub register_module_typeobject($$$)
744 my ($self, $name, $py_name) = @_;
746 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
748 $self->check_ready_type($py_name);
750 $self->register_patch_type_call($name, $py_name);
753 sub check_ready_type($$)
755 my ($self, $py_name) = @_;
756 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
759 sub register_module_import($$)
761 my ($self, $basename) = @_;
763 push (@{$self->{module_imports}}, $basename) unless (grep(/^$basename$/,@{$self->{module_imports}}));
766 sub use_type_variable($$)
768 my ($self, $orig_ctype) = @_;
769 # FIXME: Have a global lookup table for types that look different on the
770 # wire than they are named in C?
771 if ($orig_ctype->{NAME} eq "dom_sid2") {
772 $orig_ctype->{NAME} = "dom_sid";
774 my $ctype = resolveType($orig_ctype);
775 unless (defined($ctype->{BASEFILE})) {
778 # If this is an external type, make sure we do the right imports.
779 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
780 $self->register_module_import($ctype->{BASEFILE});
781 unless (defined($self->{type_imports}->{$ctype->{NAME}})) {
782 $self->{type_imports}->{$ctype->{NAME}} = $ctype->{BASEFILE};
784 return "$ctype->{NAME}_Type";
786 return "&$ctype->{NAME}_Type";
789 sub register_patch_type_call($$$)
791 my ($self, $typename, $cvar) = @_;
793 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
797 sub register_module_readycode($$)
799 my ($self, $code) = @_;
801 push (@{$self->{readycode}}, @$code);
804 sub register_module_object($$$)
806 my ($self, $name, $py_name) = @_;
808 push (@{$self->{module_objects}}, [$name, $py_name])
813 my ($self, $dest, $src) = @_;
814 if ($dest =~ /^\&/ and $src eq "NULL") {
815 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
816 } elsif ($dest =~ /^\&/) {
817 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
819 $self->pidl("$dest = $src;");
823 sub ConvertObjectFromPythonData($$$$$$;$)
825 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
827 fatal($location, "undef type for $cvar") unless(defined($ctype));
829 $ctype = resolveType($ctype);
831 my $actual_ctype = $ctype;
832 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
833 $actual_ctype = $actual_ctype->{DATA};
836 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
837 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
838 $self->pidl("$target = PyInt_AsLong($cvar);");
841 if ($actual_ctype->{TYPE} eq "SCALAR" ) {
842 if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
843 $self->pidl("if (PyObject_TypeCheck($cvar, &PyLong_Type)) {");
845 $self->pidl("$target = PyLong_AsLongLong($cvar);");
847 $self->pidl("} else {");
849 $self->pidl("if (PyObject_TypeCheck($cvar, &PyInt_Type)) {");
851 $self->pidl("$target = PyInt_AsLong($cvar);");
853 $self->pidl("} else {");
855 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
856 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
864 if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t)$/) {
865 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
866 $self->pidl("$target = PyInt_AsLong($cvar);");
871 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
872 my $ctype_name = $self->use_type_variable($ctype);
873 unless (defined ($ctype_name)) {
874 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
875 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " to Python\");");
878 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
879 $self->assign($target, "(".mapTypeName($ctype)." *)py_talloc_get_ptr($cvar)");
883 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
884 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
888 if ($actual_ctype->{TYPE} eq "SCALAR" and
889 ($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")) {
890 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
894 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
895 $self->pidl("$target = PyString_AsString($cvar);");
899 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
900 $self->pidl("$target = PyString_AsString($cvar);");
905 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
906 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
910 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
911 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
915 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
916 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
920 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
921 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
925 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
929 sub ConvertObjectFromPythonLevel($$$$$$$$)
931 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
932 my $nl = GetNextLevel($e, $l);
934 if ($l->{TYPE} eq "POINTER") {
935 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
936 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
939 if ($l->{POINTER_TYPE} ne "ref") {
940 $self->pidl("if ($py_var == Py_None) {");
942 $self->pidl("$var_name = NULL;");
944 $self->pidl("} else {");
947 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
948 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
949 if ($l->{POINTER_TYPE} ne "ref") {
953 } elsif ($l->{TYPE} eq "ARRAY") {
954 my $pl = GetPrevLevel($e, $l);
955 if ($pl && $pl->{TYPE} eq "POINTER") {
956 $var_name = get_pointer_to($var_name);
959 if (is_charset_array($e, $l)) {
960 $self->pidl("PY_CHECK_TYPE(&PyUnicode_Type, $py_var, $fail);");
961 # FIXME: Use Unix charset setting rather than utf-8
962 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
964 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
965 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
968 $self->pidl("int $counter;");
969 if (ArrayDynamicallyAllocated($e, $l)) {
970 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
972 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
974 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
980 } elsif ($l->{TYPE} eq "DATA") {
982 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
983 $var_name = get_pointer_to($var_name);
985 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
986 } elsif ($l->{TYPE} eq "SWITCH") {
987 $var_name = get_pointer_to($var_name);
988 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
989 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
990 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
991 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
993 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
997 sub ConvertObjectFromPython($$$$$$$)
999 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1001 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1004 sub ConvertScalarToPython($$$)
1006 my ($self, $ctypename, $cvar) = @_;
1008 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1010 $ctypename = expandAlias($ctypename);
1012 if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1013 return "PyLong_FromLongLong($cvar)";
1016 if ($ctypename =~ /^(char|u?int[0-9]*|time_t)$/) {
1017 return "PyInt_FromLong($cvar)";
1020 if ($ctypename eq "DATA_BLOB") {
1021 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1024 if ($ctypename eq "NTSTATUS") {
1025 return "PyErr_FromNTSTATUS($cvar)";
1028 if ($ctypename eq "WERROR") {
1029 return "PyErr_FromWERROR($cvar)";
1032 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1033 return "PyString_FromString($cvar)";
1037 if ($ctypename eq "string_array") { return "PyCObject_FromTallocPtr($cvar)"; }
1038 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
1039 if ($ctypename eq "dnsp_name") { return "PyString_FromString($cvar)"; }
1040 if ($ctypename eq "pointer") {
1041 return "PyCObject_FromTallocPtr($cvar)";
1044 die("Unknown scalar type $ctypename");
1047 sub ConvertObjectToPythonData($$$$$;$)
1049 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1051 die("undef type for $cvar") unless(defined($ctype));
1053 $ctype = resolveType($ctype);
1055 my $actual_ctype = $ctype;
1056 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1057 $actual_ctype = $actual_ctype->{DATA};
1060 if ($actual_ctype->{TYPE} eq "ENUM") {
1061 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1062 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1063 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1064 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1065 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1066 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1067 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1068 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1069 my $ctype_name = $self->use_type_variable($ctype);
1070 unless (defined($ctype_name)) {
1071 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1072 return "NULL"; # FIXME!
1074 return "py_talloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1077 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1080 sub fail_on_null($$$)
1082 my ($self, $var, $fail) = @_;
1083 $self->pidl("if ($var == NULL) {");
1090 sub ConvertObjectToPythonLevel($$$$$$)
1092 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1093 my $nl = GetNextLevel($e, $l);
1095 if ($l->{TYPE} eq "POINTER") {
1096 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1097 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1100 if ($l->{POINTER_TYPE} ne "ref") {
1101 $self->pidl("if ($var_name == NULL) {");
1103 $self->pidl("$py_var = Py_None;");
1104 $self->pidl("Py_INCREF($py_var);");
1106 $self->pidl("} else {");
1109 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1110 if ($l->{POINTER_TYPE} ne "ref") {
1114 } elsif ($l->{TYPE} eq "ARRAY") {
1115 my $pl = GetPrevLevel($e, $l);
1116 if ($pl && $pl->{TYPE} eq "POINTER") {
1117 $var_name = get_pointer_to($var_name);
1120 if (is_charset_array($e, $l)) {
1121 # FIXME: Use Unix charset setting rather than utf-8
1122 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1124 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1125 my $length = $l->{SIZE_IS};
1126 if (defined($l->{LENGTH_IS})) {
1127 $length = $l->{LENGTH_IS};
1130 $length = ParseExpr($length, $env, $e);
1131 $self->pidl("$py_var = PyList_New($length);");
1132 $self->fail_on_null($py_var, $fail);
1135 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1136 $self->pidl("int $counter;");
1137 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1139 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1140 $self->pidl("PyObject *$member_var;");
1141 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1142 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1148 } elsif ($l->{TYPE} eq "SWITCH") {
1149 $var_name = get_pointer_to($var_name);
1150 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1151 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1152 $self->fail_on_null($py_var, $fail);
1154 } elsif ($l->{TYPE} eq "DATA") {
1155 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1156 $var_name = get_pointer_to($var_name);
1158 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1159 $self->pidl("$py_var = $conv;");
1160 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1161 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1163 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1167 sub ConvertObjectToPython($$$$$$)
1169 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1171 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1176 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1178 $self->{BASENAME} = $basename;
1181 /* Python wrapper functions auto-generated by pidl */
1183 #include \"includes.h\"
1184 #include \"lib/talloc/pytalloc.h\"
1185 #include \"librpc/rpc/pyrpc.h\"
1187 #include \"$ndr_hdr\"
1191 foreach my $x (@$ndr) {
1192 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1193 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1196 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1198 foreach (@{$self->{module_methods}}) {
1199 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1200 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1203 $self->pidl("{ NULL, NULL, 0, NULL }");
1209 $self->pidl("void init$basename(void)");
1212 $self->pidl("PyObject *m;");
1213 foreach (@{$self->{module_imports}}) {
1214 $self->pidl("PyObject *dep_$_;");
1218 foreach (@{$self->{module_imports}}) {
1219 $self->pidl("dep_$_ = PyImport_ImportModule(\"samba.dcerpc.$_\");");
1220 $self->pidl("if (dep_$_ == NULL)");
1221 $self->pidl("\treturn;");
1225 foreach (keys %{$self->{type_imports}}) {
1226 my $basefile = $self->{type_imports}->{$_};
1227 $self->pidl_hdr("static PyTypeObject *$_\_Type;\n");
1228 my $pretty_name = PrettifyTypeName($_, $basefile);
1229 $self->pidl("$_\_Type = (PyTypeObject *)PyObject_GetAttrString(dep_$basefile, \"$pretty_name\");");
1230 $self->pidl("if ($_\_Type == NULL)");
1231 $self->pidl("\treturn;");
1235 foreach (@{$self->{ready_types}}) {
1236 $self->pidl("if (PyType_Ready($_) < 0)");
1237 $self->pidl("\treturn;");
1240 $self->pidl($_) foreach (@{$self->{readycode}});
1242 foreach (@{$self->{patch_type_calls}}) {
1243 my ($typename, $cvar) = @$_;
1244 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1245 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1246 $self->pidl("#endif");
1251 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1252 $self->pidl("if (m == NULL)");
1253 $self->pidl("\treturn;");
1255 foreach my $name (keys %{$self->{constants}}) {
1257 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1258 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1259 $py_obj = "PyInt_FromLong($cvar)";
1260 } elsif ($cvar =~ /^".*"$/) {
1261 $py_obj = "PyString_FromString($cvar)";
1263 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1266 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1269 foreach (@{$self->{module_objects}}) {
1270 my ($object_name, $c_name) = @$_;
1271 $self->pidl("Py_INCREF($c_name);");
1272 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1275 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1276 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1277 $self->pidl("#endif");
1282 return ($self->{res_hdr} . $self->{res});