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);
13 use Parse::Pidl::Typelist qw(hasType resolveType getType mapTypeName expandAlias);
14 use Parse::Pidl::Util qw(has_property ParseExpr unmake_str);
15 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred 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 => "", constants => {},
26 module_methods => [], module_objects => [], ready_types => [],
34 $self->{res_hdr} .= shift;
41 $self->{res} .= $self->{tabs};
50 $self->{tabs} .= "\t";
56 $self->{tabs} = substr($self->{tabs}, 0, -1);
66 $self->pidl_hdr("#include \"librpc/gen_ndr/py_$_\.h\"\n");
72 my ($self, $const) = @_;
73 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
76 sub register_constant($$$$)
78 my ($self, $name, $type, $value) = @_;
80 $self->{constants}->{$name} = [$type, $value];
83 sub EnumAndBitmapConsts($$$)
85 my ($self, $name, $d) = @_;
87 return unless (defined($d->{ELEMENTS}));
89 foreach my $e (@{$d->{ELEMENTS}}) {
90 $e =~ /^([A-Za-z0-9_]+)/;
93 $self->register_constant($cname, $d, $cname);
97 sub FromUnionToPythonFunction($$$$)
99 my ($self, $mem_ctx, $type, $switch, $name) = @_;
101 $self->pidl("PyObject *ret;");
104 $self->pidl("switch ($switch) {");
107 foreach my $e (@{$type->{ELEMENTS}}) {
108 $self->pidl("$e->{CASE}:");
113 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
115 $self->pidl("ret = Py_None;");
118 $self->pidl("return ret;");
127 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
128 $self->pidl("return NULL;");
131 sub FromPythonToUnionFunction($$$$$)
133 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
137 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
139 $self->pidl("switch ($switch) {");
142 foreach my $e (@{$type->{ELEMENTS}}) {
143 $self->pidl("$e->{CASE}:");
144 if ($e->{CASE} eq "default") { $has_default = 1; }
147 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
149 $self->pidl("break;");
155 $self->pidl("default:");
157 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
158 $self->pidl("talloc_free(ret);");
159 $self->pidl("ret = NULL;");
166 $self->pidl("return ret;");
169 sub PythonStruct($$$$$$)
171 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
173 my $env = GenerateStructEnv($d, "object");
177 my $getsetters = "NULL";
179 if ($#{$d->{ELEMENTS}} > -1) {
180 foreach my $e (@{$d->{ELEMENTS}}) {
181 my $varname = "object->$e->{NAME}";
182 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
185 $self->pidl("$cname *object = py_talloc_get_ptr(obj);");
186 $self->pidl("PyObject *py_$e->{NAME};");
187 $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
188 $self->pidl("return py_$e->{NAME};");
193 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
196 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
197 my $mem_ctx = "py_talloc_get_mem_ctx(py_obj)";
198 my $l = $e->{LEVELS}[0];
199 my $nl = GetNextLevel($e, $l);
200 if ($l->{TYPE} eq "POINTER" and
201 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
202 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
203 $self->pidl("talloc_free($varname);");
205 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
206 $self->pidl("return 0;");
212 $getsetters = "py_$name\_getsetters";
213 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
215 foreach my $e (@{$d->{ELEMENTS}}) {
216 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
218 $self->pidl("{ NULL }");
224 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *self, PyObject *args, PyObject *kwargs)");
227 $self->pidl("char *kwlist[] = {NULL};");
228 $self->pidl("$cname *ret = talloc_zero(NULL, $cname);");
229 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"\", kwlist))");
230 $self->pidl("\treturn NULL;");
231 $self->pidl("return py_talloc_import(&$name\_Type, ret);");
236 my $py_methods = "NULL";
238 # If the struct is not public there ndr_pull/ndr_push functions will
239 # be static so not callable from here
240 if (has_property($d, "public")) {
241 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
244 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
245 $self->pidl("DATA_BLOB blob;");
246 $self->pidl("enum ndr_err_code err;");
247 $self->pidl("err = ndr_push_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), NULL, object, (ndr_push_flags_fn_t)ndr_push_$name);");
248 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
250 $self->pidl("PyErr_SetNdrError(err);");
251 $self->pidl("return NULL;");
255 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
260 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
263 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
264 $self->pidl("DATA_BLOB blob;");
265 $self->pidl("enum ndr_err_code err;");
266 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
267 $self->pidl("\treturn NULL;");
269 $self->pidl("err = ndr_pull_struct_blob_all(&blob, py_talloc_get_mem_ctx(py_obj), NULL, object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
270 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
272 $self->pidl("PyErr_SetNdrError(err);");
273 $self->pidl("return NULL;");
277 $self->pidl("return Py_None;");
281 $py_methods = "py_$name\_methods";
282 $self->pidl("static PyMethodDef $py_methods\[] = {");
284 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
285 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
287 $self->pidl("#ifdef ".uc("py_$name\_extra_methods"));
288 $self->pidl("\t" .uc("py_$name\_extra_methods"));
289 $self->pidl("#endif");
291 $self->pidl("{ NULL, NULL, 0, NULL }");
297 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $name\_Type;\n");
298 $self->pidl_hdr("#define $name\_Check(op) PyObject_TypeCheck(op, &$name\_Type)\n");
299 $self->pidl_hdr("#define $name\_CheckExact(op) ((op)->ob_type == &$name\_Type)\n");
300 $self->pidl_hdr("\n");
301 $self->pidl("#ifndef ".uc("py_$name\_repr"));
302 $self->pidl("#define ".uc("py_$name\_repr") . " py_talloc_default_repr");
303 $self->pidl("#endif");
305 my $docstring = ($self->DocString($d, $name) or "NULL");
306 my $typeobject = "$name\_Type";
307 $self->pidl("PyTypeObject $typeobject = {");
309 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
310 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
311 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
312 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
313 $self->pidl(".tp_getset = $getsetters,");
314 $self->pidl(".tp_repr = ".uc("py_$name\_repr").",");
315 $self->pidl(".tp_doc = $docstring,");
316 $self->pidl(".tp_methods = $py_methods,");
317 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
318 $self->pidl(".tp_new = py_$name\_new,");
324 return "&$typeobject";
327 sub get_metadata_var($)
330 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
332 if (has_property($e, "length_is")) {
333 return get_var($e->{PROPERTIES}->{length_is});
334 } elsif (has_property($e, "size_is")) {
335 return get_var($e->{PROPERTIES}->{size_is});
341 sub find_metadata_args($)
344 my $metadata_args = { in => {}, out => {} };
346 # Determine arguments that are metadata for other arguments (size_is/length_is)
347 foreach my $e (@{$fn->{ELEMENTS}}) {
348 foreach my $dir (@{$e->{DIRECTION}}) {
349 my $main = get_metadata_var($e);
351 $metadata_args->{$dir}->{$main} = $e->{NAME};
356 return $metadata_args;
359 sub PythonFunctionUnpackOut($$$)
361 my ($self, $fn, $fnname) = @_;
363 my $outfnname = "unpack_$fnname\_args_out";
366 my $metadata_args = find_metadata_args($fn);
368 my $env = GenerateFunctionOutEnv($fn, "r->");
371 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
374 $self->pidl("PyObject *result = Py_None;");
375 foreach my $e (@{$fn->{ELEMENTS}}) {
376 next unless (grep(/out/,@{$e->{DIRECTION}}));
377 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
378 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
379 $self->pidl("PyObject *py_$e->{NAME};");
383 if ($fn->{RETURN_TYPE}) {
384 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
389 if ($result_size > 1) {
390 $self->pidl("result = PyTuple_New($result_size);");
392 } elsif ($result_size == 0) {
393 $signature .= "None";
396 foreach my $e (@{$fn->{ELEMENTS}}) {
397 next if ($metadata_args->{out}->{$e->{NAME}});
398 my $py_name = "py_$e->{NAME}";
399 if (grep(/out/,@{$e->{DIRECTION}})) {
400 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
401 if ($result_size > 1) {
402 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
404 $signature .= "$e->{NAME}, ";
406 $self->pidl("result = $py_name;");
407 $signature .= $e->{NAME};
412 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
413 $self->handle_ntstatus("r->out.result", "NULL", undef);
414 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
415 $self->handle_werror("r->out.result", "NULL", undef);
416 } elsif (defined($fn->{RETURN_TYPE})) {
417 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result");
418 if ($result_size > 1) {
419 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
421 $self->pidl("result = $conv;");
423 $signature .= "result";
426 if (substr($signature, -2) eq ", ") {
427 $signature = substr($signature, 0, -2);
429 if ($result_size > 1) {
433 $self->pidl("return result;");
438 return ($outfnname, $signature);
441 sub PythonFunctionPackIn($$$)
443 my ($self, $fn, $fnname) = @_;
444 my $metadata_args = find_metadata_args($fn);
446 my $infnname = "pack_$fnname\_args_in";
448 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
451 my $args_format = "";
452 my $args_string = "";
456 foreach my $e (@{$fn->{ELEMENTS}}) {
457 next unless (grep(/in/,@{$e->{DIRECTION}}));
458 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
459 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
460 $self->pidl("PyObject *py_$e->{NAME};");
462 $args_string .= ", &py_$e->{NAME}";
463 $args_names .= "\"$e->{NAME}\", ";
464 $signature .= "$e->{NAME}, ";
466 if (substr($signature, -2) eq ", ") {
467 $signature = substr($signature, 0, -2);
469 $self->pidl("const char *kwnames[] = {");
471 $self->pidl($args_names . "NULL");
476 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
478 $self->pidl("return false;");
483 my $env = GenerateFunctionInEnv($fn, "r->");
485 my $fail = "return false;";
486 foreach my $e (@{$fn->{ELEMENTS}}) {
487 next unless (grep(/in/,@{$e->{DIRECTION}}));
488 if ($metadata_args->{in}->{$e->{NAME}}) {
489 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
490 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
491 my $val = "PyList_Size($py_var)";
492 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
493 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
494 $self->pidl("*r->in.$e->{NAME} = $val;");
496 $self->pidl("r->in.$e->{NAME} = $val;");
499 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
502 $self->pidl("return true;");
506 return ($infnname, $signature);
509 sub PythonFunction($$$)
511 my ($self, $fn, $iface, $prettyname) = @_;
513 my $fnname = "py_$fn->{NAME}";
514 my $docstring = $self->DocString($fn, $fn->{NAME});
516 my ($insignature, $outsignature);
519 if (has_property($fn, "todo")) {
520 unless ($docstring) { $docstring = "NULL"; }
524 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
525 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
526 my $signature = "S.$prettyname($insignature) -> $outsignature";
528 $docstring = "\"$signature\\n\\n\"$docstring";
530 $docstring = "\"$signature\"";
534 return ($infn, $outfn, $docstring);
537 sub handle_werror($$$$)
539 my ($self, $var, $retval, $mem_ctx) = @_;
541 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
543 $self->pidl("PyErr_SetWERROR($var);");
544 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
545 $self->pidl("return $retval;");
551 sub handle_ntstatus($$$$)
553 my ($self, $var, $retval, $mem_ctx) = @_;
555 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
557 $self->pidl("PyErr_SetNTSTATUS($var);");
558 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
559 $self->pidl("return $retval;");
567 my ($self, $modulename, $d, $interface, $basename) = @_;
569 my $actual_ctype = $d;
570 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
571 $actual_ctype = $actual_ctype->{DATA};
574 if ($actual_ctype->{TYPE} eq "STRUCT") {
576 my $fn_name = $d->{NAME};
578 $fn_name =~ s/^$interface->{NAME}_//;
579 $fn_name =~ s/^$basename\_//;
582 if ($d->{TYPE} eq "STRUCT") {
583 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
585 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
588 $self->register_module_typeobject($fn_name, $typeobject);
591 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
592 $self->EnumAndBitmapConsts($d->{NAME}, $d);
595 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
596 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
599 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
600 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
603 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
608 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
611 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
620 my ($self, $d, $name) = @_;
621 if (has_property($d, "helpstring")) {
622 my $docstring = uc("py_doc_$name");
623 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
632 my($self,$interface,$basename) = @_;
634 $self->pidl_hdr("#ifndef _HEADER_PYTHON_$interface->{NAME}\n");
635 $self->pidl_hdr("#define _HEADER_PYTHON_$interface->{NAME}\n\n");
637 $self->pidl_hdr("\n");
639 if (has_property($interface, "pyhelper")) {
640 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
643 $self->Const($_) foreach (@{$interface->{CONSTS}});
645 foreach my $d (@{$interface->{TYPES}}) {
646 next if has_property($d, "nopython");
648 $self->PythonType($basename, $d, $interface, $basename);
651 if (defined $interface->{PROPERTIES}->{uuid}) {
652 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $interface->{NAME}_InterfaceType;\n");
657 foreach my $d (@{$interface->{FUNCTIONS}}) {
658 next if not defined($d->{OPNUM});
659 next if has_property($d, "nopython");
661 my $prettyname = $d->{NAME};
663 $prettyname =~ s/^$interface->{NAME}_//;
664 $prettyname =~ s/^$basename\_//;
666 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
668 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}", $prettyname, $fndocstring, $d->{OPNUM}]);
671 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
672 $self->pidl_hdr("extern const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[];");
674 foreach my $d (@fns) {
675 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
676 $self->pidl("{ \"$prettyname\", $docstring, (dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
678 $self->pidl("{ NULL }");
683 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *self, PyObject *args, PyObject *kwargs)");
686 $self->pidl("dcerpc_InterfaceObject *ret;");
687 $self->pidl("const char *binding_string;");
688 $self->pidl("struct cli_credentials *credentials;");
689 $self->pidl("struct loadparm_context *lp_ctx = NULL;");
690 $self->pidl("PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;");
691 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
692 $self->pidl("struct event_context *event_ctx;");
693 $self->pidl("NTSTATUS status;");
695 $self->pidl("const char *kwnames[] = {");
697 $self->pidl("\"binding\", \"lp_ctx\", \"credentials\", \"basis_connection\", NULL");
700 $self->pidl("extern struct loadparm_context *lp_from_py_object(PyObject *py_obj);");
701 $self->pidl("extern struct cli_credentials *cli_credentials_from_py_object(PyObject *py_obj);");
703 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s|OOO:$interface->{NAME}\", discard_const_p(char *, kwnames), &binding_string, &py_lp_ctx, &py_credentials, &py_basis)) {");
705 $self->pidl("return NULL;");
709 $self->pidl("lp_ctx = lp_from_py_object(py_lp_ctx);");
710 $self->pidl("if (lp_ctx == NULL) {");
712 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected loadparm context\");");
713 $self->pidl("return NULL;");
718 $self->pidl("status = dcerpc_init(lp_ctx);");
719 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
721 $self->pidl("PyErr_SetNTSTATUS(status);");
722 $self->pidl("return NULL;");
726 $self->pidl("credentials = cli_credentials_from_py_object(py_credentials);");
727 $self->pidl("if (credentials == NULL) {");
729 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected credentials\");");
730 $self->pidl("return NULL;");
734 $self->pidl("ret = PyObject_New(dcerpc_InterfaceObject, &$interface->{NAME}_InterfaceType);");
736 $self->pidl("event_ctx = event_context_init(mem_ctx);");
739 $self->pidl("if (py_basis != Py_None) {");
741 $self->pidl("struct dcerpc_pipe *base_pipe;");
743 $self->pidl("if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {");
745 $self->pidl("PyErr_SetString(PyExc_ValueError, \"basis_connection must be a DCE/RPC connection\");");
746 $self->pidl("talloc_free(mem_ctx);");
747 $self->pidl("return NULL;");
751 $self->pidl("base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;");
753 $self->pidl("status = dcerpc_secondary_context(base_pipe, &ret->pipe, &ndr_table_$interface->{NAME});");
755 $self->pidl("} else {");
757 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
758 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, event_ctx, lp_ctx);");
761 $self->handle_ntstatus("status", "NULL", "mem_ctx");
763 $self->pidl("ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;");
765 $self->pidl("return (PyObject *)ret;");
772 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
774 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
775 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
776 \"credentials should be a credentials.Credentials object.\\n\\n\"";
778 my $docstring = $self->DocString($interface, $interface->{NAME});
781 $docstring = "$signature$docstring";
783 $docstring = $signature;
786 $self->pidl("PyTypeObject $interface->{NAME}_InterfaceType = {");
788 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
789 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
790 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
791 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
792 $self->pidl(".tp_doc = $docstring,");
793 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
794 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
800 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
801 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
804 $self->pidl_hdr("\n");
805 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */\n");
808 sub register_module_method($$$$$)
810 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
812 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
815 sub register_module_typeobject($$$)
817 my ($self, $name, $py_name) = @_;
819 $self->register_module_object($name, "(PyObject *)$py_name");
821 $self->check_ready_type($py_name);
824 sub check_ready_type($$)
826 my ($self, $py_name) = @_;
827 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
830 sub register_module_readycode($$)
832 my ($self, $code) = @_;
834 push (@{$self->{readycode}}, @$code);
837 sub register_module_object($$$)
839 my ($self, $name, $py_name) = @_;
841 push (@{$self->{module_objects}}, [$name, $py_name])
846 my ($self, $dest, $src) = @_;
847 if ($dest =~ /^\&/) {
848 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
850 $self->pidl("$dest = $src;");
854 sub ConvertObjectFromPythonData($$$$$$)
856 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail) = @_;
858 die("undef type for $cvar") unless(defined($ctype));
860 $ctype = resolveType($ctype);
862 my $actual_ctype = $ctype;
863 if ($ctype->{TYPE} eq "TYPEDEF") {
864 $actual_ctype = $ctype->{DATA};
867 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
868 $actual_ctype->{TYPE} eq "SCALAR" and (
869 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
870 $self->pidl("PY_CHECK_TYPE(PyInt, $cvar, $fail);");
871 $self->pidl("$target = PyInt_AsLong($cvar);");
875 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
876 $self->pidl("PY_CHECK_TYPE($ctype->{NAME}, $cvar, $fail);");
877 $self->assign($target, "py_talloc_get_ptr($cvar)");
881 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
882 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
886 if ($actual_ctype->{TYPE} eq "SCALAR" and
887 ($actual_ctype->{NAME} eq "string" or $actual_ctype->{NAME} eq "nbt_string" or $actual_ctype->{NAME} eq "nbt_name" or $actual_ctype->{NAME} eq "wrepl_nbt_name")) {
888 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
892 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
893 $self->pidl("$target = PyString_AsString($cvar);");
898 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
899 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
903 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
904 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
908 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
909 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
913 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
914 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
918 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
922 sub ConvertObjectFromPythonLevel($$$$$$$$)
924 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
925 my $nl = GetNextLevel($e, $l);
927 if ($l->{TYPE} eq "POINTER") {
928 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
929 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
932 if ($l->{POINTER_TYPE} ne "ref") {
933 $self->pidl("if ($py_var == Py_None) {");
935 $self->pidl("$var_name = NULL;");
937 $self->pidl("} else {");
940 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
941 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
942 if ($l->{POINTER_TYPE} ne "ref") {
946 } elsif ($l->{TYPE} eq "ARRAY") {
947 my $pl = GetPrevLevel($e, $l);
948 if ($pl && $pl->{TYPE} eq "POINTER") {
949 $var_name = get_pointer_to($var_name);
952 if (is_charset_array($e, $l)) {
953 $self->pidl("PY_CHECK_TYPE(PyUnicode, $py_var, $fail);");
954 # FIXME: Use Unix charset setting rather than utf-8
955 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
957 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
958 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
961 $self->pidl("int $counter;");
962 if (ArrayDynamicallyAllocated($e, $l)) {
963 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
965 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
967 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
973 } elsif ($l->{TYPE} eq "DATA") {
975 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
976 $var_name = get_pointer_to($var_name);
978 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail);
979 } elsif ($l->{TYPE} eq "SWITCH") {
980 $var_name = get_pointer_to($var_name);
981 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
982 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
983 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
984 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
986 die("unknown level type $l->{TYPE}");
990 sub ConvertObjectFromPython($$$$$$$)
992 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
994 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
997 sub ConvertScalarToPython($$$)
999 my ($self, $ctypename, $cvar) = @_;
1001 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1003 $ctypename = expandAlias($ctypename);
1005 if ($ctypename =~ /^(char|u?int[0-9]*|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1006 return "PyInt_FromLong($cvar)";
1009 if ($ctypename eq "DATA_BLOB") {
1010 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1013 if ($ctypename eq "NTSTATUS") {
1014 return "PyErr_FromNTSTATUS($cvar)";
1017 if ($ctypename eq "WERROR") {
1018 return "PyErr_FromWERROR($cvar)";
1021 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1022 return "PyString_FromString($cvar)";
1026 if ($ctypename eq "string_array") { return "PyCObject_FromVoidPtr($cvar)"; }
1027 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
1028 if ($ctypename eq "pointer") {
1029 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
1032 die("Unknown scalar type $ctypename");
1035 sub ConvertObjectToPythonData($$$$$)
1037 my ($self, $mem_ctx, $ctype, $cvar) = @_;
1039 die("undef type for $cvar") unless(defined($ctype));
1041 $ctype = resolveType($ctype);
1043 my $actual_ctype = $ctype;
1044 if ($ctype->{TYPE} eq "TYPEDEF") {
1045 $actual_ctype = $ctype->{DATA};
1048 if ($actual_ctype->{TYPE} eq "ENUM") {
1049 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1050 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1051 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1052 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1053 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1054 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1055 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1056 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1057 return "py_talloc_import_ex(&$ctype->{NAME}_Type, $mem_ctx, $cvar)";
1060 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1063 sub fail_on_null($$$)
1065 my ($self, $var, $fail) = @_;
1066 $self->pidl("if ($var == NULL) {");
1073 sub ConvertObjectToPythonLevel($$$$$$)
1075 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1076 my $nl = GetNextLevel($e, $l);
1078 if ($l->{TYPE} eq "POINTER") {
1079 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1080 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1083 if ($l->{POINTER_TYPE} ne "ref") {
1084 $self->pidl("if ($var_name == NULL) {");
1086 $self->pidl("$py_var = Py_None;");
1088 $self->pidl("} else {");
1091 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1092 if ($l->{POINTER_TYPE} ne "ref") {
1096 } elsif ($l->{TYPE} eq "ARRAY") {
1097 my $pl = GetPrevLevel($e, $l);
1098 if ($pl && $pl->{TYPE} eq "POINTER") {
1099 $var_name = get_pointer_to($var_name);
1102 if (is_charset_array($e, $l)) {
1103 # FIXME: Use Unix charset setting rather than utf-8
1104 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1106 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1107 my $length = $l->{SIZE_IS};
1108 if (defined($l->{LENGTH_IS})) {
1109 $length = $l->{LENGTH_IS};
1112 $length = ParseExpr($length, $env, $e);
1113 $self->pidl("$py_var = PyList_New($length);");
1114 $self->fail_on_null($py_var, $fail);
1117 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1118 $self->pidl("int $counter;");
1119 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1121 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1122 $self->pidl("PyObject *$member_var;");
1123 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1124 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1130 } elsif ($l->{TYPE} eq "SWITCH") {
1131 $var_name = get_pointer_to($var_name);
1132 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1133 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1134 $self->fail_on_null($py_var, $fail);
1136 } elsif ($l->{TYPE} eq "DATA") {
1137 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1138 $var_name = get_pointer_to($var_name);
1140 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name);
1141 $self->pidl("$py_var = $conv;");
1142 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1143 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1145 die("Unknown level type $l->{TYPE} $var_name");
1149 sub ConvertObjectToPython($$$$$$)
1151 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1153 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1158 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1161 $py_hdr =~ s/ndr_([^\/]+)$/py_$1/g;
1163 $self->pidl_hdr("/* header auto-generated by pidl */\n\n");
1166 /* Python wrapper functions auto-generated by pidl */
1167 #include \"includes.h\"
1169 #include \"librpc/rpc/dcerpc.h\"
1170 #include \"lib/talloc/pytalloc.h\"
1171 #include \"librpc/rpc/pyrpc.h\"
1172 #include \"lib/events/events.h\"
1174 #include \"$ndr_hdr\"
1175 #include \"$py_hdr\"
1179 foreach my $x (@$ndr) {
1180 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1181 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1184 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1186 foreach (@{$self->{module_methods}}) {
1187 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1188 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1191 $self->pidl("{ NULL, NULL, 0, NULL }");
1197 $self->pidl("void init$basename(void)");
1200 $self->pidl("PyObject *m;");
1203 foreach (@{$self->{ready_types}}) {
1204 $self->pidl("if (PyType_Ready($_) < 0)");
1205 $self->pidl("\treturn;");
1208 $self->pidl($_) foreach (@{$self->{readycode}});
1212 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1213 $self->pidl("if (m == NULL)");
1214 $self->pidl("\treturn;");
1216 foreach my $name (keys %{$self->{constants}}) {
1218 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1219 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1220 $py_obj = "PyInt_FromLong($cvar)";
1221 } elsif ($cvar =~ /^".*"$/) {
1222 $py_obj = "PyString_FromString($cvar)";
1224 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar);
1227 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1230 foreach (@{$self->{module_objects}}) {
1231 my ($object_name, $c_name) = @$_;
1232 $self->pidl("Py_INCREF($c_name);");
1233 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1239 return ($self->{res_hdr}, $self->{res});