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}}) {
250 $self->pidl(".name = discard_const_p(char, \"$e->{NAME}\"),");
251 $self->pidl(".get = py_$name\_get_$e->{NAME},");
252 $self->pidl(".set = py_$name\_set_$e->{NAME},");
253 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
257 $self->pidl("{ .name = NULL }");
263 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
266 $self->pidl("return pytalloc_new($cname, type);");
271 my $py_methods = "NULL";
273 # If the struct is not public there ndr_pull/ndr_push functions will
274 # be static so not callable from here
275 if (has_property($d, "public")) {
276 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
279 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
280 $self->pidl("PyObject *ret = NULL;");
281 $self->pidl("DATA_BLOB blob;");
282 $self->pidl("enum ndr_err_code err;");
283 $self->pidl("TALLOC_CTX *tmp_ctx = talloc_new(pytalloc_get_mem_ctx(py_obj));");
284 $self->pidl("if (tmp_ctx == NULL) {");
286 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
287 $self->pidl("return NULL;");
290 $self->pidl("err = ndr_push_struct_blob(&blob, tmp_ctx, object, (ndr_push_flags_fn_t)ndr_push_$name);");
291 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
293 $self->pidl("TALLOC_FREE(tmp_ctx);");
294 $self->pidl("PyErr_SetNdrError(err);");
295 $self->pidl("return NULL;");
299 $self->pidl("ret = PyString_FromStringAndSize((char *)blob.data, blob.length);");
300 $self->pidl("TALLOC_FREE(tmp_ctx);");
301 $self->pidl("return ret;");
306 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
309 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
310 $self->pidl("DATA_BLOB blob;");
311 $self->pidl("Py_ssize_t blob_length = 0;");
312 $self->pidl("enum ndr_err_code err;");
313 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
314 $self->pidl("PyObject *allow_remaining_obj = NULL;");
315 $self->pidl("bool allow_remaining = false;");
317 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|O:__ndr_unpack__\",");
319 $self->pidl("discard_const_p(char *, kwnames),");
320 $self->pidl("&blob.data, &blob_length,");
321 $self->pidl("&allow_remaining_obj)) {");
324 $self->pidl("return NULL;");
327 $self->pidl("blob.length = blob_length;");
329 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
331 $self->pidl("allow_remaining = true;");
335 $self->pidl("if (allow_remaining) {");
337 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
339 $self->pidl("} else {");
341 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
344 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
346 $self->pidl("PyErr_SetNdrError(err);");
347 $self->pidl("return NULL;");
351 $self->pidl("Py_RETURN_NONE;");
356 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
359 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
360 $self->pidl("PyObject *ret;");
361 $self->pidl("char *retstr;");
363 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
364 $self->pidl("ret = PyString_FromString(retstr);");
365 $self->pidl("talloc_free(retstr);");
367 $self->pidl("return ret;");
372 $py_methods = "py_$name\_methods";
373 $self->pidl("static PyMethodDef $py_methods\[] = {");
375 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
376 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
377 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_NOARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
378 $self->pidl("{ NULL, NULL, 0, NULL }");
384 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
386 my $docstring = $self->DocString($d, $name);
387 my $typeobject = "$name\_Type";
388 $self->pidl("static PyTypeObject $typeobject = {");
390 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
391 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
392 $self->pidl(".tp_getset = $getsetters,");
394 $self->pidl(".tp_doc = $docstring,");
396 $self->pidl(".tp_methods = $py_methods,");
397 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
398 $self->pidl(".tp_new = py_$name\_new,");
404 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
405 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
406 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
409 return "&$typeobject";
412 sub PythonFunctionStruct($$$$)
414 my ($self, $modulename, $fn, $iface, $prettyname) = @_;
416 my $inenv = GenerateFunctionInEnv($fn, "object->");
417 my $outenv = GenerateFunctionOutEnv($fn, "object->");
419 my $name = "$fn->{NAME}";
420 my $cname = "struct $name";
424 my $getsetters = "NULL";
426 foreach my $e (@{$fn->{ELEMENTS}}) {
427 if (grep(/in/,@{$e->{DIRECTION}})) {
428 my $inname = "$name\_in";
429 my $ename = "in.$e->{NAME}";
430 $self->PythonElementGetSet($inname, $cname, $ename, $e, $inenv);
432 if (grep(/out/,@{$e->{DIRECTION}})) {
433 my $outname = "$name\_out";
434 my $ename = "out.$e->{NAME}";
435 $self->PythonElementGetSet($outname, $cname, $ename, $e, $outenv);
439 if (defined($fn->{RETURN_TYPE})) {
440 my $e = ReturnTypeElement($fn);
441 my $ename = "out.result";
442 $self->PythonElementGetSet($name, $cname, $ename, $e, $outenv);
445 $getsetters = "py_$name\_getsetters";
446 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
448 foreach my $e (@{$fn->{ELEMENTS}}) {
449 if (grep(/in/,@{$e->{DIRECTION}})) {
452 $self->pidl(".name = discard_const_p(char, \"in_$e->{NAME}\"),");
453 $self->pidl(".get = py_$name\_in_get_$e->{NAME},");
454 $self->pidl(".set = py_$name\_in_set_$e->{NAME},");
455 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
459 if (grep(/out/,@{$e->{DIRECTION}})) {
462 $self->pidl(".name = discard_const_p(char, \"out_$e->{NAME}\"),");
463 $self->pidl(".get = py_$name\_out_get_$e->{NAME},");
464 $self->pidl(".set = py_$name\_out_set_$e->{NAME},");
465 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
470 if (defined($fn->{RETURN_TYPE})) {
473 $self->pidl(".name = discard_const_p(char, \"result\"),");
474 $self->pidl(".get = py_$name\_get_result,");
475 $self->pidl(".set = py_$name\_set_result,");
476 $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of type $fn->{RETURN_TYPE}\")");
480 $self->pidl("{ .name = NULL }");
485 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
488 $self->pidl("return pytalloc_new($cname, type);");
493 my $py_methods = "NULL";
495 my $ndr_call = "const struct ndr_interface_call *call = NULL;";
496 my $object_ptr = "$cname *object = ($cname *)pytalloc_get_ptr(py_obj);";
498 $self->pidl("static PyObject *py_$name\_ndr_opnum(PyTypeObject *type)");
503 $self->pidl("return PyInt_FromLong($fn->{OPNUM});");
508 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj, int ndr_inout_flags, uint32_t ndr_push_flags)");
511 $self->pidl("$ndr_call");
512 $self->pidl("$object_ptr");
513 $self->pidl("PyObject *ret = NULL;");
514 $self->pidl("struct ndr_push *push = NULL;");
515 $self->pidl("DATA_BLOB blob;");
516 $self->pidl("enum ndr_err_code err;");
518 $self->pidl("if (ndr_table_$iface\.num_calls < $fn->{OPNUM}) {");
520 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_pack\");");
521 $self->pidl("return NULL;");
524 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
526 $self->pidl("push = ndr_push_init_ctx(pytalloc_get_mem_ctx(py_obj));");
527 $self->pidl("if (push == NULL) {");
529 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
530 $self->pidl("return NULL;");
534 $self->pidl("push->flags |= ndr_push_flags;");
536 $self->pidl("err = call->ndr_push(push, ndr_inout_flags, object);");
537 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
539 $self->pidl("TALLOC_FREE(push);");
540 $self->pidl("PyErr_SetNdrError(err);");
541 $self->pidl("return NULL;");
544 $self->pidl("blob = ndr_push_blob(push);");
545 $self->pidl("ret = PyString_FromStringAndSize((char *)blob.data, blob.length);");
546 $self->pidl("TALLOC_FREE(push);");
547 $self->pidl("return ret;");
552 $self->pidl("static PyObject *py_$name\_ndr_pack_in(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
555 $self->pidl("const char * const kwnames[] = { \"bigendian\", \"ndr64\", NULL };");
556 $self->pidl("PyObject *bigendian_obj = NULL;");
557 $self->pidl("PyObject *ndr64_obj = NULL;");
558 $self->pidl("uint32_t ndr_push_flags = 0;");
560 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"|OO:__ndr_pack_in__\",");
562 $self->pidl("discard_const_p(char *, kwnames),");
563 $self->pidl("&bigendian_obj,");
564 $self->pidl("&ndr64_obj)) {");
567 $self->pidl("return NULL;");
571 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
573 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_BIGENDIAN;");
576 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
578 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_NDR64;");
582 $self->pidl("return py_$name\_ndr_pack(py_obj, NDR_IN, ndr_push_flags);");
587 $self->pidl("static PyObject *py_$name\_ndr_pack_out(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
590 $self->pidl("const char * const kwnames[] = { \"bigendian\", \"ndr64\", NULL };");
591 $self->pidl("PyObject *bigendian_obj = NULL;");
592 $self->pidl("PyObject *ndr64_obj = NULL;");
593 $self->pidl("uint32_t ndr_push_flags = 0;");
595 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"|OO:__ndr_pack_out__\",");
597 $self->pidl("discard_const_p(char *, kwnames),");
598 $self->pidl("&bigendian_obj,");
599 $self->pidl("&ndr64_obj)) {");
602 $self->pidl("return NULL;");
606 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
608 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_BIGENDIAN;");
611 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
613 $self->pidl("ndr_push_flags |= LIBNDR_FLAG_NDR64;");
617 $self->pidl("return py_$name\_ndr_pack(py_obj, NDR_OUT, ndr_push_flags);");
622 $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)");
625 $self->pidl("$ndr_call");
626 $self->pidl("$object_ptr");
627 $self->pidl("struct ndr_pull *pull = NULL;");
628 $self->pidl("enum ndr_err_code err;");
630 $self->pidl("if (ndr_table_$iface\.num_calls < $fn->{OPNUM}) {");
632 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_unpack\");");
633 $self->pidl("return NULL;");
636 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
638 $self->pidl("pull = ndr_pull_init_blob(blob, object);");
639 $self->pidl("if (pull == NULL) {");
641 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
642 $self->pidl("return NULL;");
646 $self->pidl("pull->flags |= ndr_pull_flags;");
648 $self->pidl("err = call->ndr_pull(pull, ndr_inout_flags, object);");
649 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
651 $self->pidl("TALLOC_FREE(pull);");
652 $self->pidl("PyErr_SetNdrError(err);");
653 $self->pidl("return NULL;");
656 $self->pidl("if (!allow_remaining) {");
658 $self->pidl("uint32_t highest_ofs;");
660 $self->pidl("if (pull->offset > pull->relative_highest_offset) {");
662 $self->pidl("highest_ofs = pull->offset;");
664 $self->pidl("} else {");
666 $self->pidl("highest_ofs = pull->relative_highest_offset;");
669 $self->pidl("if (highest_ofs < pull->data_size) {");
671 $self->pidl("err = ndr_pull_error(pull, NDR_ERR_UNREAD_BYTES,");
673 $self->pidl("\"not all bytes consumed ofs[%u] size[%u]\",");
674 $self->pidl("highest_ofs, pull->data_size);");
676 $self->pidl("TALLOC_FREE(pull);");
677 $self->pidl("PyErr_SetNdrError(err);");
678 $self->pidl("return NULL;");
684 $self->pidl("TALLOC_FREE(pull);");
685 $self->pidl("Py_RETURN_NONE;");
690 $self->pidl("static PyObject *py_$name\_ndr_unpack_in(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
693 $self->pidl("DATA_BLOB blob;");
694 $self->pidl("Py_ssize_t blob_length = 0;");
695 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"bigendian\", \"ndr64\", \"allow_remaining\", NULL };");
696 $self->pidl("PyObject *bigendian_obj = NULL;");
697 $self->pidl("PyObject *ndr64_obj = NULL;");
698 $self->pidl("uint32_t ndr_pull_flags = LIBNDR_FLAG_REF_ALLOC;");
699 $self->pidl("PyObject *allow_remaining_obj = NULL;");
700 $self->pidl("bool allow_remaining = false;");
702 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|OOO:__ndr_unpack_in__\",");
704 $self->pidl("discard_const_p(char *, kwnames),");
705 $self->pidl("&blob.data, &blob_length,");
706 $self->pidl("&bigendian_obj,");
707 $self->pidl("&ndr64_obj,");
708 $self->pidl("&allow_remaining_obj)) {");
711 $self->pidl("return NULL;");
714 $self->pidl("blob.length = blob_length;");
716 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
718 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_BIGENDIAN;");
721 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
723 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_NDR64;");
727 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
729 $self->pidl("allow_remaining = true;");
733 $self->pidl("return py_$name\_ndr_unpack(py_obj, &blob, NDR_IN, ndr_pull_flags, allow_remaining);");
738 $self->pidl("static PyObject *py_$name\_ndr_unpack_out(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
741 $self->pidl("DATA_BLOB blob;");
742 $self->pidl("Py_ssize_t blob_length = 0;");
743 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"bigendian\", \"ndr64\", \"allow_remaining\", NULL };");
744 $self->pidl("PyObject *bigendian_obj = NULL;");
745 $self->pidl("PyObject *ndr64_obj = NULL;");
746 $self->pidl("uint32_t ndr_pull_flags = LIBNDR_FLAG_REF_ALLOC;");
747 $self->pidl("PyObject *allow_remaining_obj = NULL;");
748 $self->pidl("bool allow_remaining = false;");
750 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|OOO:__ndr_unpack_out__\",");
752 $self->pidl("discard_const_p(char *, kwnames),");
753 $self->pidl("&blob.data, &blob_length,");
754 $self->pidl("&bigendian_obj,");
755 $self->pidl("&ndr64_obj,");
756 $self->pidl("&allow_remaining_obj)) {");
759 $self->pidl("return NULL;");
762 $self->pidl("blob.length = blob_length;");
764 $self->pidl("if (bigendian_obj && PyObject_IsTrue(bigendian_obj)) {");
766 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_BIGENDIAN;");
769 $self->pidl("if (ndr64_obj && PyObject_IsTrue(ndr64_obj)) {");
771 $self->pidl("ndr_pull_flags |= LIBNDR_FLAG_NDR64;");
775 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
777 $self->pidl("allow_remaining = true;");
781 $self->pidl("return py_$name\_ndr_unpack(py_obj, &blob, NDR_OUT, ndr_pull_flags, allow_remaining);");
786 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj, const char *name, int ndr_inout_flags)");
789 $self->pidl("$ndr_call");
790 $self->pidl("$object_ptr");
791 $self->pidl("PyObject *ret;");
792 $self->pidl("char *retstr;");
794 $self->pidl("if (ndr_table_$iface\.num_calls < $fn->{OPNUM}) {");
796 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Internal Error, ndr_interface_call missing for py_$name\_ndr_print\");");
797 $self->pidl("return NULL;");
800 $self->pidl("call = &ndr_table_$iface\.calls[$fn->{OPNUM}];");
802 $self->pidl("retstr = ndr_print_function_string(pytalloc_get_mem_ctx(py_obj), call->ndr_print, name, ndr_inout_flags, object);");
803 $self->pidl("ret = PyString_FromString(retstr);");
804 $self->pidl("TALLOC_FREE(retstr);");
806 $self->pidl("return ret;");
811 $self->pidl("static PyObject *py_$name\_ndr_print_in(PyObject *py_obj)");
814 $self->pidl("return py_$name\_ndr_print(py_obj, \"$name\_in\", NDR_IN);");
819 $self->pidl("static PyObject *py_$name\_ndr_print_out(PyObject *py_obj)");
822 $self->pidl("return py_$name\_ndr_print(py_obj, \"$name\_out\", NDR_OUT);");
827 $py_methods = "py_$name\_methods";
828 $self->pidl("static PyMethodDef $py_methods\[] = {");
830 $self->pidl("{ \"opnum\", (PyCFunction)py_$name\_ndr_opnum, METH_NOARGS|METH_CLASS,");
832 $self->pidl("\"$modulename.$prettyname.opnum() -> ".sprintf("%d (0x%02x)", $fn->{OPNUM}, $fn->{OPNUM})." \" },");
834 $self->pidl("{ \"__ndr_pack_in__\", (PyCFunction)py_$name\_ndr_pack_in, METH_VARARGS|METH_KEYWORDS,");
836 $self->pidl("\"S.ndr_pack_in(object, bigendian=False, ndr64=False) -> blob\\nNDR pack input\" },");
838 $self->pidl("{ \"__ndr_pack_out__\", (PyCFunction)py_$name\_ndr_pack_out, METH_VARARGS|METH_KEYWORDS,");
840 $self->pidl("\"S.ndr_pack_out(object, bigendian=False, ndr64=False) -> blob\\nNDR pack output\" },");
842 $self->pidl("{ \"__ndr_unpack_in__\", (PyCFunction)py_$name\_ndr_unpack_in, METH_VARARGS|METH_KEYWORDS,");
844 $self->pidl("\"S.ndr_unpack_in(class, blob, bigendian=False, ndr64=False, allow_remaining=False) -> None\\nNDR unpack input\" },");
846 $self->pidl("{ \"__ndr_unpack_out__\", (PyCFunction)py_$name\_ndr_unpack_out, METH_VARARGS|METH_KEYWORDS,");
848 $self->pidl("\"S.ndr_unpack_out(class, blob, bigendian=False, ndr64=False, allow_remaining=False) -> None\\nNDR unpack output\" },");
850 $self->pidl("{ \"__ndr_print_in__\", (PyCFunction)py_$name\_ndr_print_in, METH_NOARGS, \"S.ndr_print_in(object) -> None\\nNDR print input\" },");
851 $self->pidl("{ \"__ndr_print_out__\", (PyCFunction)py_$name\_ndr_print_out, METH_NOARGS, \"S.ndr_print_out(object) -> None\\nNDR print output\" },");
852 $self->pidl("{ NULL, NULL, 0, NULL }");
857 $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
859 my $docstring = $self->DocString($fn, $name);
860 my $typeobject = "$name\_Type";
861 $self->pidl("static PyTypeObject $typeobject = {");
863 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
864 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
865 $self->pidl(".tp_getset = $getsetters,");
867 $self->pidl(".tp_doc = $docstring,");
869 $self->pidl(".tp_methods = $py_methods,");
870 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
871 $self->pidl(".tp_new = py_$name\_new,");
877 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
878 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
879 "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
882 return "&$typeobject";
885 sub get_metadata_var($)
888 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
890 if (has_property($e, "length_is")) {
891 return get_var($e->{PROPERTIES}->{length_is});
892 } elsif (has_property($e, "size_is")) {
893 return get_var($e->{PROPERTIES}->{size_is});
899 sub find_metadata_args($)
902 my $metadata_args = { in => {}, out => {} };
904 # Determine arguments that are metadata for other arguments (size_is/length_is)
905 foreach my $e (@{$fn->{ELEMENTS}}) {
906 foreach my $dir (@{$e->{DIRECTION}}) {
907 my $main = get_metadata_var($e);
909 $metadata_args->{$dir}->{$main} = $e->{NAME};
914 return $metadata_args;
917 sub PythonFunctionUnpackOut($$$)
919 my ($self, $fn, $fnname) = @_;
921 my $outfnname = "unpack_$fnname\_args_out";
924 my $metadata_args = find_metadata_args($fn);
926 my $env = GenerateFunctionOutEnv($fn, "r->");
929 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
932 $self->pidl("PyObject *result;");
933 foreach my $e (@{$fn->{ELEMENTS}}) {
934 next unless (grep(/out/,@{$e->{DIRECTION}}));
935 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
936 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
937 $self->pidl("PyObject *py_$e->{NAME};");
941 if ($fn->{RETURN_TYPE}) {
942 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
947 if ($result_size > 1) {
948 $self->pidl("result = PyTuple_New($result_size);");
950 } elsif ($result_size == 0) {
951 $self->pidl("result = Py_None;");
952 $self->pidl("Py_INCREF(result);");
953 $signature .= "None";
956 foreach my $e (@{$fn->{ELEMENTS}}) {
957 next if ($metadata_args->{out}->{$e->{NAME}});
958 my $py_name = "py_$e->{NAME}";
959 if (grep(/out/,@{$e->{DIRECTION}})) {
960 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
961 if ($result_size > 1) {
962 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
964 $signature .= "$e->{NAME}, ";
966 $self->pidl("result = $py_name;");
967 $signature .= $e->{NAME};
972 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
973 $self->handle_ntstatus("r->out.result", "NULL", undef);
974 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
975 $self->handle_werror("r->out.result", "NULL", undef);
976 } elsif (defined($fn->{RETURN_TYPE})) {
977 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
978 if ($result_size > 1) {
979 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
981 $self->pidl("result = $conv;");
983 $signature .= "result";
986 if (substr($signature, -2) eq ", ") {
987 $signature = substr($signature, 0, -2);
989 if ($result_size > 1) {
993 $self->pidl("return result;");
998 return ($outfnname, $signature);
1001 sub PythonFunctionPackIn($$$)
1003 my ($self, $fn, $fnname) = @_;
1004 my $metadata_args = find_metadata_args($fn);
1006 my $infnname = "pack_$fnname\_args_in";
1008 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
1011 my $args_format = "";
1012 my $args_string = "";
1013 my $args_names = "";
1016 foreach my $e (@{$fn->{ELEMENTS}}) {
1017 next unless (grep(/in/,@{$e->{DIRECTION}}));
1018 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
1019 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
1020 $self->pidl("PyObject *py_$e->{NAME};");
1021 $args_format .= "O";
1022 $args_string .= ", &py_$e->{NAME}";
1023 $args_names .= "\"$e->{NAME}\", ";
1024 $signature .= "$e->{NAME}, ";
1026 if (substr($signature, -2) eq ", ") {
1027 $signature = substr($signature, 0, -2);
1029 $self->pidl("const char *kwnames[] = {");
1031 $self->pidl($args_names . "NULL");
1036 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
1038 $self->pidl("return false;");
1043 my $env = GenerateFunctionInEnv($fn, "r->");
1045 my $fail = "return false;";
1046 foreach my $e (@{$fn->{ELEMENTS}}) {
1047 next unless (grep(/in/,@{$e->{DIRECTION}}));
1048 if ($metadata_args->{in}->{$e->{NAME}}) {
1049 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
1050 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1051 my $val = "PyList_GET_SIZE($py_var)";
1052 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
1053 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
1054 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
1056 $self->pidl("PyErr_NoMemory();");
1060 $self->pidl("*r->in.$e->{NAME} = $val;");
1062 $self->pidl("r->in.$e->{NAME} = $val;");
1065 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
1068 $self->pidl("return true;");
1072 return ($infnname, $signature);
1075 sub PythonFunction($$$)
1077 my ($self, $fn, $iface, $prettyname) = @_;
1079 my $fnname = "py_$fn->{NAME}";
1080 my $docstring = $self->DocString($fn, $fn->{NAME});
1082 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
1083 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
1084 my $signature = "S.$prettyname($insignature) -> $outsignature";
1086 $docstring = "\"$signature\\n\\n\"$docstring";
1088 $docstring = "\"$signature\"";
1091 return ($infn, $outfn, $docstring);
1094 sub handle_werror($$$$)
1096 my ($self, $var, $retval, $mem_ctx) = @_;
1098 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
1100 $self->pidl("PyErr_SetWERROR($var);");
1101 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
1102 $self->pidl("return $retval;");
1108 sub handle_ntstatus($$$$)
1110 my ($self, $var, $retval, $mem_ctx) = @_;
1112 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
1114 $self->pidl("PyErr_SetNTSTATUS($var);");
1115 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
1116 $self->pidl("return $retval;");
1122 sub PythonType($$$$)
1124 my ($self, $modulename, $d, $interface, $basename) = @_;
1126 my $actual_ctype = $d;
1127 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1128 $actual_ctype = $actual_ctype->{DATA};
1131 if ($actual_ctype->{TYPE} eq "STRUCT") {
1133 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
1135 if ($d->{TYPE} eq "STRUCT") {
1136 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
1138 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
1141 $self->register_module_typeobject($fn_name, $typeobject, $d->{ORIGINAL});
1144 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
1145 $self->EnumAndBitmapConsts($d->{NAME}, $d);
1148 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
1149 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
1152 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
1153 my $prettyname = PrettifyTypeName($d->{NAME}, $basename);
1154 my $typeobject = "$d->{NAME}\_Type";
1155 my $docstring = $self->DocString($d, $d->{NAME});
1156 my $cname = "union $d->{NAME}";
1158 $self->pidl("static PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
1161 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
1166 $self->pidl("static ".mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
1169 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
1174 my $getsetters = "NULL";
1175 my $py_methods = "NULL";
1176 my $typename = mapTypeName($d);
1179 ## PyCapsule (starting with 2.7) vs. PyCObject (up to 3.2)
1181 ## As we need to support python 2.6, we can't use PyCapsule yet.
1183 ## When we'll get support fpr Python3 we'll have to emulate
1184 ## PyCObject using PyCapsule and convert these functions to
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("static const char *mem_ctx_type = \"TALLOC_CTX\";");
1193 $self->pidl("const char *mem_ctx_desc = NULL;");
1194 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
1195 $self->pidl("int level = 0;");
1196 $self->pidl("PyObject *in_obj = NULL;");
1197 $self->pidl("static const char *in_type = \"$typename\";");
1198 $self->pidl("const char *in_desc = NULL;");
1199 $self->pidl("$typename *in = NULL;");
1200 $self->pidl("int cmp;");
1202 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
1204 $self->pidl("discard_const_p(char *, kwnames),");
1205 $self->pidl("&mem_ctx_obj,");
1206 $self->pidl("&level,");
1207 $self->pidl("&in_obj)) {");
1210 $self->pidl("return NULL;");
1213 $self->pidl("if (!PyCObject_Check(mem_ctx_obj)) {");
1215 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx needs to be of type PyCObject!\");");
1216 $self->pidl("return NULL;");
1219 $self->pidl("mem_ctx_desc = (const char *)PyCObject_GetDesc(mem_ctx_obj);");
1221 $self->pidl("if (mem_ctx_desc == NULL) {");
1222 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx hash no PyCObject_GetDesc()!\");");
1223 $self->pidl("return NULL;");
1226 $self->pidl("cmp = strncmp(mem_ctx_type, mem_ctx_desc, strlen(mem_ctx_type) + 1);");
1227 $self->pidl("if (cmp != 0) {");
1229 $self->pidl("PyErr_Format(PyExc_TypeError, \"mem_ctx should have PyCObject_GetDesc() = %s!\", mem_ctx_type);");
1230 $self->pidl("return NULL;");
1233 $self->pidl("mem_ctx = PyCObject_AsVoidPtr(mem_ctx_obj);");
1234 $self->pidl("if (mem_ctx == NULL) {");
1236 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
1237 $self->pidl("return NULL;");
1240 $self->pidl("if (!PyCObject_Check(in_obj)) {");
1242 $self->pidl("PyErr_SetString(PyExc_TypeError, \"in needs to be of type PyCObject!\");");
1243 $self->pidl("return NULL;");
1246 $self->pidl("in_desc = (const char *)PyCObject_GetDesc(in_obj);");
1248 $self->pidl("if (in_desc == NULL) {");
1249 $self->pidl("PyErr_SetString(PyExc_TypeError, \"in hash no PyCObject_GetDesc()!\");");
1250 $self->pidl("return NULL;");
1253 $self->pidl("cmp = strncmp(in_type, in_desc, strlen(in_type) + 1);");
1254 $self->pidl("if (cmp != 0) {");
1256 $self->pidl("PyErr_Format(PyExc_TypeError, \"in should have PyCObject_GetDesc() = %s!\", in_type);");
1257 $self->pidl("return NULL;");
1260 $self->pidl("in = ($typename *)PyCObject_AsVoidPtr(in_obj);");
1262 $self->pidl("return py_import_$d->{NAME}(mem_ctx, level, in);");
1267 $self->pidl("static PyObject *py_$d->{NAME}\_export(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1270 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
1271 $self->pidl("PyObject *mem_ctx_obj = NULL;");
1272 $self->pidl("static const char *mem_ctx_type = \"TALLOC_CTX\";");
1273 $self->pidl("const char *mem_ctx_desc = NULL;");
1274 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
1275 $self->pidl("int level = 0;");
1276 $self->pidl("PyObject *in = NULL;");
1277 $self->pidl("static const char *out_type = \"$typename\";");
1278 $self->pidl("$typename *out = NULL;");
1279 $self->pidl("int cmp;");
1281 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
1283 $self->pidl("discard_const_p(char *, kwnames),");
1284 $self->pidl("&mem_ctx_obj,");
1285 $self->pidl("&level,");
1286 $self->pidl("&in)) {");
1289 $self->pidl("return NULL;");
1292 $self->pidl("if (!PyCObject_Check(mem_ctx_obj)) {");
1294 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx needs to be of type PyCObject!\");");
1295 $self->pidl("return NULL;");
1298 $self->pidl("mem_ctx_desc = (const char *)PyCObject_GetDesc(mem_ctx_obj);");
1300 $self->pidl("if (mem_ctx_desc == NULL) {");
1301 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx hash no PyCObject_GetDesc()!\");");
1302 $self->pidl("return NULL;");
1305 $self->pidl("cmp = strncmp(mem_ctx_type, mem_ctx_desc, strlen(mem_ctx_type) + 1);");
1306 $self->pidl("if (cmp != 0) {");
1308 $self->pidl("PyErr_Format(PyExc_TypeError, \"mem_ctx should have PyCObject_GetDesc() = %s!\", mem_ctx_type);");
1309 $self->pidl("return NULL;");
1312 $self->pidl("mem_ctx = PyCObject_AsVoidPtr(mem_ctx_obj);");
1313 $self->pidl("if (mem_ctx == NULL) {");
1315 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
1316 $self->pidl("return NULL;");
1320 $self->pidl("out = py_export_$d->{NAME}(mem_ctx, level, in);");
1321 $self->pidl("if (out == NULL) {");
1323 $self->pidl("return NULL;");
1326 $self->pidl("return PyCObject_FromVoidPtrAndDesc(out, discard_const_p(char, out_type), NULL);");
1331 $py_methods = "py_$d->{NAME}_methods";
1332 $self->pidl("static PyMethodDef $py_methods\[] = {");
1334 $self->pidl("{ \"__import__\", (PyCFunction)py_$d->{NAME}\_import,");
1336 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
1337 $self->pidl("\"T.__import__(mem_ctx, level, in) => ret.\" },");
1339 $self->pidl("{ \"__export__\", (PyCFunction)py_$d->{NAME}\_export,");
1341 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
1342 $self->pidl("\"T.__export__(mem_ctx, level, in) => ret.\" },");
1344 $self->pidl("{ NULL, NULL, 0, NULL }");
1349 $self->pidl("static PyObject *py_$d->{NAME}\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1352 $self->pidl("PyErr_Format(PyExc_TypeError, \"New %s Objects are not supported\", type->tp_name);");
1353 $self->pidl("return NULL;");
1359 $self->pidl_hdr("static PyTypeObject $typeobject;\n");
1360 $self->pidl("static PyTypeObject $typeobject = {");
1362 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1363 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
1364 $self->pidl(".tp_getset = $getsetters,");
1366 $self->pidl(".tp_doc = $docstring,");
1368 $self->pidl(".tp_methods = $py_methods,");
1369 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1370 $self->pidl(".tp_new = py_$d->{NAME}\_new,");
1376 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
1377 $self->register_module_prereadycode(["$typeobject.tp_base = $talloc_typename;",
1378 "$typeobject.tp_basicsize = pytalloc_BaseObject_size();",
1381 $self->register_module_typeobject($prettyname, "&$typeobject", $d->{ORIGINAL});
1387 my ($self, $d, $name) = @_;
1388 if (has_property($d, "helpstring")) {
1389 my $docstring = uc("py_doc_$name");
1390 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
1399 my($self,$interface,$basename) = @_;
1401 if (has_property($interface, "pyhelper")) {
1402 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
1405 $self->Const($_) foreach (@{$interface->{CONSTS}});
1407 foreach my $d (@{$interface->{TYPES}}) {
1408 next if has_property($d, "nopython");
1410 $self->PythonType($basename, $d, $interface, $basename);
1413 if (defined $interface->{PROPERTIES}->{uuid}) {
1414 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
1419 foreach my $d (@{$interface->{FUNCTIONS}}) {
1420 next if has_property($d, "noopnum");
1421 next if has_property($d, "nopython");
1422 next if has_property($d, "todo");
1425 foreach my $e (@{$d->{ELEMENTS}}) {
1426 if (ContainsPipe($e, $e->{LEVELS}[0])) {
1433 my $prettyname = $d->{NAME};
1435 $prettyname =~ s/^$interface->{NAME}_//;
1436 $prettyname =~ s/^$basename\_//;
1438 my $typeobject = $self->PythonFunctionStruct($basename, $d, $interface->{NAME}, $prettyname);
1439 $self->register_module_typeobject($prettyname, $typeobject, $d->{ORIGINAL});
1441 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
1443 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
1446 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
1448 foreach my $d (@fns) {
1449 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
1450 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
1452 $self->pidl("{ NULL }");
1457 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1460 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
1467 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
1469 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
1470 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
1471 \"credentials should be a credentials.Credentials object.\\n\\n\"";
1473 my $docstring = $self->DocString($interface, $interface->{NAME});
1476 $docstring = "$signature$docstring";
1478 $docstring = $signature;
1481 my $if_typename = "$interface->{NAME}_InterfaceType";
1483 $self->pidl("static PyTypeObject $if_typename = {");
1485 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1486 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
1487 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
1488 $self->pidl(".tp_doc = $docstring,");
1489 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1490 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
1496 $self->register_module_typeobject($interface->{NAME}, "&$if_typename", $interface->{ORIGINAL});
1497 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
1498 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
1499 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
1502 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1505 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
1511 my $signature = "\"$interface->{NAME}_abstract_syntax()\\n\"";
1513 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
1516 $docstring = "$signature$docstring";
1518 $docstring = $signature;
1521 my $syntax_typename = "$interface->{NAME}_SyntaxType";
1523 $self->pidl("static PyTypeObject $syntax_typename = {");
1525 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1526 $self->pidl(".tp_name = \"$basename.$interface->{NAME}_abstract_syntax\",");
1527 $self->pidl(".tp_doc = $docstring,");
1528 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1529 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
1535 $self->register_module_typeobject("$interface->{NAME}_abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1536 if (not defined($self->existing_module_object("abstract_syntax"))) {
1537 # Only the first syntax gets registered with the legacy
1538 # "abstract_syntax" name
1539 $self->register_module_typeobject("abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1541 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
1542 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;",
1543 "$syntax_typename.tp_basicsize = pytalloc_BaseObject_size();",
1547 $self->pidl_hdr("\n");
1550 sub register_module_method($$$$$)
1552 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
1554 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
1557 sub register_module_typeobject($$$$)
1559 my ($self, $name, $py_name, $location) = @_;
1561 $self->register_module_object($name, "(PyObject *)(void *)$py_name", $location);
1563 $self->check_ready_type($py_name);
1565 $self->register_patch_type_call($name, $py_name);
1568 sub check_ready_type($$)
1570 my ($self, $py_name) = @_;
1571 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
1574 sub register_module_import($$)
1576 my ($self, $module_path) = @_;
1578 my $var_name = $module_path;
1579 $var_name =~ s/\./_/g;
1580 $var_name = "dep_$var_name";
1582 unless (defined $self->{module_imports_uniq}->{$var_name}) {
1583 my $h = { "key" => $var_name, "val" => $module_path};
1584 push @{$self->{module_imports}}, $h;
1585 $self->{module_imports_uniq}->{$var_name} = $h;
1590 sub import_type_variable($$$)
1592 my ($self, $module, $name) = @_;
1594 $self->register_module_import($module);
1595 unless (defined $self->{type_imports_uniq}->{$name}) {
1596 my $h = { "key" => $name, "val" => $module};
1597 push @{$self->{type_imports}}, $h;
1598 $self->{type_imports_uniq}->{$name} = $h;
1600 return "$name\_Type";
1603 sub use_type_variable($$)
1605 my ($self, $orig_ctype) = @_;
1606 # FIXME: Have a global lookup table for types that look different on the
1607 # wire than they are named in C?
1608 if ($orig_ctype->{NAME} eq "dom_sid2" or
1609 $orig_ctype->{NAME} eq "dom_sid28" or
1610 $orig_ctype->{NAME} eq "dom_sid0") {
1611 $orig_ctype->{NAME} = "dom_sid";
1613 if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
1614 $orig_ctype->{NAME} = "security_descriptor";
1617 my $ctype = resolveType($orig_ctype);
1618 unless (defined($ctype->{BASEFILE})) {
1621 # If this is an external type, make sure we do the right imports.
1622 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
1623 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
1625 return "&$ctype->{NAME}_Type";
1628 sub register_patch_type_call($$$)
1630 my ($self, $typename, $cvar) = @_;
1632 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
1636 sub register_module_prereadycode($$)
1638 my ($self, $code) = @_;
1640 push (@{$self->{prereadycode}}, @$code);
1643 sub register_module_postreadycode($$)
1645 my ($self, $code) = @_;
1647 push (@{$self->{postreadycode}}, @$code);
1650 sub existing_module_object($$)
1652 my ($self, $name) = @_;
1654 if (defined($self->{module_object_uniq}->{$name})) {
1655 return $self->{module_object_uniq}->{$name};
1661 sub register_module_object($$$$)
1663 my ($self, $name, $py_name, $location) = @_;
1665 my $existing = $self->existing_module_object($name);
1666 fatal($location, "module_object($name, $py_name) registered twice! $existing.") if defined($existing);
1668 push (@{$self->{module_objects}}, [$name, $py_name]);
1669 $self->{module_object_uniq}->{$name} = $py_name;
1674 my ($self, $dest, $src) = @_;
1675 if ($dest =~ /^\&/ and $src eq "NULL") {
1676 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
1677 } elsif ($dest =~ /^\&/) {
1678 my $destvar = get_value_of($dest);
1679 $self->pidl("$destvar = *$src;");
1681 $self->pidl("$dest = $src;");
1685 sub ConvertStringFromPythonData($$$$$)
1687 my ($self, $mem_ctx, $py_var, $target, $fail) = @_;
1691 $self->pidl("const char *test_str;");
1692 $self->pidl("const char *talloc_str;");
1693 $self->pidl("PyObject *unicode = NULL;");
1694 $self->pidl("if (PyUnicode_Check($py_var)) {");
1696 # FIXME: Use Unix charset setting rather than utf-8
1697 $self->pidl("unicode = PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\");");
1698 $self->pidl("if (unicode == NULL) {");
1700 $self->pidl("PyErr_NoMemory();");
1701 $self->pidl("$fail");
1705 $self->pidl("test_str = PyString_AS_STRING(unicode);");
1707 $self->pidl("} else if (PyString_Check($py_var)) {");
1709 $self->pidl("test_str = PyString_AS_STRING($py_var);");
1711 $self->pidl("} else {");
1713 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1714 $self->pidl("$fail");
1717 $self->pidl("talloc_str = talloc_strdup($mem_ctx, test_str);");
1718 $self->pidl("if (unicode != NULL) {");
1720 $self->pidl("Py_DECREF(unicode);");
1723 $self->pidl("if (talloc_str == NULL) {");
1725 $self->pidl("PyErr_NoMemory();");
1726 $self->pidl("$fail");
1729 $self->pidl("$target = talloc_str;");
1734 sub ConvertObjectFromPythonData($$$$$$;$$)
1736 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location, $switch) = @_;
1738 fatal($location, "undef type for $cvar") unless(defined($ctype));
1740 $ctype = resolveType($ctype);
1742 my $actual_ctype = $ctype;
1743 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1744 $actual_ctype = $actual_ctype->{DATA};
1747 # We need to cover ENUMs, BITMAPS and SCALAR values here, as
1748 # all could otherwise be assigned invalid integer values
1749 my $ctype_alias = "";
1751 if ($actual_ctype->{TYPE} eq "ENUM") {
1752 # Importantly, ENUM values are unsigned in pidl, and
1753 # typically map to uint32
1754 $ctype_alias = enum_type_fn($actual_ctype);
1755 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1756 $ctype_alias = bitmap_type_fn($actual_ctype);
1757 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1758 $ctype_alias = expandAlias($actual_ctype->{NAME});
1761 # This is the unsigned Python Integer -> C integer validation
1762 # case. The signed case is below.
1763 if ($ctype_alias =~ /^(uint[0-9]*|hyper|udlong|udlongr
1764 |NTTIME_hyper|NTTIME|NTTIME_1sec
1768 $self->pidl("const unsigned long long uint_max = ndr_sizeof2uintmax(sizeof($target));");
1769 $self->pidl("if (PyLong_Check($cvar)) {");
1771 $self->pidl("unsigned long long test_var;");
1772 $self->pidl("test_var = PyLong_AsUnsignedLongLong($cvar);");
1773 $self->pidl("if (PyErr_Occurred() != NULL) {");
1778 $self->pidl("if (test_var > uint_max) {");
1780 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %llu\",\\");
1781 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1785 $self->pidl("$target = test_var;");
1787 $self->pidl("} else if (PyInt_Check($cvar)) {");
1789 $self->pidl("long test_var;");
1790 $self->pidl("test_var = PyInt_AsLong($cvar);");
1791 $self->pidl("if (test_var < 0 || test_var > uint_max) {");
1793 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %ld\",\\");
1794 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1798 $self->pidl("$target = test_var;");
1800 $self->pidl("} else {");
1802 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1803 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1812 # Confirm the signed python integer fits in the C type
1813 # correctly. It is subtly different from the unsigned case
1814 # above, so while it looks like a duplicate, it is not
1815 # actually a duplicate.
1816 if ($ctype_alias =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1819 $self->pidl("const long long int_max = ndr_sizeof2intmax(sizeof($target));");
1820 $self->pidl("const long long int_min = -int_max - 1;");
1821 $self->pidl("if (PyLong_Check($cvar)) {");
1823 $self->pidl("long long test_var;");
1824 $self->pidl("test_var = PyLong_AsLongLong($cvar);");
1825 $self->pidl("if (PyErr_Occurred() != NULL) {");
1830 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1832 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %lld\",\\");
1833 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1837 $self->pidl("$target = test_var;");
1839 $self->pidl("} else if (PyInt_Check($cvar)) {");
1841 $self->pidl("long test_var;");
1842 $self->pidl("test_var = PyInt_AsLong($cvar);");
1843 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1845 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %ld\",\\");
1846 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1850 $self->pidl("$target = test_var;");
1852 $self->pidl("} else {");
1854 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1855 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
1864 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1865 my $ctype_name = $self->use_type_variable($ctype);
1866 unless (defined ($ctype_name)) {
1867 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1868 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1871 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1872 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1874 $self->pidl("PyErr_NoMemory();");
1875 $self->pidl("$fail");
1878 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1882 if ($actual_ctype->{TYPE} eq "UNION") {
1883 my $ctype_name = $self->use_type_variable($ctype);
1884 unless (defined ($ctype_name)) {
1885 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1886 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1889 my $export = "pyrpc_export_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
1890 $self->assign($target, "(".mapTypeName($ctype)." *)$export");
1894 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1895 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
1899 if ($actual_ctype->{TYPE} eq "SCALAR" and
1900 ($actual_ctype->{NAME} eq "string"
1901 or $actual_ctype->{NAME} eq "nbt_string"
1902 or $actual_ctype->{NAME} eq "nbt_name"
1903 or $actual_ctype->{NAME} eq "wrepl_nbt_name"
1904 or $actual_ctype->{NAME} eq "dns_string"
1905 or $actual_ctype->{NAME} eq "dnsp_string"
1906 or $actual_ctype->{NAME} eq "dns_name"
1907 or $actual_ctype->{NAME} eq "ipv4address"
1908 or $actual_ctype->{NAME} eq "ipv6address"
1909 or $actual_ctype->{NAME} eq "dnsp_name")) {
1910 $self->ConvertStringFromPythonData($mem_ctx, $cvar, $target, $fail);
1914 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1915 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1919 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1920 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1924 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1925 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1929 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1930 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
1934 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1935 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
1939 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1943 sub ConvertObjectFromPythonLevel($$$$$$$$)
1945 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1946 my $nl = GetNextLevel($e, $l);
1947 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1948 $nl = GetNextLevel($e, $nl);
1950 my $pl = GetPrevLevel($e, $l);
1951 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1952 $pl = GetPrevLevel($e, $pl);
1955 $self->pidl("if ($py_var == NULL) {");
1957 $self->pidl("PyErr_Format(PyExc_AttributeError, \"Cannot delete NDR object: " .
1958 mapTypeName($var_name) . "\");");
1963 if ($l->{TYPE} eq "POINTER") {
1964 if ($l->{POINTER_TYPE} ne "ref") {
1965 $self->pidl("if ($py_var == Py_None) {");
1967 $self->pidl("$var_name = NULL;");
1969 $self->pidl("} else {");
1972 # if we want to handle more than one level of pointer in python interfaces
1973 # then this is where we would need to allocate it
1974 if ($l->{POINTER_TYPE} eq "ref") {
1975 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1976 $self->pidl("if ($var_name == NULL) {");
1978 $self->pidl("PyErr_NoMemory();");
1982 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1983 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1984 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1985 $self->pidl("if ($var_name == NULL) {");
1987 $self->pidl("PyErr_NoMemory();");
1992 $self->pidl("$var_name = NULL;");
1994 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1995 $var_name = get_value_of($var_name);
1997 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1998 if ($l->{POINTER_TYPE} ne "ref") {
2002 } elsif ($l->{TYPE} eq "ARRAY") {
2003 if ($pl && $pl->{TYPE} eq "POINTER") {
2004 $var_name = get_pointer_to($var_name);
2007 if (is_charset_array($e, $l)) {
2008 $self->ConvertStringFromPythonData($mem_ctx, $py_var, $var_name, $fail);
2010 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
2011 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
2014 $self->pidl("int $counter;");
2015 if (ArrayDynamicallyAllocated($e, $l)) {
2016 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
2017 $self->pidl("if (!$var_name) { $fail; }");
2018 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
2020 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
2022 $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));");
2023 $self->pidl("$fail");
2027 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
2029 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
2035 } elsif ($l->{TYPE} eq "DATA") {
2036 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
2037 $var_name = get_pointer_to($var_name);
2039 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
2040 } elsif ($l->{TYPE} eq "SWITCH") {
2041 $var_name = get_pointer_to($var_name);
2042 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
2043 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
2046 my $union_type = mapTypeName($nl->{DATA_TYPE});
2047 $self->pidl("$union_type *$switch_ptr;");
2048 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $nl->{DATA_TYPE}, $switch_ptr, $fail, $e->{ORIGINAL}, $switch);
2049 $self->fail_on_null($switch_ptr, $fail);
2050 $self->assign($var_name, "$switch_ptr");
2053 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
2054 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
2056 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
2060 sub ConvertObjectFromPython($$$$$$$)
2062 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
2064 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
2067 sub ConvertScalarToPython($$$)
2069 my ($self, $ctypename, $cvar) = @_;
2071 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
2073 $ctypename = expandAlias($ctypename);
2075 if ($ctypename =~ /^(int64|dlong)$/) {
2076 return "ndr_PyLong_FromLongLong($cvar)";
2079 if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
2080 return "ndr_PyLong_FromUnsignedLongLong($cvar)";
2083 if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
2084 return "PyInt_FromLong($cvar)";
2087 # Needed to ensure unsigned values in a 32 or 16 bit enum is
2088 # cast correctly to a uint32_t, not sign extended to a a
2089 # possibly 64 bit unsigned long. (enums are signed in C,
2091 if ($ctypename =~ /^(uint32|uint3264)$/) {
2092 return "ndr_PyLong_FromUnsignedLongLong((uint32_t)$cvar)";
2095 if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
2096 return "PyInt_FromLong((uint16_t)$cvar)";
2099 if ($ctypename eq "DATA_BLOB") {
2100 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
2103 if ($ctypename eq "NTSTATUS") {
2104 return "PyErr_FromNTSTATUS($cvar)";
2107 if ($ctypename eq "WERROR") {
2108 return "PyErr_FromWERROR($cvar)";
2111 if ($ctypename eq "HRESULT") {
2112 return "PyErr_FromHRESULT($cvar)";
2115 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
2116 return "PyString_FromStringOrNULL($cvar)";
2119 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
2120 return "PyString_FromStringOrNULL($cvar)";
2124 if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
2125 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
2126 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
2127 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
2128 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
2129 if ($ctypename eq "pointer") {
2130 return "pytalloc_CObject_FromTallocPtr($cvar)";
2133 die("Unknown scalar type $ctypename");
2136 sub ConvertObjectToPythonData($$$$$;$$)
2138 my ($self, $mem_ctx, $ctype, $cvar, $location, $switch) = @_;
2140 die("undef type for $cvar") unless(defined($ctype));
2142 $ctype = resolveType($ctype);
2144 my $actual_ctype = $ctype;
2145 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
2146 $actual_ctype = $actual_ctype->{DATA};
2149 if ($actual_ctype->{TYPE} eq "ENUM") {
2150 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
2151 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
2152 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
2153 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
2154 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
2155 } elsif ($actual_ctype->{TYPE} eq "UNION") {
2156 my $ctype_name = $self->use_type_variable($ctype);
2157 unless (defined($ctype_name)) {
2158 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
2159 return "NULL"; # FIXME!
2161 return "pyrpc_import_union($ctype_name, $mem_ctx, $switch, $cvar, \"".mapTypeName($ctype)."\")";
2162 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
2163 my $ctype_name = $self->use_type_variable($ctype);
2164 unless (defined($ctype_name)) {
2165 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
2166 return "NULL"; # FIXME!
2168 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
2171 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
2174 sub fail_on_null($$$)
2176 my ($self, $var, $fail) = @_;
2177 $self->pidl("if ($var == NULL) {");
2184 sub ConvertObjectToPythonLevel($$$$$$)
2186 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
2187 my $nl = GetNextLevel($e, $l);
2188 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
2189 $nl = GetNextLevel($e, $nl);
2191 my $pl = GetPrevLevel($e, $l);
2192 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
2193 $pl = GetPrevLevel($e, $pl);
2196 if ($l->{TYPE} eq "POINTER") {
2197 if ($l->{POINTER_TYPE} ne "ref") {
2198 $self->pidl("if ($var_name == NULL) {");
2200 $self->pidl("$py_var = Py_None;");
2201 $self->pidl("Py_INCREF($py_var);");
2203 $self->pidl("} else {");
2206 my $var_name2 = $var_name;
2207 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
2208 $var_name2 = get_value_of($var_name);
2210 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
2211 if ($l->{POINTER_TYPE} ne "ref") {
2215 } elsif ($l->{TYPE} eq "ARRAY") {
2216 if ($pl && $pl->{TYPE} eq "POINTER") {
2217 $var_name = get_pointer_to($var_name);
2220 if (is_charset_array($e, $l)) {
2221 # FIXME: Use Unix charset setting rather than utf-8
2222 $self->pidl("if ($var_name == NULL) {");
2224 $self->pidl("$py_var = Py_None;");
2225 $self->pidl("Py_INCREF($py_var);");
2227 $self->pidl("} else {");
2229 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
2233 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
2234 my $length = $l->{SIZE_IS};
2235 if (defined($l->{LENGTH_IS})) {
2236 $length = $l->{LENGTH_IS};
2239 $length = ParseExpr($length, $env, $e);
2240 $self->pidl("$py_var = PyList_New($length);");
2241 $self->fail_on_null($py_var, $fail);
2244 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
2245 $self->pidl("int $counter;");
2246 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
2248 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
2249 $self->pidl("PyObject *$member_var;");
2250 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
2251 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
2257 } elsif ($l->{TYPE} eq "SWITCH") {
2258 $var_name = get_pointer_to($var_name);
2259 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
2260 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $nl->{DATA_TYPE}, $var_name, $e->{ORIGINAL}, $switch);
2261 $self->pidl("$py_var = $conv;");
2262 $self->fail_on_null($py_var, $fail);
2264 } elsif ($l->{TYPE} eq "DATA") {
2265 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
2266 $var_name = get_pointer_to($var_name);
2268 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
2269 $self->pidl("$py_var = $conv;");
2270 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
2271 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
2273 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
2277 sub ConvertObjectToPython($$$$$$)
2279 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
2281 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
2286 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
2288 $self->{BASENAME} = $basename;
2291 /* Python wrapper functions auto-generated by pidl */
2292 #define PY_SSIZE_T_CLEAN 1 /* We use Py_ssize_t for PyArg_ParseTupleAndKeywords */
2294 #include \"includes.h\"
2295 #include <pytalloc.h>
2296 #include \"librpc/rpc/pyrpc.h\"
2297 #include \"librpc/rpc/pyrpc_util.h\"
2299 #include \"$ndr_hdr\"
2302 * These functions are here to ensure they can be optimized out by
2303 * the compiler based on the constant input values
2306 static inline unsigned long long ndr_sizeof2uintmax(size_t var_size)
2322 static inline long long ndr_sizeof2intmax(size_t var_size)
2338 static inline PyObject *ndr_PyLong_FromLongLong(long long v)
2340 if (v > LONG_MAX || v < LONG_MIN) {
2341 return PyLong_FromLongLong(v);
2343 return PyInt_FromLong(v);
2347 static inline PyObject *ndr_PyLong_FromUnsignedLongLong(unsigned long long v)
2350 return PyLong_FromUnsignedLongLong(v);
2352 return PyInt_FromLong(v);
2358 foreach my $x (@$ndr) {
2359 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
2360 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
2363 $self->pidl("static PyMethodDef $basename\_methods[] = {");
2365 foreach (@{$self->{module_methods}}) {
2366 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
2367 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
2370 $self->pidl("{ NULL, NULL, 0, NULL }");
2376 $self->pidl_hdr("void init$basename(void);");
2377 $self->pidl("void init$basename(void)");
2380 $self->pidl("PyObject *m;");
2381 foreach my $h (@{$self->{module_imports}}) {
2382 $self->pidl("PyObject *$h->{'key'};");
2386 foreach my $h (@{$self->{module_imports}}) {
2387 my $var_name = $h->{'key'};
2388 my $module_path = $h->{'val'};
2389 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
2390 $self->pidl("if ($var_name == NULL)");
2391 $self->pidl("\treturn;");
2395 foreach my $h (@{$self->{type_imports}}) {
2396 my $type_var = "$h->{'key'}\_Type";
2397 my $module_path = $h->{'val'};
2398 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
2399 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
2400 my $module_var = "dep_$module_path";
2401 $module_var =~ s/\./_/g;
2402 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
2403 $self->pidl("if ($type_var == NULL)");
2404 $self->pidl("\treturn;");
2408 $self->pidl($_) foreach (@{$self->{prereadycode}});
2410 foreach (@{$self->{ready_types}}) {
2411 $self->pidl("if (PyType_Ready($_) < 0)");
2412 $self->pidl("\treturn;");
2415 $self->pidl($_) foreach (@{$self->{postreadycode}});
2417 foreach (@{$self->{patch_type_calls}}) {
2418 my ($typename, $cvar) = @$_;
2419 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
2420 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
2421 $self->pidl("#endif");
2426 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
2427 $self->pidl("if (m == NULL)");
2428 $self->pidl("\treturn;");
2430 foreach my $h (@{$self->{constants}}) {
2431 my $pretty_name = PrettifyTypeName($h->{'key'}, $basename);
2433 my ($ctype, $cvar) = @{$h->{'val'}};
2434 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
2435 $py_obj = "ndr_PyLong_FromUnsignedLongLong($cvar)";
2436 } elsif ($cvar =~ /^".*"$/) {
2437 $py_obj = "PyString_FromString($cvar)";
2439 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
2442 $self->pidl("PyModule_AddObject(m, \"$pretty_name\", $py_obj);");
2445 foreach (@{$self->{module_objects}}) {
2446 my ($object_name, $c_name) = @$_;
2447 $self->pidl("Py_INCREF($c_name);");
2448 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
2451 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
2452 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
2453 $self->pidl("#endif");
2458 return ($self->{res_hdr} . $self->{res});