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 => {},
28 module_objects => [], module_objects_uniq => {},
30 module_imports => [], module_imports_uniq => {},
31 type_imports => [], type_imports_uniq => {},
32 patch_type_calls => [], prereadycode => [],
40 $self->{res_hdr} .= shift;
47 if ((!($d =~ /^#/))) {
48 $self->{res} .= $self->{tabs};
58 $self->{tabs} .= "\t";
64 $self->{tabs} = substr($self->{tabs}, 0, -1);
67 sub PrettifyTypeName($$)
69 my ($name, $basename) = @_;
71 $basename =~ s/^.*\.([^.]+)$/\1/;
73 $name =~ s/^$basename\_//;
86 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
87 $self->register_module_import("samba.dcerpc.$_");
93 my ($self, $const) = @_;
94 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
97 sub register_constant($$$$)
99 my ($self, $name, $type, $value) = @_;
101 unless (defined $self->{constants_uniq}->{$name}) {
102 my $h = {"key" => $name, "val" => [$type, $value]};
103 push @{$self->{constants}}, $h;
104 $self->{constants_uniq}->{$name} = $h;
108 sub EnumAndBitmapConsts($$$)
110 my ($self, $name, $d) = @_;
112 return unless (defined($d->{ELEMENTS}));
114 foreach my $e (@{$d->{ELEMENTS}}) {
115 $e =~ /^([A-Za-z0-9_]+)/;
118 $self->register_constant($cname, $d, $cname);
122 sub FromUnionToPythonFunction($$$$)
124 my ($self, $mem_ctx, $type, $switch, $name) = @_;
126 $self->pidl("PyObject *ret;");
129 $self->pidl("switch ($switch) {");
132 foreach my $e (@{$type->{ELEMENTS}}) {
133 $self->pidl("$e->{CASE}:");
138 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
140 $self->pidl("ret = Py_None;");
141 $self->pidl("Py_INCREF(ret);");
144 $self->pidl("return ret;");
153 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
154 $self->pidl("return NULL;");
157 sub FromPythonToUnionFunction($$$$$)
159 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
163 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
165 $self->pidl("switch ($switch) {");
168 foreach my $e (@{$type->{ELEMENTS}}) {
169 $self->pidl("$e->{CASE}:");
170 if ($e->{CASE} eq "default") { $has_default = 1; }
173 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
175 $self->pidl("break;");
181 $self->pidl("default:");
183 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
184 $self->pidl("talloc_free(ret);");
185 $self->pidl("ret = NULL;");
192 $self->pidl("return ret;");
195 sub PythonStruct($$$$$$)
197 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
199 my $env = GenerateStructEnv($d, "object");
203 my $getsetters = "NULL";
205 if ($#{$d->{ELEMENTS}} > -1) {
206 foreach my $e (@{$d->{ELEMENTS}}) {
207 my $varname = "object->$e->{NAME}";
208 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
211 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
212 $self->pidl("PyObject *py_$e->{NAME};");
213 $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
214 $self->pidl("return py_$e->{NAME};");
219 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
222 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
223 my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
224 my $l = $e->{LEVELS}[0];
225 my $nl = GetNextLevel($e, $l);
226 if ($l->{TYPE} eq "POINTER" and
227 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
228 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
229 $self->pidl("talloc_unlink($mem_ctx, discard_const($varname));");
231 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
232 $self->pidl("return 0;");
238 $getsetters = "py_$name\_getsetters";
239 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
241 foreach my $e (@{$d->{ELEMENTS}}) {
244 $self->pidl(".name = discard_const_p(char, \"$e->{NAME}\"),");
245 $self->pidl(".get = py_$name\_get_$e->{NAME},");
246 $self->pidl(".set = py_$name\_set_$e->{NAME},");
247 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
251 $self->pidl("{ .name = NULL }");
257 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
260 $self->pidl("return pytalloc_new($cname, type);");
265 my $py_methods = "NULL";
267 # If the struct is not public there ndr_pull/ndr_push functions will
268 # be static so not callable from here
269 if (has_property($d, "public")) {
270 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
273 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
274 $self->pidl("PyObject *ret = NULL;");
275 $self->pidl("DATA_BLOB blob;");
276 $self->pidl("enum ndr_err_code err;");
277 $self->pidl("TALLOC_CTX *tmp_ctx = talloc_new(pytalloc_get_mem_ctx(py_obj));");
278 $self->pidl("if (tmp_ctx == NULL) {");
280 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
281 $self->pidl("return NULL;");
284 $self->pidl("err = ndr_push_struct_blob(&blob, tmp_ctx, object, (ndr_push_flags_fn_t)ndr_push_$name);");
285 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
287 $self->pidl("TALLOC_FREE(tmp_ctx);");
288 $self->pidl("PyErr_SetNdrError(err);");
289 $self->pidl("return NULL;");
293 $self->pidl("ret = PyString_FromStringAndSize((char *)blob.data, blob.length);");
294 $self->pidl("TALLOC_FREE(tmp_ctx);");
295 $self->pidl("return ret;");
300 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
303 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
304 $self->pidl("DATA_BLOB blob;");
305 $self->pidl("Py_ssize_t blob_length = 0;");
306 $self->pidl("enum ndr_err_code err;");
307 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
308 $self->pidl("PyObject *allow_remaining_obj = NULL;");
309 $self->pidl("bool allow_remaining = false;");
311 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|O:__ndr_unpack__\",");
313 $self->pidl("discard_const_p(char *, kwnames),");
314 $self->pidl("&blob.data, &blob_length,");
315 $self->pidl("&allow_remaining_obj)) {");
318 $self->pidl("return NULL;");
321 $self->pidl("blob.length = blob_length;");
323 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
325 $self->pidl("allow_remaining = true;");
329 $self->pidl("if (allow_remaining) {");
331 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
333 $self->pidl("} else {");
335 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
338 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
340 $self->pidl("PyErr_SetNdrError(err);");
341 $self->pidl("return NULL;");
345 $self->pidl("Py_RETURN_NONE;");
350 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
353 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
354 $self->pidl("PyObject *ret;");
355 $self->pidl("char *retstr;");
357 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
358 $self->pidl("ret = PyString_FromString(retstr);");
359 $self->pidl("talloc_free(retstr);");
361 $self->pidl("return ret;");
366 $py_methods = "py_$name\_methods";
367 $self->pidl("static PyMethodDef $py_methods\[] = {");
369 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
370 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
371 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_NOARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
372 $self->pidl("{ NULL, NULL, 0, NULL }");
378 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
380 my $docstring = $self->DocString($d, $name);
381 my $typeobject = "$name\_Type";
382 $self->pidl("static PyTypeObject $typeobject = {");
384 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
385 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
386 $self->pidl(".tp_getset = $getsetters,");
388 $self->pidl(".tp_doc = $docstring,");
390 $self->pidl(".tp_methods = $py_methods,");
391 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
392 $self->pidl(".tp_new = py_$name\_new,");
398 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
399 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
400 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
403 return "&$typeobject";
406 sub get_metadata_var($)
409 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
411 if (has_property($e, "length_is")) {
412 return get_var($e->{PROPERTIES}->{length_is});
413 } elsif (has_property($e, "size_is")) {
414 return get_var($e->{PROPERTIES}->{size_is});
420 sub find_metadata_args($)
423 my $metadata_args = { in => {}, out => {} };
425 # Determine arguments that are metadata for other arguments (size_is/length_is)
426 foreach my $e (@{$fn->{ELEMENTS}}) {
427 foreach my $dir (@{$e->{DIRECTION}}) {
428 my $main = get_metadata_var($e);
430 $metadata_args->{$dir}->{$main} = $e->{NAME};
435 return $metadata_args;
438 sub PythonFunctionUnpackOut($$$)
440 my ($self, $fn, $fnname) = @_;
442 my $outfnname = "unpack_$fnname\_args_out";
445 my $metadata_args = find_metadata_args($fn);
447 my $env = GenerateFunctionOutEnv($fn, "r->");
450 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
453 $self->pidl("PyObject *result;");
454 foreach my $e (@{$fn->{ELEMENTS}}) {
455 next unless (grep(/out/,@{$e->{DIRECTION}}));
456 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
457 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
458 $self->pidl("PyObject *py_$e->{NAME};");
462 if ($fn->{RETURN_TYPE}) {
463 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
468 if ($result_size > 1) {
469 $self->pidl("result = PyTuple_New($result_size);");
471 } elsif ($result_size == 0) {
472 $self->pidl("result = Py_None;");
473 $self->pidl("Py_INCREF(result);");
474 $signature .= "None";
477 foreach my $e (@{$fn->{ELEMENTS}}) {
478 next if ($metadata_args->{out}->{$e->{NAME}});
479 my $py_name = "py_$e->{NAME}";
480 if (grep(/out/,@{$e->{DIRECTION}})) {
481 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
482 if ($result_size > 1) {
483 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
485 $signature .= "$e->{NAME}, ";
487 $self->pidl("result = $py_name;");
488 $signature .= $e->{NAME};
493 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
494 $self->handle_ntstatus("r->out.result", "NULL", undef);
495 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
496 $self->handle_werror("r->out.result", "NULL", undef);
497 } elsif (defined($fn->{RETURN_TYPE})) {
498 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
499 if ($result_size > 1) {
500 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
502 $self->pidl("result = $conv;");
504 $signature .= "result";
507 if (substr($signature, -2) eq ", ") {
508 $signature = substr($signature, 0, -2);
510 if ($result_size > 1) {
514 $self->pidl("return result;");
519 return ($outfnname, $signature);
522 sub PythonFunctionPackIn($$$)
524 my ($self, $fn, $fnname) = @_;
525 my $metadata_args = find_metadata_args($fn);
527 my $infnname = "pack_$fnname\_args_in";
529 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
532 my $args_format = "";
533 my $args_string = "";
537 foreach my $e (@{$fn->{ELEMENTS}}) {
538 next unless (grep(/in/,@{$e->{DIRECTION}}));
539 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
540 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
541 $self->pidl("PyObject *py_$e->{NAME};");
543 $args_string .= ", &py_$e->{NAME}";
544 $args_names .= "\"$e->{NAME}\", ";
545 $signature .= "$e->{NAME}, ";
547 if (substr($signature, -2) eq ", ") {
548 $signature = substr($signature, 0, -2);
550 $self->pidl("const char *kwnames[] = {");
552 $self->pidl($args_names . "NULL");
557 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
559 $self->pidl("return false;");
564 my $env = GenerateFunctionInEnv($fn, "r->");
566 my $fail = "return false;";
567 foreach my $e (@{$fn->{ELEMENTS}}) {
568 next unless (grep(/in/,@{$e->{DIRECTION}}));
569 if ($metadata_args->{in}->{$e->{NAME}}) {
570 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
571 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
572 my $val = "PyList_GET_SIZE($py_var)";
573 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
574 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
575 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
577 $self->pidl("PyErr_NoMemory();");
581 $self->pidl("*r->in.$e->{NAME} = $val;");
583 $self->pidl("r->in.$e->{NAME} = $val;");
586 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
589 $self->pidl("return true;");
593 return ($infnname, $signature);
596 sub PythonFunction($$$)
598 my ($self, $fn, $iface, $prettyname) = @_;
600 my $fnname = "py_$fn->{NAME}";
601 my $docstring = $self->DocString($fn, $fn->{NAME});
603 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
604 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
605 my $signature = "S.$prettyname($insignature) -> $outsignature";
607 $docstring = "\"$signature\\n\\n\"$docstring";
609 $docstring = "\"$signature\"";
612 return ($infn, $outfn, $docstring);
615 sub handle_werror($$$$)
617 my ($self, $var, $retval, $mem_ctx) = @_;
619 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
621 $self->pidl("PyErr_SetWERROR($var);");
622 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
623 $self->pidl("return $retval;");
629 sub handle_ntstatus($$$$)
631 my ($self, $var, $retval, $mem_ctx) = @_;
633 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
635 $self->pidl("PyErr_SetNTSTATUS($var);");
636 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
637 $self->pidl("return $retval;");
645 my ($self, $modulename, $d, $interface, $basename) = @_;
647 my $actual_ctype = $d;
648 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
649 $actual_ctype = $actual_ctype->{DATA};
652 if ($actual_ctype->{TYPE} eq "STRUCT") {
654 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
656 if ($d->{TYPE} eq "STRUCT") {
657 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
659 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
662 $self->register_module_typeobject($fn_name, $typeobject, $d->{ORIGINAL});
665 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
666 $self->EnumAndBitmapConsts($d->{NAME}, $d);
669 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
670 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
673 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
674 my $prettyname = PrettifyTypeName($d->{NAME}, $basename);
675 my $typeobject = "$d->{NAME}\_Type";
676 my $docstring = $self->DocString($d, $d->{NAME});
677 my $cname = "union $d->{NAME}";
679 $self->pidl("static PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
682 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
687 $self->pidl("static ".mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
690 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
695 my $getsetters = "NULL";
696 my $py_methods = "NULL";
697 my $typename = mapTypeName($d);
700 ## PyCapsule (starting with 2.7) vs. PyCObject (up to 3.2)
702 ## As we need to support python 2.6, we can't use PyCapsule yet.
704 ## When we'll get support fpr Python3 we'll have to emulate
705 ## PyCObject using PyCapsule and convert these functions to
708 $self->pidl("static PyObject *py_$d->{NAME}\_import(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
711 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
712 $self->pidl("PyObject *mem_ctx_obj = NULL;");
713 $self->pidl("static const char *mem_ctx_type = \"TALLOC_CTX\";");
714 $self->pidl("const char *mem_ctx_desc = NULL;");
715 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
716 $self->pidl("int level = 0;");
717 $self->pidl("PyObject *in_obj = NULL;");
718 $self->pidl("static const char *in_type = \"$typename\";");
719 $self->pidl("const char *in_desc = NULL;");
720 $self->pidl("$typename *in = NULL;");
721 $self->pidl("int cmp;");
723 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
725 $self->pidl("discard_const_p(char *, kwnames),");
726 $self->pidl("&mem_ctx_obj,");
727 $self->pidl("&level,");
728 $self->pidl("&in_obj)) {");
731 $self->pidl("return NULL;");
734 $self->pidl("if (!PyCObject_Check(mem_ctx_obj)) {");
736 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx needs to be of type PyCObject!\");");
737 $self->pidl("return NULL;");
740 $self->pidl("mem_ctx_desc = (const char *)PyCObject_GetDesc(mem_ctx_obj);");
742 $self->pidl("if (mem_ctx_desc == NULL) {");
743 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx hash no PyCObject_GetDesc()!\");");
744 $self->pidl("return NULL;");
747 $self->pidl("cmp = strncmp(mem_ctx_type, mem_ctx_desc, strlen(mem_ctx_type) + 1);");
748 $self->pidl("if (cmp != 0) {");
750 $self->pidl("PyErr_Format(PyExc_TypeError, \"mem_ctx should have PyCObject_GetDesc() = %s!\", mem_ctx_type);");
751 $self->pidl("return NULL;");
754 $self->pidl("mem_ctx = PyCObject_AsVoidPtr(mem_ctx_obj);");
755 $self->pidl("if (mem_ctx == NULL) {");
757 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
758 $self->pidl("return NULL;");
761 $self->pidl("if (!PyCObject_Check(in_obj)) {");
763 $self->pidl("PyErr_SetString(PyExc_TypeError, \"in needs to be of type PyCObject!\");");
764 $self->pidl("return NULL;");
767 $self->pidl("in_desc = (const char *)PyCObject_GetDesc(in_obj);");
769 $self->pidl("if (in_desc == NULL) {");
770 $self->pidl("PyErr_SetString(PyExc_TypeError, \"in hash no PyCObject_GetDesc()!\");");
771 $self->pidl("return NULL;");
774 $self->pidl("cmp = strncmp(in_type, in_desc, strlen(in_type) + 1);");
775 $self->pidl("if (cmp != 0) {");
777 $self->pidl("PyErr_Format(PyExc_TypeError, \"in should have PyCObject_GetDesc() = %s!\", in_type);");
778 $self->pidl("return NULL;");
781 $self->pidl("in = ($typename *)PyCObject_AsVoidPtr(in_obj);");
783 $self->pidl("return py_import_$d->{NAME}(mem_ctx, level, in);");
788 $self->pidl("static PyObject *py_$d->{NAME}\_export(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
791 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
792 $self->pidl("PyObject *mem_ctx_obj = NULL;");
793 $self->pidl("static const char *mem_ctx_type = \"TALLOC_CTX\";");
794 $self->pidl("const char *mem_ctx_desc = NULL;");
795 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
796 $self->pidl("int level = 0;");
797 $self->pidl("PyObject *in = NULL;");
798 $self->pidl("static const char *out_type = \"$typename\";");
799 $self->pidl("$typename *out = NULL;");
800 $self->pidl("int cmp;");
802 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
804 $self->pidl("discard_const_p(char *, kwnames),");
805 $self->pidl("&mem_ctx_obj,");
806 $self->pidl("&level,");
807 $self->pidl("&in)) {");
810 $self->pidl("return NULL;");
813 $self->pidl("if (!PyCObject_Check(mem_ctx_obj)) {");
815 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx needs to be of type PyCObject!\");");
816 $self->pidl("return NULL;");
819 $self->pidl("mem_ctx_desc = (const char *)PyCObject_GetDesc(mem_ctx_obj);");
821 $self->pidl("if (mem_ctx_desc == NULL) {");
822 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx hash no PyCObject_GetDesc()!\");");
823 $self->pidl("return NULL;");
826 $self->pidl("cmp = strncmp(mem_ctx_type, mem_ctx_desc, strlen(mem_ctx_type) + 1);");
827 $self->pidl("if (cmp != 0) {");
829 $self->pidl("PyErr_Format(PyExc_TypeError, \"mem_ctx should have PyCObject_GetDesc() = %s!\", mem_ctx_type);");
830 $self->pidl("return NULL;");
833 $self->pidl("mem_ctx = PyCObject_AsVoidPtr(mem_ctx_obj);");
834 $self->pidl("if (mem_ctx == NULL) {");
836 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
837 $self->pidl("return NULL;");
841 $self->pidl("out = py_export_$d->{NAME}(mem_ctx, level, in);");
842 $self->pidl("if (out == NULL) {");
844 $self->pidl("return NULL;");
847 $self->pidl("return PyCObject_FromVoidPtrAndDesc(out, discard_const_p(char, out_type), NULL);");
852 $py_methods = "py_$d->{NAME}_methods";
853 $self->pidl("static PyMethodDef $py_methods\[] = {");
855 $self->pidl("{ \"__import__\", (PyCFunction)py_$d->{NAME}\_import,");
857 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
858 $self->pidl("\"T.__import__(mem_ctx, level, in) => ret.\" },");
860 $self->pidl("{ \"__export__\", (PyCFunction)py_$d->{NAME}\_export,");
862 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
863 $self->pidl("\"T.__export__(mem_ctx, level, in) => ret.\" },");
865 $self->pidl("{ NULL, NULL, 0, NULL }");
870 $self->pidl("static PyObject *py_$d->{NAME}\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
873 $self->pidl("PyErr_Format(PyExc_TypeError, \"New %s Objects are not supported\", type->tp_name);");
874 $self->pidl("return NULL;");
880 $self->pidl_hdr("static PyTypeObject $typeobject;\n");
881 $self->pidl("static PyTypeObject $typeobject = {");
883 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
884 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
885 $self->pidl(".tp_getset = $getsetters,");
887 $self->pidl(".tp_doc = $docstring,");
889 $self->pidl(".tp_methods = $py_methods,");
890 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
891 $self->pidl(".tp_new = py_$d->{NAME}\_new,");
897 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
898 $self->register_module_prereadycode(["$typeobject.tp_base = $talloc_typename;",
899 "$typeobject.tp_basicsize = pytalloc_BaseObject_size();",
902 $self->register_module_typeobject($prettyname, "&$typeobject", $d->{ORIGINAL});
908 my ($self, $d, $name) = @_;
909 if (has_property($d, "helpstring")) {
910 my $docstring = uc("py_doc_$name");
911 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
920 my($self,$interface,$basename) = @_;
922 if (has_property($interface, "pyhelper")) {
923 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
926 $self->Const($_) foreach (@{$interface->{CONSTS}});
928 foreach my $d (@{$interface->{TYPES}}) {
929 next if has_property($d, "nopython");
931 $self->PythonType($basename, $d, $interface, $basename);
934 if (defined $interface->{PROPERTIES}->{uuid}) {
935 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
940 foreach my $d (@{$interface->{FUNCTIONS}}) {
941 next if has_property($d, "noopnum");
942 next if has_property($d, "nopython");
943 next if has_property($d, "todo");
946 foreach my $e (@{$d->{ELEMENTS}}) {
947 if (ContainsPipe($e, $e->{LEVELS}[0])) {
954 my $prettyname = $d->{NAME};
956 $prettyname =~ s/^$interface->{NAME}_//;
957 $prettyname =~ s/^$basename\_//;
959 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
961 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
964 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
966 foreach my $d (@fns) {
967 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
968 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
970 $self->pidl("{ NULL }");
975 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
978 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
985 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
987 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
988 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
989 \"credentials should be a credentials.Credentials object.\\n\\n\"";
991 my $docstring = $self->DocString($interface, $interface->{NAME});
994 $docstring = "$signature$docstring";
996 $docstring = $signature;
999 my $if_typename = "$interface->{NAME}_InterfaceType";
1001 $self->pidl("static PyTypeObject $if_typename = {");
1003 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1004 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
1005 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
1006 $self->pidl(".tp_doc = $docstring,");
1007 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1008 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
1014 $self->register_module_typeobject($interface->{NAME}, "&$if_typename", $interface->{ORIGINAL});
1015 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
1016 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
1017 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
1020 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1023 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
1029 my $signature = "\"$interface->{NAME}_abstract_syntax()\\n\"";
1031 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
1034 $docstring = "$signature$docstring";
1036 $docstring = $signature;
1039 my $syntax_typename = "$interface->{NAME}_SyntaxType";
1041 $self->pidl("static PyTypeObject $syntax_typename = {");
1043 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1044 $self->pidl(".tp_name = \"$basename.$interface->{NAME}_abstract_syntax\",");
1045 $self->pidl(".tp_doc = $docstring,");
1046 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1047 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
1053 $self->register_module_typeobject("$interface->{NAME}_abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1054 if (not defined($self->existing_module_object("abstract_syntax"))) {
1055 # Only the first syntax gets registered with the legacy
1056 # "abstract_syntax" name
1057 $self->register_module_typeobject("abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1059 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
1060 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;",
1061 "$syntax_typename.tp_basicsize = pytalloc_BaseObject_size();",
1065 $self->pidl_hdr("\n");
1068 sub register_module_method($$$$$)
1070 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
1072 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
1075 sub register_module_typeobject($$$$)
1077 my ($self, $name, $py_name, $location) = @_;
1079 $self->register_module_object($name, "(PyObject *)(void *)$py_name", $location);
1081 $self->check_ready_type($py_name);
1083 $self->register_patch_type_call($name, $py_name);
1086 sub check_ready_type($$)
1088 my ($self, $py_name) = @_;
1089 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
1092 sub register_module_import($$)
1094 my ($self, $module_path) = @_;
1096 my $var_name = $module_path;
1097 $var_name =~ s/\./_/g;
1098 $var_name = "dep_$var_name";
1100 unless (defined $self->{module_imports_uniq}->{$var_name}) {
1101 my $h = { "key" => $var_name, "val" => $module_path};
1102 push @{$self->{module_imports}}, $h;
1103 $self->{module_imports_uniq}->{$var_name} = $h;
1108 sub import_type_variable($$$)
1110 my ($self, $module, $name) = @_;
1112 $self->register_module_import($module);
1113 unless (defined $self->{type_imports_uniq}->{$name}) {
1114 my $h = { "key" => $name, "val" => $module};
1115 push @{$self->{type_imports}}, $h;
1116 $self->{type_imports_uniq}->{$name} = $h;
1118 return "$name\_Type";
1121 sub use_type_variable($$)
1123 my ($self, $orig_ctype) = @_;
1124 # FIXME: Have a global lookup table for types that look different on the
1125 # wire than they are named in C?
1126 if ($orig_ctype->{NAME} eq "dom_sid2" or
1127 $orig_ctype->{NAME} eq "dom_sid28" or
1128 $orig_ctype->{NAME} eq "dom_sid0") {
1129 $orig_ctype->{NAME} = "dom_sid";
1131 if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
1132 $orig_ctype->{NAME} = "security_descriptor";
1135 my $ctype = resolveType($orig_ctype);
1136 unless (defined($ctype->{BASEFILE})) {
1139 # If this is an external type, make sure we do the right imports.
1140 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
1141 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
1143 return "&$ctype->{NAME}_Type";
1146 sub register_patch_type_call($$$)
1148 my ($self, $typename, $cvar) = @_;
1150 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
1154 sub register_module_prereadycode($$)
1156 my ($self, $code) = @_;
1158 push (@{$self->{prereadycode}}, @$code);
1161 sub register_module_postreadycode($$)
1163 my ($self, $code) = @_;
1165 push (@{$self->{postreadycode}}, @$code);
1168 sub existing_module_object($$)
1170 my ($self, $name) = @_;
1172 if (defined($self->{module_object_uniq}->{$name})) {
1173 return $self->{module_object_uniq}->{$name};
1179 sub register_module_object($$$$)
1181 my ($self, $name, $py_name, $location) = @_;
1183 my $existing = $self->existing_module_object($name);
1184 fatal($location, "module_object($name, $py_name) registered twice! $existing.") if defined($existing);
1186 push (@{$self->{module_objects}}, [$name, $py_name]);
1187 $self->{module_object_uniq}->{$name} = $py_name;
1192 my ($self, $dest, $src) = @_;
1193 if ($dest =~ /^\&/ and $src eq "NULL") {
1194 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
1195 } elsif ($dest =~ /^\&/) {
1196 my $destvar = get_value_of($dest);
1197 $self->pidl("$destvar = *$src;");
1199 $self->pidl("$dest = $src;");
1203 sub ConvertStringFromPythonData($$$$$)
1205 my ($self, $mem_ctx, $py_var, $target, $fail) = @_;
1209 $self->pidl("const char *test_str;");
1210 $self->pidl("const char *talloc_str;");
1211 $self->pidl("PyObject *unicode = NULL;");
1212 $self->pidl("if (PyUnicode_Check($py_var)) {");
1214 # FIXME: Use Unix charset setting rather than utf-8
1215 $self->pidl("unicode = PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\");");
1216 $self->pidl("if (unicode == NULL) {");
1218 $self->pidl("PyErr_NoMemory();");
1219 $self->pidl("$fail");
1223 $self->pidl("test_str = PyString_AS_STRING(unicode);");
1225 $self->pidl("} else if (PyString_Check($py_var)) {");
1227 $self->pidl("test_str = PyString_AS_STRING($py_var);");
1229 $self->pidl("} else {");
1231 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1232 $self->pidl("$fail");
1235 $self->pidl("talloc_str = talloc_strdup($mem_ctx, test_str);");
1236 $self->pidl("if (unicode != NULL) {");
1238 $self->pidl("Py_DECREF(unicode);");
1241 $self->pidl("if (talloc_str == NULL) {");
1243 $self->pidl("PyErr_NoMemory();");
1244 $self->pidl("$fail");
1247 $self->pidl("$target = talloc_str;");
1252 sub ConvertObjectFromPythonData($$$$$$;$$)
1254 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location, $switch) = @_;
1256 fatal($location, "undef type for $cvar") unless(defined($ctype));
1258 $ctype = resolveType($ctype);
1260 my $actual_ctype = $ctype;
1261 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1262 $actual_ctype = $actual_ctype->{DATA};
1265 # We need to cover ENUMs, BITMAPS and SCALAR values here, as
1266 # all could otherwise be assigned invalid integer values
1267 my $ctype_alias = "";
1269 if ($actual_ctype->{TYPE} eq "ENUM") {
1270 # Importantly, ENUM values are unsigned in pidl, and
1271 # typically map to uint32
1272 $ctype_alias = enum_type_fn($actual_ctype);
1273 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1274 $ctype_alias = bitmap_type_fn($actual_ctype);
1275 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1276 $ctype_alias = expandAlias($actual_ctype->{NAME});
1279 # This is the unsigned Python Integer -> C integer validation
1280 # case. The signed case is below.
1281 if ($ctype_alias =~ /^(uint[0-9]*|hyper|udlong|udlongr
1282 |NTTIME_hyper|NTTIME|NTTIME_1sec
1286 $self->pidl("const unsigned long long uint_max = ndr_sizeof2uintmax(sizeof($target));");
1287 $self->pidl("if (PyLong_Check($cvar)) {");
1289 $self->pidl("unsigned long long test_var;");
1290 $self->pidl("test_var = PyLong_AsUnsignedLongLong($cvar);");
1291 $self->pidl("if (PyErr_Occurred() != NULL) {");
1296 $self->pidl("if (test_var > uint_max) {");
1298 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %llu\",\\");
1299 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1303 $self->pidl("$target = test_var;");
1305 $self->pidl("} else if (PyInt_Check($cvar)) {");
1307 $self->pidl("long test_var;");
1308 $self->pidl("test_var = PyInt_AsLong($cvar);");
1309 $self->pidl("if (test_var < 0 || test_var > uint_max) {");
1311 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %ld\",\\");
1312 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1316 $self->pidl("$target = test_var;");
1318 $self->pidl("} else {");
1320 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1321 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1330 # Confirm the signed python integer fits in the C type
1331 # correctly. It is subtly different from the unsigned case
1332 # above, so while it looks like a duplicate, it is not
1333 # actually a duplicate.
1334 if ($ctype_alias =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1337 $self->pidl("const long long int_max = ndr_sizeof2intmax(sizeof($target));");
1338 $self->pidl("const long long int_min = -int_max - 1;");
1339 $self->pidl("if (PyLong_Check($cvar)) {");
1341 $self->pidl("long long test_var;");
1342 $self->pidl("test_var = PyLong_AsLongLong($cvar);");
1343 $self->pidl("if (PyErr_Occurred() != NULL) {");
1348 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1350 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %lld\",\\");
1351 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1355 $self->pidl("$target = test_var;");
1357 $self->pidl("} else if (PyInt_Check($cvar)) {");
1359 $self->pidl("long test_var;");
1360 $self->pidl("test_var = PyInt_AsLong($cvar);");
1361 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1363 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %ld\",\\");
1364 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1368 $self->pidl("$target = test_var;");
1370 $self->pidl("} else {");
1372 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1373 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1382 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1383 my $ctype_name = $self->use_type_variable($ctype);
1384 unless (defined ($ctype_name)) {
1385 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1386 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1389 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1390 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1392 $self->pidl("PyErr_NoMemory();");
1393 $self->pidl("$fail");
1396 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1400 if ($actual_ctype->{TYPE} eq "UNION") {
1401 my $ctype_name = $self->use_type_variable($ctype);
1402 unless (defined ($ctype_name)) {
1403 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1404 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1407 my $export = "pyrpc_export_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
1408 $self->assign($target, "(".mapTypeName($ctype)." *)$export");
1412 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1413 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
1417 if ($actual_ctype->{TYPE} eq "SCALAR" and
1418 ($actual_ctype->{NAME} eq "string"
1419 or $actual_ctype->{NAME} eq "nbt_string"
1420 or $actual_ctype->{NAME} eq "nbt_name"
1421 or $actual_ctype->{NAME} eq "wrepl_nbt_name"
1422 or $actual_ctype->{NAME} eq "dns_string"
1423 or $actual_ctype->{NAME} eq "dnsp_string"
1424 or $actual_ctype->{NAME} eq "dns_name"
1425 or $actual_ctype->{NAME} eq "ipv4address"
1426 or $actual_ctype->{NAME} eq "ipv6address"
1427 or $actual_ctype->{NAME} eq "dnsp_name")) {
1428 $self->ConvertStringFromPythonData($mem_ctx, $cvar, $target, $fail);
1432 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1433 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1437 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1438 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1442 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1443 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1447 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1448 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
1452 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1453 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
1457 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1461 sub ConvertObjectFromPythonLevel($$$$$$$$)
1463 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1464 my $nl = GetNextLevel($e, $l);
1465 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1466 $nl = GetNextLevel($e, $nl);
1468 my $pl = GetPrevLevel($e, $l);
1469 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1470 $pl = GetPrevLevel($e, $pl);
1473 $self->pidl("if ($py_var == NULL) {");
1475 $self->pidl("PyErr_Format(PyExc_AttributeError, \"Cannot delete NDR object: " .
1476 mapTypeName($var_name) . "\");");
1481 if ($l->{TYPE} eq "POINTER") {
1482 if ($l->{POINTER_TYPE} ne "ref") {
1483 $self->pidl("if ($py_var == Py_None) {");
1485 $self->pidl("$var_name = NULL;");
1487 $self->pidl("} else {");
1490 # if we want to handle more than one level of pointer in python interfaces
1491 # then this is where we would need to allocate it
1492 if ($l->{POINTER_TYPE} eq "ref") {
1493 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1494 $self->pidl("if ($var_name == NULL) {");
1496 $self->pidl("PyErr_NoMemory();");
1500 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1501 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1502 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1503 $self->pidl("if ($var_name == NULL) {");
1505 $self->pidl("PyErr_NoMemory();");
1510 $self->pidl("$var_name = NULL;");
1512 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1513 $var_name = get_value_of($var_name);
1515 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1516 if ($l->{POINTER_TYPE} ne "ref") {
1520 } elsif ($l->{TYPE} eq "ARRAY") {
1521 if ($pl && $pl->{TYPE} eq "POINTER") {
1522 $var_name = get_pointer_to($var_name);
1525 if (is_charset_array($e, $l)) {
1526 $self->ConvertStringFromPythonData($mem_ctx, $py_var, $var_name, $fail);
1528 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1529 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1532 $self->pidl("int $counter;");
1533 if (ArrayDynamicallyAllocated($e, $l)) {
1534 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1535 $self->pidl("if (!$var_name) { $fail; }");
1536 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1538 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
1540 $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));");
1541 $self->pidl("$fail");
1545 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1547 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
1553 } elsif ($l->{TYPE} eq "DATA") {
1554 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1555 $var_name = get_pointer_to($var_name);
1557 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1558 } elsif ($l->{TYPE} eq "SWITCH") {
1559 $var_name = get_pointer_to($var_name);
1560 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1561 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1564 my $union_type = mapTypeName($nl->{DATA_TYPE});
1565 $self->pidl("$union_type *$switch_ptr;");
1566 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $nl->{DATA_TYPE}, $switch_ptr, $fail, $e->{ORIGINAL}, $switch);
1567 $self->fail_on_null($switch_ptr, $fail);
1568 $self->assign($var_name, "$switch_ptr");
1571 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1572 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1574 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1578 sub ConvertObjectFromPython($$$$$$$)
1580 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1582 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1585 sub ConvertScalarToPython($$$)
1587 my ($self, $ctypename, $cvar) = @_;
1589 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1591 $ctypename = expandAlias($ctypename);
1593 if ($ctypename =~ /^(int64|dlong)$/) {
1594 return "ndr_PyLong_FromLongLong($cvar)";
1597 if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
1598 return "ndr_PyLong_FromUnsignedLongLong($cvar)";
1601 if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
1602 return "PyInt_FromLong($cvar)";
1605 # Needed to ensure unsigned values in a 32 or 16 bit enum is
1606 # cast correctly to a uint32_t, not sign extended to a a
1607 # possibly 64 bit unsigned long. (enums are signed in C,
1609 if ($ctypename =~ /^(uint32|uint3264)$/) {
1610 return "ndr_PyLong_FromUnsignedLongLong((uint32_t)$cvar)";
1613 if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
1614 return "PyInt_FromLong((uint16_t)$cvar)";
1617 if ($ctypename eq "DATA_BLOB") {
1618 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1621 if ($ctypename eq "NTSTATUS") {
1622 return "PyErr_FromNTSTATUS($cvar)";
1625 if ($ctypename eq "WERROR") {
1626 return "PyErr_FromWERROR($cvar)";
1629 if ($ctypename eq "HRESULT") {
1630 return "PyErr_FromHRESULT($cvar)";
1633 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1634 return "PyString_FromStringOrNULL($cvar)";
1637 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1638 return "PyString_FromStringOrNULL($cvar)";
1642 if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
1643 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
1644 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
1645 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
1646 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
1647 if ($ctypename eq "pointer") {
1648 return "pytalloc_CObject_FromTallocPtr($cvar)";
1651 die("Unknown scalar type $ctypename");
1654 sub ConvertObjectToPythonData($$$$$;$$)
1656 my ($self, $mem_ctx, $ctype, $cvar, $location, $switch) = @_;
1658 die("undef type for $cvar") unless(defined($ctype));
1660 $ctype = resolveType($ctype);
1662 my $actual_ctype = $ctype;
1663 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1664 $actual_ctype = $actual_ctype->{DATA};
1667 if ($actual_ctype->{TYPE} eq "ENUM") {
1668 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1669 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1670 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1671 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1672 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1673 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1674 my $ctype_name = $self->use_type_variable($ctype);
1675 unless (defined($ctype_name)) {
1676 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1677 return "NULL"; # FIXME!
1679 return "pyrpc_import_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
1680 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1681 my $ctype_name = $self->use_type_variable($ctype);
1682 unless (defined($ctype_name)) {
1683 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1684 return "NULL"; # FIXME!
1686 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1689 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1692 sub fail_on_null($$$)
1694 my ($self, $var, $fail) = @_;
1695 $self->pidl("if ($var == NULL) {");
1702 sub ConvertObjectToPythonLevel($$$$$$)
1704 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1705 my $nl = GetNextLevel($e, $l);
1706 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1707 $nl = GetNextLevel($e, $nl);
1709 my $pl = GetPrevLevel($e, $l);
1710 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1711 $pl = GetPrevLevel($e, $pl);
1714 if ($l->{TYPE} eq "POINTER") {
1715 if ($l->{POINTER_TYPE} ne "ref") {
1716 $self->pidl("if ($var_name == NULL) {");
1718 $self->pidl("$py_var = Py_None;");
1719 $self->pidl("Py_INCREF($py_var);");
1721 $self->pidl("} else {");
1724 my $var_name2 = $var_name;
1725 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1726 $var_name2 = get_value_of($var_name);
1728 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
1729 if ($l->{POINTER_TYPE} ne "ref") {
1733 } elsif ($l->{TYPE} eq "ARRAY") {
1734 if ($pl && $pl->{TYPE} eq "POINTER") {
1735 $var_name = get_pointer_to($var_name);
1738 if (is_charset_array($e, $l)) {
1739 # FIXME: Use Unix charset setting rather than utf-8
1740 $self->pidl("if ($var_name == NULL) {");
1742 $self->pidl("$py_var = Py_None;");
1743 $self->pidl("Py_INCREF($py_var);");
1745 $self->pidl("} else {");
1747 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1751 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1752 my $length = $l->{SIZE_IS};
1753 if (defined($l->{LENGTH_IS})) {
1754 $length = $l->{LENGTH_IS};
1757 $length = ParseExpr($length, $env, $e);
1758 $self->pidl("$py_var = PyList_New($length);");
1759 $self->fail_on_null($py_var, $fail);
1762 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1763 $self->pidl("int $counter;");
1764 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1766 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1767 $self->pidl("PyObject *$member_var;");
1768 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
1769 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1775 } elsif ($l->{TYPE} eq "SWITCH") {
1776 $var_name = get_pointer_to($var_name);
1777 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1778 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $nl->{DATA_TYPE}, $var_name, $e->{ORIGINAL}, $switch);
1779 $self->pidl("$py_var = $conv;");
1780 $self->fail_on_null($py_var, $fail);
1782 } elsif ($l->{TYPE} eq "DATA") {
1783 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1784 $var_name = get_pointer_to($var_name);
1786 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1787 $self->pidl("$py_var = $conv;");
1788 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1789 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
1791 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1795 sub ConvertObjectToPython($$$$$$)
1797 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1799 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1804 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1806 $self->{BASENAME} = $basename;
1809 /* Python wrapper functions auto-generated by pidl */
1810 #define PY_SSIZE_T_CLEAN 1 /* We use Py_ssize_t for PyArg_ParseTupleAndKeywords */
1812 #include \"includes.h\"
1813 #include <pytalloc.h>
1814 #include \"librpc/rpc/pyrpc.h\"
1815 #include \"librpc/rpc/pyrpc_util.h\"
1817 #include \"$ndr_hdr\"
1820 * These functions are here to ensure they can be optimized out by
1821 * the compiler based on the constant input values
1824 static inline unsigned long long ndr_sizeof2uintmax(size_t var_size)
1840 static inline long long ndr_sizeof2intmax(size_t var_size)
1856 static inline PyObject *ndr_PyLong_FromLongLong(long long v)
1858 if (v > LONG_MAX || v < LONG_MIN) {
1859 return PyLong_FromLongLong(v);
1861 return PyInt_FromLong(v);
1865 static inline PyObject *ndr_PyLong_FromUnsignedLongLong(unsigned long long v)
1868 return PyLong_FromUnsignedLongLong(v);
1870 return PyInt_FromLong(v);
1876 foreach my $x (@$ndr) {
1877 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1878 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1881 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1883 foreach (@{$self->{module_methods}}) {
1884 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1885 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1888 $self->pidl("{ NULL, NULL, 0, NULL }");
1894 $self->pidl_hdr("void init$basename(void);");
1895 $self->pidl("void init$basename(void)");
1898 $self->pidl("PyObject *m;");
1899 foreach my $h (@{$self->{module_imports}}) {
1900 $self->pidl("PyObject *$h->{'key'};");
1904 foreach my $h (@{$self->{module_imports}}) {
1905 my $var_name = $h->{'key'};
1906 my $module_path = $h->{'val'};
1907 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
1908 $self->pidl("if ($var_name == NULL)");
1909 $self->pidl("\treturn;");
1913 foreach my $h (@{$self->{type_imports}}) {
1914 my $type_var = "$h->{'key'}\_Type";
1915 my $module_path = $h->{'val'};
1916 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
1917 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
1918 my $module_var = "dep_$module_path";
1919 $module_var =~ s/\./_/g;
1920 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
1921 $self->pidl("if ($type_var == NULL)");
1922 $self->pidl("\treturn;");
1926 $self->pidl($_) foreach (@{$self->{prereadycode}});
1928 foreach (@{$self->{ready_types}}) {
1929 $self->pidl("if (PyType_Ready($_) < 0)");
1930 $self->pidl("\treturn;");
1933 $self->pidl($_) foreach (@{$self->{postreadycode}});
1935 foreach (@{$self->{patch_type_calls}}) {
1936 my ($typename, $cvar) = @$_;
1937 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1938 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1939 $self->pidl("#endif");
1944 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1945 $self->pidl("if (m == NULL)");
1946 $self->pidl("\treturn;");
1948 foreach my $h (@{$self->{constants}}) {
1949 my $pretty_name = PrettifyTypeName($h->{'key'}, $basename);
1951 my ($ctype, $cvar) = @{$h->{'val'}};
1952 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1953 $py_obj = "ndr_PyLong_FromUnsignedLongLong($cvar)";
1954 } elsif ($cvar =~ /^".*"$/) {
1955 $py_obj = "PyString_FromString($cvar)";
1957 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1960 $self->pidl("PyModule_AddObject(m, \"$pretty_name\", $py_obj);");
1963 foreach (@{$self->{module_objects}}) {
1964 my ($object_name, $c_name) = @$_;
1965 $self->pidl("Py_INCREF($c_name);");
1966 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1969 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1970 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1971 $self->pidl("#endif");
1976 return ($self->{res_hdr} . $self->{res});