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(ReturnTypeElement 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 PythonElementGetSet($$$$$$) {
196 my ($self, $name, $cname, $ename, $e, $env) = @_;
198 my $varname = "object->$ename";
199 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
202 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
203 $self->pidl("PyObject *py_$e->{NAME};");
204 $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
205 $self->pidl("return py_$e->{NAME};");
210 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
213 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
214 my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
215 my $l = $e->{LEVELS}[0];
216 my $nl = GetNextLevel($e, $l);
217 if ($l->{TYPE} eq "POINTER" and
218 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
219 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
220 $self->pidl("talloc_unlink($mem_ctx, discard_const($varname));");
222 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
223 $self->pidl("return 0;");
229 sub PythonStruct($$$$$$)
231 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
233 my $env = GenerateStructEnv($d, "object");
237 my $getsetters = "NULL";
239 if ($#{$d->{ELEMENTS}} > -1) {
240 foreach my $e (@{$d->{ELEMENTS}}) {
241 $self->PythonElementGetSet($name, $cname, $e->{NAME}, $e, $env);
244 $getsetters = "py_$name\_getsetters";
245 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
247 foreach my $e (@{$d->{ELEMENTS}}) {
249 if (ref($e->{TYPE}) eq "HASH") {
250 $etype = $e->{TYPE}->{NAME};
256 $self->pidl(".name = discard_const_p(char, \"$e->{NAME}\"),");
257 $self->pidl(".get = py_$name\_get_$e->{NAME},");
258 $self->pidl(".set = py_$name\_set_$e->{NAME},");
259 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $etype\")");
263 $self->pidl("{ .name = NULL }");
269 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
272 $self->pidl("return pytalloc_new($cname, type);");
277 my $py_methods = "NULL";
279 # If the struct is not public there ndr_pull/ndr_push functions will
280 # be static so not callable from here
281 if (has_property($d, "public")) {
282 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj, PyObject *Py_UNUSED(ignored))");
285 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
286 $self->pidl("PyObject *ret = NULL;");
287 $self->pidl("DATA_BLOB blob;");
288 $self->pidl("enum ndr_err_code err;");
289 $self->pidl("TALLOC_CTX *tmp_ctx = talloc_new(pytalloc_get_mem_ctx(py_obj));");
290 $self->pidl("if (tmp_ctx == NULL) {");
292 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
293 $self->pidl("return NULL;");
296 $self->pidl("err = ndr_push_struct_blob(&blob, tmp_ctx, object, (ndr_push_flags_fn_t)ndr_push_$name);");
297 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
299 $self->pidl("TALLOC_FREE(tmp_ctx);");
300 $self->pidl("PyErr_SetNdrError(err);");
301 $self->pidl("return NULL;");
305 $self->pidl("ret = PyBytes_FromStringAndSize((char *)blob.data, blob.length);");
306 $self->pidl("TALLOC_FREE(tmp_ctx);");
307 $self->pidl("return ret;");
312 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
315 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
316 $self->pidl("DATA_BLOB blob = {.data = NULL, .length = 0};");
317 $self->pidl("Py_ssize_t blob_length = 0;");
318 $self->pidl("enum ndr_err_code err;");
319 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
320 $self->pidl("PyObject *allow_remaining_obj = NULL;");
321 $self->pidl("bool allow_remaining = false;");
323 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, PYARG_BYTES_LEN \"|O:__ndr_unpack__\",");
325 $self->pidl("discard_const_p(char *, kwnames),");
326 $self->pidl("&blob.data, &blob_length,");
327 $self->pidl("&allow_remaining_obj)) {");
330 $self->pidl("return NULL;");
333 $self->pidl("blob.length = blob_length;");
335 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
337 $self->pidl("allow_remaining = true;");
341 $self->pidl("if (allow_remaining) {");
343 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
345 $self->pidl("} else {");
347 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
350 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
352 $self->pidl("PyErr_SetNdrError(err);");
353 $self->pidl("return NULL;");
357 $self->pidl("Py_RETURN_NONE;");
362 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj, PyObject *Py_UNUSED(ignored))");
365 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
366 $self->pidl("PyObject *ret;");
367 $self->pidl("char *retstr;");
369 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
370 $self->pidl("ret = PyUnicode_FromString(retstr);");
371 $self->pidl("talloc_free(retstr);");
373 $self->pidl("return ret;");
378 $py_methods = "py_$name\_methods";
379 $self->pidl("static PyMethodDef $py_methods\[] = {");
381 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
382 $self->pidl("{ \"__ndr_unpack__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$name\_ndr_unpack), METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
383 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_NOARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
384 $self->pidl("{ NULL, NULL, 0, NULL }");
390 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
392 my $docstring = $self->DocString($d, $name);
393 my $typeobject = "$name\_Type";
394 $self->pidl("static PyTypeObject $typeobject = {");
396 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
397 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
398 $self->pidl(".tp_getset = $getsetters,");
400 $self->pidl(".tp_doc = $docstring,");
402 $self->pidl(".tp_methods = $py_methods,");
403 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
404 $self->pidl(".tp_new = py_$name\_new,");
410 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
411 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
412 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
415 return "&$typeobject";
418 sub PythonFunctionStruct($$$$)
420 my ($self, $modulename, $fn, $iface, $prettyname) = @_;
422 my $inenv = GenerateFunctionInEnv($fn, "object->");
423 my $outenv = GenerateFunctionOutEnv($fn, "object->");
425 my $name = "$fn->{NAME}";
426 my $cname = "struct $name";
430 my $getsetters = "NULL";
432 foreach my $e (@{$fn->{ELEMENTS}}) {
433 if (grep(/in/,@{$e->{DIRECTION}})) {
434 my $inname = "$name\_in";
435 my $ename = "in.$e->{NAME}";
436 $self->PythonElementGetSet($inname, $cname, $ename, $e, $inenv);
438 if (grep(/out/,@{$e->{DIRECTION}})) {
439 my $outname = "$name\_out";
440 my $ename = "out.$e->{NAME}";
441 $self->PythonElementGetSet($outname, $cname, $ename, $e, $outenv);
445 if (defined($fn->{RETURN_TYPE})) {
446 my $e = ReturnTypeElement($fn);
447 my $ename = "out.result";
448 $self->PythonElementGetSet($name, $cname, $ename, $e, $outenv);
451 $getsetters = "py_$name\_getsetters";
452 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
454 foreach my $e (@{$fn->{ELEMENTS}}) {
455 if (grep(/in/,@{$e->{DIRECTION}})) {
458 $self->pidl(".name = discard_const_p(char, \"in_$e->{NAME}\"),");
459 $self->pidl(".get = py_$name\_in_get_$e->{NAME},");
460 $self->pidl(".set = py_$name\_in_set_$e->{NAME},");
461 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
465 if (grep(/out/,@{$e->{DIRECTION}})) {
468 $self->pidl(".name = discard_const_p(char, \"out_$e->{NAME}\"),");
469 $self->pidl(".get = py_$name\_out_get_$e->{NAME},");
470 $self->pidl(".set = py_$name\_out_set_$e->{NAME},");
471 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
476 if (defined($fn->{RETURN_TYPE})) {
479 $self->pidl(".name = discard_const_p(char, \"result\"),");
480 $self->pidl(".get = py_$name\_get_result,");
481 $self->pidl(".set = py_$name\_set_result,");
482 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of type $fn->{RETURN_TYPE}\")");
486 $self->pidl("{ .name = NULL }");
491 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
494 $self->pidl("return pytalloc_new($cname, type);");
499 my $py_methods = "NULL";
501 my $ndr_call = "const struct ndr_interface_call *call = NULL;";
502 my $object_ptr = "$cname *object = ($cname *)pytalloc_get_ptr(py_obj);";
504 $self->pidl("static PyObject *py_$name\_ndr_opnum(PyTypeObject *type, PyObject *Py_UNUSED(ignored))");
509 $self->pidl("return PyInt_FromLong($fn->{OPNUM});");
514 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj, int ndr_inout_flags, uint32_t ndr_push_flags)");
517 $self->pidl("$ndr_call");
518 $self->pidl("$object_ptr");
519 $self->pidl("PyObject *ret = NULL;");
520 $self->pidl("struct ndr_push *push = NULL;");
521 $self->pidl("DATA_BLOB blob;");
522 $self->pidl("enum ndr_err_code err;");
524 $self->pidl("if (ndr_table_$iface\.num_calls < " . ($fn->{OPNUM}+1) .
527 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_pack\");");
528 $self->pidl("return NULL;");
531 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
533 $self->pidl("push = ndr_push_init_ctx(pytalloc_get_mem_ctx(py_obj));");
534 $self->pidl("if (push == NULL) {");
536 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
537 $self->pidl("return NULL;");
541 $self->pidl("push->flags |= ndr_push_flags;");
543 $self->pidl("err = call->ndr_push(push, ndr_inout_flags, object);");
544 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
546 $self->pidl("TALLOC_FREE(push);");
547 $self->pidl("PyErr_SetNdrError(err);");
548 $self->pidl("return NULL;");
551 $self->pidl("blob = ndr_push_blob(push);");
552 $self->pidl("ret = PyBytes_FromStringAndSize((char *)blob.data, blob.length);");
553 $self->pidl("TALLOC_FREE(push);");
554 $self->pidl("return ret;");
559 $self->pidl("static PyObject *py_$name\_ndr_pack_in(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
562 $self->pidl("const char * const kwnames[] = { \"bigendian\", \"ndr64\", NULL };");
563 $self->pidl("PyObject *bigendian_obj = NULL;");
564 $self->pidl("PyObject *ndr64_obj = NULL;");
565 $self->pidl("uint32_t ndr_push_flags = 0;");
567 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"|OO:__ndr_pack_in__\",");
569 $self->pidl("discard_const_p(char *, kwnames),");
570 $self->pidl("&bigendian_obj,");
571 $self->pidl("&ndr64_obj)) {");
574 $self->pidl("return NULL;");
578 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
580 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_BIGENDIAN;");
583 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
585 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_NDR64;");
589 $self->pidl("return py_$name\_ndr_pack(py_obj, NDR_IN, ndr_push_flags);");
594 $self->pidl("static PyObject *py_$name\_ndr_pack_out(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
597 $self->pidl("const char * const kwnames[] = { \"bigendian\", \"ndr64\", NULL };");
598 $self->pidl("PyObject *bigendian_obj = NULL;");
599 $self->pidl("PyObject *ndr64_obj = NULL;");
600 $self->pidl("uint32_t ndr_push_flags = 0;");
602 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"|OO:__ndr_pack_out__\",");
604 $self->pidl("discard_const_p(char *, kwnames),");
605 $self->pidl("&bigendian_obj,");
606 $self->pidl("&ndr64_obj)) {");
609 $self->pidl("return NULL;");
613 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
615 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_BIGENDIAN;");
618 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
620 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_NDR64;");
624 $self->pidl("return py_$name\_ndr_pack(py_obj, NDR_OUT, ndr_push_flags);");
629 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, const DATA_BLOB *blob, int ndr_inout_flags, uint32_t ndr_pull_flags, bool allow_remaining)");
632 $self->pidl("$ndr_call");
633 $self->pidl("$object_ptr");
634 $self->pidl("struct ndr_pull *pull = NULL;");
635 $self->pidl("enum ndr_err_code err;");
637 $self->pidl("if (ndr_table_$iface\.num_calls < " . ($fn->{OPNUM}+1) .
640 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_unpack\");");
641 $self->pidl("return NULL;");
644 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
646 $self->pidl("pull = ndr_pull_init_blob(blob, object);");
647 $self->pidl("if (pull == NULL) {");
649 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
650 $self->pidl("return NULL;");
654 $self->pidl("pull->flags |= ndr_pull_flags;");
656 $self->pidl("err = call->ndr_pull(pull, ndr_inout_flags, object);");
657 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
659 $self->pidl("TALLOC_FREE(pull);");
660 $self->pidl("PyErr_SetNdrError(err);");
661 $self->pidl("return NULL;");
664 $self->pidl("if (!allow_remaining) {");
666 $self->pidl("uint32_t highest_ofs;");
668 $self->pidl("if (pull->offset > pull->relative_highest_offset) {");
670 $self->pidl("highest_ofs = pull->offset;");
672 $self->pidl("} else {");
674 $self->pidl("highest_ofs = pull->relative_highest_offset;");
677 $self->pidl("if (highest_ofs < pull->data_size) {");
679 $self->pidl("err = ndr_pull_error(pull, NDR_ERR_UNREAD_BYTES,");
681 $self->pidl("\"not all bytes consumed ofs[%u] size[%u]\",");
682 $self->pidl("highest_ofs, pull->data_size);");
684 $self->pidl("TALLOC_FREE(pull);");
685 $self->pidl("PyErr_SetNdrError(err);");
686 $self->pidl("return NULL;");
692 $self->pidl("TALLOC_FREE(pull);");
693 $self->pidl("Py_RETURN_NONE;");
698 $self->pidl("static PyObject *py_$name\_ndr_unpack_in(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
701 $self->pidl("DATA_BLOB blob;");
702 $self->pidl("Py_ssize_t blob_length = 0;");
703 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"bigendian\", \"ndr64\", \"allow_remaining\", NULL };");
704 $self->pidl("PyObject *bigendian_obj = NULL;");
705 $self->pidl("PyObject *ndr64_obj = NULL;");
706 $self->pidl("uint32_t ndr_pull_flags = LIBNDR_FLAG_REF_ALLOC;");
707 $self->pidl("PyObject *allow_remaining_obj = NULL;");
708 $self->pidl("bool allow_remaining = false;");
710 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, PYARG_BYTES_LEN \"|OOO:__ndr_unpack_in__\",");
712 $self->pidl("discard_const_p(char *, kwnames),");
713 $self->pidl("&blob.data, &blob_length,");
714 $self->pidl("&bigendian_obj,");
715 $self->pidl("&ndr64_obj,");
716 $self->pidl("&allow_remaining_obj)) {");
719 $self->pidl("return NULL;");
722 $self->pidl("blob.length = blob_length;");
724 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
726 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_BIGENDIAN;");
729 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
731 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_NDR64;");
735 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
737 $self->pidl("allow_remaining = true;");
741 $self->pidl("return py_$name\_ndr_unpack(py_obj, &blob, NDR_IN, ndr_pull_flags, allow_remaining);");
746 $self->pidl("static PyObject *py_$name\_ndr_unpack_out(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
749 $self->pidl("DATA_BLOB blob;");
750 $self->pidl("Py_ssize_t blob_length = 0;");
751 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"bigendian\", \"ndr64\", \"allow_remaining\", NULL };");
752 $self->pidl("PyObject *bigendian_obj = NULL;");
753 $self->pidl("PyObject *ndr64_obj = NULL;");
754 $self->pidl("uint32_t ndr_pull_flags = LIBNDR_FLAG_REF_ALLOC;");
755 $self->pidl("PyObject *allow_remaining_obj = NULL;");
756 $self->pidl("bool allow_remaining = false;");
758 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, PYARG_BYTES_LEN \"|OOO:__ndr_unpack_out__\",");
760 $self->pidl("discard_const_p(char *, kwnames),");
761 $self->pidl("&blob.data, &blob_length,");
762 $self->pidl("&bigendian_obj,");
763 $self->pidl("&ndr64_obj,");
764 $self->pidl("&allow_remaining_obj)) {");
767 $self->pidl("return NULL;");
770 $self->pidl("blob.length = blob_length;");
772 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
774 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_BIGENDIAN;");
777 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
779 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_NDR64;");
783 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
785 $self->pidl("allow_remaining = true;");
789 $self->pidl("return py_$name\_ndr_unpack(py_obj, &blob, NDR_OUT, ndr_pull_flags, allow_remaining);");
794 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj, const char *name, int ndr_inout_flags)");
797 $self->pidl("$ndr_call");
798 $self->pidl("$object_ptr");
799 $self->pidl("PyObject *ret;");
800 $self->pidl("char *retstr;");
802 $self->pidl("if (ndr_table_$iface\.num_calls < " . ($fn->{OPNUM}+1) .
805 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_print\");");
806 $self->pidl("return NULL;");
809 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
811 $self->pidl("retstr = ndr_print_function_string(pytalloc_get_mem_ctx(py_obj), call->ndr_print, name, ndr_inout_flags, object);");
812 $self->pidl("ret = PyUnicode_FromString(retstr);");
813 $self->pidl("TALLOC_FREE(retstr);");
815 $self->pidl("return ret;");
820 $self->pidl("static PyObject *py_$name\_ndr_print_in(PyObject *py_obj, PyObject *Py_UNUSED(ignored))");
823 $self->pidl("return py_$name\_ndr_print(py_obj, \"$name\_in\", NDR_IN);");
828 $self->pidl("static PyObject *py_$name\_ndr_print_out(PyObject *py_obj, PyObject *Py_UNUSED(ignored))");
831 $self->pidl("return py_$name\_ndr_print(py_obj, \"$name\_out\", NDR_OUT);");
836 $py_methods = "py_$name\_methods";
837 $self->pidl("static PyMethodDef $py_methods\[] = {");
839 $self->pidl("{ \"opnum\", (PyCFunction)py_$name\_ndr_opnum, METH_NOARGS|METH_CLASS,");
841 $self->pidl("\"$modulename.$prettyname.opnum() -> ".sprintf("%d (0x%02x)", $fn->{OPNUM}, $fn->{OPNUM})." \" },");
843 $self->pidl("{ \"__ndr_pack_in__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$name\_ndr_pack_in), METH_VARARGS|METH_KEYWORDS,");
845 $self->pidl("\"S.ndr_pack_in(object, bigendian=False, ndr64=False) -> blob\\nNDR pack input\" },");
847 $self->pidl("{ \"__ndr_pack_out__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$name\_ndr_pack_out), METH_VARARGS|METH_KEYWORDS,");
849 $self->pidl("\"S.ndr_pack_out(object, bigendian=False, ndr64=False) -> blob\\nNDR pack output\" },");
851 $self->pidl("{ \"__ndr_unpack_in__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$name\_ndr_unpack_in), METH_VARARGS|METH_KEYWORDS,");
853 $self->pidl("\"S.ndr_unpack_in(class, blob, bigendian=False, ndr64=False, allow_remaining=False) -> None\\nNDR unpack input\" },");
855 $self->pidl("{ \"__ndr_unpack_out__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$name\_ndr_unpack_out), METH_VARARGS|METH_KEYWORDS,");
857 $self->pidl("\"S.ndr_unpack_out(class, blob, bigendian=False, ndr64=False, allow_remaining=False) -> None\\nNDR unpack output\" },");
859 $self->pidl("{ \"__ndr_print_in__\", (PyCFunction)py_$name\_ndr_print_in, METH_NOARGS, \"S.ndr_print_in(object) -> None\\nNDR print input\" },");
860 $self->pidl("{ \"__ndr_print_out__\", (PyCFunction)py_$name\_ndr_print_out, METH_NOARGS, \"S.ndr_print_out(object) -> None\\nNDR print output\" },");
861 $self->pidl("{ NULL, NULL, 0, NULL }");
866 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
868 my $docstring = $self->DocString($fn, $name);
869 my $typeobject = "$name\_Type";
870 $self->pidl("static PyTypeObject $typeobject = {");
872 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
873 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
874 $self->pidl(".tp_getset = $getsetters,");
876 $self->pidl(".tp_doc = $docstring,");
878 $self->pidl(".tp_methods = $py_methods,");
879 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
880 $self->pidl(".tp_new = py_$name\_new,");
886 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
887 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
888 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
891 return "&$typeobject";
894 sub get_metadata_var($)
897 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
899 if (has_property($e, "length_is")) {
900 return get_var($e->{PROPERTIES}->{length_is});
901 } elsif (has_property($e, "size_is")) {
902 return get_var($e->{PROPERTIES}->{size_is});
908 sub find_metadata_args($)
911 my $metadata_args = { in => {}, out => {} };
913 # Determine arguments that are metadata for other arguments (size_is/length_is)
914 foreach my $e (@{$fn->{ELEMENTS}}) {
915 foreach my $dir (@{$e->{DIRECTION}}) {
916 my $main = get_metadata_var($e);
918 $metadata_args->{$dir}->{$main} = $e->{NAME};
923 return $metadata_args;
926 sub PythonFunctionUnpackOut($$$)
928 my ($self, $fn, $fnname) = @_;
930 my $outfnname = "unpack_$fnname\_args_out";
933 my $metadata_args = find_metadata_args($fn);
935 my $env = GenerateFunctionOutEnv($fn, "r->");
938 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
941 $self->pidl("PyObject *result;");
942 foreach my $e (@{$fn->{ELEMENTS}}) {
943 next unless (grep(/out/,@{$e->{DIRECTION}}));
944 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
945 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
946 $self->pidl("PyObject *py_$e->{NAME};");
950 if ($fn->{RETURN_TYPE}) {
951 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
956 if ($result_size > 1) {
957 $self->pidl("result = PyTuple_New($result_size);");
959 } elsif ($result_size == 0) {
960 $self->pidl("result = Py_None;");
961 $self->pidl("Py_INCREF(result);");
962 $signature .= "None";
965 foreach my $e (@{$fn->{ELEMENTS}}) {
966 next if ($metadata_args->{out}->{$e->{NAME}});
967 my $py_name = "py_$e->{NAME}";
968 if (grep(/out/,@{$e->{DIRECTION}})) {
969 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
970 if ($result_size > 1) {
971 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
973 $signature .= "$e->{NAME}, ";
975 $self->pidl("result = $py_name;");
976 $signature .= $e->{NAME};
981 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
982 $self->handle_ntstatus("r->out.result", "NULL", undef);
983 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
984 $self->handle_werror("r->out.result", "NULL", undef);
985 } elsif (defined($fn->{RETURN_TYPE})) {
986 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
987 if ($result_size > 1) {
988 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
990 $self->pidl("result = $conv;");
992 $signature .= "result";
995 if (substr($signature, -2) eq ", ") {
996 $signature = substr($signature, 0, -2);
998 if ($result_size > 1) {
1002 $self->pidl("return result;");
1007 return ($outfnname, $signature);
1010 sub PythonFunctionPackIn($$$)
1012 my ($self, $fn, $fnname) = @_;
1013 my $metadata_args = find_metadata_args($fn);
1015 my $infnname = "pack_$fnname\_args_in";
1017 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
1020 my $args_format = "";
1021 my $args_string = "";
1022 my $args_names = "";
1025 foreach my $e (@{$fn->{ELEMENTS}}) {
1026 next unless (grep(/in/,@{$e->{DIRECTION}}));
1027 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
1028 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
1029 $self->pidl("PyObject *py_$e->{NAME};");
1030 $args_format .= "O";
1031 $args_string .= ", &py_$e->{NAME}";
1032 $args_names .= "\"$e->{NAME}\", ";
1033 $signature .= "$e->{NAME}, ";
1035 if (substr($signature, -2) eq ", ") {
1036 $signature = substr($signature, 0, -2);
1038 $self->pidl("const char *kwnames[] = {");
1040 $self->pidl($args_names . "NULL");
1045 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
1047 $self->pidl("return false;");
1052 my $env = GenerateFunctionInEnv($fn, "r->");
1054 my $fail = "return false;";
1055 foreach my $e (@{$fn->{ELEMENTS}}) {
1056 next unless (grep(/in/,@{$e->{DIRECTION}}));
1057 if ($metadata_args->{in}->{$e->{NAME}}) {
1058 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
1059 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1060 my $val = "PyList_GET_SIZE($py_var)";
1061 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
1062 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
1063 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
1065 $self->pidl("PyErr_NoMemory();");
1069 $self->pidl("*r->in.$e->{NAME} = $val;");
1071 $self->pidl("r->in.$e->{NAME} = $val;");
1074 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
1077 $self->pidl("return true;");
1081 return ($infnname, $signature);
1084 sub PythonFunction($$$)
1086 my ($self, $fn, $iface, $prettyname) = @_;
1088 my $fnname = "py_$fn->{NAME}";
1089 my $docstring = $self->DocString($fn, $fn->{NAME});
1091 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
1092 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
1093 my $signature = "S.$prettyname($insignature) -> $outsignature";
1095 $docstring = "\"$signature\\n\\n\"$docstring";
1097 $docstring = "\"$signature\"";
1100 return ($infn, $outfn, $docstring);
1103 sub handle_werror($$$$)
1105 my ($self, $var, $retval, $mem_ctx) = @_;
1107 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
1109 $self->pidl("PyErr_SetWERROR($var);");
1110 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
1111 $self->pidl("return $retval;");
1117 sub handle_ntstatus($$$$)
1119 my ($self, $var, $retval, $mem_ctx) = @_;
1121 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
1123 $self->pidl("PyErr_SetNTSTATUS($var);");
1124 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
1125 $self->pidl("return $retval;");
1131 sub PythonType($$$$)
1133 my ($self, $modulename, $d, $interface, $basename) = @_;
1135 my $actual_ctype = $d;
1136 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1137 $actual_ctype = $actual_ctype->{DATA};
1140 if ($actual_ctype->{TYPE} eq "STRUCT") {
1142 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
1144 if ($d->{TYPE} eq "STRUCT") {
1145 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
1147 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
1150 $self->register_module_typeobject($fn_name, $typeobject, $d->{ORIGINAL});
1153 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
1154 $self->EnumAndBitmapConsts($d->{NAME}, $d);
1157 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
1158 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
1161 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
1162 my $prettyname = PrettifyTypeName($d->{NAME}, $basename);
1163 my $typeobject = "$d->{NAME}\_Type";
1164 my $docstring = $self->DocString($d, $d->{NAME});
1165 my $cname = "union $d->{NAME}";
1167 $self->pidl("static PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
1170 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
1175 $self->pidl("static ".mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
1178 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
1183 my $getsetters = "NULL";
1184 my $py_methods = "NULL";
1185 my $typename = mapTypeName($d);
1187 $self->pidl("static PyObject *py_$d->{NAME}\_import(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1190 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
1191 $self->pidl("PyObject *mem_ctx_obj = NULL;");
1192 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
1193 $self->pidl("int level = 0;");
1194 $self->pidl("PyObject *in_obj = NULL;");
1195 $self->pidl("$typename *in = NULL;");
1197 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
1199 $self->pidl("discard_const_p(char *, kwnames),");
1200 $self->pidl("&mem_ctx_obj,");
1201 $self->pidl("&level,");
1202 $self->pidl("&in_obj)) {");
1205 $self->pidl("return NULL;");
1208 $self->pidl("mem_ctx = pytalloc_get_ptr(mem_ctx_obj);");
1209 $self->pidl("if (mem_ctx == NULL) {");
1211 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
1212 $self->pidl("return NULL;");
1215 $self->pidl("in = ($typename *)pytalloc_get_ptr(in_obj);");
1216 $self->pidl("if (in == NULL) {");
1218 $self->pidl("PyErr_Format(PyExc_TypeError, \"in needs to be a pointer to $typename!\");");
1219 $self->pidl("return NULL;");
1223 $self->pidl("return py_import_$d->{NAME}(mem_ctx, level, in);");
1228 $self->pidl("static PyObject *py_$d->{NAME}\_export(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1231 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
1232 $self->pidl("PyObject *mem_ctx_obj = NULL;");
1233 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
1234 $self->pidl("int level = 0;");
1235 $self->pidl("PyObject *in = NULL;");
1236 $self->pidl("$typename *out = NULL;");
1238 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:export\",");
1240 $self->pidl("discard_const_p(char *, kwnames),");
1241 $self->pidl("&mem_ctx_obj,");
1242 $self->pidl("&level,");
1243 $self->pidl("&in)) {");
1246 $self->pidl("return NULL;");
1249 $self->pidl("mem_ctx = pytalloc_get_ptr(mem_ctx_obj);");
1250 $self->pidl("if (mem_ctx == NULL) {");
1252 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
1253 $self->pidl("return NULL;");
1257 $self->pidl("out = py_export_$d->{NAME}(mem_ctx, level, in);");
1258 $self->pidl("if (out == NULL) {");
1260 $self->pidl("return NULL;");
1264 $self->pidl("return pytalloc_GenericObject_reference(out);");
1269 $py_methods = "py_$d->{NAME}_methods";
1270 $self->pidl("static PyMethodDef $py_methods\[] = {");
1272 $self->pidl("{ \"__import__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$d->{NAME}\_import),");
1274 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
1275 $self->pidl("\"T.__import__(mem_ctx, level, in) => ret.\" },");
1277 $self->pidl("{ \"__export__\", PY_DISCARD_FUNC_SIG(PyCFunction,py_$d->{NAME}\_export),");
1279 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
1280 $self->pidl("\"T.__export__(mem_ctx, level, in) => ret.\" },");
1282 $self->pidl("{ NULL, NULL, 0, NULL }");
1287 $self->pidl("static PyObject *py_$d->{NAME}\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1290 $self->pidl("PyErr_Format(PyExc_TypeError, \"New %s Objects are not supported\", type->tp_name);");
1291 $self->pidl("return NULL;");
1297 $self->pidl_hdr("static PyTypeObject $typeobject;\n");
1298 $self->pidl("static PyTypeObject $typeobject = {");
1300 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
1301 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
1302 $self->pidl(".tp_getset = $getsetters,");
1304 $self->pidl(".tp_doc = $docstring,");
1306 $self->pidl(".tp_methods = $py_methods,");
1307 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1308 $self->pidl(".tp_new = py_$d->{NAME}\_new,");
1314 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
1315 $self->register_module_prereadycode(["$typeobject.tp_base = $talloc_typename;",
1316 "$typeobject.tp_basicsize = pytalloc_BaseObject_size();",
1319 $self->register_module_typeobject($prettyname, "&$typeobject", $d->{ORIGINAL});
1325 my ($self, $d, $name) = @_;
1326 if (has_property($d, "helpstring")) {
1327 my $docstring = uc("py_doc_$name");
1328 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
1337 my($self,$interface,$basename) = @_;
1339 if (has_property($interface, "pyhelper")) {
1340 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
1343 $self->Const($_) foreach (@{$interface->{CONSTS}});
1345 foreach my $d (@{$interface->{TYPES}}) {
1346 next if has_property($d, "nopython");
1348 $self->PythonType($basename, $d, $interface, $basename);
1351 if (defined $interface->{PROPERTIES}->{uuid}) {
1352 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
1357 foreach my $d (@{$interface->{FUNCTIONS}}) {
1358 next if has_property($d, "noopnum");
1359 next if has_property($d, "nopython");
1360 next if has_property($d, "todo");
1363 foreach my $e (@{$d->{ELEMENTS}}) {
1364 if (ContainsPipe($e, $e->{LEVELS}[0])) {
1371 my $prettyname = $d->{NAME};
1373 $prettyname =~ s/^$interface->{NAME}_//;
1374 $prettyname =~ s/^$basename\_//;
1376 my $typeobject = $self->PythonFunctionStruct($basename, $d, $interface->{NAME}, $prettyname);
1377 $self->register_module_typeobject($prettyname, $typeobject, $d->{ORIGINAL});
1379 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
1381 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
1384 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
1386 foreach my $d (@fns) {
1387 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
1388 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
1390 $self->pidl("{ NULL }");
1395 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1398 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
1405 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
1407 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
1408 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
1409 \"credentials should be a credentials.Credentials object.\\n\\n\"";
1411 my $docstring = $self->DocString($interface, $interface->{NAME});
1414 $docstring = "$signature$docstring";
1416 $docstring = $signature;
1419 my $if_typename = "$interface->{NAME}_InterfaceType";
1421 $self->pidl("static PyTypeObject $if_typename = {");
1423 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
1424 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
1425 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
1426 $self->pidl(".tp_doc = $docstring,");
1427 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1428 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
1434 $self->register_module_typeobject($interface->{NAME}, "&$if_typename", $interface->{ORIGINAL});
1435 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
1436 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
1437 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn NULL;", ""]);
1440 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1443 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
1449 my $signature = "\"$interface->{NAME}_abstract_syntax()\\n\"";
1451 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
1454 $docstring = "$signature$docstring";
1456 $docstring = $signature;
1459 my $syntax_typename = "$interface->{NAME}_SyntaxType";
1461 $self->pidl("static PyTypeObject $syntax_typename = {");
1463 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
1464 $self->pidl(".tp_name = \"$basename.$interface->{NAME}_abstract_syntax\",");
1465 $self->pidl(".tp_doc = $docstring,");
1466 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1467 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
1473 $self->register_module_typeobject("$interface->{NAME}_abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1474 if (not defined($self->existing_module_object("abstract_syntax"))) {
1475 # Only the first syntax gets registered with the legacy
1476 # "abstract_syntax" name
1477 $self->register_module_typeobject("abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1479 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
1480 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;",
1481 "$syntax_typename.tp_basicsize = pytalloc_BaseObject_size();",
1485 $self->pidl_hdr("\n");
1488 sub register_module_method($$$$$)
1490 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
1492 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
1495 sub register_module_typeobject($$$$)
1497 my ($self, $name, $py_name, $location) = @_;
1499 $self->register_module_object($name, "(PyObject *)(void *)$py_name", $location);
1501 $self->check_ready_type($py_name);
1503 $self->register_patch_type_call($name, $py_name);
1506 sub check_ready_type($$)
1508 my ($self, $py_name) = @_;
1509 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
1512 sub register_module_import($$)
1514 my ($self, $module_path) = @_;
1516 my $var_name = $module_path;
1517 $var_name =~ s/\./_/g;
1518 $var_name = "dep_$var_name";
1520 unless (defined $self->{module_imports_uniq}->{$var_name}) {
1521 my $h = { "key" => $var_name, "val" => $module_path};
1522 push @{$self->{module_imports}}, $h;
1523 $self->{module_imports_uniq}->{$var_name} = $h;
1528 sub import_type_variable($$$)
1530 my ($self, $module, $name) = @_;
1532 $self->register_module_import($module);
1533 unless (defined $self->{type_imports_uniq}->{$name}) {
1534 my $h = { "key" => $name, "val" => $module};
1535 push @{$self->{type_imports}}, $h;
1536 $self->{type_imports_uniq}->{$name} = $h;
1538 return "$name\_Type";
1541 sub use_type_variable($$)
1543 my ($self, $orig_ctype) = @_;
1544 # FIXME: Have a global lookup table for types that look different on the
1545 # wire than they are named in C?
1546 if ($orig_ctype->{NAME} eq "dom_sid2" or
1547 $orig_ctype->{NAME} eq "dom_sid28" or
1548 $orig_ctype->{NAME} eq "dom_sid0") {
1549 $orig_ctype->{NAME} = "dom_sid";
1551 if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
1552 $orig_ctype->{NAME} = "security_descriptor";
1555 my $ctype = resolveType($orig_ctype);
1556 unless (defined($ctype->{BASEFILE})) {
1559 # If this is an external type, make sure we do the right imports.
1560 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
1561 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
1563 return "&$ctype->{NAME}_Type";
1566 sub register_patch_type_call($$$)
1568 my ($self, $typename, $cvar) = @_;
1570 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
1574 sub register_module_prereadycode($$)
1576 my ($self, $code) = @_;
1578 push (@{$self->{prereadycode}}, @$code);
1581 sub register_module_postreadycode($$)
1583 my ($self, $code) = @_;
1585 push (@{$self->{postreadycode}}, @$code);
1588 sub existing_module_object($$)
1590 my ($self, $name) = @_;
1592 if (defined($self->{module_object_uniq}->{$name})) {
1593 return $self->{module_object_uniq}->{$name};
1599 sub register_module_object($$$$)
1601 my ($self, $name, $py_name, $location) = @_;
1603 my $existing = $self->existing_module_object($name);
1604 fatal($location, "module_object($name, $py_name) registered twice! $existing.") if defined($existing);
1606 push (@{$self->{module_objects}}, [$name, $py_name]);
1607 $self->{module_object_uniq}->{$name} = $py_name;
1612 my ($self, $dest, $src) = @_;
1613 if ($dest =~ /^\&/ and $src eq "NULL") {
1614 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
1615 } elsif ($dest =~ /^\&/) {
1616 my $destvar = get_value_of($dest);
1617 $self->pidl("$destvar = *$src;");
1619 $self->pidl("$dest = $src;");
1623 sub ConvertStringFromPythonData($$$$$)
1625 my ($self, $mem_ctx, $py_var, $target, $fail) = @_;
1629 $self->pidl("const char *test_str;");
1630 $self->pidl("const char *talloc_str;");
1631 $self->pidl("PyObject *unicode = NULL;");
1632 $self->pidl("if (PyUnicode_Check($py_var)) {");
1634 # FIXME: Use Unix charset setting rather than utf-8
1635 $self->pidl("unicode = PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\");");
1636 $self->pidl("if (unicode == NULL) {");
1638 $self->pidl("PyErr_NoMemory();");
1639 $self->pidl("$fail");
1643 $self->pidl("test_str = PyBytes_AS_STRING(unicode);");
1645 $self->pidl("} else if (PyBytes_Check($py_var)) {");
1647 $self->pidl("test_str = PyBytes_AS_STRING($py_var);");
1649 $self->pidl("} else {");
1651 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1652 $self->pidl("$fail");
1655 $self->pidl("talloc_str = talloc_strdup($mem_ctx, test_str);");
1656 $self->pidl("if (unicode != NULL) {");
1658 $self->pidl("Py_DECREF(unicode);");
1661 $self->pidl("if (talloc_str == NULL) {");
1663 $self->pidl("PyErr_NoMemory();");
1664 $self->pidl("$fail");
1667 $self->pidl("$target = talloc_str;");
1672 sub ConvertObjectFromPythonData($$$$$$;$$)
1674 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location, $switch) = @_;
1676 fatal($location, "undef type for $cvar") unless(defined($ctype));
1678 $ctype = resolveType($ctype);
1680 my $actual_ctype = $ctype;
1681 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1682 $actual_ctype = $actual_ctype->{DATA};
1685 # We need to cover ENUMs, BITMAPS and SCALAR values here, as
1686 # all could otherwise be assigned invalid integer values
1687 my $ctype_alias = "";
1689 if ($actual_ctype->{TYPE} eq "ENUM") {
1690 # Importantly, ENUM values are unsigned in pidl, and
1691 # typically map to uint32
1692 $ctype_alias = enum_type_fn($actual_ctype);
1693 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1694 $ctype_alias = bitmap_type_fn($actual_ctype);
1695 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1696 $ctype_alias = expandAlias($actual_ctype->{NAME});
1699 # This is the unsigned Python Integer -> C integer validation
1700 # case. The signed case is below.
1701 if ($ctype_alias =~ /^(uint[0-9]*|hyper|udlong|udlongr
1702 |NTTIME_hyper|NTTIME|NTTIME_1sec
1706 $self->pidl("const unsigned long long uint_max = ndr_sizeof2uintmax(sizeof($target));");
1707 $self->pidl("if (PyLong_Check($cvar)) {");
1709 $self->pidl("unsigned long long test_var;");
1710 $self->pidl("test_var = PyLong_AsUnsignedLongLong($cvar);");
1711 $self->pidl("if (PyErr_Occurred() != NULL) {");
1716 $self->pidl("if (test_var > uint_max) {");
1718 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %llu\",\\");
1719 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1723 $self->pidl("$target = test_var;");
1725 $self->pidl("} else if (PyInt_Check($cvar)) {");
1727 $self->pidl("long test_var;");
1728 $self->pidl("test_var = PyInt_AsLong($cvar);");
1729 $self->pidl("if (test_var < 0 || (unsigned long long)test_var > uint_max) {");
1731 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %ld\",\\");
1732 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1736 $self->pidl("$target = test_var;");
1738 $self->pidl("} else {");
1740 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1741 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1750 # Confirm the signed python integer fits in the C type
1751 # correctly. It is subtly different from the unsigned case
1752 # above, so while it looks like a duplicate, it is not
1753 # actually a duplicate.
1754 if ($ctype_alias =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1757 $self->pidl("const long long int_max = ndr_sizeof2intmax(sizeof($target));");
1758 $self->pidl("const long long int_min = -int_max - 1;");
1759 $self->pidl("if (PyLong_Check($cvar)) {");
1761 $self->pidl("long long test_var;");
1762 $self->pidl("test_var = PyLong_AsLongLong($cvar);");
1763 $self->pidl("if (PyErr_Occurred() != NULL) {");
1768 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1770 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %lld\",\\");
1771 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1775 $self->pidl("$target = test_var;");
1777 $self->pidl("} else if (PyInt_Check($cvar)) {");
1779 $self->pidl("long test_var;");
1780 $self->pidl("test_var = PyInt_AsLong($cvar);");
1781 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1783 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %ld\",\\");
1784 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1788 $self->pidl("$target = test_var;");
1790 $self->pidl("} else {");
1792 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1793 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1802 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1803 my $ctype_name = $self->use_type_variable($ctype);
1804 unless (defined ($ctype_name)) {
1805 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1806 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1809 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1810 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1812 $self->pidl("PyErr_NoMemory();");
1813 $self->pidl("$fail");
1816 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1820 if ($actual_ctype->{TYPE} eq "UNION") {
1821 my $ctype_name = $self->use_type_variable($ctype);
1822 unless (defined ($ctype_name)) {
1823 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1824 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1827 my $export = "pyrpc_export_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
1828 $self->assign($target, "(".mapTypeName($ctype)." *)$export");
1832 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1833 $self->pidl("$target = data_blob_talloc($mem_ctx, PyBytes_AS_STRING($cvar), PyBytes_GET_SIZE($cvar));");
1837 if ($actual_ctype->{TYPE} eq "SCALAR" and
1838 ($actual_ctype->{NAME} eq "string"
1839 or $actual_ctype->{NAME} eq "nbt_string"
1840 or $actual_ctype->{NAME} eq "nbt_name"
1841 or $actual_ctype->{NAME} eq "wrepl_nbt_name"
1842 or $actual_ctype->{NAME} eq "dns_string"
1843 or $actual_ctype->{NAME} eq "dnsp_string"
1844 or $actual_ctype->{NAME} eq "dns_name"
1845 or $actual_ctype->{NAME} eq "ipv4address"
1846 or $actual_ctype->{NAME} eq "ipv6address"
1847 or $actual_ctype->{NAME} eq "dnsp_name")) {
1848 $self->ConvertStringFromPythonData($mem_ctx, $cvar, $target, $fail);
1852 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1853 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1857 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1858 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1862 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1863 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1867 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1868 $self->pidl("$target = pytalloc_get_ptr($cvar);");
1872 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1873 $self->assign($target, "pytalloc_get_ptr($cvar)");
1877 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1881 sub ConvertObjectFromPythonLevel($$$$$$$$$)
1883 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail, $recurse) = @_;
1884 my $nl = GetNextLevel($e, $l);
1885 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1886 $nl = GetNextLevel($e, $nl);
1888 my $pl = GetPrevLevel($e, $l);
1889 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1890 $pl = GetPrevLevel($e, $pl);
1893 if ($recurse == 0) {
1894 $self->pidl("if ($py_var == NULL) {");
1896 $self->pidl("PyErr_Format(PyExc_AttributeError, \"Cannot delete NDR object: " .
1897 mapTypeName($var_name) . "\");");
1902 $recurse = $recurse + 1;
1904 if ($l->{TYPE} eq "POINTER") {
1905 my $need_deindent = 0;
1908 if ($l->{POINTER_TYPE} ne "ref") {
1909 $self->pidl("if ($py_var == Py_None) {");
1911 $self->pidl("$var_name = NULL;");
1913 $self->pidl("} else {");
1916 if ($nl->{TYPE} eq "POINTER") {
1921 if ($l->{POINTER_TYPE} eq "ref" or $need_deref == 1) {
1922 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1923 $self->pidl("if ($var_name == NULL) {");
1925 $self->pidl("PyErr_NoMemory();");
1929 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1930 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1931 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1932 $self->pidl("if ($var_name == NULL) {");
1934 $self->pidl("PyErr_NoMemory();");
1939 $self->pidl("$var_name = NULL;");
1941 if ($need_deref == 1) {
1942 my $ndr_pointer_typename = $self->import_type_variable("samba.dcerpc.base", "ndr_pointer");
1943 $self->pidl("$py_var = py_dcerpc_ndr_pointer_deref($ndr_pointer_typename, $py_var);");
1945 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1946 $var_name = get_value_of($var_name);
1948 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail, $recurse);
1949 if ($need_deindent == 1) {
1953 } elsif ($l->{TYPE} eq "ARRAY") {
1954 if ($pl && $pl->{TYPE} eq "POINTER") {
1955 $var_name = get_pointer_to($var_name);
1958 if (is_charset_array($e, $l)) {
1959 $self->ConvertStringFromPythonData($mem_ctx, $py_var, $var_name, $fail);
1961 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1962 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1965 $self->pidl("int $counter;");
1966 if (ArrayDynamicallyAllocated($e, $l)) {
1967 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1968 $self->pidl("if (!$var_name) { $fail; }");
1969 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1971 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
1973 $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));");
1974 $self->pidl("$fail");
1978 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1980 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail, 0);
1986 } elsif ($l->{TYPE} eq "DATA") {
1987 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1988 $var_name = get_pointer_to($var_name);
1990 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1991 } elsif ($l->{TYPE} eq "SWITCH") {
1992 $var_name = get_pointer_to($var_name);
1993 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1994 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1997 my $union_type = mapTypeName($nl->{DATA_TYPE});
1998 $self->pidl("$union_type *$switch_ptr;");
1999 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $nl->{DATA_TYPE}, $switch_ptr, $fail, $e->{ORIGINAL}, $switch);
2000 $self->fail_on_null($switch_ptr, $fail);
2001 $self->assign($var_name, "$switch_ptr");
2004 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
2005 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail, $recurse);
2007 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
2011 sub ConvertObjectFromPython($$$$$$$)
2013 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
2016 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail, $recurse);
2019 sub ConvertScalarToPython($$$$)
2021 my ($self, $ctypename, $cvar, $mem_ctx) = @_;
2023 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
2025 $ctypename = expandAlias($ctypename);
2027 if ($ctypename =~ /^(int64|dlong)$/) {
2028 return "PyLong_FromLongLong($cvar)";
2031 if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
2032 return "PyLong_FromUnsignedLongLong($cvar)";
2035 if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
2036 return "PyInt_FromLong($cvar)";
2039 # Needed to ensure unsigned values in a 32 or 16 bit enum is
2040 # cast correctly to a uint32_t, not sign extended to a a
2041 # possibly 64 bit unsigned long. (enums are signed in C,
2043 if ($ctypename =~ /^(uint32|uint3264)$/) {
2044 return "PyLong_FromUnsignedLongLong((uint32_t)$cvar)";
2047 if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
2048 return "PyInt_FromLong((uint16_t)$cvar)";
2051 if ($ctypename eq "DATA_BLOB") {
2052 return "PyBytes_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
2055 if ($ctypename eq "NTSTATUS") {
2056 return "PyErr_FromNTSTATUS($cvar)";
2059 if ($ctypename eq "WERROR") {
2060 return "PyErr_FromWERROR($cvar)";
2063 if ($ctypename eq "HRESULT") {
2064 return "PyErr_FromHRESULT($cvar)";
2067 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
2068 return "PyString_FromStringOrNULL($cvar)";
2071 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
2072 return "PyString_FromStringOrNULL($cvar)";
2076 if ($ctypename eq "string_array") {
2077 return "pytalloc_GenericObject_reference_ex($mem_ctx, $cvar)";
2079 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
2080 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
2081 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
2082 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
2083 if ($ctypename eq "pointer") {
2084 return "pytalloc_GenericObject_reference_ex($mem_ctx, $cvar)";
2087 die("Unknown scalar type $ctypename");
2090 sub ConvertObjectToPythonData($$$$$;$$)
2092 my ($self, $mem_ctx, $ctype, $cvar, $location, $switch) = @_;
2094 die("undef type for $cvar") unless(defined($ctype));
2096 $ctype = resolveType($ctype);
2098 my $actual_ctype = $ctype;
2099 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
2100 $actual_ctype = $actual_ctype->{DATA};
2103 if ($actual_ctype->{TYPE} eq "ENUM") {
2104 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar, $mem_ctx);
2105 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
2106 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar, $mem_ctx);
2107 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
2108 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar, $mem_ctx);
2109 } elsif ($actual_ctype->{TYPE} eq "UNION") {
2110 my $ctype_name = $self->use_type_variable($ctype);
2111 unless (defined($ctype_name)) {
2112 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
2113 return "NULL"; # FIXME!
2115 return "pyrpc_import_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
2116 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
2117 my $ctype_name = $self->use_type_variable($ctype);
2118 unless (defined($ctype_name)) {
2119 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
2120 return "NULL"; # FIXME!
2122 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
2125 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
2128 sub fail_on_null($$$)
2130 my ($self, $var, $fail) = @_;
2131 $self->pidl("if ($var == NULL) {");
2138 sub ConvertObjectToPythonLevel($$$$$$$)
2140 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail, $recurse) = @_;
2141 my $nl = GetNextLevel($e, $l);
2142 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
2143 $nl = GetNextLevel($e, $nl);
2145 my $pl = GetPrevLevel($e, $l);
2146 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
2147 $pl = GetPrevLevel($e, $pl);
2150 if ($l->{TYPE} eq "POINTER") {
2152 if ($l->{POINTER_TYPE} ne "ref" and $nl->{TYPE} eq "POINTER") {
2155 if ($l->{POINTER_TYPE} ne "ref") {
2156 if ($recurse == 0) {
2157 $self->pidl("if ($var_name == NULL) {");
2159 $self->pidl("$py_var = Py_None;");
2160 $self->pidl("Py_INCREF($py_var);");
2162 $self->pidl("} else {");
2168 $recurse = $recurse + 1;
2170 my $var_name2 = $var_name;
2171 my $recurse2 = $recurse;
2172 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
2173 $var_name2 = get_value_of($var_name);
2176 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail, $recurse2);
2177 if ($l->{POINTER_TYPE} ne "ref") {
2182 my $py_var_wrap = undef;
2186 $py_var_wrap = "py_$e->{NAME}_level_$l->{LEVEL_INDEX}";
2187 $self->pidl("PyObject *$py_var_wrap = $py_var;");
2188 my $ndr_pointer_typename = $self->import_type_variable("samba.dcerpc.base", "ndr_pointer");
2189 $self->pidl("$py_var = py_dcerpc_ndr_pointer_wrap($ndr_pointer_typename, $py_var_wrap);");
2190 $self->pidl("Py_XDECREF($py_var_wrap);");
2194 } elsif ($l->{TYPE} eq "ARRAY") {
2195 if ($pl && $pl->{TYPE} eq "POINTER") {
2196 $var_name = get_pointer_to($var_name);
2199 if (is_charset_array($e, $l)) {
2200 # FIXME: Use Unix charset setting rather than utf-8
2201 $self->pidl("if ($var_name == NULL) {");
2203 $self->pidl("$py_var = Py_None;");
2204 $self->pidl("Py_INCREF($py_var);");
2206 $self->pidl("} else {");
2208 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
2212 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
2213 my $length = $l->{SIZE_IS};
2214 if (defined($l->{LENGTH_IS})) {
2215 $length = $l->{LENGTH_IS};
2218 $length = ParseExpr($length, $env, $e);
2219 $self->pidl("$py_var = PyList_New($length);");
2220 $self->fail_on_null($py_var, $fail);
2223 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
2224 $self->pidl("int $counter;");
2225 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
2227 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
2228 $self->pidl("PyObject *$member_var;");
2229 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail, $recurse);
2230 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
2236 } elsif ($l->{TYPE} eq "SWITCH") {
2237 $var_name = get_pointer_to($var_name);
2238 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
2239 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $nl->{DATA_TYPE}, $var_name, $e->{ORIGINAL}, $switch);
2240 $self->pidl("$py_var = $conv;");
2241 $self->fail_on_null($py_var, $fail);
2243 } elsif ($l->{TYPE} eq "DATA") {
2244 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
2245 $var_name = get_pointer_to($var_name);
2247 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
2248 $self->pidl("$py_var = $conv;");
2249 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
2250 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail, $recurse);
2252 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
2256 sub ConvertObjectToPython($$$$$$)
2258 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
2261 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail, $recurse);
2266 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
2268 $self->{BASENAME} = $basename;
2271 /* Python wrapper functions auto-generated by pidl */
2272 #define PY_SSIZE_T_CLEAN 1 /* We use Py_ssize_t for PyArg_ParseTupleAndKeywords */
2274 #include \"python/py3compat.h\"
2275 #include \"includes.h\"
2276 #include \"python/modules.h\"
2277 #include <pytalloc.h>
2278 #include \"librpc/rpc/pyrpc.h\"
2279 #include \"librpc/rpc/pyrpc_util.h\"
2281 #include \"$ndr_hdr\"
2284 * These functions are here to ensure they can be optimized out by
2285 * the compiler based on the constant input values
2288 static inline unsigned long long ndr_sizeof2uintmax(size_t var_size)
2304 static inline long long ndr_sizeof2intmax(size_t var_size)
2322 foreach my $x (@$ndr) {
2323 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
2324 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
2327 $self->pidl("static PyMethodDef $basename\_methods[] = {");
2329 foreach (@{$self->{module_methods}}) {
2330 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
2331 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
2334 $self->pidl("{ NULL, NULL, 0, NULL }");
2340 $self->pidl("static struct PyModuleDef moduledef = {");
2342 $self->pidl("PyModuleDef_HEAD_INIT,");
2343 $self->pidl(".m_name = \"$basename\",");
2344 $self->pidl(".m_doc = \"$basename DCE/RPC\",");
2345 $self->pidl(".m_size = -1,");
2346 $self->pidl(".m_methods = $basename\_methods,");
2350 $self->pidl("MODULE_INIT_FUNC($basename)");
2353 $self->pidl("PyObject *m = NULL;");
2354 foreach my $h (@{$self->{module_imports}}) {
2355 $self->pidl("PyObject *$h->{'key'} = NULL;");
2359 foreach my $h (@{$self->{module_imports}}) {
2360 my $var_name = $h->{'key'};
2361 my $module_path = $h->{'val'};
2362 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
2363 $self->pidl("if ($var_name == NULL)");
2364 $self->pidl("\tgoto out;");
2368 foreach my $h (@{$self->{type_imports}}) {
2369 my $type_var = "$h->{'key'}\_Type";
2370 my $module_path = $h->{'val'};
2371 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
2372 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
2373 my $module_var = "dep_$module_path";
2374 $module_var =~ s/\./_/g;
2375 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
2376 $self->pidl("if ($type_var == NULL)");
2377 $self->pidl("\tgoto out;");
2381 $self->pidl($_) foreach (@{$self->{prereadycode}});
2383 foreach (@{$self->{ready_types}}) {
2384 $self->pidl("if (PyType_Ready($_) < 0)");
2385 $self->pidl("\tgoto out;");
2388 $self->pidl($_) foreach (@{$self->{postreadycode}});
2390 foreach (@{$self->{patch_type_calls}}) {
2391 my ($typename, $cvar) = @$_;
2392 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
2393 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
2394 $self->pidl("#endif");
2399 $self->pidl("m = PyModule_Create(&moduledef);");
2400 $self->pidl("if (m == NULL)");
2401 $self->pidl("\tgoto out;");
2403 foreach my $h (@{$self->{constants}}) {
2404 my $pretty_name = PrettifyTypeName($h->{'key'}, $basename);
2406 my ($ctype, $cvar) = @{$h->{'val'}};
2407 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
2408 $py_obj = "PyLong_FromUnsignedLongLong($cvar)";
2409 } elsif ($cvar =~ /^".*"$/) {
2410 $py_obj = "PyUnicode_FromString($cvar)";
2412 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
2415 $self->pidl("PyModule_AddObject(m, \"$pretty_name\", $py_obj);");
2418 foreach (@{$self->{module_objects}}) {
2419 my ($object_name, $c_name) = @$_;
2420 $self->pidl("Py_INCREF($c_name);");
2421 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
2424 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
2425 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
2426 $self->pidl("#endif");
2427 $self->pidl("out:");
2428 foreach my $h (@{$self->{module_imports}}) {
2429 my $mod_var = $h->{'key'};
2430 $self->pidl("Py_XDECREF($mod_var);");
2432 $self->pidl("return m;");
2436 return ($self->{res_hdr} . $self->{res});