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 bitmap_type_fn enum_type_fn);
14 use Parse::Pidl::Util qw(has_property ParseExpr unmake_str);
15 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe 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 => "",
26 constants => [], constants_uniq => {},
27 module_methods => [], module_objects => [], ready_types => [],
28 module_imports => [], module_imports_uniq => {},
29 type_imports => [], type_imports_uniq => {},
30 patch_type_calls => [], prereadycode => [],
38 $self->{res_hdr} .= shift;
45 if ((!($d =~ /^#/))) {
46 $self->{res} .= $self->{tabs};
56 $self->{tabs} .= "\t";
62 $self->{tabs} = substr($self->{tabs}, 0, -1);
65 sub PrettifyTypeName($$)
67 my ($name, $basename) = @_;
69 $basename =~ s/^.*\.([^.]+)$/\1/;
71 $name =~ s/^$basename\_//;
84 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
85 $self->register_module_import("samba.dcerpc.$_");
91 my ($self, $const) = @_;
92 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
95 sub register_constant($$$$)
97 my ($self, $name, $type, $value) = @_;
99 unless (defined $self->{constants_uniq}->{$name}) {
100 my $h = {"key" => $name, "val" => [$type, $value]};
101 push @{$self->{constants}}, $h;
102 $self->{constants_uniq}->{$name} = $h;
106 sub EnumAndBitmapConsts($$$)
108 my ($self, $name, $d) = @_;
110 return unless (defined($d->{ELEMENTS}));
112 foreach my $e (@{$d->{ELEMENTS}}) {
113 $e =~ /^([A-Za-z0-9_]+)/;
116 $self->register_constant($cname, $d, $cname);
120 sub FromUnionToPythonFunction($$$$)
122 my ($self, $mem_ctx, $type, $switch, $name) = @_;
124 $self->pidl("PyObject *ret;");
127 $self->pidl("switch ($switch) {");
130 foreach my $e (@{$type->{ELEMENTS}}) {
131 $self->pidl("$e->{CASE}:");
136 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
138 $self->pidl("ret = Py_None;");
139 $self->pidl("Py_INCREF(ret);");
142 $self->pidl("return ret;");
151 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
152 $self->pidl("return NULL;");
155 sub FromPythonToUnionFunction($$$$$)
157 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
161 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
163 $self->pidl("switch ($switch) {");
166 foreach my $e (@{$type->{ELEMENTS}}) {
167 $self->pidl("$e->{CASE}:");
168 if ($e->{CASE} eq "default") { $has_default = 1; }
171 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
173 $self->pidl("break;");
179 $self->pidl("default:");
181 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
182 $self->pidl("talloc_free(ret);");
183 $self->pidl("ret = NULL;");
190 $self->pidl("return ret;");
193 sub PythonStruct($$$$$$)
195 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
197 my $env = GenerateStructEnv($d, "object");
201 my $getsetters = "NULL";
203 if ($#{$d->{ELEMENTS}} > -1) {
204 foreach my $e (@{$d->{ELEMENTS}}) {
205 my $varname = "object->$e->{NAME}";
206 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
209 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
210 $self->pidl("PyObject *py_$e->{NAME};");
211 $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
212 $self->pidl("return py_$e->{NAME};");
217 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
220 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
221 my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
222 my $l = $e->{LEVELS}[0];
223 my $nl = GetNextLevel($e, $l);
224 if ($l->{TYPE} eq "POINTER" and
225 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
226 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
227 $self->pidl("talloc_unlink($mem_ctx, discard_const($varname));");
229 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
230 $self->pidl("return 0;");
236 $getsetters = "py_$name\_getsetters";
237 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
239 foreach my $e (@{$d->{ELEMENTS}}) {
242 $self->pidl(".name = discard_const_p(char, \"$e->{NAME}\"),");
243 $self->pidl(".get = py_$name\_get_$e->{NAME},");
244 $self->pidl(".set = py_$name\_set_$e->{NAME},");
245 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element $e->{NAME}\")");
249 $self->pidl("{ .name = NULL }");
255 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
258 $self->pidl("return pytalloc_new($cname, type);");
263 my $py_methods = "NULL";
265 # If the struct is not public there ndr_pull/ndr_push functions will
266 # be static so not callable from here
267 if (has_property($d, "public")) {
268 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
271 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
272 $self->pidl("PyObject *ret = NULL;");
273 $self->pidl("DATA_BLOB blob;");
274 $self->pidl("enum ndr_err_code err;");
275 $self->pidl("TALLOC_CTX *tmp_ctx = talloc_new(pytalloc_get_mem_ctx(py_obj));");
276 $self->pidl("if (tmp_ctx == NULL) {");
278 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
279 $self->pidl("return NULL;");
282 $self->pidl("err = ndr_push_struct_blob(&blob, tmp_ctx, object, (ndr_push_flags_fn_t)ndr_push_$name);");
283 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
285 $self->pidl("TALLOC_FREE(tmp_ctx);");
286 $self->pidl("PyErr_SetNdrError(err);");
287 $self->pidl("return NULL;");
291 $self->pidl("ret = PyString_FromStringAndSize((char *)blob.data, blob.length);");
292 $self->pidl("TALLOC_FREE(tmp_ctx);");
293 $self->pidl("return ret;");
298 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
301 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
302 $self->pidl("DATA_BLOB blob;");
303 $self->pidl("Py_ssize_t blob_length = 0;");
304 $self->pidl("enum ndr_err_code err;");
305 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
306 $self->pidl("PyObject *allow_remaining_obj = NULL;");
307 $self->pidl("bool allow_remaining = false;");
309 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|O:__ndr_unpack__\",");
311 $self->pidl("discard_const_p(char *, kwnames),");
312 $self->pidl("&blob.data, &blob_length,");
313 $self->pidl("&allow_remaining_obj)) {");
316 $self->pidl("return NULL;");
319 $self->pidl("blob.length = blob_length;");
321 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
323 $self->pidl("allow_remaining = true;");
327 $self->pidl("if (allow_remaining) {");
329 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
331 $self->pidl("} else {");
333 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
336 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
338 $self->pidl("PyErr_SetNdrError(err);");
339 $self->pidl("return NULL;");
343 $self->pidl("Py_RETURN_NONE;");
348 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
351 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
352 $self->pidl("PyObject *ret;");
353 $self->pidl("char *retstr;");
355 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
356 $self->pidl("ret = PyString_FromString(retstr);");
357 $self->pidl("talloc_free(retstr);");
359 $self->pidl("return ret;");
364 $py_methods = "py_$name\_methods";
365 $self->pidl("static PyMethodDef $py_methods\[] = {");
367 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
368 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
369 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_NOARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
370 $self->pidl("{ NULL, NULL, 0, NULL }");
376 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
378 my $docstring = $self->DocString($d, $name);
379 my $typeobject = "$name\_Type";
380 $self->pidl("static PyTypeObject $typeobject = {");
382 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
383 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
384 $self->pidl(".tp_getset = $getsetters,");
386 $self->pidl(".tp_doc = $docstring,");
388 $self->pidl(".tp_methods = $py_methods,");
389 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
390 $self->pidl(".tp_new = py_$name\_new,");
396 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
397 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
398 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
401 return "&$typeobject";
404 sub get_metadata_var($)
407 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
409 if (has_property($e, "length_is")) {
410 return get_var($e->{PROPERTIES}->{length_is});
411 } elsif (has_property($e, "size_is")) {
412 return get_var($e->{PROPERTIES}->{size_is});
418 sub find_metadata_args($)
421 my $metadata_args = { in => {}, out => {} };
423 # Determine arguments that are metadata for other arguments (size_is/length_is)
424 foreach my $e (@{$fn->{ELEMENTS}}) {
425 foreach my $dir (@{$e->{DIRECTION}}) {
426 my $main = get_metadata_var($e);
428 $metadata_args->{$dir}->{$main} = $e->{NAME};
433 return $metadata_args;
436 sub PythonFunctionUnpackOut($$$)
438 my ($self, $fn, $fnname) = @_;
440 my $outfnname = "unpack_$fnname\_args_out";
443 my $metadata_args = find_metadata_args($fn);
445 my $env = GenerateFunctionOutEnv($fn, "r->");
448 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
451 $self->pidl("PyObject *result;");
452 foreach my $e (@{$fn->{ELEMENTS}}) {
453 next unless (grep(/out/,@{$e->{DIRECTION}}));
454 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
455 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
456 $self->pidl("PyObject *py_$e->{NAME};");
460 if ($fn->{RETURN_TYPE}) {
461 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
466 if ($result_size > 1) {
467 $self->pidl("result = PyTuple_New($result_size);");
469 } elsif ($result_size == 0) {
470 $self->pidl("result = Py_None;");
471 $self->pidl("Py_INCREF(result);");
472 $signature .= "None";
475 foreach my $e (@{$fn->{ELEMENTS}}) {
476 next if ($metadata_args->{out}->{$e->{NAME}});
477 my $py_name = "py_$e->{NAME}";
478 if (grep(/out/,@{$e->{DIRECTION}})) {
479 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
480 if ($result_size > 1) {
481 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
483 $signature .= "$e->{NAME}, ";
485 $self->pidl("result = $py_name;");
486 $signature .= $e->{NAME};
491 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
492 $self->handle_ntstatus("r->out.result", "NULL", undef);
493 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
494 $self->handle_werror("r->out.result", "NULL", undef);
495 } elsif (defined($fn->{RETURN_TYPE})) {
496 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
497 if ($result_size > 1) {
498 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
500 $self->pidl("result = $conv;");
502 $signature .= "result";
505 if (substr($signature, -2) eq ", ") {
506 $signature = substr($signature, 0, -2);
508 if ($result_size > 1) {
512 $self->pidl("return result;");
517 return ($outfnname, $signature);
520 sub PythonFunctionPackIn($$$)
522 my ($self, $fn, $fnname) = @_;
523 my $metadata_args = find_metadata_args($fn);
525 my $infnname = "pack_$fnname\_args_in";
527 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
530 my $args_format = "";
531 my $args_string = "";
535 foreach my $e (@{$fn->{ELEMENTS}}) {
536 next unless (grep(/in/,@{$e->{DIRECTION}}));
537 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
538 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
539 $self->pidl("PyObject *py_$e->{NAME};");
541 $args_string .= ", &py_$e->{NAME}";
542 $args_names .= "\"$e->{NAME}\", ";
543 $signature .= "$e->{NAME}, ";
545 if (substr($signature, -2) eq ", ") {
546 $signature = substr($signature, 0, -2);
548 $self->pidl("const char *kwnames[] = {");
550 $self->pidl($args_names . "NULL");
555 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
557 $self->pidl("return false;");
562 my $env = GenerateFunctionInEnv($fn, "r->");
564 my $fail = "return false;";
565 foreach my $e (@{$fn->{ELEMENTS}}) {
566 next unless (grep(/in/,@{$e->{DIRECTION}}));
567 if ($metadata_args->{in}->{$e->{NAME}}) {
568 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
569 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
570 my $val = "PyList_GET_SIZE($py_var)";
571 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
572 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
573 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
575 $self->pidl("PyErr_NoMemory();");
579 $self->pidl("*r->in.$e->{NAME} = $val;");
581 $self->pidl("r->in.$e->{NAME} = $val;");
584 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
587 $self->pidl("return true;");
591 return ($infnname, $signature);
594 sub PythonFunction($$$)
596 my ($self, $fn, $iface, $prettyname) = @_;
598 my $fnname = "py_$fn->{NAME}";
599 my $docstring = $self->DocString($fn, $fn->{NAME});
601 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
602 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
603 my $signature = "S.$prettyname($insignature) -> $outsignature";
605 $docstring = "\"$signature\\n\\n\"$docstring";
607 $docstring = "\"$signature\"";
610 return ($infn, $outfn, $docstring);
613 sub handle_werror($$$$)
615 my ($self, $var, $retval, $mem_ctx) = @_;
617 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
619 $self->pidl("PyErr_SetWERROR($var);");
620 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
621 $self->pidl("return $retval;");
627 sub handle_ntstatus($$$$)
629 my ($self, $var, $retval, $mem_ctx) = @_;
631 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
633 $self->pidl("PyErr_SetNTSTATUS($var);");
634 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
635 $self->pidl("return $retval;");
643 my ($self, $modulename, $d, $interface, $basename) = @_;
645 my $actual_ctype = $d;
646 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
647 $actual_ctype = $actual_ctype->{DATA};
650 if ($actual_ctype->{TYPE} eq "STRUCT") {
652 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
654 if ($d->{TYPE} eq "STRUCT") {
655 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
657 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
660 $self->register_module_typeobject($fn_name, $typeobject);
663 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
664 $self->EnumAndBitmapConsts($d->{NAME}, $d);
667 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
668 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
671 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
672 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
673 $self->pidl_hdr("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in);\n");
676 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
681 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
682 $self->pidl_hdr(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in);\n");
685 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
694 my ($self, $d, $name) = @_;
695 if (has_property($d, "helpstring")) {
696 my $docstring = uc("py_doc_$name");
697 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
706 my($self,$interface,$basename) = @_;
708 if (has_property($interface, "pyhelper")) {
709 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
712 $self->Const($_) foreach (@{$interface->{CONSTS}});
714 foreach my $d (@{$interface->{TYPES}}) {
715 next if has_property($d, "nopython");
717 $self->PythonType($basename, $d, $interface, $basename);
720 if (defined $interface->{PROPERTIES}->{uuid}) {
721 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
726 foreach my $d (@{$interface->{FUNCTIONS}}) {
727 next if has_property($d, "noopnum");
728 next if has_property($d, "nopython");
729 next if has_property($d, "todo");
732 foreach my $e (@{$d->{ELEMENTS}}) {
733 if (ContainsPipe($e, $e->{LEVELS}[0])) {
740 my $prettyname = $d->{NAME};
742 $prettyname =~ s/^$interface->{NAME}_//;
743 $prettyname =~ s/^$basename\_//;
745 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
747 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
750 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
752 foreach my $d (@fns) {
753 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
754 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
756 $self->pidl("{ NULL }");
761 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
764 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
771 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
773 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
774 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
775 \"credentials should be a credentials.Credentials object.\\n\\n\"";
777 my $docstring = $self->DocString($interface, $interface->{NAME});
780 $docstring = "$signature$docstring";
782 $docstring = $signature;
785 my $if_typename = "$interface->{NAME}_InterfaceType";
787 $self->pidl("static PyTypeObject $if_typename = {");
789 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
790 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
791 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
792 $self->pidl(".tp_doc = $docstring,");
793 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
794 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
800 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
801 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
802 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
803 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
806 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
809 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
815 my $signature = "\"abstract_syntax()\\n\"";
817 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
820 $docstring = "$signature$docstring";
822 $docstring = $signature;
825 my $syntax_typename = "$interface->{NAME}_SyntaxType";
827 $self->pidl("static PyTypeObject $syntax_typename = {");
829 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
830 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
831 $self->pidl(".tp_doc = $docstring,");
832 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
833 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
839 $self->register_module_typeobject("abstract_syntax", "&$syntax_typename");
840 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
841 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;",
842 "$syntax_typename.tp_basicsize = pytalloc_BaseObject_size();",
846 $self->pidl_hdr("\n");
849 sub register_module_method($$$$$)
851 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
853 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
856 sub register_module_typeobject($$$)
858 my ($self, $name, $py_name) = @_;
860 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
862 $self->check_ready_type($py_name);
864 $self->register_patch_type_call($name, $py_name);
867 sub check_ready_type($$)
869 my ($self, $py_name) = @_;
870 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
873 sub register_module_import($$)
875 my ($self, $module_path) = @_;
877 my $var_name = $module_path;
878 $var_name =~ s/\./_/g;
879 $var_name = "dep_$var_name";
881 unless (defined $self->{module_imports_uniq}->{$var_name}) {
882 my $h = { "key" => $var_name, "val" => $module_path};
883 push @{$self->{module_imports}}, $h;
884 $self->{module_imports_uniq}->{$var_name} = $h;
889 sub import_type_variable($$$)
891 my ($self, $module, $name) = @_;
893 $self->register_module_import($module);
894 unless (defined $self->{type_imports_uniq}->{$name}) {
895 my $h = { "key" => $name, "val" => $module};
896 push @{$self->{type_imports}}, $h;
897 $self->{type_imports_uniq}->{$name} = $h;
899 return "$name\_Type";
902 sub use_type_variable($$)
904 my ($self, $orig_ctype) = @_;
905 # FIXME: Have a global lookup table for types that look different on the
906 # wire than they are named in C?
907 if ($orig_ctype->{NAME} eq "dom_sid2" or
908 $orig_ctype->{NAME} eq "dom_sid28" or
909 $orig_ctype->{NAME} eq "dom_sid0") {
910 $orig_ctype->{NAME} = "dom_sid";
912 if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
913 $orig_ctype->{NAME} = "security_descriptor";
916 my $ctype = resolveType($orig_ctype);
917 unless (defined($ctype->{BASEFILE})) {
920 # If this is an external type, make sure we do the right imports.
921 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
922 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
924 return "&$ctype->{NAME}_Type";
927 sub register_patch_type_call($$$)
929 my ($self, $typename, $cvar) = @_;
931 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
935 sub register_module_prereadycode($$)
937 my ($self, $code) = @_;
939 push (@{$self->{prereadycode}}, @$code);
942 sub register_module_postreadycode($$)
944 my ($self, $code) = @_;
946 push (@{$self->{postreadycode}}, @$code);
949 sub register_module_object($$$)
951 my ($self, $name, $py_name) = @_;
953 push (@{$self->{module_objects}}, [$name, $py_name])
958 my ($self, $dest, $src) = @_;
959 if ($dest =~ /^\&/ and $src eq "NULL") {
960 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
961 } elsif ($dest =~ /^\&/) {
962 my $destvar = get_value_of($dest);
963 $self->pidl("$destvar = *$src;");
965 $self->pidl("$dest = $src;");
969 sub ConvertStringFromPythonData($$$$$)
971 my ($self, $mem_ctx, $py_var, $target, $fail) = @_;
975 $self->pidl("const char *test_str;");
976 $self->pidl("const char *talloc_str;");
977 $self->pidl("PyObject *unicode = NULL;");
978 $self->pidl("if (PyUnicode_Check($py_var)) {");
980 # FIXME: Use Unix charset setting rather than utf-8
981 $self->pidl("unicode = PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\");");
982 $self->pidl("if (unicode == NULL) {");
984 $self->pidl("PyErr_NoMemory();");
985 $self->pidl("$fail");
989 $self->pidl("test_str = PyString_AS_STRING(unicode);");
991 $self->pidl("} else if (PyString_Check($py_var)) {");
993 $self->pidl("test_str = PyString_AS_STRING($py_var);");
995 $self->pidl("} else {");
997 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
998 $self->pidl("$fail");
1001 $self->pidl("talloc_str = talloc_strdup($mem_ctx, test_str);");
1002 $self->pidl("if (unicode != NULL) {");
1004 $self->pidl("Py_DECREF(unicode);");
1007 $self->pidl("if (talloc_str == NULL) {");
1009 $self->pidl("PyErr_NoMemory();");
1010 $self->pidl("$fail");
1013 $self->pidl("$target = talloc_str;");
1018 sub ConvertObjectFromPythonData($$$$$$;$)
1020 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
1022 fatal($location, "undef type for $cvar") unless(defined($ctype));
1024 $ctype = resolveType($ctype);
1026 my $actual_ctype = $ctype;
1027 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1028 $actual_ctype = $actual_ctype->{DATA};
1031 # We need to cover ENUMs, BITMAPS and SCALAR values here, as
1032 # all could otherwise be assigned invalid integer values
1033 my $ctype_alias = "";
1035 if ($actual_ctype->{TYPE} eq "ENUM") {
1036 # Importantly, ENUM values are unsigned in pidl, and
1037 # typically map to uint32
1038 $ctype_alias = enum_type_fn($actual_ctype);
1039 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1040 $ctype_alias = bitmap_type_fn($actual_ctype);
1041 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1042 $ctype_alias = expandAlias($actual_ctype->{NAME});
1045 # This is the unsigned Python Integer -> C integer validation
1046 # case. The signed case is below.
1047 if ($ctype_alias =~ /^(uint[0-9]*|hyper|udlong|udlongr
1048 |NTTIME_hyper|NTTIME|NTTIME_1sec
1052 $self->pidl("const unsigned long long uint_max = ndr_sizeof2uintmax(sizeof($target));");
1053 $self->pidl("if (PyLong_Check($cvar)) {");
1055 $self->pidl("unsigned long long test_var;");
1056 $self->pidl("test_var = PyLong_AsUnsignedLongLong($cvar);");
1057 $self->pidl("if (PyErr_Occurred() != NULL) {");
1062 $self->pidl("if (test_var > uint_max) {");
1064 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %llu\",\\");
1065 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1069 $self->pidl("$target = test_var;");
1071 $self->pidl("} else if (PyInt_Check($cvar)) {");
1073 $self->pidl("long test_var;");
1074 $self->pidl("test_var = PyInt_AsLong($cvar);");
1075 $self->pidl("if (test_var < 0 || test_var > uint_max) {");
1077 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %ld\",\\");
1078 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1082 $self->pidl("$target = test_var;");
1084 $self->pidl("} else {");
1086 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1087 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1096 # Confirm the signed python integer fits in the C type
1097 # correctly. It is subtly different from the unsigned case
1098 # above, so while it looks like a duplicate, it is not
1099 # actually a duplicate.
1100 if ($ctype_alias =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1103 $self->pidl("const long long int_max = ndr_sizeof2intmax(sizeof($target));");
1104 $self->pidl("const long long int_min = -int_max - 1;");
1105 $self->pidl("if (PyLong_Check($cvar)) {");
1107 $self->pidl("long long test_var;");
1108 $self->pidl("test_var = PyLong_AsLongLong($cvar);");
1109 $self->pidl("if (PyErr_Occurred() != NULL) {");
1114 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1116 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %lld\",\\");
1117 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1121 $self->pidl("$target = test_var;");
1123 $self->pidl("} else if (PyInt_Check($cvar)) {");
1125 $self->pidl("long test_var;");
1126 $self->pidl("test_var = PyInt_AsLong($cvar);");
1127 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1129 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %ld\",\\");
1130 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1134 $self->pidl("$target = test_var;");
1136 $self->pidl("} else {");
1138 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1139 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1148 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1149 my $ctype_name = $self->use_type_variable($ctype);
1150 unless (defined ($ctype_name)) {
1151 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1152 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1155 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1156 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1158 $self->pidl("PyErr_NoMemory();");
1159 $self->pidl("$fail");
1162 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1166 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1167 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
1171 if ($actual_ctype->{TYPE} eq "SCALAR" and
1172 ($actual_ctype->{NAME} eq "string"
1173 or $actual_ctype->{NAME} eq "nbt_string"
1174 or $actual_ctype->{NAME} eq "nbt_name"
1175 or $actual_ctype->{NAME} eq "wrepl_nbt_name"
1176 or $actual_ctype->{NAME} eq "dns_string"
1177 or $actual_ctype->{NAME} eq "dnsp_string"
1178 or $actual_ctype->{NAME} eq "dns_name"
1179 or $actual_ctype->{NAME} eq "ipv4address"
1180 or $actual_ctype->{NAME} eq "ipv6address"
1181 or $actual_ctype->{NAME} eq "dnsp_name")) {
1182 $self->ConvertStringFromPythonData($mem_ctx, $cvar, $target, $fail);
1186 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1187 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1191 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1192 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1196 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1197 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1201 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1202 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
1206 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1207 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
1211 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1215 sub ConvertObjectFromPythonLevel($$$$$$$$)
1217 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1218 my $nl = GetNextLevel($e, $l);
1219 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1220 $nl = GetNextLevel($e, $nl);
1222 my $pl = GetPrevLevel($e, $l);
1223 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1224 $pl = GetPrevLevel($e, $pl);
1227 $self->pidl("if ($py_var == NULL) {");
1229 $self->pidl("PyErr_Format(PyExc_AttributeError, \"Cannot delete NDR object: " .
1230 mapTypeName($var_name) . "\");");
1235 if ($l->{TYPE} eq "POINTER") {
1236 if ($l->{POINTER_TYPE} ne "ref") {
1237 $self->pidl("if ($py_var == Py_None) {");
1239 $self->pidl("$var_name = NULL;");
1241 $self->pidl("} else {");
1244 # if we want to handle more than one level of pointer in python interfaces
1245 # then this is where we would need to allocate it
1246 if ($l->{POINTER_TYPE} eq "ref") {
1247 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1248 $self->pidl("if ($var_name == NULL) {");
1250 $self->pidl("PyErr_NoMemory();");
1254 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1255 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1256 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1257 $self->pidl("if ($var_name == NULL) {");
1259 $self->pidl("PyErr_NoMemory();");
1264 $self->pidl("$var_name = NULL;");
1266 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1267 $var_name = get_value_of($var_name);
1269 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1270 if ($l->{POINTER_TYPE} ne "ref") {
1274 } elsif ($l->{TYPE} eq "ARRAY") {
1275 if ($pl && $pl->{TYPE} eq "POINTER") {
1276 $var_name = get_pointer_to($var_name);
1279 if (is_charset_array($e, $l)) {
1280 $self->ConvertStringFromPythonData($mem_ctx, $py_var, $var_name, $fail);
1282 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1283 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1286 $self->pidl("int $counter;");
1287 if (ArrayDynamicallyAllocated($e, $l)) {
1288 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1289 $self->pidl("if (!$var_name) { $fail; }");
1290 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1292 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
1294 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected list of type %s, length %zu, got %zd\", Py_TYPE($py_var)->tp_name, ARRAY_SIZE($var_name), PyList_GET_SIZE($py_var));");
1295 $self->pidl("$fail");
1299 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1301 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
1307 } elsif ($l->{TYPE} eq "DATA") {
1308 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1309 $var_name = get_pointer_to($var_name);
1311 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1312 } elsif ($l->{TYPE} eq "SWITCH") {
1313 $var_name = get_pointer_to($var_name);
1314 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1315 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1318 my $union_type = mapTypeName($nl->{DATA_TYPE});
1319 $self->pidl("$union_type *$switch_ptr;");
1320 $self->pidl("$switch_ptr = py_export_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1321 $self->fail_on_null($switch_ptr, $fail);
1322 $self->assign($var_name, "$switch_ptr");
1325 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1326 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1328 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1332 sub ConvertObjectFromPython($$$$$$$)
1334 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1336 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1339 sub ConvertScalarToPython($$$)
1341 my ($self, $ctypename, $cvar) = @_;
1343 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1345 $ctypename = expandAlias($ctypename);
1347 if ($ctypename =~ /^(int64|dlong)$/) {
1348 return "ndr_PyLong_FromLongLong($cvar)";
1351 if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
1352 return "ndr_PyLong_FromUnsignedLongLong($cvar)";
1355 if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
1356 return "PyInt_FromLong($cvar)";
1359 # Needed to ensure unsigned values in a 32 or 16 bit enum is
1360 # cast correctly to a uint32_t, not sign extended to a a
1361 # possibly 64 bit unsigned long. (enums are signed in C,
1363 if ($ctypename =~ /^(uint32|uint3264)$/) {
1364 return "ndr_PyLong_FromUnsignedLongLong((uint32_t)$cvar)";
1367 if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
1368 return "PyInt_FromLong((uint16_t)$cvar)";
1371 if ($ctypename eq "DATA_BLOB") {
1372 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1375 if ($ctypename eq "NTSTATUS") {
1376 return "PyErr_FromNTSTATUS($cvar)";
1379 if ($ctypename eq "WERROR") {
1380 return "PyErr_FromWERROR($cvar)";
1383 if ($ctypename eq "HRESULT") {
1384 return "PyErr_FromHRESULT($cvar)";
1387 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1388 return "PyString_FromStringOrNULL($cvar)";
1391 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1392 return "PyString_FromStringOrNULL($cvar)";
1396 if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
1397 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
1398 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
1399 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
1400 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
1401 if ($ctypename eq "pointer") {
1402 return "pytalloc_CObject_FromTallocPtr($cvar)";
1405 die("Unknown scalar type $ctypename");
1408 sub ConvertObjectToPythonData($$$$$;$)
1410 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1412 die("undef type for $cvar") unless(defined($ctype));
1414 $ctype = resolveType($ctype);
1416 my $actual_ctype = $ctype;
1417 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1418 $actual_ctype = $actual_ctype->{DATA};
1421 if ($actual_ctype->{TYPE} eq "ENUM") {
1422 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1423 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1424 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1425 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1426 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1427 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1428 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1429 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1430 my $ctype_name = $self->use_type_variable($ctype);
1431 unless (defined($ctype_name)) {
1432 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1433 return "NULL"; # FIXME!
1435 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1438 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1441 sub fail_on_null($$$)
1443 my ($self, $var, $fail) = @_;
1444 $self->pidl("if ($var == NULL) {");
1451 sub ConvertObjectToPythonLevel($$$$$$)
1453 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1454 my $nl = GetNextLevel($e, $l);
1455 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1456 $nl = GetNextLevel($e, $nl);
1458 my $pl = GetPrevLevel($e, $l);
1459 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1460 $pl = GetPrevLevel($e, $pl);
1463 if ($l->{TYPE} eq "POINTER") {
1464 if ($l->{POINTER_TYPE} ne "ref") {
1465 $self->pidl("if ($var_name == NULL) {");
1467 $self->pidl("$py_var = Py_None;");
1468 $self->pidl("Py_INCREF($py_var);");
1470 $self->pidl("} else {");
1473 my $var_name2 = $var_name;
1474 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1475 $var_name2 = get_value_of($var_name);
1477 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
1478 if ($l->{POINTER_TYPE} ne "ref") {
1482 } elsif ($l->{TYPE} eq "ARRAY") {
1483 if ($pl && $pl->{TYPE} eq "POINTER") {
1484 $var_name = get_pointer_to($var_name);
1487 if (is_charset_array($e, $l)) {
1488 # FIXME: Use Unix charset setting rather than utf-8
1489 $self->pidl("if ($var_name == NULL) {");
1491 $self->pidl("$py_var = Py_None;");
1492 $self->pidl("Py_INCREF($py_var);");
1494 $self->pidl("} else {");
1496 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1500 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1501 my $length = $l->{SIZE_IS};
1502 if (defined($l->{LENGTH_IS})) {
1503 $length = $l->{LENGTH_IS};
1506 $length = ParseExpr($length, $env, $e);
1507 $self->pidl("$py_var = PyList_New($length);");
1508 $self->fail_on_null($py_var, $fail);
1511 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1512 $self->pidl("int $counter;");
1513 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1515 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1516 $self->pidl("PyObject *$member_var;");
1517 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
1518 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1524 } elsif ($l->{TYPE} eq "SWITCH") {
1525 $var_name = get_pointer_to($var_name);
1526 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1527 $self->pidl("$py_var = py_import_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1528 $self->fail_on_null($py_var, $fail);
1530 } elsif ($l->{TYPE} eq "DATA") {
1531 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1532 $var_name = get_pointer_to($var_name);
1534 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1535 $self->pidl("$py_var = $conv;");
1536 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1537 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
1539 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1543 sub ConvertObjectToPython($$$$$$)
1545 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1547 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1552 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1554 $self->{BASENAME} = $basename;
1557 /* Python wrapper functions auto-generated by pidl */
1558 #define PY_SSIZE_T_CLEAN 1 /* We use Py_ssize_t for PyArg_ParseTupleAndKeywords */
1560 #include \"includes.h\"
1561 #include <pytalloc.h>
1562 #include \"librpc/rpc/pyrpc.h\"
1563 #include \"librpc/rpc/pyrpc_util.h\"
1565 #include \"$ndr_hdr\"
1568 * These functions are here to ensure they can be optimized out by
1569 * the compiler based on the constant input values
1572 static inline unsigned long long ndr_sizeof2uintmax(size_t var_size)
1588 static inline long long ndr_sizeof2intmax(size_t var_size)
1604 static inline PyObject *ndr_PyLong_FromLongLong(long long v)
1606 if (v > LONG_MAX || v < LONG_MIN) {
1607 return PyLong_FromLongLong(v);
1609 return PyInt_FromLong(v);
1613 static inline PyObject *ndr_PyLong_FromUnsignedLongLong(unsigned long long v)
1616 return PyLong_FromUnsignedLongLong(v);
1618 return PyInt_FromLong(v);
1624 foreach my $x (@$ndr) {
1625 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1626 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1629 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1631 foreach (@{$self->{module_methods}}) {
1632 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1633 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1636 $self->pidl("{ NULL, NULL, 0, NULL }");
1642 $self->pidl_hdr("void init$basename(void);");
1643 $self->pidl("void init$basename(void)");
1646 $self->pidl("PyObject *m;");
1647 foreach my $h (@{$self->{module_imports}}) {
1648 $self->pidl("PyObject *$h->{'key'};");
1652 foreach my $h (@{$self->{module_imports}}) {
1653 my $var_name = $h->{'key'};
1654 my $module_path = $h->{'val'};
1655 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
1656 $self->pidl("if ($var_name == NULL)");
1657 $self->pidl("\treturn;");
1661 foreach my $h (@{$self->{type_imports}}) {
1662 my $type_var = "$h->{'key'}\_Type";
1663 my $module_path = $h->{'val'};
1664 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
1665 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
1666 my $module_var = "dep_$module_path";
1667 $module_var =~ s/\./_/g;
1668 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
1669 $self->pidl("if ($type_var == NULL)");
1670 $self->pidl("\treturn;");
1674 $self->pidl($_) foreach (@{$self->{prereadycode}});
1676 foreach (@{$self->{ready_types}}) {
1677 $self->pidl("if (PyType_Ready($_) < 0)");
1678 $self->pidl("\treturn;");
1681 $self->pidl($_) foreach (@{$self->{postreadycode}});
1683 foreach (@{$self->{patch_type_calls}}) {
1684 my ($typename, $cvar) = @$_;
1685 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1686 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1687 $self->pidl("#endif");
1692 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1693 $self->pidl("if (m == NULL)");
1694 $self->pidl("\treturn;");
1696 foreach my $h (@{$self->{constants}}) {
1697 my $name = $h->{'key'};
1699 my ($ctype, $cvar) = @{$h->{'val'}};
1700 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1701 $py_obj = "ndr_PyLong_FromUnsignedLongLong($cvar)";
1702 } elsif ($cvar =~ /^".*"$/) {
1703 $py_obj = "PyString_FromString($cvar)";
1705 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1708 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1711 foreach (@{$self->{module_objects}}) {
1712 my ($object_name, $c_name) = @$_;
1713 $self->pidl("Py_INCREF($c_name);");
1714 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1717 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1718 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1719 $self->pidl("#endif");
1724 return ($self->{res_hdr} . $self->{res});