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) = @_;
128 $self->pidl("PyObject *ret = NULL;");
131 $self->pidl("switch ($switch) {");
133 foreach my $e (@{$type->{ELEMENTS}}) {
134 $self->pidl("$e->{CASE}:");
135 if ($e->{CASE} eq "default") { $has_default = 1; }
140 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
142 $self->pidl("ret = Py_None;");
143 $self->pidl("Py_INCREF(ret);");
146 $self->pidl("break;");
153 $self->pidl("default:");
155 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
156 $self->pidl("ret = NULL;");
157 $self->pidl("break;");
163 $self->pidl("return ret;");
166 sub FromPythonToUnionFunction($$$$$)
168 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
172 $self->pidl("$typename *ret = NULL;");
174 $self->pidl("ret = talloc_zero($mem_ctx, $typename);");
175 $self->pidl("if (ret == NULL) {");
177 $self->pidl("PyErr_NoMemory();");
178 $self->pidl("return NULL;");
183 my $fail = "TALLOC_FREE(ret); return NULL;";
185 $self->pidl("switch ($switch) {");
187 foreach my $e (@{$type->{ELEMENTS}}) {
188 $self->pidl("$e->{CASE}:");
189 if ($e->{CASE} eq "default") { $has_default = 1; }
192 $self->ConvertObjectFromPython({}, "ret", $e, $name, "ret->$e->{NAME}", $fail);
194 $self->pidl("break;");
200 $self->pidl("default:");
202 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
203 $self->pidl("TALLOC_FREE(ret);");
204 $self->pidl("break;");
210 $self->pidl("return ret;");
213 sub PythonElementGetSet($$$$$$) {
214 my ($self, $name, $cname, $ename, $e, $env) = @_;
216 my $varname = "object->$ename";
217 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
220 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
221 $self->pidl("PyObject *py_$e->{NAME};");
222 $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
223 $self->pidl("return py_$e->{NAME};");
228 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
231 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
232 my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
233 my $l = $e->{LEVELS}[0];
234 my $nl = GetNextLevel($e, $l);
235 if ($l->{TYPE} eq "POINTER" and
236 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
237 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
238 $self->pidl("talloc_unlink($mem_ctx, discard_const($varname));");
240 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
241 $self->pidl("return 0;");
247 sub PythonStruct($$$$$$)
249 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
251 my $env = GenerateStructEnv($d, "object");
255 my $getsetters = "NULL";
257 if ($#{$d->{ELEMENTS}} > -1) {
258 foreach my $e (@{$d->{ELEMENTS}}) {
259 $self->PythonElementGetSet($name, $cname, $e->{NAME}, $e, $env);
262 $getsetters = "py_$name\_getsetters";
263 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
265 foreach my $e (@{$d->{ELEMENTS}}) {
267 if (ref($e->{TYPE}) eq "HASH") {
268 $etype = $e->{TYPE}->{NAME};
274 $self->pidl(".name = discard_const_p(char, \"$e->{NAME}\"),");
275 $self->pidl(".get = py_$name\_get_$e->{NAME},");
276 $self->pidl(".set = py_$name\_set_$e->{NAME},");
277 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $etype\")");
281 $self->pidl("{ .name = NULL }");
287 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
290 $self->pidl("return pytalloc_new($cname, type);");
295 my $py_methods = "NULL";
297 # If the struct is not public there ndr_pull/ndr_push functions will
298 # be static so not callable from here
299 if (has_property($d, "public")) {
300 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
303 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
304 $self->pidl("PyObject *ret = NULL;");
305 $self->pidl("DATA_BLOB blob;");
306 $self->pidl("enum ndr_err_code err;");
307 $self->pidl("TALLOC_CTX *tmp_ctx = talloc_new(pytalloc_get_mem_ctx(py_obj));");
308 $self->pidl("if (tmp_ctx == NULL) {");
310 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
311 $self->pidl("return NULL;");
314 $self->pidl("err = ndr_push_struct_blob(&blob, tmp_ctx, object, (ndr_push_flags_fn_t)ndr_push_$name);");
315 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
317 $self->pidl("TALLOC_FREE(tmp_ctx);");
318 $self->pidl("PyErr_SetNdrError(err);");
319 $self->pidl("return NULL;");
323 $self->pidl("ret = PyBytes_FromStringAndSize((char *)blob.data, blob.length);");
324 $self->pidl("TALLOC_FREE(tmp_ctx);");
325 $self->pidl("return ret;");
330 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
333 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
334 $self->pidl("DATA_BLOB blob;");
335 $self->pidl("Py_ssize_t blob_length = 0;");
336 $self->pidl("enum ndr_err_code err;");
337 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
338 $self->pidl("PyObject *allow_remaining_obj = NULL;");
339 $self->pidl("bool allow_remaining = false;");
341 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, PYARG_BYTES_LEN \"|O:__ndr_unpack__\",");
343 $self->pidl("discard_const_p(char *, kwnames),");
344 $self->pidl("&blob.data, &blob_length,");
345 $self->pidl("&allow_remaining_obj)) {");
348 $self->pidl("return NULL;");
351 $self->pidl("blob.length = blob_length;");
353 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
355 $self->pidl("allow_remaining = true;");
359 $self->pidl("if (allow_remaining) {");
361 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
363 $self->pidl("} else {");
365 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
368 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
370 $self->pidl("PyErr_SetNdrError(err);");
371 $self->pidl("return NULL;");
375 $self->pidl("Py_RETURN_NONE;");
380 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
383 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
384 $self->pidl("PyObject *ret;");
385 $self->pidl("char *retstr;");
387 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
388 $self->pidl("ret = PyStr_FromString(retstr);");
389 $self->pidl("talloc_free(retstr);");
391 $self->pidl("return ret;");
396 $py_methods = "py_$name\_methods";
397 $self->pidl("static PyMethodDef $py_methods\[] = {");
399 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
400 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
401 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_NOARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
402 $self->pidl("{ NULL, NULL, 0, NULL }");
408 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
410 my $docstring = $self->DocString($d, $name);
411 my $typeobject = "$name\_Type";
412 $self->pidl("static PyTypeObject $typeobject = {");
414 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
415 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
416 $self->pidl(".tp_getset = $getsetters,");
418 $self->pidl(".tp_doc = $docstring,");
420 $self->pidl(".tp_methods = $py_methods,");
421 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
422 $self->pidl(".tp_new = py_$name\_new,");
428 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
429 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
430 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
433 return "&$typeobject";
436 sub PythonFunctionStruct($$$$)
438 my ($self, $modulename, $fn, $iface, $prettyname) = @_;
440 my $inenv = GenerateFunctionInEnv($fn, "object->");
441 my $outenv = GenerateFunctionOutEnv($fn, "object->");
443 my $name = "$fn->{NAME}";
444 my $cname = "struct $name";
448 my $getsetters = "NULL";
450 foreach my $e (@{$fn->{ELEMENTS}}) {
451 if (grep(/in/,@{$e->{DIRECTION}})) {
452 my $inname = "$name\_in";
453 my $ename = "in.$e->{NAME}";
454 $self->PythonElementGetSet($inname, $cname, $ename, $e, $inenv);
456 if (grep(/out/,@{$e->{DIRECTION}})) {
457 my $outname = "$name\_out";
458 my $ename = "out.$e->{NAME}";
459 $self->PythonElementGetSet($outname, $cname, $ename, $e, $outenv);
463 if (defined($fn->{RETURN_TYPE})) {
464 my $e = ReturnTypeElement($fn);
465 my $ename = "out.result";
466 $self->PythonElementGetSet($name, $cname, $ename, $e, $outenv);
469 $getsetters = "py_$name\_getsetters";
470 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
472 foreach my $e (@{$fn->{ELEMENTS}}) {
473 if (grep(/in/,@{$e->{DIRECTION}})) {
476 $self->pidl(".name = discard_const_p(char, \"in_$e->{NAME}\"),");
477 $self->pidl(".get = py_$name\_in_get_$e->{NAME},");
478 $self->pidl(".set = py_$name\_in_set_$e->{NAME},");
479 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
483 if (grep(/out/,@{$e->{DIRECTION}})) {
486 $self->pidl(".name = discard_const_p(char, \"out_$e->{NAME}\"),");
487 $self->pidl(".get = py_$name\_out_get_$e->{NAME},");
488 $self->pidl(".set = py_$name\_out_set_$e->{NAME},");
489 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
494 if (defined($fn->{RETURN_TYPE})) {
497 $self->pidl(".name = discard_const_p(char, \"result\"),");
498 $self->pidl(".get = py_$name\_get_result,");
499 $self->pidl(".set = py_$name\_set_result,");
500 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of type $fn->{RETURN_TYPE}\")");
504 $self->pidl("{ .name = NULL }");
509 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
512 $self->pidl("return pytalloc_new($cname, type);");
517 my $py_methods = "NULL";
519 my $ndr_call = "const struct ndr_interface_call *call = NULL;";
520 my $object_ptr = "$cname *object = ($cname *)pytalloc_get_ptr(py_obj);";
522 $self->pidl("static PyObject *py_$name\_ndr_opnum(PyTypeObject *type)");
527 $self->pidl("return PyInt_FromLong($fn->{OPNUM});");
532 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj, int ndr_inout_flags, uint32_t ndr_push_flags)");
535 $self->pidl("$ndr_call");
536 $self->pidl("$object_ptr");
537 $self->pidl("PyObject *ret = NULL;");
538 $self->pidl("struct ndr_push *push = NULL;");
539 $self->pidl("DATA_BLOB blob;");
540 $self->pidl("enum ndr_err_code err;");
542 $self->pidl("if (ndr_table_$iface\.num_calls < " . ($fn->{OPNUM}+1) .
545 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_pack\");");
546 $self->pidl("return NULL;");
549 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
551 $self->pidl("push = ndr_push_init_ctx(pytalloc_get_mem_ctx(py_obj));");
552 $self->pidl("if (push == NULL) {");
554 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
555 $self->pidl("return NULL;");
559 $self->pidl("push->flags |= ndr_push_flags;");
561 $self->pidl("err = call->ndr_push(push, ndr_inout_flags, object);");
562 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
564 $self->pidl("TALLOC_FREE(push);");
565 $self->pidl("PyErr_SetNdrError(err);");
566 $self->pidl("return NULL;");
569 $self->pidl("blob = ndr_push_blob(push);");
570 $self->pidl("ret = PyBytes_FromStringAndSize((char *)blob.data, blob.length);");
571 $self->pidl("TALLOC_FREE(push);");
572 $self->pidl("return ret;");
577 $self->pidl("static PyObject *py_$name\_ndr_pack_in(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
580 $self->pidl("const char * const kwnames[] = { \"bigendian\", \"ndr64\", NULL };");
581 $self->pidl("PyObject *bigendian_obj = NULL;");
582 $self->pidl("PyObject *ndr64_obj = NULL;");
583 $self->pidl("uint32_t ndr_push_flags = 0;");
585 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"|OO:__ndr_pack_in__\",");
587 $self->pidl("discard_const_p(char *, kwnames),");
588 $self->pidl("&bigendian_obj,");
589 $self->pidl("&ndr64_obj)) {");
592 $self->pidl("return NULL;");
596 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
598 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_BIGENDIAN;");
601 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
603 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_NDR64;");
607 $self->pidl("return py_$name\_ndr_pack(py_obj, NDR_IN, ndr_push_flags);");
612 $self->pidl("static PyObject *py_$name\_ndr_pack_out(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
615 $self->pidl("const char * const kwnames[] = { \"bigendian\", \"ndr64\", NULL };");
616 $self->pidl("PyObject *bigendian_obj = NULL;");
617 $self->pidl("PyObject *ndr64_obj = NULL;");
618 $self->pidl("uint32_t ndr_push_flags = 0;");
620 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"|OO:__ndr_pack_out__\",");
622 $self->pidl("discard_const_p(char *, kwnames),");
623 $self->pidl("&bigendian_obj,");
624 $self->pidl("&ndr64_obj)) {");
627 $self->pidl("return NULL;");
631 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
633 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_BIGENDIAN;");
636 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
638 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_NDR64;");
642 $self->pidl("return py_$name\_ndr_pack(py_obj, NDR_OUT, ndr_push_flags);");
647 $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)");
650 $self->pidl("$ndr_call");
651 $self->pidl("$object_ptr");
652 $self->pidl("struct ndr_pull *pull = NULL;");
653 $self->pidl("enum ndr_err_code err;");
655 $self->pidl("if (ndr_table_$iface\.num_calls < " . ($fn->{OPNUM}+1) .
658 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_unpack\");");
659 $self->pidl("return NULL;");
662 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
664 $self->pidl("pull = ndr_pull_init_blob(blob, object);");
665 $self->pidl("if (pull == NULL) {");
667 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
668 $self->pidl("return NULL;");
672 $self->pidl("pull->flags |= ndr_pull_flags;");
674 $self->pidl("err = call->ndr_pull(pull, ndr_inout_flags, object);");
675 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
677 $self->pidl("TALLOC_FREE(pull);");
678 $self->pidl("PyErr_SetNdrError(err);");
679 $self->pidl("return NULL;");
682 $self->pidl("if (!allow_remaining) {");
684 $self->pidl("uint32_t highest_ofs;");
686 $self->pidl("if (pull->offset > pull->relative_highest_offset) {");
688 $self->pidl("highest_ofs = pull->offset;");
690 $self->pidl("} else {");
692 $self->pidl("highest_ofs = pull->relative_highest_offset;");
695 $self->pidl("if (highest_ofs < pull->data_size) {");
697 $self->pidl("err = ndr_pull_error(pull, NDR_ERR_UNREAD_BYTES,");
699 $self->pidl("\"not all bytes consumed ofs[%u] size[%u]\",");
700 $self->pidl("highest_ofs, pull->data_size);");
702 $self->pidl("TALLOC_FREE(pull);");
703 $self->pidl("PyErr_SetNdrError(err);");
704 $self->pidl("return NULL;");
710 $self->pidl("TALLOC_FREE(pull);");
711 $self->pidl("Py_RETURN_NONE;");
716 $self->pidl("static PyObject *py_$name\_ndr_unpack_in(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
719 $self->pidl("DATA_BLOB blob;");
720 $self->pidl("Py_ssize_t blob_length = 0;");
721 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"bigendian\", \"ndr64\", \"allow_remaining\", NULL };");
722 $self->pidl("PyObject *bigendian_obj = NULL;");
723 $self->pidl("PyObject *ndr64_obj = NULL;");
724 $self->pidl("uint32_t ndr_pull_flags = LIBNDR_FLAG_REF_ALLOC;");
725 $self->pidl("PyObject *allow_remaining_obj = NULL;");
726 $self->pidl("bool allow_remaining = false;");
728 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, PYARG_BYTES_LEN \"|OOO:__ndr_unpack_in__\",");
730 $self->pidl("discard_const_p(char *, kwnames),");
731 $self->pidl("&blob.data, &blob_length,");
732 $self->pidl("&bigendian_obj,");
733 $self->pidl("&ndr64_obj,");
734 $self->pidl("&allow_remaining_obj)) {");
737 $self->pidl("return NULL;");
740 $self->pidl("blob.length = blob_length;");
742 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
744 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_BIGENDIAN;");
747 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
749 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_NDR64;");
753 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
755 $self->pidl("allow_remaining = true;");
759 $self->pidl("return py_$name\_ndr_unpack(py_obj, &blob, NDR_IN, ndr_pull_flags, allow_remaining);");
764 $self->pidl("static PyObject *py_$name\_ndr_unpack_out(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
767 $self->pidl("DATA_BLOB blob;");
768 $self->pidl("Py_ssize_t blob_length = 0;");
769 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"bigendian\", \"ndr64\", \"allow_remaining\", NULL };");
770 $self->pidl("PyObject *bigendian_obj = NULL;");
771 $self->pidl("PyObject *ndr64_obj = NULL;");
772 $self->pidl("uint32_t ndr_pull_flags = LIBNDR_FLAG_REF_ALLOC;");
773 $self->pidl("PyObject *allow_remaining_obj = NULL;");
774 $self->pidl("bool allow_remaining = false;");
776 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, PYARG_BYTES_LEN \"|OOO:__ndr_unpack_out__\",");
778 $self->pidl("discard_const_p(char *, kwnames),");
779 $self->pidl("&blob.data, &blob_length,");
780 $self->pidl("&bigendian_obj,");
781 $self->pidl("&ndr64_obj,");
782 $self->pidl("&allow_remaining_obj)) {");
785 $self->pidl("return NULL;");
788 $self->pidl("blob.length = blob_length;");
790 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
792 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_BIGENDIAN;");
795 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
797 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_NDR64;");
801 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
803 $self->pidl("allow_remaining = true;");
807 $self->pidl("return py_$name\_ndr_unpack(py_obj, &blob, NDR_OUT, ndr_pull_flags, allow_remaining);");
812 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj, const char *name, int ndr_inout_flags)");
815 $self->pidl("$ndr_call");
816 $self->pidl("$object_ptr");
817 $self->pidl("PyObject *ret;");
818 $self->pidl("char *retstr;");
820 $self->pidl("if (ndr_table_$iface\.num_calls < " . ($fn->{OPNUM}+1) .
823 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_print\");");
824 $self->pidl("return NULL;");
827 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
829 $self->pidl("retstr = ndr_print_function_string(pytalloc_get_mem_ctx(py_obj), call->ndr_print, name, ndr_inout_flags, object);");
830 $self->pidl("ret = PyStr_FromString(retstr);");
831 $self->pidl("TALLOC_FREE(retstr);");
833 $self->pidl("return ret;");
838 $self->pidl("static PyObject *py_$name\_ndr_print_in(PyObject *py_obj, PyObject *py_obj2)");
841 $self->pidl("return py_$name\_ndr_print(py_obj, \"$name\_in\", NDR_IN);");
846 $self->pidl("static PyObject *py_$name\_ndr_print_out(PyObject *py_obj, PyObject *py_obj2)");
849 $self->pidl("return py_$name\_ndr_print(py_obj, \"$name\_out\", NDR_OUT);");
854 $py_methods = "py_$name\_methods";
855 $self->pidl("static PyMethodDef $py_methods\[] = {");
857 $self->pidl("{ \"opnum\", (PyCFunction)py_$name\_ndr_opnum, METH_NOARGS|METH_CLASS,");
859 $self->pidl("\"$modulename.$prettyname.opnum() -> ".sprintf("%d (0x%02x)", $fn->{OPNUM}, $fn->{OPNUM})." \" },");
861 $self->pidl("{ \"__ndr_pack_in__\", (PyCFunction)py_$name\_ndr_pack_in, METH_VARARGS|METH_KEYWORDS,");
863 $self->pidl("\"S.ndr_pack_in(object, bigendian=False, ndr64=False) -> blob\\nNDR pack input\" },");
865 $self->pidl("{ \"__ndr_pack_out__\", (PyCFunction)py_$name\_ndr_pack_out, METH_VARARGS|METH_KEYWORDS,");
867 $self->pidl("\"S.ndr_pack_out(object, bigendian=False, ndr64=False) -> blob\\nNDR pack output\" },");
869 $self->pidl("{ \"__ndr_unpack_in__\", (PyCFunction)py_$name\_ndr_unpack_in, METH_VARARGS|METH_KEYWORDS,");
871 $self->pidl("\"S.ndr_unpack_in(class, blob, bigendian=False, ndr64=False, allow_remaining=False) -> None\\nNDR unpack input\" },");
873 $self->pidl("{ \"__ndr_unpack_out__\", (PyCFunction)py_$name\_ndr_unpack_out, METH_VARARGS|METH_KEYWORDS,");
875 $self->pidl("\"S.ndr_unpack_out(class, blob, bigendian=False, ndr64=False, allow_remaining=False) -> None\\nNDR unpack output\" },");
877 $self->pidl("{ \"__ndr_print_in__\", (PyCFunction)py_$name\_ndr_print_in, METH_NOARGS, \"S.ndr_print_in(object) -> None\\nNDR print input\" },");
878 $self->pidl("{ \"__ndr_print_out__\", (PyCFunction)py_$name\_ndr_print_out, METH_NOARGS, \"S.ndr_print_out(object) -> None\\nNDR print output\" },");
879 $self->pidl("{ NULL, NULL, 0, NULL }");
884 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
886 my $docstring = $self->DocString($fn, $name);
887 my $typeobject = "$name\_Type";
888 $self->pidl("static PyTypeObject $typeobject = {");
890 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
891 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
892 $self->pidl(".tp_getset = $getsetters,");
894 $self->pidl(".tp_doc = $docstring,");
896 $self->pidl(".tp_methods = $py_methods,");
897 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
898 $self->pidl(".tp_new = py_$name\_new,");
904 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
905 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
906 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
909 return "&$typeobject";
912 sub get_metadata_var($)
915 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
917 if (has_property($e, "length_is")) {
918 return get_var($e->{PROPERTIES}->{length_is});
919 } elsif (has_property($e, "size_is")) {
920 return get_var($e->{PROPERTIES}->{size_is});
926 sub find_metadata_args($)
929 my $metadata_args = { in => {}, out => {} };
931 # Determine arguments that are metadata for other arguments (size_is/length_is)
932 foreach my $e (@{$fn->{ELEMENTS}}) {
933 foreach my $dir (@{$e->{DIRECTION}}) {
934 my $main = get_metadata_var($e);
936 $metadata_args->{$dir}->{$main} = $e->{NAME};
941 return $metadata_args;
944 sub PythonFunctionUnpackOut($$$)
946 my ($self, $fn, $fnname) = @_;
948 my $outfnname = "unpack_$fnname\_args_out";
951 my $metadata_args = find_metadata_args($fn);
953 my $env = GenerateFunctionOutEnv($fn, "r->");
956 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
959 $self->pidl("PyObject *result = NULL;");
960 foreach my $e (@{$fn->{ELEMENTS}}) {
961 next unless (grep(/out/,@{$e->{DIRECTION}}));
962 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
963 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
964 $self->pidl("PyObject *py_$e->{NAME} = NULL;");
968 if ($fn->{RETURN_TYPE}) {
969 if ($fn->{RETURN_TYPE} ne "WERROR" and $fn->{RETURN_TYPE} ne "NTSTATUS") {
970 $self->pidl("PyObject *py_result = NULL;");
977 my $fail = "return NULL;";
979 if ($result_size > 1) {
980 $self->pidl("int ret;");
982 $self->pidl("result = PyTuple_New($result_size);");
983 $self->fail_on_null("result", $fail);
984 $fail = "Py_DECREF(result); " . $fail;
987 } elsif ($result_size == 0) {
989 $self->pidl("result = Py_None;");
990 $self->pidl("Py_INCREF(result);");
991 $signature .= "None";
996 foreach my $e (@{$fn->{ELEMENTS}}) {
997 next if ($metadata_args->{out}->{$e->{NAME}});
998 my $py_name = "py_$e->{NAME}";
999 if (grep(/out/,@{$e->{DIRECTION}})) {
1000 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, $fail);
1001 if ($result_size > 1) {
1002 $self->pidl("ret = PyTuple_SetItem(result, $i, $py_name);");
1003 $self->pidl("if (ret != 0) {");
1009 $signature .= "$e->{NAME}, ";
1011 $self->pidl("result = $py_name;");
1012 $signature .= $e->{NAME};
1018 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
1019 $self->handle_ntstatus("r->out.result", "NULL", undef);
1021 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
1022 $self->handle_werror("r->out.result", "NULL", undef);
1024 } elsif (defined($fn->{RETURN_TYPE})) {
1025 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
1026 $self->pidl("py_result = $conv;");
1027 $self->fail_on_null("py_result", $fail);
1028 if ($result_size > 1) {
1029 $self->pidl("ret = PyTuple_SetItem(result, $i, py_result);");
1030 $self->pidl("if (ret != 0) {");
1036 $self->pidl("result = py_result;");
1039 $signature .= "result";
1042 if (substr($signature, -2) eq ", ") {
1043 $signature = substr($signature, 0, -2);
1045 if ($result_size > 1) {
1049 $self->pidl("return result;");
1054 return ($outfnname, $signature);
1057 sub PythonFunctionPackIn($$$)
1059 my ($self, $fn, $fnname) = @_;
1060 my $metadata_args = find_metadata_args($fn);
1062 my $infnname = "pack_$fnname\_args_in";
1064 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
1067 my $args_format = "";
1068 my $args_string = "";
1069 my $args_names = "";
1072 foreach my $e (@{$fn->{ELEMENTS}}) {
1073 next unless (grep(/in/,@{$e->{DIRECTION}}));
1074 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
1075 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
1076 $self->pidl("PyObject *py_$e->{NAME};");
1077 $args_format .= "O";
1078 $args_string .= ", &py_$e->{NAME}";
1079 $args_names .= "\"$e->{NAME}\", ";
1080 $signature .= "$e->{NAME}, ";
1082 if (substr($signature, -2) eq ", ") {
1083 $signature = substr($signature, 0, -2);
1085 $self->pidl("const char *kwnames[] = {");
1087 $self->pidl($args_names . "NULL");
1092 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
1094 $self->pidl("return false;");
1099 my $env = GenerateFunctionInEnv($fn, "r->");
1101 my $fail = "return false;";
1102 foreach my $e (@{$fn->{ELEMENTS}}) {
1103 next unless (grep(/in/,@{$e->{DIRECTION}}));
1104 if ($metadata_args->{in}->{$e->{NAME}}) {
1105 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
1106 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1107 my $val = "PyList_GET_SIZE($py_var)";
1108 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
1109 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
1110 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
1112 $self->pidl("PyErr_NoMemory();");
1116 $self->pidl("*r->in.$e->{NAME} = $val;");
1118 $self->pidl("r->in.$e->{NAME} = $val;");
1121 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
1124 $self->pidl("return true;");
1128 return ($infnname, $signature);
1131 sub PythonFunction($$$)
1133 my ($self, $fn, $iface, $prettyname) = @_;
1135 my $fnname = "py_$fn->{NAME}";
1136 my $docstring = $self->DocString($fn, $fn->{NAME});
1138 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
1139 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
1140 my $signature = "S.$prettyname($insignature) -> $outsignature";
1142 $docstring = "\"$signature\\n\\n\"$docstring";
1144 $docstring = "\"$signature\"";
1147 return ($infn, $outfn, $docstring);
1150 sub handle_werror($$$$)
1152 my ($self, $var, $retval, $mem_ctx) = @_;
1154 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
1156 $self->pidl("PyErr_SetWERROR($var);");
1157 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
1158 $self->pidl("return $retval;");
1164 sub handle_ntstatus($$$$)
1166 my ($self, $var, $retval, $mem_ctx) = @_;
1168 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
1170 $self->pidl("PyErr_SetNTSTATUS($var);");
1171 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
1172 $self->pidl("return $retval;");
1178 sub PythonType($$$$)
1180 my ($self, $modulename, $d, $interface, $basename) = @_;
1182 my $actual_ctype = $d;
1183 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1184 $actual_ctype = $actual_ctype->{DATA};
1187 if ($actual_ctype->{TYPE} eq "STRUCT") {
1189 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
1191 if ($d->{TYPE} eq "STRUCT") {
1192 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
1194 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
1197 $self->register_module_typeobject($fn_name, $typeobject, $d->{ORIGINAL});
1200 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
1201 $self->EnumAndBitmapConsts($d->{NAME}, $d);
1204 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
1205 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
1208 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
1209 my $prettyname = PrettifyTypeName($d->{NAME}, $basename);
1210 my $typeobject = "$d->{NAME}\_Type";
1211 my $docstring = $self->DocString($d, $d->{NAME});
1212 my $cname = "union $d->{NAME}";
1214 $self->pidl("static PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
1217 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
1222 $self->pidl("static ".mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
1225 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
1230 my $getsetters = "NULL";
1231 my $py_methods = "NULL";
1232 my $typename = mapTypeName($d);
1234 $self->pidl("static PyObject *py_$d->{NAME}\_import(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1237 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
1238 $self->pidl("PyObject *mem_ctx_obj = NULL;");
1239 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
1240 $self->pidl("int level = 0;");
1241 $self->pidl("PyObject *in_obj = NULL;");
1242 $self->pidl("$typename *in = NULL;");
1244 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
1246 $self->pidl("discard_const_p(char *, kwnames),");
1247 $self->pidl("&mem_ctx_obj,");
1248 $self->pidl("&level,");
1249 $self->pidl("&in_obj)) {");
1252 $self->pidl("return NULL;");
1255 $self->pidl("mem_ctx = pytalloc_get_ptr(mem_ctx_obj);");
1256 $self->pidl("if (mem_ctx == NULL) {");
1258 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
1259 $self->pidl("return NULL;");
1262 $self->pidl("in = ($typename *)pytalloc_get_ptr(in_obj);");
1263 $self->pidl("if (in == NULL) {");
1265 $self->pidl("PyErr_Format(PyExc_TypeError, \"in needs to be a pointer to $typename!\");");
1266 $self->pidl("return NULL;");
1270 $self->pidl("return py_import_$d->{NAME}(mem_ctx, level, in);");
1275 $self->pidl("static PyObject *py_$d->{NAME}\_export(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1278 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
1279 $self->pidl("PyObject *mem_ctx_obj = NULL;");
1280 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
1281 $self->pidl("int level = 0;");
1282 $self->pidl("PyObject *in = NULL;");
1283 $self->pidl("$typename *out = NULL;");
1285 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
1287 $self->pidl("discard_const_p(char *, kwnames),");
1288 $self->pidl("&mem_ctx_obj,");
1289 $self->pidl("&level,");
1290 $self->pidl("&in)) {");
1293 $self->pidl("return NULL;");
1296 $self->pidl("mem_ctx = pytalloc_get_ptr(mem_ctx_obj);");
1297 $self->pidl("if (mem_ctx == NULL) {");
1299 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
1300 $self->pidl("return NULL;");
1304 $self->pidl("out = py_export_$d->{NAME}(mem_ctx, level, in);");
1305 $self->pidl("if (out == NULL) {");
1307 $self->pidl("return NULL;");
1311 $self->pidl("return pytalloc_GenericObject_reference(out);");
1316 $py_methods = "py_$d->{NAME}_methods";
1317 $self->pidl("static PyMethodDef $py_methods\[] = {");
1319 $self->pidl("{ \"__import__\", (PyCFunction)py_$d->{NAME}\_import,");
1321 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
1322 $self->pidl("\"T.__import__(mem_ctx, level, in) => ret.\" },");
1324 $self->pidl("{ \"__export__\", (PyCFunction)py_$d->{NAME}\_export,");
1326 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
1327 $self->pidl("\"T.__export__(mem_ctx, level, in) => ret.\" },");
1329 $self->pidl("{ NULL, NULL, 0, NULL }");
1334 $self->pidl("static PyObject *py_$d->{NAME}\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1337 $self->pidl("PyErr_Format(PyExc_TypeError, \"New %s Objects are not supported\", type->tp_name);");
1338 $self->pidl("return NULL;");
1344 $self->pidl_hdr("static PyTypeObject $typeobject;\n");
1345 $self->pidl("static PyTypeObject $typeobject = {");
1347 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
1348 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
1349 $self->pidl(".tp_getset = $getsetters,");
1351 $self->pidl(".tp_doc = $docstring,");
1353 $self->pidl(".tp_methods = $py_methods,");
1354 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1355 $self->pidl(".tp_new = py_$d->{NAME}\_new,");
1361 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
1362 $self->register_module_prereadycode(["$typeobject.tp_base = $talloc_typename;",
1363 "$typeobject.tp_basicsize = pytalloc_BaseObject_size();",
1366 $self->register_module_typeobject($prettyname, "&$typeobject", $d->{ORIGINAL});
1372 my ($self, $d, $name) = @_;
1373 if (has_property($d, "helpstring")) {
1374 my $docstring = uc("py_doc_$name");
1375 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
1384 my($self,$interface,$basename) = @_;
1386 if (has_property($interface, "pyhelper")) {
1387 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
1390 $self->Const($_) foreach (@{$interface->{CONSTS}});
1392 foreach my $d (@{$interface->{TYPES}}) {
1393 next if has_property($d, "nopython");
1395 $self->PythonType($basename, $d, $interface, $basename);
1398 if (defined $interface->{PROPERTIES}->{uuid}) {
1399 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
1404 foreach my $d (@{$interface->{FUNCTIONS}}) {
1405 next if has_property($d, "noopnum");
1406 next if has_property($d, "nopython");
1407 next if has_property($d, "todo");
1410 foreach my $e (@{$d->{ELEMENTS}}) {
1411 if (ContainsPipe($e, $e->{LEVELS}[0])) {
1418 my $prettyname = $d->{NAME};
1420 $prettyname =~ s/^$interface->{NAME}_//;
1421 $prettyname =~ s/^$basename\_//;
1423 my $typeobject = $self->PythonFunctionStruct($basename, $d, $interface->{NAME}, $prettyname);
1424 $self->register_module_typeobject($prettyname, $typeobject, $d->{ORIGINAL});
1426 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
1428 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
1431 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
1433 foreach my $d (@fns) {
1434 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
1435 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
1437 $self->pidl("{ NULL }");
1442 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1445 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
1452 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
1454 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
1455 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
1456 \"credentials should be a credentials.Credentials object.\\n\\n\"";
1458 my $docstring = $self->DocString($interface, $interface->{NAME});
1461 $docstring = "$signature$docstring";
1463 $docstring = $signature;
1466 my $if_typename = "$interface->{NAME}_InterfaceType";
1468 $self->pidl("static PyTypeObject $if_typename = {");
1470 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
1471 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
1472 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
1473 $self->pidl(".tp_doc = $docstring,");
1474 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1475 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
1481 $self->register_module_typeobject($interface->{NAME}, "&$if_typename", $interface->{ORIGINAL});
1482 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
1483 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
1484 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn NULL;", ""]);
1487 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1490 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
1496 my $signature = "\"$interface->{NAME}_abstract_syntax()\\n\"";
1498 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
1501 $docstring = "$signature$docstring";
1503 $docstring = $signature;
1506 my $syntax_typename = "$interface->{NAME}_SyntaxType";
1508 $self->pidl("static PyTypeObject $syntax_typename = {");
1510 $self->pidl("PyVarObject_HEAD_INIT(NULL, 0)");
1511 $self->pidl(".tp_name = \"$basename.$interface->{NAME}_abstract_syntax\",");
1512 $self->pidl(".tp_doc = $docstring,");
1513 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1514 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
1520 $self->register_module_typeobject("$interface->{NAME}_abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1521 if (not defined($self->existing_module_object("abstract_syntax"))) {
1522 # Only the first syntax gets registered with the legacy
1523 # "abstract_syntax" name
1524 $self->register_module_typeobject("abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1526 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
1527 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;",
1528 "$syntax_typename.tp_basicsize = pytalloc_BaseObject_size();",
1532 $self->pidl_hdr("\n");
1535 sub register_module_method($$$$$)
1537 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
1539 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
1542 sub register_module_typeobject($$$$)
1544 my ($self, $name, $py_name, $location) = @_;
1546 $self->register_module_object($name, "(PyObject *)(void *)$py_name", $location);
1548 $self->check_ready_type($py_name);
1550 $self->register_patch_type_call($name, $py_name);
1553 sub check_ready_type($$)
1555 my ($self, $py_name) = @_;
1556 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
1559 sub register_module_import($$)
1561 my ($self, $module_path) = @_;
1563 my $var_name = $module_path;
1564 $var_name =~ s/\./_/g;
1565 $var_name = "dep_$var_name";
1567 unless (defined $self->{module_imports_uniq}->{$var_name}) {
1568 my $h = { "key" => $var_name, "val" => $module_path};
1569 push @{$self->{module_imports}}, $h;
1570 $self->{module_imports_uniq}->{$var_name} = $h;
1575 sub import_type_variable($$$)
1577 my ($self, $module, $name) = @_;
1579 $self->register_module_import($module);
1580 unless (defined $self->{type_imports_uniq}->{$name}) {
1581 my $h = { "key" => $name, "val" => $module};
1582 push @{$self->{type_imports}}, $h;
1583 $self->{type_imports_uniq}->{$name} = $h;
1585 return "$name\_Type";
1588 sub use_type_variable($$)
1590 my ($self, $orig_ctype) = @_;
1591 # FIXME: Have a global lookup table for types that look different on the
1592 # wire than they are named in C?
1593 if ($orig_ctype->{NAME} eq "dom_sid2" or
1594 $orig_ctype->{NAME} eq "dom_sid28" or
1595 $orig_ctype->{NAME} eq "dom_sid0") {
1596 $orig_ctype->{NAME} = "dom_sid";
1598 if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
1599 $orig_ctype->{NAME} = "security_descriptor";
1602 my $ctype = resolveType($orig_ctype);
1603 unless (defined($ctype->{BASEFILE})) {
1606 # If this is an external type, make sure we do the right imports.
1607 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
1608 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
1610 return "&$ctype->{NAME}_Type";
1613 sub register_patch_type_call($$$)
1615 my ($self, $typename, $cvar) = @_;
1617 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
1621 sub register_module_prereadycode($$)
1623 my ($self, $code) = @_;
1625 push (@{$self->{prereadycode}}, @$code);
1628 sub register_module_postreadycode($$)
1630 my ($self, $code) = @_;
1632 push (@{$self->{postreadycode}}, @$code);
1635 sub existing_module_object($$)
1637 my ($self, $name) = @_;
1639 if (defined($self->{module_object_uniq}->{$name})) {
1640 return $self->{module_object_uniq}->{$name};
1646 sub register_module_object($$$$)
1648 my ($self, $name, $py_name, $location) = @_;
1650 my $existing = $self->existing_module_object($name);
1651 fatal($location, "module_object($name, $py_name) registered twice! $existing.") if defined($existing);
1653 push (@{$self->{module_objects}}, [$name, $py_name]);
1654 $self->{module_object_uniq}->{$name} = $py_name;
1659 my ($self, $dest, $src) = @_;
1660 if ($dest =~ /^\&/ and $src eq "NULL") {
1661 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
1662 } elsif ($dest =~ /^\&/) {
1663 my $destvar = get_value_of($dest);
1664 $self->pidl("$destvar = *$src;");
1666 $self->pidl("$dest = $src;");
1670 sub ConvertStringFromPythonData($$$$$)
1672 my ($self, $mem_ctx, $py_var, $target, $fail) = @_;
1676 $self->pidl("const char *test_str;");
1677 $self->pidl("const char *talloc_str;");
1678 $self->pidl("PyObject *unicode = NULL;");
1679 $self->pidl("if (PyUnicode_Check($py_var)) {");
1681 # FIXME: Use Unix charset setting rather than utf-8
1682 $self->pidl("unicode = PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\");");
1683 $self->pidl("if (unicode == NULL) {");
1685 $self->pidl("PyErr_NoMemory();");
1686 $self->pidl("$fail");
1690 $self->pidl("test_str = PyBytes_AS_STRING(unicode);");
1692 $self->pidl("} else if (PyBytes_Check($py_var)) {");
1694 $self->pidl("test_str = PyBytes_AS_STRING($py_var);");
1696 $self->pidl("} else {");
1698 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1699 $self->pidl("$fail");
1702 $self->pidl("talloc_str = talloc_strdup($mem_ctx, test_str);");
1703 $self->pidl("if (unicode != NULL) {");
1705 $self->pidl("Py_DECREF(unicode);");
1708 $self->pidl("if (talloc_str == NULL) {");
1710 $self->pidl("PyErr_NoMemory();");
1711 $self->pidl("$fail");
1714 $self->pidl("$target = talloc_str;");
1719 sub ConvertObjectFromPythonData($$$$$$;$$)
1721 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location, $switch) = @_;
1723 fatal($location, "undef type for $cvar") unless(defined($ctype));
1725 $ctype = resolveType($ctype);
1727 my $actual_ctype = $ctype;
1728 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1729 $actual_ctype = $actual_ctype->{DATA};
1732 # We need to cover ENUMs, BITMAPS and SCALAR values here, as
1733 # all could otherwise be assigned invalid integer values
1734 my $ctype_alias = "";
1736 if ($actual_ctype->{TYPE} eq "ENUM") {
1737 # Importantly, ENUM values are unsigned in pidl, and
1738 # typically map to uint32
1739 $ctype_alias = enum_type_fn($actual_ctype);
1740 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1741 $ctype_alias = bitmap_type_fn($actual_ctype);
1742 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1743 $ctype_alias = expandAlias($actual_ctype->{NAME});
1746 # This is the unsigned Python Integer -> C integer validation
1747 # case. The signed case is below.
1748 if ($ctype_alias =~ /^(uint[0-9]*|hyper|udlong|udlongr
1749 |NTTIME_hyper|NTTIME|NTTIME_1sec
1753 $self->pidl("unsigned long long ull_value;");
1754 $self->pidl("ull_value = ndr_PyLong_AsCheckedUnsignedLongLong($cvar, sizeof($target));");
1755 $self->pidl("if (PyErr_Occurred() != NULL) {");
1760 $self->pidl("$target = (" . mapTypeName($ctype_alias) . ")ull_value;");
1766 # Confirm the signed python integer fits in the C type
1767 # correctly. It is subtly different from the unsigned case
1768 # above, so while it looks like a duplicate, it is not
1769 # actually a duplicate.
1770 if ($ctype_alias =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1773 $self->pidl("long long ll_value;");
1774 $self->pidl("ll_value = ndr_PyLong_AsCheckedLongLong($cvar, sizeof($target));");
1775 $self->pidl("if (PyErr_Occurred() != NULL) {");
1780 $self->pidl("$target = (" . mapTypeName($ctype_alias) . ")ll_value;");
1786 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1787 my $ctype_name = $self->use_type_variable($ctype);
1788 unless (defined ($ctype_name)) {
1789 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1790 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1793 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1794 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1796 $self->pidl("PyErr_NoMemory();");
1797 $self->pidl("$fail");
1800 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1804 if ($actual_ctype->{TYPE} eq "UNION") {
1805 my $ctype_name = $self->use_type_variable($ctype);
1806 unless (defined ($ctype_name)) {
1807 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1808 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1811 my $export = "pyrpc_export_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
1812 $self->assign($target, "(".mapTypeName($ctype)." *)$export");
1816 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1817 $self->pidl("$target = data_blob_talloc($mem_ctx, PyBytes_AS_STRING($cvar), PyBytes_GET_SIZE($cvar));");
1821 if ($actual_ctype->{TYPE} eq "SCALAR" and
1822 ($actual_ctype->{NAME} eq "string"
1823 or $actual_ctype->{NAME} eq "nbt_string"
1824 or $actual_ctype->{NAME} eq "nbt_name"
1825 or $actual_ctype->{NAME} eq "wrepl_nbt_name"
1826 or $actual_ctype->{NAME} eq "dns_string"
1827 or $actual_ctype->{NAME} eq "dnsp_string"
1828 or $actual_ctype->{NAME} eq "dns_name"
1829 or $actual_ctype->{NAME} eq "ipv4address"
1830 or $actual_ctype->{NAME} eq "ipv6address"
1831 or $actual_ctype->{NAME} eq "dnsp_name")) {
1832 $self->ConvertStringFromPythonData($mem_ctx, $cvar, $target, $fail);
1836 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1837 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1841 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1842 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1846 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1847 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1851 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1852 $self->pidl("$target = pytalloc_get_ptr($cvar);");
1856 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1857 $self->assign($target, "pytalloc_get_ptr($cvar)");
1861 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1865 sub ConvertObjectFromPythonLevel($$$$$$$$$)
1867 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail, $recurse) = @_;
1868 my $nl = GetNextLevel($e, $l);
1869 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1870 $nl = GetNextLevel($e, $nl);
1872 my $pl = GetPrevLevel($e, $l);
1873 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1874 $pl = GetPrevLevel($e, $pl);
1877 if ($recurse == 0) {
1878 $self->pidl("if ($py_var == NULL) {");
1880 $self->pidl("PyErr_Format(PyExc_AttributeError, \"Cannot delete NDR object: " .
1881 mapTypeName($var_name) . "\");");
1886 $recurse = $recurse + 1;
1888 if ($l->{TYPE} eq "POINTER") {
1889 my $need_deindent = 0;
1892 if ($l->{POINTER_TYPE} ne "ref") {
1893 $self->pidl("if ($py_var == Py_None) {");
1895 $self->pidl("$var_name = NULL;");
1897 $self->pidl("} else {");
1900 if ($nl->{TYPE} eq "POINTER") {
1905 if ($l->{POINTER_TYPE} eq "ref" or $need_deref == 1) {
1906 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1907 $self->pidl("if ($var_name == NULL) {");
1909 $self->pidl("PyErr_NoMemory();");
1913 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1914 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1915 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1916 $self->pidl("if ($var_name == NULL) {");
1918 $self->pidl("PyErr_NoMemory();");
1923 $self->pidl("$var_name = NULL;");
1925 if ($need_deref == 1) {
1926 my $ndr_pointer_typename = $self->import_type_variable("samba.dcerpc.base", "ndr_pointer");
1927 $self->pidl("$py_var = py_dcerpc_ndr_pointer_deref($ndr_pointer_typename, $py_var);");
1929 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1930 $var_name = get_value_of($var_name);
1932 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail, $recurse);
1933 if ($need_deindent == 1) {
1937 } elsif ($l->{TYPE} eq "ARRAY") {
1938 if ($pl && $pl->{TYPE} eq "POINTER") {
1939 $var_name = get_pointer_to($var_name);
1942 if (is_charset_array($e, $l)) {
1943 $self->ConvertStringFromPythonData($mem_ctx, $py_var, $var_name, $fail);
1945 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1946 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1949 $self->pidl("int $counter;");
1950 if (ArrayDynamicallyAllocated($e, $l)) {
1951 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1952 $self->pidl("if (!$var_name) { $fail; }");
1953 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1955 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
1957 $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));");
1958 $self->pidl("$fail");
1962 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1964 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail, 0);
1970 } elsif ($l->{TYPE} eq "DATA") {
1971 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1972 $var_name = get_pointer_to($var_name);
1974 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1975 } elsif ($l->{TYPE} eq "SWITCH") {
1976 $var_name = get_pointer_to($var_name);
1977 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1978 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1981 my $union_type = mapTypeName($nl->{DATA_TYPE});
1982 $self->pidl("$union_type *$switch_ptr;");
1983 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $nl->{DATA_TYPE}, $switch_ptr, $fail, $e->{ORIGINAL}, $switch);
1984 $self->fail_on_null($switch_ptr, $fail);
1985 $self->assign($var_name, "$switch_ptr");
1988 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1989 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail, $recurse);
1991 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1995 sub ConvertObjectFromPython($$$$$$$)
1997 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
2000 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail, $recurse);
2003 sub ConvertScalarToPython($$$$)
2005 my ($self, $ctypename, $cvar, $mem_ctx) = @_;
2007 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
2009 $ctypename = expandAlias($ctypename);
2011 if ($ctypename =~ /^(int64|dlong)$/) {
2012 return "ndr_PyLong_FromLongLong($cvar)";
2015 if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
2016 return "ndr_PyLong_FromUnsignedLongLong($cvar)";
2019 if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
2020 return "PyInt_FromLong($cvar)";
2023 # Needed to ensure unsigned values in a 32 or 16 bit enum is
2024 # cast correctly to a uint32_t, not sign extended to a a
2025 # possibly 64 bit unsigned long. (enums are signed in C,
2027 if ($ctypename =~ /^(uint32|uint3264)$/) {
2028 return "ndr_PyLong_FromUnsignedLongLong((uint32_t)$cvar)";
2031 if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
2032 return "PyInt_FromLong((uint16_t)$cvar)";
2035 if ($ctypename eq "DATA_BLOB") {
2036 return "PyBytes_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
2039 if ($ctypename eq "NTSTATUS") {
2040 return "PyErr_FromNTSTATUS($cvar)";
2043 if ($ctypename eq "WERROR") {
2044 return "PyErr_FromWERROR($cvar)";
2047 if ($ctypename eq "HRESULT") {
2048 return "PyErr_FromHRESULT($cvar)";
2051 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
2052 return "PyString_FromStringOrNULL($cvar)";
2055 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
2056 return "PyString_FromStringOrNULL($cvar)";
2060 if ($ctypename eq "string_array") {
2061 return "pytalloc_GenericObject_reference_ex($mem_ctx, $cvar)";
2063 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
2064 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
2065 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
2066 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
2067 if ($ctypename eq "pointer") {
2068 return "pytalloc_GenericObject_reference_ex($mem_ctx, $cvar)";
2071 die("Unknown scalar type $ctypename");
2074 sub ConvertObjectToPythonData($$$$$;$$)
2076 my ($self, $mem_ctx, $ctype, $cvar, $location, $switch) = @_;
2078 die("undef type for $cvar") unless(defined($ctype));
2080 $ctype = resolveType($ctype);
2082 my $actual_ctype = $ctype;
2083 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
2084 $actual_ctype = $actual_ctype->{DATA};
2087 if ($actual_ctype->{TYPE} eq "ENUM") {
2088 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar, $mem_ctx);
2089 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
2090 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar, $mem_ctx);
2091 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
2092 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar, $mem_ctx);
2093 } elsif ($actual_ctype->{TYPE} eq "UNION") {
2094 my $ctype_name = $self->use_type_variable($ctype);
2095 unless (defined($ctype_name)) {
2096 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
2097 return "NULL"; # FIXME!
2099 return "pyrpc_import_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
2100 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
2101 my $ctype_name = $self->use_type_variable($ctype);
2102 unless (defined($ctype_name)) {
2103 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
2104 return "NULL"; # FIXME!
2106 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
2109 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
2112 sub fail_on_null($$$)
2114 my ($self, $var, $fail) = @_;
2115 $self->pidl("if ($var == NULL) {");
2122 sub ConvertObjectToPythonLevel($$$$$$$)
2124 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail, $recurse) = @_;
2125 my $nl = GetNextLevel($e, $l);
2126 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
2127 $nl = GetNextLevel($e, $nl);
2129 my $pl = GetPrevLevel($e, $l);
2130 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
2131 $pl = GetPrevLevel($e, $pl);
2134 if ($l->{TYPE} eq "POINTER") {
2136 if ($l->{POINTER_TYPE} ne "ref" and $nl->{TYPE} eq "POINTER") {
2139 if ($l->{POINTER_TYPE} ne "ref") {
2140 if ($recurse == 0) {
2141 $self->pidl("if ($var_name == NULL) {");
2143 $self->pidl("$py_var = Py_None;");
2144 $self->pidl("Py_INCREF($py_var);");
2146 $self->pidl("} else {");
2152 $recurse = $recurse + 1;
2154 my $var_name2 = $var_name;
2155 my $recurse2 = $recurse;
2156 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
2157 $var_name2 = get_value_of($var_name);
2160 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail, $recurse2);
2161 if ($l->{POINTER_TYPE} ne "ref") {
2166 my $py_var_wrap = undef;
2170 $py_var_wrap = "py_$e->{NAME}_level_$l->{LEVEL_INDEX}";
2171 $self->pidl("PyObject *$py_var_wrap = $py_var;");
2172 my $ndr_pointer_typename = $self->import_type_variable("samba.dcerpc.base", "ndr_pointer");
2173 $self->pidl("$py_var = py_dcerpc_ndr_pointer_wrap($ndr_pointer_typename, $py_var_wrap);");
2174 $self->pidl("Py_XDECREF($py_var_wrap);");
2178 } elsif ($l->{TYPE} eq "ARRAY") {
2179 if ($pl && $pl->{TYPE} eq "POINTER") {
2180 $var_name = get_pointer_to($var_name);
2183 if (is_charset_array($e, $l)) {
2184 # FIXME: Use Unix charset setting rather than utf-8
2185 $self->pidl("if ($var_name == NULL) {");
2187 $self->pidl("$py_var = Py_None;");
2188 $self->pidl("Py_INCREF($py_var);");
2190 $self->pidl("} else {");
2192 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
2193 $self->fail_on_null($py_var, $fail);
2197 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
2198 my $length = $l->{SIZE_IS};
2199 if (defined($l->{LENGTH_IS})) {
2200 $length = $l->{LENGTH_IS};
2203 $length = ParseExpr($length, $env, $e);
2204 $self->pidl("$py_var = PyList_New($length);");
2205 $self->fail_on_null($py_var, $fail);
2206 my $fail2 = "Py_DECREF($py_var); $fail";
2209 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
2210 $self->pidl("int $counter;");
2211 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
2213 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
2214 my $ret_var = "ret_$e->{NAME}_$l->{LEVEL_INDEX}";
2215 $self->pidl("PyObject *$member_var;");
2216 $self->pidl("int $ret_var;");
2217 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail2, $recurse);
2218 $self->pidl("$ret_var = PyList_SetItem($py_var, $counter, $member_var);");
2219 $self->pidl("if ($ret_var != 0) {");
2221 $self->pidl($fail2);
2229 } elsif ($l->{TYPE} eq "SWITCH") {
2230 $var_name = get_pointer_to($var_name);
2231 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
2232 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $nl->{DATA_TYPE}, $var_name, $e->{ORIGINAL}, $switch);
2233 $self->pidl("$py_var = $conv;");
2234 $self->fail_on_null($py_var, $fail);
2236 } elsif ($l->{TYPE} eq "DATA") {
2237 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
2238 $var_name = get_pointer_to($var_name);
2240 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
2241 $self->pidl("$py_var = $conv;");
2242 $self->fail_on_null($py_var, $fail);
2243 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
2244 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail, $recurse);
2246 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
2250 sub ConvertObjectToPython($$$$$$)
2252 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
2255 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail, $recurse);
2260 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
2262 $self->{BASENAME} = $basename;
2265 /* Python wrapper functions auto-generated by pidl */
2266 #define PY_SSIZE_T_CLEAN 1 /* We use Py_ssize_t for PyArg_ParseTupleAndKeywords */
2268 #include \"python/py3compat.h\"
2269 #include \"includes.h\"
2270 #include <pytalloc.h>
2271 #include \"librpc/rpc/pyrpc.h\"
2272 #include \"librpc/rpc/pyrpc_util.h\"
2274 #include \"$ndr_hdr\"
2277 * These functions are here to ensure they can be optimized out by
2278 * the compiler based on the constant input values
2281 static inline unsigned long long ndr_sizeof2uintmax(size_t var_size)
2297 static inline long long ndr_sizeof2intmax(size_t var_size)
2313 static inline PyObject *ndr_PyLong_FromLongLong(long long v)
2315 if (v > LONG_MAX || v < LONG_MIN) {
2316 return PyLong_FromLongLong(v);
2318 return PyInt_FromLong(v);
2322 static inline PyObject *ndr_PyLong_FromUnsignedLongLong(unsigned long long v)
2325 return PyLong_FromUnsignedLongLong(v);
2327 return PyInt_FromLong(v);
2332 * This is the unsigned Python Integer -> C integer validation
2333 * case. The signed case is below.
2335 static inline unsigned long long ndr_PyLong_AsCheckedUnsignedLongLong(PyObject *py_value,
2338 const unsigned long long uint_max = ndr_sizeof2uintmax(target_size);
2339 unsigned long long ret_value = 0;
2341 if (PyLong_Check(py_value)) {
2342 unsigned long long test_var;
2344 test_var = PyLong_AsUnsignedLongLong(py_value);
2345 if (PyErr_Occurred() != NULL) {
2349 if (test_var > uint_max) {
2350 PyErr_Format(PyExc_OverflowError,
2351 \"Expected type %s or %s within range 0 - %llu, got %llu\",
2352 PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);
2356 ret_value = test_var;
2361 if (PyInt_Check(py_value)) {
2364 test_var = PyInt_AsLong(py_value);
2365 if (PyErr_Occurred() != NULL) {
2369 if (test_var < 0 || (unsigned long long)test_var > uint_max) {
2370 PyErr_Format(PyExc_OverflowError,
2371 \"Expected type %s or %s within range 0 - %llu, got %ld\",
2372 PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);
2376 ret_value = test_var;
2381 PyErr_Format(PyExc_TypeError,
2382 \"Expected type %s or %s within range 0 - %llu\",
2383 PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max);
2389 * Confirm the signed python integer fits in the C type
2390 * correctly. It is subtly different from the unsigned case
2391 * above, so while it looks like a duplicate, it is not
2392 * actually a duplicate.
2394 static inline long long ndr_PyLong_AsCheckedLongLong(PyObject *py_value,
2397 const long long int_max = ndr_sizeof2intmax(target_size);
2398 const long long int_min = -int_max - 1;
2399 long long ret_value;
2401 if (PyLong_Check(py_value)) {
2404 test_var = PyLong_AsLongLong(py_value);
2405 if (PyErr_Occurred() != NULL) {
2409 if (test_var < int_min || test_var > int_max) {
2410 PyErr_Format(PyExc_OverflowError,
2411 \"Expected type %s or %s within range %lld - %lld, got %lld\",
2412 PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);
2416 ret_value = test_var;
2421 if (PyInt_Check(py_value)) {
2424 test_var = PyInt_AsLong(py_value);
2425 if (test_var < int_min || test_var > int_max) {
2426 PyErr_Format(PyExc_OverflowError,
2427 \"Expected type %s or %s within range %lld - %lld, got %ld\",
2428 PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);
2432 ret_value = test_var;
2437 PyErr_Format(PyExc_TypeError,
2438 \"Expected type %s or %s within range %lld - %lld\",
2439 PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max);
2445 foreach my $x (@$ndr) {
2446 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
2447 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
2450 $self->pidl("static PyMethodDef $basename\_methods[] = {");
2452 foreach (@{$self->{module_methods}}) {
2453 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
2454 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
2457 $self->pidl("{ NULL, NULL, 0, NULL }");
2463 $self->pidl("static struct PyModuleDef moduledef = {");
2465 $self->pidl("PyModuleDef_HEAD_INIT,");
2466 $self->pidl(".m_name = \"$basename\",");
2467 $self->pidl(".m_doc = \"$basename DCE/RPC\",");
2468 $self->pidl(".m_size = -1,");
2469 $self->pidl(".m_methods = $basename\_methods,");
2473 $self->pidl("MODULE_INIT_FUNC($basename)");
2476 $self->pidl("PyObject *m = NULL;");
2477 foreach my $h (@{$self->{module_imports}}) {
2478 $self->pidl("PyObject *$h->{'key'} = NULL;");
2482 foreach my $h (@{$self->{module_imports}}) {
2483 my $var_name = $h->{'key'};
2484 my $module_path = $h->{'val'};
2485 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
2486 $self->pidl("if ($var_name == NULL)");
2487 $self->pidl("\tgoto out;");
2491 foreach my $h (@{$self->{type_imports}}) {
2492 my $type_var = "$h->{'key'}\_Type";
2493 my $module_path = $h->{'val'};
2494 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
2495 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
2496 my $module_var = "dep_$module_path";
2497 $module_var =~ s/\./_/g;
2498 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
2499 $self->pidl("if ($type_var == NULL)");
2500 $self->pidl("\tgoto out;");
2504 $self->pidl($_) foreach (@{$self->{prereadycode}});
2506 foreach (@{$self->{ready_types}}) {
2507 $self->pidl("if (PyType_Ready($_) < 0)");
2508 $self->pidl("\tgoto out;");
2511 $self->pidl($_) foreach (@{$self->{postreadycode}});
2513 foreach (@{$self->{patch_type_calls}}) {
2514 my ($typename, $cvar) = @$_;
2515 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
2516 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
2517 $self->pidl("#endif");
2522 $self->pidl("m = PyModule_Create(&moduledef);");
2523 $self->pidl("if (m == NULL)");
2524 $self->pidl("\tgoto out;");
2526 foreach my $h (@{$self->{constants}}) {
2527 my $pretty_name = PrettifyTypeName($h->{'key'}, $basename);
2529 my ($ctype, $cvar) = @{$h->{'val'}};
2530 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
2531 $py_obj = "ndr_PyLong_FromUnsignedLongLong($cvar)";
2532 } elsif ($cvar =~ /^".*"$/) {
2533 $py_obj = "PyStr_FromString($cvar)";
2535 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
2538 $self->pidl("PyModule_AddObject(m, \"$pretty_name\", $py_obj);");
2541 foreach (@{$self->{module_objects}}) {
2542 my ($object_name, $c_name) = @$_;
2543 $self->pidl("Py_INCREF($c_name);");
2544 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
2547 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
2548 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
2549 $self->pidl("#endif");
2550 $self->pidl("out:");
2551 foreach my $h (@{$self->{module_imports}}) {
2552 my $mod_var = $h->{'key'};
2553 $self->pidl("Py_XDECREF($mod_var);");
2555 $self->pidl("return m;");
2559 return ($self->{res_hdr} . $self->{res});