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 => [],
27 patch_type_calls => [], readycode => [] };
34 $self->{res_hdr} .= shift;
41 if ((!($d =~ /^#/))) {
42 $self->{res} .= $self->{tabs};
52 $self->{tabs} .= "\t";
58 $self->{tabs} = substr($self->{tabs}, 0, -1);
68 $self->pidl_hdr("#include \"librpc/gen_ndr/py_$_\.h\"\n");
74 my ($self, $const) = @_;
75 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
78 sub register_constant($$$$)
80 my ($self, $name, $type, $value) = @_;
82 $self->{constants}->{$name} = [$type, $value];
85 sub EnumAndBitmapConsts($$$)
87 my ($self, $name, $d) = @_;
89 return unless (defined($d->{ELEMENTS}));
91 foreach my $e (@{$d->{ELEMENTS}}) {
92 $e =~ /^([A-Za-z0-9_]+)/;
95 $self->register_constant($cname, $d, $cname);
99 sub FromUnionToPythonFunction($$$$)
101 my ($self, $mem_ctx, $type, $switch, $name) = @_;
103 $self->pidl("PyObject *ret;");
106 $self->pidl("switch ($switch) {");
109 foreach my $e (@{$type->{ELEMENTS}}) {
110 $self->pidl("$e->{CASE}:");
115 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
117 $self->pidl("ret = Py_None;");
120 $self->pidl("return ret;");
129 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
130 $self->pidl("return NULL;");
133 sub FromPythonToUnionFunction($$$$$)
135 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
139 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
141 $self->pidl("switch ($switch) {");
144 foreach my $e (@{$type->{ELEMENTS}}) {
145 $self->pidl("$e->{CASE}:");
146 if ($e->{CASE} eq "default") { $has_default = 1; }
149 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
151 $self->pidl("break;");
157 $self->pidl("default:");
159 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
160 $self->pidl("talloc_free(ret);");
161 $self->pidl("ret = NULL;");
168 $self->pidl("return ret;");
171 sub PythonStruct($$$$$$)
173 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
175 my $env = GenerateStructEnv($d, "object");
179 my $getsetters = "NULL";
181 if ($#{$d->{ELEMENTS}} > -1) {
182 foreach my $e (@{$d->{ELEMENTS}}) {
183 my $varname = "object->$e->{NAME}";
184 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
187 $self->pidl("$cname *object = py_talloc_get_ptr(obj);");
188 $self->pidl("PyObject *py_$e->{NAME};");
189 $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
190 $self->pidl("return py_$e->{NAME};");
195 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
198 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
199 my $mem_ctx = "py_talloc_get_mem_ctx(py_obj)";
200 my $l = $e->{LEVELS}[0];
201 my $nl = GetNextLevel($e, $l);
202 if ($l->{TYPE} eq "POINTER" and
203 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
204 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
205 $self->pidl("talloc_free($varname);");
207 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
208 $self->pidl("return 0;");
214 $getsetters = "py_$name\_getsetters";
215 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
217 foreach my $e (@{$d->{ELEMENTS}}) {
218 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
220 $self->pidl("{ NULL }");
226 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
229 $self->pidl("return py_talloc_new($cname, type);");
234 my $py_methods = "NULL";
236 # If the struct is not public there ndr_pull/ndr_push functions will
237 # be static so not callable from here
238 if (has_property($d, "public")) {
239 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
242 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
243 $self->pidl("DATA_BLOB blob;");
244 $self->pidl("enum ndr_err_code err;");
245 $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);");
246 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
248 $self->pidl("PyErr_SetNdrError(err);");
249 $self->pidl("return NULL;");
253 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
258 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
261 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
262 $self->pidl("DATA_BLOB blob;");
263 $self->pidl("enum ndr_err_code err;");
264 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
265 $self->pidl("\treturn NULL;");
267 $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);");
268 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
270 $self->pidl("PyErr_SetNdrError(err);");
271 $self->pidl("return NULL;");
275 $self->pidl("return Py_None;");
279 $py_methods = "py_$name\_methods";
280 $self->pidl("static PyMethodDef $py_methods\[] = {");
282 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
283 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
284 $self->pidl("{ NULL, NULL, 0, NULL }");
290 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $name\_Type;\n");
291 $self->pidl_hdr("#define $name\_Check(op) PyObject_TypeCheck(op, &$name\_Type)\n");
292 $self->pidl_hdr("#define $name\_CheckExact(op) ((op)->ob_type == &$name\_Type)\n");
293 $self->pidl_hdr("\n");
295 my $docstring = $self->DocString($d, $name);
296 my $typeobject = "$name\_Type";
297 $self->pidl("PyTypeObject $typeobject = {");
299 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
300 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
301 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
302 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
303 $self->pidl(".tp_getset = $getsetters,");
304 $self->pidl(".tp_repr = py_talloc_default_repr,");
306 $self->pidl(".tp_doc = $docstring,");
308 $self->pidl(".tp_methods = $py_methods,");
309 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
310 $self->pidl(".tp_new = py_$name\_new,");
316 return "&$typeobject";
319 sub get_metadata_var($)
322 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
324 if (has_property($e, "length_is")) {
325 return get_var($e->{PROPERTIES}->{length_is});
326 } elsif (has_property($e, "size_is")) {
327 return get_var($e->{PROPERTIES}->{size_is});
333 sub find_metadata_args($)
336 my $metadata_args = { in => {}, out => {} };
338 # Determine arguments that are metadata for other arguments (size_is/length_is)
339 foreach my $e (@{$fn->{ELEMENTS}}) {
340 foreach my $dir (@{$e->{DIRECTION}}) {
341 my $main = get_metadata_var($e);
343 $metadata_args->{$dir}->{$main} = $e->{NAME};
348 return $metadata_args;
351 sub PythonFunctionUnpackOut($$$)
353 my ($self, $fn, $fnname) = @_;
355 my $outfnname = "unpack_$fnname\_args_out";
358 my $metadata_args = find_metadata_args($fn);
360 my $env = GenerateFunctionOutEnv($fn, "r->");
363 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
366 $self->pidl("PyObject *result = Py_None;");
367 foreach my $e (@{$fn->{ELEMENTS}}) {
368 next unless (grep(/out/,@{$e->{DIRECTION}}));
369 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
370 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
371 $self->pidl("PyObject *py_$e->{NAME};");
375 if ($fn->{RETURN_TYPE}) {
376 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
381 if ($result_size > 1) {
382 $self->pidl("result = PyTuple_New($result_size);");
384 } elsif ($result_size == 0) {
385 $signature .= "None";
388 foreach my $e (@{$fn->{ELEMENTS}}) {
389 next if ($metadata_args->{out}->{$e->{NAME}});
390 my $py_name = "py_$e->{NAME}";
391 if (grep(/out/,@{$e->{DIRECTION}})) {
392 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
393 if ($result_size > 1) {
394 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
396 $signature .= "$e->{NAME}, ";
398 $self->pidl("result = $py_name;");
399 $signature .= $e->{NAME};
404 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
405 $self->handle_ntstatus("r->out.result", "NULL", undef);
406 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
407 $self->handle_werror("r->out.result", "NULL", undef);
408 } elsif (defined($fn->{RETURN_TYPE})) {
409 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result");
410 if ($result_size > 1) {
411 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
413 $self->pidl("result = $conv;");
415 $signature .= "result";
418 if (substr($signature, -2) eq ", ") {
419 $signature = substr($signature, 0, -2);
421 if ($result_size > 1) {
425 $self->pidl("return result;");
430 return ($outfnname, $signature);
433 sub PythonFunctionPackIn($$$)
435 my ($self, $fn, $fnname) = @_;
436 my $metadata_args = find_metadata_args($fn);
438 my $infnname = "pack_$fnname\_args_in";
440 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
443 my $args_format = "";
444 my $args_string = "";
448 foreach my $e (@{$fn->{ELEMENTS}}) {
449 next unless (grep(/in/,@{$e->{DIRECTION}}));
450 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
451 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
452 $self->pidl("PyObject *py_$e->{NAME};");
454 $args_string .= ", &py_$e->{NAME}";
455 $args_names .= "\"$e->{NAME}\", ";
456 $signature .= "$e->{NAME}, ";
458 if (substr($signature, -2) eq ", ") {
459 $signature = substr($signature, 0, -2);
461 $self->pidl("const char *kwnames[] = {");
463 $self->pidl($args_names . "NULL");
468 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
470 $self->pidl("return false;");
475 my $env = GenerateFunctionInEnv($fn, "r->");
477 my $fail = "return false;";
478 foreach my $e (@{$fn->{ELEMENTS}}) {
479 next unless (grep(/in/,@{$e->{DIRECTION}}));
480 if ($metadata_args->{in}->{$e->{NAME}}) {
481 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
482 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
483 my $val = "PyList_Size($py_var)";
484 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
485 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
486 $self->pidl("*r->in.$e->{NAME} = $val;");
488 $self->pidl("r->in.$e->{NAME} = $val;");
491 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
494 $self->pidl("return true;");
498 return ($infnname, $signature);
501 sub PythonFunction($$$)
503 my ($self, $fn, $iface, $prettyname) = @_;
505 my $fnname = "py_$fn->{NAME}";
506 my $docstring = $self->DocString($fn, $fn->{NAME});
508 my ($insignature, $outsignature);
511 if (has_property($fn, "todo")) {
512 unless ($docstring) { $docstring = "NULL"; }
516 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
517 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
518 my $signature = "S.$prettyname($insignature) -> $outsignature";
520 $docstring = "\"$signature\\n\\n\"$docstring";
522 $docstring = "\"$signature\"";
526 return ($infn, $outfn, $docstring);
529 sub handle_werror($$$$)
531 my ($self, $var, $retval, $mem_ctx) = @_;
533 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
535 $self->pidl("PyErr_SetWERROR($var);");
536 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
537 $self->pidl("return $retval;");
543 sub handle_ntstatus($$$$)
545 my ($self, $var, $retval, $mem_ctx) = @_;
547 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
549 $self->pidl("PyErr_SetNTSTATUS($var);");
550 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
551 $self->pidl("return $retval;");
559 my ($self, $modulename, $d, $interface, $basename) = @_;
561 my $actual_ctype = $d;
562 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
563 $actual_ctype = $actual_ctype->{DATA};
566 if ($actual_ctype->{TYPE} eq "STRUCT") {
568 my $fn_name = $d->{NAME};
570 $fn_name =~ s/^$interface->{NAME}_//;
571 $fn_name =~ s/^$basename\_//;
574 if ($d->{TYPE} eq "STRUCT") {
575 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
577 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
580 $self->register_module_typeobject($fn_name, $typeobject);
583 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
584 $self->EnumAndBitmapConsts($d->{NAME}, $d);
587 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
588 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
591 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
592 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
595 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
600 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
603 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
612 my ($self, $d, $name) = @_;
613 if (has_property($d, "helpstring")) {
614 my $docstring = uc("py_doc_$name");
615 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
624 my($self,$interface,$basename) = @_;
626 $self->pidl_hdr("#ifndef _HEADER_PYTHON_$interface->{NAME}\n");
627 $self->pidl_hdr("#define _HEADER_PYTHON_$interface->{NAME}\n\n");
629 $self->pidl_hdr("\n");
631 if (has_property($interface, "pyhelper")) {
632 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
635 $self->Const($_) foreach (@{$interface->{CONSTS}});
637 foreach my $d (@{$interface->{TYPES}}) {
638 next if has_property($d, "nopython");
640 $self->PythonType($basename, $d, $interface, $basename);
643 if (defined $interface->{PROPERTIES}->{uuid}) {
644 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $interface->{NAME}_InterfaceType;\n");
649 foreach my $d (@{$interface->{FUNCTIONS}}) {
650 next if not defined($d->{OPNUM});
651 next if has_property($d, "nopython");
653 my $prettyname = $d->{NAME};
655 $prettyname =~ s/^$interface->{NAME}_//;
656 $prettyname =~ s/^$basename\_//;
658 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
660 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}", $prettyname, $fndocstring, $d->{OPNUM}]);
663 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
664 $self->pidl_hdr("extern const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[];");
666 foreach my $d (@fns) {
667 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
668 $self->pidl("{ \"$prettyname\", $docstring, (dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
670 $self->pidl("{ NULL }");
675 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
678 $self->pidl("dcerpc_InterfaceObject *ret;");
679 $self->pidl("const char *binding_string;");
680 $self->pidl("struct cli_credentials *credentials;");
681 $self->pidl("struct loadparm_context *lp_ctx = NULL;");
682 $self->pidl("PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;");
683 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
684 $self->pidl("struct event_context *event_ctx;");
685 $self->pidl("NTSTATUS status;");
687 $self->pidl("const char *kwnames[] = {");
689 $self->pidl("\"binding\", \"lp_ctx\", \"credentials\", \"basis_connection\", NULL");
692 $self->pidl("extern struct loadparm_context *lp_from_py_object(PyObject *py_obj);");
693 $self->pidl("extern struct cli_credentials *cli_credentials_from_py_object(PyObject *py_obj);");
695 $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)) {");
697 $self->pidl("return NULL;");
701 $self->pidl("lp_ctx = lp_from_py_object(py_lp_ctx);");
702 $self->pidl("if (lp_ctx == NULL) {");
704 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected loadparm context\");");
705 $self->pidl("return NULL;");
710 $self->pidl("status = dcerpc_init(lp_ctx);");
711 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
713 $self->pidl("PyErr_SetNTSTATUS(status);");
714 $self->pidl("return NULL;");
718 $self->pidl("credentials = cli_credentials_from_py_object(py_credentials);");
719 $self->pidl("if (credentials == NULL) {");
721 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected credentials\");");
722 $self->pidl("return NULL;");
726 $self->pidl("ret = PyObject_New(dcerpc_InterfaceObject, type);");
728 $self->pidl("event_ctx = event_context_init(mem_ctx);");
731 $self->pidl("if (py_basis != Py_None) {");
733 $self->pidl("struct dcerpc_pipe *base_pipe;");
735 $self->pidl("if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {");
737 $self->pidl("PyErr_SetString(PyExc_ValueError, \"basis_connection must be a DCE/RPC connection\");");
738 $self->pidl("talloc_free(mem_ctx);");
739 $self->pidl("return NULL;");
743 $self->pidl("base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;");
745 $self->pidl("status = dcerpc_secondary_context(base_pipe, &ret->pipe, &ndr_table_$interface->{NAME});");
747 $self->pidl("} else {");
749 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
750 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, event_ctx, lp_ctx);");
753 $self->handle_ntstatus("status", "NULL", "mem_ctx");
755 $self->pidl("ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;");
757 $self->pidl("return (PyObject *)ret;");
764 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
766 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
767 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
768 \"credentials should be a credentials.Credentials object.\\n\\n\"";
770 my $docstring = $self->DocString($interface, $interface->{NAME});
773 $docstring = "$signature$docstring";
775 $docstring = $signature;
778 $self->pidl("PyTypeObject $interface->{NAME}_InterfaceType = {");
780 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
781 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
782 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
783 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
784 $self->pidl(".tp_doc = $docstring,");
785 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
786 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
792 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
793 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
796 $self->pidl_hdr("\n");
797 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */\n");
800 sub register_module_method($$$$$)
802 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
804 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
807 sub register_module_typeobject($$$)
809 my ($self, $name, $py_name) = @_;
811 $self->register_module_object($name, "(PyObject *)$py_name");
813 $self->check_ready_type($py_name);
815 $self->register_patch_type_call($name, $py_name);
818 sub check_ready_type($$)
820 my ($self, $py_name) = @_;
821 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
824 sub register_patch_type_call($$$)
826 my ($self, $typename, $cvar) = @_;
828 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
832 sub register_module_readycode($$)
834 my ($self, $code) = @_;
836 push (@{$self->{readycode}}, @$code);
839 sub register_module_object($$$)
841 my ($self, $name, $py_name) = @_;
843 push (@{$self->{module_objects}}, [$name, $py_name])
848 my ($self, $dest, $src) = @_;
849 if ($dest =~ /^\&/) {
850 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
852 $self->pidl("$dest = $src;");
856 sub ConvertObjectFromPythonData($$$$$$)
858 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail) = @_;
860 die("undef type for $cvar") unless(defined($ctype));
862 $ctype = resolveType($ctype);
864 my $actual_ctype = $ctype;
865 if ($ctype->{TYPE} eq "TYPEDEF") {
866 $actual_ctype = $ctype->{DATA};
869 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
870 $actual_ctype->{TYPE} eq "SCALAR" and (
871 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
872 $self->pidl("PY_CHECK_TYPE(PyInt, $cvar, $fail);");
873 $self->pidl("$target = PyInt_AsLong($cvar);");
877 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
878 $self->pidl("PY_CHECK_TYPE($ctype->{NAME}, $cvar, $fail);");
879 $self->assign($target, "py_talloc_get_ptr($cvar)");
883 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
884 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
888 if ($actual_ctype->{TYPE} eq "SCALAR" and
889 ($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")) {
890 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
894 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
895 $self->pidl("$target = PyString_AsString($cvar);");
900 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
901 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
905 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
906 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
910 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
911 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
915 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
916 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
920 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
924 sub ConvertObjectFromPythonLevel($$$$$$$$)
926 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
927 my $nl = GetNextLevel($e, $l);
929 if ($l->{TYPE} eq "POINTER") {
930 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
931 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
934 if ($l->{POINTER_TYPE} ne "ref") {
935 $self->pidl("if ($py_var == Py_None) {");
937 $self->pidl("$var_name = NULL;");
939 $self->pidl("} else {");
942 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
943 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
944 if ($l->{POINTER_TYPE} ne "ref") {
948 } elsif ($l->{TYPE} eq "ARRAY") {
949 my $pl = GetPrevLevel($e, $l);
950 if ($pl && $pl->{TYPE} eq "POINTER") {
951 $var_name = get_pointer_to($var_name);
954 if (is_charset_array($e, $l)) {
955 $self->pidl("PY_CHECK_TYPE(PyUnicode, $py_var, $fail);");
956 # FIXME: Use Unix charset setting rather than utf-8
957 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
959 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
960 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
963 $self->pidl("int $counter;");
964 if (ArrayDynamicallyAllocated($e, $l)) {
965 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
967 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
969 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
975 } elsif ($l->{TYPE} eq "DATA") {
977 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
978 $var_name = get_pointer_to($var_name);
980 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail);
981 } elsif ($l->{TYPE} eq "SWITCH") {
982 $var_name = get_pointer_to($var_name);
983 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
984 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
985 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
986 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
988 die("unknown level type $l->{TYPE}");
992 sub ConvertObjectFromPython($$$$$$$)
994 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
996 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
999 sub ConvertScalarToPython($$$)
1001 my ($self, $ctypename, $cvar) = @_;
1003 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1005 $ctypename = expandAlias($ctypename);
1007 if ($ctypename =~ /^(char|u?int[0-9]*|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1008 return "PyInt_FromLong($cvar)";
1011 if ($ctypename eq "DATA_BLOB") {
1012 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1015 if ($ctypename eq "NTSTATUS") {
1016 return "PyErr_FromNTSTATUS($cvar)";
1019 if ($ctypename eq "WERROR") {
1020 return "PyErr_FromWERROR($cvar)";
1023 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1024 return "PyString_FromString($cvar)";
1028 if ($ctypename eq "string_array") { return "PyCObject_FromVoidPtr($cvar)"; }
1029 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
1030 if ($ctypename eq "pointer") {
1031 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
1034 die("Unknown scalar type $ctypename");
1037 sub ConvertObjectToPythonData($$$$$)
1039 my ($self, $mem_ctx, $ctype, $cvar) = @_;
1041 die("undef type for $cvar") unless(defined($ctype));
1043 $ctype = resolveType($ctype);
1045 my $actual_ctype = $ctype;
1046 if ($ctype->{TYPE} eq "TYPEDEF") {
1047 $actual_ctype = $ctype->{DATA};
1050 if ($actual_ctype->{TYPE} eq "ENUM") {
1051 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1052 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1053 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1054 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1055 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1056 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1057 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1058 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1059 return "py_talloc_import_ex(&$ctype->{NAME}_Type, $mem_ctx, $cvar)";
1062 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1065 sub fail_on_null($$$)
1067 my ($self, $var, $fail) = @_;
1068 $self->pidl("if ($var == NULL) {");
1075 sub ConvertObjectToPythonLevel($$$$$$)
1077 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1078 my $nl = GetNextLevel($e, $l);
1080 if ($l->{TYPE} eq "POINTER") {
1081 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1082 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1085 if ($l->{POINTER_TYPE} ne "ref") {
1086 $self->pidl("if ($var_name == NULL) {");
1088 $self->pidl("$py_var = Py_None;");
1090 $self->pidl("} else {");
1093 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1094 if ($l->{POINTER_TYPE} ne "ref") {
1098 } elsif ($l->{TYPE} eq "ARRAY") {
1099 my $pl = GetPrevLevel($e, $l);
1100 if ($pl && $pl->{TYPE} eq "POINTER") {
1101 $var_name = get_pointer_to($var_name);
1104 if (is_charset_array($e, $l)) {
1105 # FIXME: Use Unix charset setting rather than utf-8
1106 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1108 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1109 my $length = $l->{SIZE_IS};
1110 if (defined($l->{LENGTH_IS})) {
1111 $length = $l->{LENGTH_IS};
1114 $length = ParseExpr($length, $env, $e);
1115 $self->pidl("$py_var = PyList_New($length);");
1116 $self->fail_on_null($py_var, $fail);
1119 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1120 $self->pidl("int $counter;");
1121 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1123 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1124 $self->pidl("PyObject *$member_var;");
1125 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1126 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1132 } elsif ($l->{TYPE} eq "SWITCH") {
1133 $var_name = get_pointer_to($var_name);
1134 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1135 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1136 $self->fail_on_null($py_var, $fail);
1138 } elsif ($l->{TYPE} eq "DATA") {
1139 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1140 $var_name = get_pointer_to($var_name);
1142 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name);
1143 $self->pidl("$py_var = $conv;");
1144 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1145 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1147 die("Unknown level type $l->{TYPE} $var_name");
1151 sub ConvertObjectToPython($$$$$$)
1153 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1155 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1160 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1163 $py_hdr =~ s/ndr_([^\/]+)$/py_$1/g;
1165 $self->pidl_hdr("/* header auto-generated by pidl */\n\n");
1168 /* Python wrapper functions auto-generated by pidl */
1169 #include \"includes.h\"
1171 #include \"librpc/rpc/dcerpc.h\"
1172 #include \"lib/talloc/pytalloc.h\"
1173 #include \"librpc/rpc/pyrpc.h\"
1174 #include \"lib/events/events.h\"
1176 #include \"$ndr_hdr\"
1177 #include \"$py_hdr\"
1181 foreach my $x (@$ndr) {
1182 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1183 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1186 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1188 foreach (@{$self->{module_methods}}) {
1189 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1190 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1193 $self->pidl("{ NULL, NULL, 0, NULL }");
1199 $self->pidl("void init$basename(void)");
1202 $self->pidl("PyObject *m;");
1205 foreach (@{$self->{ready_types}}) {
1206 $self->pidl("if (PyType_Ready($_) < 0)");
1207 $self->pidl("\treturn;");
1210 $self->pidl($_) foreach (@{$self->{readycode}});
1212 foreach (@{$self->{patch_type_calls}}) {
1213 my ($typename, $cvar) = @$_;
1214 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1215 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1216 $self->pidl("#endif");
1221 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1222 $self->pidl("if (m == NULL)");
1223 $self->pidl("\treturn;");
1225 foreach my $name (keys %{$self->{constants}}) {
1227 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1228 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1229 $py_obj = "PyInt_FromLong($cvar)";
1230 } elsif ($cvar =~ /^".*"$/) {
1231 $py_obj = "PyString_FromString($cvar)";
1233 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar);
1236 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1239 foreach (@{$self->{module_objects}}) {
1240 my ($object_name, $c_name) = @$_;
1241 $self->pidl("Py_INCREF($c_name);");
1242 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1245 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1246 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1247 $self->pidl("#endif");
1252 return ($self->{res_hdr}, $self->{res});