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("$cname *ret = talloc_zero(NULL, $cname);");
228 $self->pidl("return py_talloc_import(&$name\_Type, ret);");
233 my $py_methods = "NULL";
235 # If the struct is not public there ndr_pull/ndr_push functions will
236 # be static so not callable from here
237 if (has_property($d, "public")) {
238 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
241 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
242 $self->pidl("DATA_BLOB blob;");
243 $self->pidl("enum ndr_err_code err;");
244 $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);");
245 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
247 $self->pidl("PyErr_SetNdrError(err);");
248 $self->pidl("return NULL;");
252 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
257 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
260 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
261 $self->pidl("DATA_BLOB blob;");
262 $self->pidl("enum ndr_err_code err;");
263 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
264 $self->pidl("\treturn NULL;");
266 $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);");
267 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
269 $self->pidl("PyErr_SetNdrError(err);");
270 $self->pidl("return NULL;");
274 $self->pidl("return Py_None;");
278 $py_methods = "py_$name\_methods";
279 $self->pidl("static PyMethodDef $py_methods\[] = {");
281 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
282 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
283 $self->pidl("{ NULL, NULL, 0, NULL }");
289 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $name\_Type;\n");
290 $self->pidl_hdr("#define $name\_Check(op) PyObject_TypeCheck(op, &$name\_Type)\n");
291 $self->pidl_hdr("#define $name\_CheckExact(op) ((op)->ob_type == &$name\_Type)\n");
292 $self->pidl_hdr("\n");
293 my $docstring = ($self->DocString($d, $name) or "NULL");
294 my $typeobject = "$name\_Type";
295 $self->pidl("PyTypeObject $typeobject = {");
297 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
298 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
299 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
300 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
301 $self->pidl(".tp_getset = $getsetters,");
302 $self->pidl(".tp_repr = py_talloc_default_repr,");
303 $self->pidl(".tp_doc = $docstring,");
304 $self->pidl(".tp_methods = $py_methods,");
305 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
306 $self->pidl(".tp_new = py_$name\_new,");
312 return "&$typeobject";
315 sub get_metadata_var($)
318 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
320 if (has_property($e, "length_is")) {
321 return get_var($e->{PROPERTIES}->{length_is});
322 } elsif (has_property($e, "size_is")) {
323 return get_var($e->{PROPERTIES}->{size_is});
329 sub find_metadata_args($)
332 my $metadata_args = { in => {}, out => {} };
334 # Determine arguments that are metadata for other arguments (size_is/length_is)
335 foreach my $e (@{$fn->{ELEMENTS}}) {
336 foreach my $dir (@{$e->{DIRECTION}}) {
337 my $main = get_metadata_var($e);
339 $metadata_args->{$dir}->{$main} = $e->{NAME};
344 return $metadata_args;
347 sub PythonFunctionUnpackOut($$$)
349 my ($self, $fn, $fnname) = @_;
351 my $outfnname = "unpack_$fnname\_args_out";
354 my $metadata_args = find_metadata_args($fn);
356 my $env = GenerateFunctionOutEnv($fn, "r->");
359 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
362 $self->pidl("PyObject *result = Py_None;");
363 foreach my $e (@{$fn->{ELEMENTS}}) {
364 next unless (grep(/out/,@{$e->{DIRECTION}}));
365 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
366 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
367 $self->pidl("PyObject *py_$e->{NAME};");
371 if ($fn->{RETURN_TYPE}) {
372 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
377 if ($result_size > 1) {
378 $self->pidl("result = PyTuple_New($result_size);");
380 } elsif ($result_size == 0) {
381 $signature .= "None";
384 foreach my $e (@{$fn->{ELEMENTS}}) {
385 next if ($metadata_args->{out}->{$e->{NAME}});
386 my $py_name = "py_$e->{NAME}";
387 if (grep(/out/,@{$e->{DIRECTION}})) {
388 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
389 if ($result_size > 1) {
390 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
392 $signature .= "$e->{NAME}, ";
394 $self->pidl("result = $py_name;");
395 $signature .= $e->{NAME};
400 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
401 $self->handle_ntstatus("r->out.result", "NULL", undef);
402 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
403 $self->handle_werror("r->out.result", "NULL", undef);
404 } elsif (defined($fn->{RETURN_TYPE})) {
405 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result");
406 if ($result_size > 1) {
407 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
409 $self->pidl("result = $conv;");
411 $signature .= "result";
414 if (substr($signature, -2) eq ", ") {
415 $signature = substr($signature, 0, -2);
417 if ($result_size > 1) {
421 $self->pidl("return result;");
426 return ($outfnname, $signature);
429 sub PythonFunctionPackIn($$$)
431 my ($self, $fn, $fnname) = @_;
432 my $metadata_args = find_metadata_args($fn);
434 my $infnname = "pack_$fnname\_args_in";
436 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
439 my $args_format = "";
440 my $args_string = "";
444 foreach my $e (@{$fn->{ELEMENTS}}) {
445 next unless (grep(/in/,@{$e->{DIRECTION}}));
446 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
447 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
448 $self->pidl("PyObject *py_$e->{NAME};");
450 $args_string .= ", &py_$e->{NAME}";
451 $args_names .= "\"$e->{NAME}\", ";
452 $signature .= "$e->{NAME}, ";
454 if (substr($signature, -2) eq ", ") {
455 $signature = substr($signature, 0, -2);
457 $self->pidl("const char *kwnames[] = {");
459 $self->pidl($args_names . "NULL");
464 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
466 $self->pidl("return false;");
471 my $env = GenerateFunctionInEnv($fn, "r->");
473 my $fail = "return false;";
474 foreach my $e (@{$fn->{ELEMENTS}}) {
475 next unless (grep(/in/,@{$e->{DIRECTION}}));
476 if ($metadata_args->{in}->{$e->{NAME}}) {
477 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
478 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
479 my $val = "PyList_Size($py_var)";
480 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
481 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
482 $self->pidl("*r->in.$e->{NAME} = $val;");
484 $self->pidl("r->in.$e->{NAME} = $val;");
487 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
490 $self->pidl("return true;");
494 return ($infnname, $signature);
497 sub PythonFunction($$$)
499 my ($self, $fn, $iface, $prettyname) = @_;
501 my $fnname = "py_$fn->{NAME}";
502 my $docstring = $self->DocString($fn, $fn->{NAME});
504 my ($insignature, $outsignature);
507 if (has_property($fn, "todo")) {
508 unless ($docstring) { $docstring = "NULL"; }
512 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
513 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
514 my $signature = "S.$prettyname($insignature) -> $outsignature";
516 $docstring = "\"$signature\\n\\n\"$docstring";
518 $docstring = "\"$signature\"";
522 return ($infn, $outfn, $docstring);
525 sub handle_werror($$$$)
527 my ($self, $var, $retval, $mem_ctx) = @_;
529 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
531 $self->pidl("PyErr_SetWERROR($var);");
532 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
533 $self->pidl("return $retval;");
539 sub handle_ntstatus($$$$)
541 my ($self, $var, $retval, $mem_ctx) = @_;
543 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
545 $self->pidl("PyErr_SetNTSTATUS($var);");
546 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
547 $self->pidl("return $retval;");
555 my ($self, $modulename, $d, $interface, $basename) = @_;
557 my $actual_ctype = $d;
558 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
559 $actual_ctype = $actual_ctype->{DATA};
562 if ($actual_ctype->{TYPE} eq "STRUCT") {
564 my $fn_name = $d->{NAME};
566 $fn_name =~ s/^$interface->{NAME}_//;
567 $fn_name =~ s/^$basename\_//;
570 if ($d->{TYPE} eq "STRUCT") {
571 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
573 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
576 $self->register_module_typeobject($fn_name, $typeobject);
579 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
580 $self->EnumAndBitmapConsts($d->{NAME}, $d);
583 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
584 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
587 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
588 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
591 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
596 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
599 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
608 my ($self, $d, $name) = @_;
609 if (has_property($d, "helpstring")) {
610 my $docstring = uc("py_doc_$name");
611 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
620 my($self,$interface,$basename) = @_;
622 $self->pidl_hdr("#ifndef _HEADER_PYTHON_$interface->{NAME}\n");
623 $self->pidl_hdr("#define _HEADER_PYTHON_$interface->{NAME}\n\n");
625 $self->pidl_hdr("\n");
627 $self->Const($_) foreach (@{$interface->{CONSTS}});
629 foreach my $d (@{$interface->{TYPES}}) {
630 next if has_property($d, "nopython");
632 $self->PythonType($basename, $d, $interface, $basename);
635 if (defined $interface->{PROPERTIES}->{uuid}) {
636 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $interface->{NAME}_InterfaceType;\n");
641 foreach my $d (@{$interface->{FUNCTIONS}}) {
642 next if not defined($d->{OPNUM});
643 next if has_property($d, "nopython");
645 my $prettyname = $d->{NAME};
647 $prettyname =~ s/^$interface->{NAME}_//;
648 $prettyname =~ s/^$basename\_//;
650 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
652 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}", $prettyname, $fndocstring, $d->{OPNUM}]);
655 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
656 $self->pidl_hdr("extern const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[];");
658 foreach my $d (@fns) {
659 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
660 $self->pidl("{ \"$prettyname\", $docstring, (dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
662 $self->pidl("{ NULL }");
667 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *self, PyObject *args, PyObject *kwargs)");
670 $self->pidl("dcerpc_InterfaceObject *ret;");
671 $self->pidl("const char *binding_string;");
672 $self->pidl("struct cli_credentials *credentials;");
673 $self->pidl("struct loadparm_context *lp_ctx = NULL;");
674 $self->pidl("PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;");
675 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
676 $self->pidl("struct event_context *event_ctx;");
677 $self->pidl("NTSTATUS status;");
679 $self->pidl("const char *kwnames[] = {");
681 $self->pidl("\"binding\", \"lp_ctx\", \"credentials\", \"basis_connection\", NULL");
684 $self->pidl("extern struct loadparm_context *lp_from_py_object(PyObject *py_obj);");
685 $self->pidl("extern struct cli_credentials *cli_credentials_from_py_object(PyObject *py_obj);");
687 $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)) {");
689 $self->pidl("return NULL;");
693 $self->pidl("lp_ctx = lp_from_py_object(py_lp_ctx);");
694 $self->pidl("if (lp_ctx == NULL) {");
696 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected loadparm context\");");
697 $self->pidl("return NULL;");
702 $self->pidl("status = dcerpc_init(lp_ctx);");
703 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
705 $self->pidl("PyErr_SetNTSTATUS(status);");
706 $self->pidl("return NULL;");
710 $self->pidl("credentials = cli_credentials_from_py_object(py_credentials);");
711 $self->pidl("if (credentials == NULL) {");
713 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected credentials\");");
714 $self->pidl("return NULL;");
718 $self->pidl("ret = PyObject_New(dcerpc_InterfaceObject, &$interface->{NAME}_InterfaceType);");
720 $self->pidl("event_ctx = event_context_init(mem_ctx);");
723 $self->pidl("if (py_basis != Py_None) {");
725 $self->pidl("struct dcerpc_pipe *base_pipe;");
727 $self->pidl("if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {");
729 $self->pidl("PyErr_SetString(PyExc_ValueError, \"basis_connection must be a DCE/RPC connection\");");
730 $self->pidl("talloc_free(mem_ctx);");
731 $self->pidl("return NULL;");
735 $self->pidl("base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;");
737 $self->pidl("status = dcerpc_secondary_context(base_pipe, &ret->pipe, &ndr_table_$interface->{NAME});");
739 $self->pidl("} else {");
741 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
742 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, event_ctx, lp_ctx);");
745 $self->handle_ntstatus("status", "NULL", "mem_ctx");
747 $self->pidl("ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;");
749 $self->pidl("return (PyObject *)ret;");
756 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
758 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
759 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
760 \"credentials should be a credentials.Credentials object.\\n\\n\"";
762 my $docstring = $self->DocString($interface, $interface->{NAME});
765 $docstring = "$signature$docstring";
767 $docstring = $signature;
770 $self->pidl("PyTypeObject $interface->{NAME}_InterfaceType = {");
772 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
773 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
774 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
775 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
776 $self->pidl(".tp_doc = $docstring,");
777 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
778 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
784 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
785 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
788 $self->pidl_hdr("\n");
789 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */\n");
792 sub register_module_method($$$$$)
794 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
796 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
799 sub register_module_typeobject($$$)
801 my ($self, $name, $py_name) = @_;
803 $self->register_module_object($name, "(PyObject *)$py_name");
805 $self->check_ready_type($py_name);
808 sub check_ready_type($$)
810 my ($self, $py_name) = @_;
811 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
814 sub register_module_readycode($$)
816 my ($self, $code) = @_;
818 push (@{$self->{readycode}}, @$code);
821 sub register_module_object($$$)
823 my ($self, $name, $py_name) = @_;
825 push (@{$self->{module_objects}}, [$name, $py_name])
830 my ($self, $dest, $src) = @_;
831 if ($dest =~ /^\&/) {
832 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
834 $self->pidl("$dest = $src;");
838 sub ConvertObjectFromPythonData($$$$$$)
840 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail) = @_;
842 die("undef type for $cvar") unless(defined($ctype));
844 $ctype = resolveType($ctype);
846 my $actual_ctype = $ctype;
847 if ($ctype->{TYPE} eq "TYPEDEF") {
848 $actual_ctype = $ctype->{DATA};
851 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
852 $actual_ctype->{TYPE} eq "SCALAR" and (
853 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
854 $self->pidl("PY_CHECK_TYPE(PyInt, $cvar, $fail);");
855 $self->pidl("$target = PyInt_AsLong($cvar);");
859 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
860 $self->pidl("PY_CHECK_TYPE($ctype->{NAME}, $cvar, $fail);");
861 $self->assign($target, "py_talloc_get_ptr($cvar)");
865 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
866 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
870 if ($actual_ctype->{TYPE} eq "SCALAR" and
871 ($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")) {
872 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
876 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
877 $self->pidl("$target = PyString_AsString($cvar);");
882 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
883 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
887 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
888 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
892 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
893 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
897 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
898 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
902 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
906 sub ConvertObjectFromPythonLevel($$$$$$$$)
908 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
909 my $nl = GetNextLevel($e, $l);
911 if ($l->{TYPE} eq "POINTER") {
912 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
913 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
916 if ($l->{POINTER_TYPE} ne "ref") {
917 $self->pidl("if ($py_var == Py_None) {");
919 $self->pidl("$var_name = NULL;");
921 $self->pidl("} else {");
924 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
925 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
926 if ($l->{POINTER_TYPE} ne "ref") {
930 } elsif ($l->{TYPE} eq "ARRAY") {
931 my $pl = GetPrevLevel($e, $l);
932 if ($pl && $pl->{TYPE} eq "POINTER") {
933 $var_name = get_pointer_to($var_name);
936 if (is_charset_array($e, $l)) {
937 $self->pidl("PY_CHECK_TYPE(PyUnicode, $py_var, $fail);");
938 # FIXME: Use Unix charset setting rather than utf-8
939 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
941 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
942 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
945 $self->pidl("int $counter;");
946 if (ArrayDynamicallyAllocated($e, $l)) {
947 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
949 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
951 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
957 } elsif ($l->{TYPE} eq "DATA") {
959 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
960 $var_name = get_pointer_to($var_name);
962 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail);
963 } elsif ($l->{TYPE} eq "SWITCH") {
964 $var_name = get_pointer_to($var_name);
965 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
966 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
967 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
968 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
970 die("unknown level type $l->{TYPE}");
974 sub ConvertObjectFromPython($$$$$$$)
976 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
978 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
981 sub ConvertScalarToPython($$$)
983 my ($self, $ctypename, $cvar) = @_;
985 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
987 $ctypename = expandAlias($ctypename);
989 if ($ctypename =~ /^(char|u?int[0-9]*|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
990 return "PyInt_FromLong($cvar)";
993 if ($ctypename eq "DATA_BLOB") {
994 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
997 if ($ctypename eq "NTSTATUS") {
998 return "PyErr_FromNTSTATUS($cvar)";
1001 if ($ctypename eq "WERROR") {
1002 return "PyErr_FromWERROR($cvar)";
1005 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1006 return "PyString_FromString($cvar)";
1010 if ($ctypename eq "string_array") { return "PyCObject_FromVoidPtr($cvar)"; }
1011 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
1012 if ($ctypename eq "pointer") {
1013 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
1016 die("Unknown scalar type $ctypename");
1019 sub ConvertObjectToPythonData($$$$$)
1021 my ($self, $mem_ctx, $ctype, $cvar) = @_;
1023 die("undef type for $cvar") unless(defined($ctype));
1025 $ctype = resolveType($ctype);
1027 my $actual_ctype = $ctype;
1028 if ($ctype->{TYPE} eq "TYPEDEF") {
1029 $actual_ctype = $ctype->{DATA};
1032 if ($actual_ctype->{TYPE} eq "ENUM") {
1033 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1034 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1035 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1036 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1037 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1038 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1039 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1040 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1041 return "py_talloc_import_ex(&$ctype->{NAME}_Type, $mem_ctx, $cvar)";
1044 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1047 sub fail_on_null($$$)
1049 my ($self, $var, $fail) = @_;
1050 $self->pidl("if ($var == NULL) {");
1057 sub ConvertObjectToPythonLevel($$$$$$)
1059 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1060 my $nl = GetNextLevel($e, $l);
1062 if ($l->{TYPE} eq "POINTER") {
1063 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1064 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1067 if ($l->{POINTER_TYPE} ne "ref") {
1068 $self->pidl("if ($var_name == NULL) {");
1070 $self->pidl("$py_var = Py_None;");
1072 $self->pidl("} else {");
1075 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1076 if ($l->{POINTER_TYPE} ne "ref") {
1080 } elsif ($l->{TYPE} eq "ARRAY") {
1081 my $pl = GetPrevLevel($e, $l);
1082 if ($pl && $pl->{TYPE} eq "POINTER") {
1083 $var_name = get_pointer_to($var_name);
1086 if (is_charset_array($e, $l)) {
1087 # FIXME: Use Unix charset setting rather than utf-8
1088 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1090 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1091 my $length = $l->{SIZE_IS};
1092 if (defined($l->{LENGTH_IS})) {
1093 $length = $l->{LENGTH_IS};
1096 $length = ParseExpr($length, $env, $e);
1097 $self->pidl("$py_var = PyList_New($length);");
1098 $self->fail_on_null($py_var, $fail);
1101 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1102 $self->pidl("int $counter;");
1103 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1105 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1106 $self->pidl("PyObject *$member_var;");
1107 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1108 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1114 } elsif ($l->{TYPE} eq "SWITCH") {
1115 $var_name = get_pointer_to($var_name);
1116 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1117 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1118 $self->fail_on_null($py_var, $fail);
1120 } elsif ($l->{TYPE} eq "DATA") {
1121 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1122 $var_name = get_pointer_to($var_name);
1124 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name);
1125 $self->pidl("$py_var = $conv;");
1126 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1127 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1129 die("Unknown level type $l->{TYPE} $var_name");
1133 sub ConvertObjectToPython($$$$$$)
1135 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1137 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1142 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1145 $py_hdr =~ s/ndr_([^\/]+)$/py_$1/g;
1147 $self->pidl_hdr("/* header auto-generated by pidl */\n\n");
1150 /* Python wrapper functions auto-generated by pidl */
1151 #include \"includes.h\"
1153 #include \"librpc/rpc/dcerpc.h\"
1154 #include \"lib/talloc/pytalloc.h\"
1155 #include \"librpc/rpc/pyrpc.h\"
1156 #include \"lib/events/events.h\"
1158 #include \"$ndr_hdr\"
1159 #include \"$py_hdr\"
1163 foreach my $x (@$ndr) {
1164 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1165 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1168 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1170 foreach (@{$self->{module_methods}}) {
1171 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1172 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1175 $self->pidl("{ NULL, NULL, 0, NULL }");
1181 $self->pidl("void init$basename(void)");
1184 $self->pidl("PyObject *m;");
1187 foreach (@{$self->{ready_types}}) {
1188 $self->pidl("if (PyType_Ready($_) < 0)");
1189 $self->pidl("\treturn;");
1192 $self->pidl($_) foreach (@{$self->{readycode}});
1196 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1197 $self->pidl("if (m == NULL)");
1198 $self->pidl("\treturn;");
1200 foreach my $name (keys %{$self->{constants}}) {
1202 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1203 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1204 $py_obj = "PyInt_FromLong($cvar)";
1205 } elsif ($cvar =~ /^".*"$/) {
1206 $py_obj = "PyString_FromString($cvar)";
1208 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar);
1211 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1214 foreach (@{$self->{module_objects}}) {
1215 my ($object_name, $c_name) = @$_;
1216 $self->pidl("Py_INCREF($c_name);");
1217 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1223 return ($self->{res_hdr}, $self->{res});