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 module_imports => [], type_imports => {},
28 patch_type_calls => [], readycode => [] };
35 $self->{res_hdr} .= shift;
42 if ((!($d =~ /^#/))) {
43 $self->{res} .= $self->{tabs};
53 $self->{tabs} .= "\t";
59 $self->{tabs} = substr($self->{tabs}, 0, -1);
69 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
70 $self->register_module_import($_);
76 my ($self, $const) = @_;
77 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
80 sub register_constant($$$$)
82 my ($self, $name, $type, $value) = @_;
84 $self->{constants}->{$name} = [$type, $value];
87 sub EnumAndBitmapConsts($$$)
89 my ($self, $name, $d) = @_;
91 return unless (defined($d->{ELEMENTS}));
93 foreach my $e (@{$d->{ELEMENTS}}) {
94 $e =~ /^([A-Za-z0-9_]+)/;
97 $self->register_constant($cname, $d, $cname);
101 sub FromUnionToPythonFunction($$$$)
103 my ($self, $mem_ctx, $type, $switch, $name) = @_;
105 $self->pidl("PyObject *ret;");
108 $self->pidl("switch ($switch) {");
111 foreach my $e (@{$type->{ELEMENTS}}) {
112 $self->pidl("$e->{CASE}:");
117 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
119 $self->pidl("ret = Py_None;");
122 $self->pidl("return ret;");
131 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
132 $self->pidl("return NULL;");
135 sub FromPythonToUnionFunction($$$$$)
137 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
141 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
143 $self->pidl("switch ($switch) {");
146 foreach my $e (@{$type->{ELEMENTS}}) {
147 $self->pidl("$e->{CASE}:");
148 if ($e->{CASE} eq "default") { $has_default = 1; }
151 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
153 $self->pidl("break;");
159 $self->pidl("default:");
161 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
162 $self->pidl("talloc_free(ret);");
163 $self->pidl("ret = NULL;");
170 $self->pidl("return ret;");
173 sub PythonStruct($$$$$$)
175 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
177 my $env = GenerateStructEnv($d, "object");
181 my $getsetters = "NULL";
183 if ($#{$d->{ELEMENTS}} > -1) {
184 foreach my $e (@{$d->{ELEMENTS}}) {
185 my $varname = "object->$e->{NAME}";
186 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
189 $self->pidl("$cname *object = py_talloc_get_ptr(obj);");
190 $self->pidl("PyObject *py_$e->{NAME};");
191 $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
192 $self->pidl("return py_$e->{NAME};");
197 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
200 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
201 my $mem_ctx = "py_talloc_get_mem_ctx(py_obj)";
202 my $l = $e->{LEVELS}[0];
203 my $nl = GetNextLevel($e, $l);
204 if ($l->{TYPE} eq "POINTER" and
205 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
206 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
207 $self->pidl("talloc_free($varname);");
209 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
210 $self->pidl("return 0;");
216 $getsetters = "py_$name\_getsetters";
217 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
219 foreach my $e (@{$d->{ELEMENTS}}) {
220 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
222 $self->pidl("{ NULL }");
228 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
231 $self->pidl("return py_talloc_new($cname, type);");
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\" },");
286 $self->pidl("{ NULL, NULL, 0, NULL }");
292 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
294 my $docstring = $self->DocString($d, $name);
295 my $typeobject = "$name\_Type";
296 $self->pidl("static PyTypeObject $typeobject = {");
298 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
299 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
300 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
301 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
302 $self->pidl(".tp_getset = $getsetters,");
303 $self->pidl(".tp_repr = py_talloc_default_repr,");
305 $self->pidl(".tp_doc = $docstring,");
307 $self->pidl(".tp_methods = $py_methods,");
308 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
309 $self->pidl(".tp_new = py_$name\_new,");
315 return "&$typeobject";
318 sub get_metadata_var($)
321 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
323 if (has_property($e, "length_is")) {
324 return get_var($e->{PROPERTIES}->{length_is});
325 } elsif (has_property($e, "size_is")) {
326 return get_var($e->{PROPERTIES}->{size_is});
332 sub find_metadata_args($)
335 my $metadata_args = { in => {}, out => {} };
337 # Determine arguments that are metadata for other arguments (size_is/length_is)
338 foreach my $e (@{$fn->{ELEMENTS}}) {
339 foreach my $dir (@{$e->{DIRECTION}}) {
340 my $main = get_metadata_var($e);
342 $metadata_args->{$dir}->{$main} = $e->{NAME};
347 return $metadata_args;
350 sub PythonFunctionUnpackOut($$$)
352 my ($self, $fn, $fnname) = @_;
354 my $outfnname = "unpack_$fnname\_args_out";
357 my $metadata_args = find_metadata_args($fn);
359 my $env = GenerateFunctionOutEnv($fn, "r->");
362 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
365 $self->pidl("PyObject *result = Py_None;");
366 foreach my $e (@{$fn->{ELEMENTS}}) {
367 next unless (grep(/out/,@{$e->{DIRECTION}}));
368 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
369 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
370 $self->pidl("PyObject *py_$e->{NAME};");
374 if ($fn->{RETURN_TYPE}) {
375 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
380 if ($result_size > 1) {
381 $self->pidl("result = PyTuple_New($result_size);");
383 } elsif ($result_size == 0) {
384 $signature .= "None";
387 foreach my $e (@{$fn->{ELEMENTS}}) {
388 next if ($metadata_args->{out}->{$e->{NAME}});
389 my $py_name = "py_$e->{NAME}";
390 if (grep(/out/,@{$e->{DIRECTION}})) {
391 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
392 if ($result_size > 1) {
393 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
395 $signature .= "$e->{NAME}, ";
397 $self->pidl("result = $py_name;");
398 $signature .= $e->{NAME};
403 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
404 $self->handle_ntstatus("r->out.result", "NULL", undef);
405 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
406 $self->handle_werror("r->out.result", "NULL", undef);
407 } elsif (defined($fn->{RETURN_TYPE})) {
408 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result");
409 if ($result_size > 1) {
410 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
412 $self->pidl("result = $conv;");
414 $signature .= "result";
417 if (substr($signature, -2) eq ", ") {
418 $signature = substr($signature, 0, -2);
420 if ($result_size > 1) {
424 $self->pidl("return result;");
429 return ($outfnname, $signature);
432 sub PythonFunctionPackIn($$$)
434 my ($self, $fn, $fnname) = @_;
435 my $metadata_args = find_metadata_args($fn);
437 my $infnname = "pack_$fnname\_args_in";
439 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
442 my $args_format = "";
443 my $args_string = "";
447 foreach my $e (@{$fn->{ELEMENTS}}) {
448 next unless (grep(/in/,@{$e->{DIRECTION}}));
449 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
450 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
451 $self->pidl("PyObject *py_$e->{NAME};");
453 $args_string .= ", &py_$e->{NAME}";
454 $args_names .= "\"$e->{NAME}\", ";
455 $signature .= "$e->{NAME}, ";
457 if (substr($signature, -2) eq ", ") {
458 $signature = substr($signature, 0, -2);
460 $self->pidl("const char *kwnames[] = {");
462 $self->pidl($args_names . "NULL");
467 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
469 $self->pidl("return false;");
474 my $env = GenerateFunctionInEnv($fn, "r->");
476 my $fail = "return false;";
477 foreach my $e (@{$fn->{ELEMENTS}}) {
478 next unless (grep(/in/,@{$e->{DIRECTION}}));
479 if ($metadata_args->{in}->{$e->{NAME}}) {
480 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
481 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
482 my $val = "PyList_Size($py_var)";
483 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
484 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
485 $self->pidl("*r->in.$e->{NAME} = $val;");
487 $self->pidl("r->in.$e->{NAME} = $val;");
490 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
493 $self->pidl("return true;");
497 return ($infnname, $signature);
500 sub PythonFunction($$$)
502 my ($self, $fn, $iface, $prettyname) = @_;
504 my $fnname = "py_$fn->{NAME}";
505 my $docstring = $self->DocString($fn, $fn->{NAME});
507 my ($insignature, $outsignature);
510 if (has_property($fn, "todo")) {
511 unless ($docstring) { $docstring = "NULL"; }
515 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
516 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
517 my $signature = "S.$prettyname($insignature) -> $outsignature";
519 $docstring = "\"$signature\\n\\n\"$docstring";
521 $docstring = "\"$signature\"";
525 return ($infn, $outfn, $docstring);
528 sub handle_werror($$$$)
530 my ($self, $var, $retval, $mem_ctx) = @_;
532 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
534 $self->pidl("PyErr_SetWERROR($var);");
535 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
536 $self->pidl("return $retval;");
542 sub handle_ntstatus($$$$)
544 my ($self, $var, $retval, $mem_ctx) = @_;
546 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
548 $self->pidl("PyErr_SetNTSTATUS($var);");
549 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
550 $self->pidl("return $retval;");
558 my ($self, $modulename, $d, $interface, $basename) = @_;
560 my $actual_ctype = $d;
561 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
562 $actual_ctype = $actual_ctype->{DATA};
565 if ($actual_ctype->{TYPE} eq "STRUCT") {
567 my $fn_name = $d->{NAME};
569 $fn_name =~ s/^$interface->{NAME}_//;
570 $fn_name =~ s/^$basename\_//;
573 if ($d->{TYPE} eq "STRUCT") {
574 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
576 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
579 $self->register_module_typeobject($fn_name, $typeobject);
582 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
583 $self->EnumAndBitmapConsts($d->{NAME}, $d);
586 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
587 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
590 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
591 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
594 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
599 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
602 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
611 my ($self, $d, $name) = @_;
612 if (has_property($d, "helpstring")) {
613 my $docstring = uc("py_doc_$name");
614 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
623 my($self,$interface,$basename) = @_;
625 if (has_property($interface, "pyhelper")) {
626 $self->pidl_hdr("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
629 $self->Const($_) foreach (@{$interface->{CONSTS}});
631 foreach my $d (@{$interface->{TYPES}}) {
632 next if has_property($d, "nopython");
634 $self->PythonType($basename, $d, $interface, $basename);
637 if (defined $interface->{PROPERTIES}->{uuid}) {
638 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
643 foreach my $d (@{$interface->{FUNCTIONS}}) {
644 next if not defined($d->{OPNUM});
645 next if has_property($d, "nopython");
647 my $prettyname = $d->{NAME};
649 $prettyname =~ s/^$interface->{NAME}_//;
650 $prettyname =~ s/^$basename\_//;
652 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
654 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}", $prettyname, $fndocstring, $d->{OPNUM}]);
657 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
659 foreach my $d (@fns) {
660 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
661 $self->pidl("{ \"$prettyname\", $docstring, (dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
663 $self->pidl("{ NULL }");
668 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
671 $self->pidl("dcerpc_InterfaceObject *ret;");
672 $self->pidl("const char *binding_string;");
673 $self->pidl("struct cli_credentials *credentials;");
674 $self->pidl("struct loadparm_context *lp_ctx = NULL;");
675 $self->pidl("PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;");
676 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
677 $self->pidl("struct event_context *event_ctx;");
678 $self->pidl("NTSTATUS status;");
680 $self->pidl("const char *kwnames[] = {");
682 $self->pidl("\"binding\", \"lp_ctx\", \"credentials\", \"basis_connection\", NULL");
685 $self->pidl("extern struct loadparm_context *lp_from_py_object(PyObject *py_obj);");
686 $self->pidl("extern struct cli_credentials *cli_credentials_from_py_object(PyObject *py_obj);");
688 $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)) {");
690 $self->pidl("return NULL;");
694 $self->pidl("lp_ctx = lp_from_py_object(py_lp_ctx);");
695 $self->pidl("if (lp_ctx == NULL) {");
697 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected loadparm context\");");
698 $self->pidl("return NULL;");
703 $self->pidl("status = dcerpc_init(lp_ctx);");
704 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
706 $self->pidl("PyErr_SetNTSTATUS(status);");
707 $self->pidl("return NULL;");
711 $self->pidl("credentials = cli_credentials_from_py_object(py_credentials);");
712 $self->pidl("if (credentials == NULL) {");
714 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected credentials\");");
715 $self->pidl("return NULL;");
719 $self->pidl("ret = PyObject_New(dcerpc_InterfaceObject, type);");
721 $self->pidl("event_ctx = event_context_init(mem_ctx);");
724 $self->pidl("if (py_basis != Py_None) {");
726 $self->pidl("struct dcerpc_pipe *base_pipe;");
728 $self->pidl("if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {");
730 $self->pidl("PyErr_SetString(PyExc_ValueError, \"basis_connection must be a DCE/RPC connection\");");
731 $self->pidl("talloc_free(mem_ctx);");
732 $self->pidl("return NULL;");
736 $self->pidl("base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;");
738 $self->pidl("status = dcerpc_secondary_context(base_pipe, &ret->pipe, &ndr_table_$interface->{NAME});");
740 $self->pidl("} else {");
742 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
743 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, event_ctx, lp_ctx);");
746 $self->handle_ntstatus("status", "NULL", "mem_ctx");
748 $self->pidl("ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;");
750 $self->pidl("return (PyObject *)ret;");
757 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
759 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
760 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
761 \"credentials should be a credentials.Credentials object.\\n\\n\"";
763 my $docstring = $self->DocString($interface, $interface->{NAME});
766 $docstring = "$signature$docstring";
768 $docstring = $signature;
771 $self->pidl("static PyTypeObject $interface->{NAME}_InterfaceType = {");
773 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
774 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
775 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
776 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
777 $self->pidl(".tp_doc = $docstring,");
778 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
779 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
785 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
786 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
789 $self->pidl_hdr("\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);
807 $self->register_patch_type_call($name, $py_name);
810 sub check_ready_type($$)
812 my ($self, $py_name) = @_;
813 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
816 sub register_module_import($$)
818 my ($self, $basename) = @_;
820 push (@{$self->{module_imports}}, $basename);
823 sub use_type_variable($$)
825 my ($self, $orig_ctype) = @_;
826 my $ctype = resolveType($orig_ctype);
827 unless (defined($ctype->{BASEFILE})) {
828 fatal($orig_ctype, "Unable to determine origin of type " . mapTypeName($orig_ctype));
830 # If this is an external type, make sure we do the right imports.
831 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
832 unless (defined($self->{type_imports}->{$ctype->{NAME}})) {
833 $self->{type_imports}->{$ctype->{NAME}} = $ctype->{BASEFILE};
835 return "$ctype->{NAME}_Type"
837 return "&$ctype->{NAME}_Type";
840 sub register_patch_type_call($$$)
842 my ($self, $typename, $cvar) = @_;
844 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
848 sub register_module_readycode($$)
850 my ($self, $code) = @_;
852 push (@{$self->{readycode}}, @$code);
855 sub register_module_object($$$)
857 my ($self, $name, $py_name) = @_;
859 push (@{$self->{module_objects}}, [$name, $py_name])
864 my ($self, $dest, $src) = @_;
865 if ($dest =~ /^\&/) {
866 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
868 $self->pidl("$dest = $src;");
872 sub ConvertObjectFromPythonData($$$$$$)
874 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail) = @_;
876 die("undef type for $cvar") unless(defined($ctype));
878 $ctype = resolveType($ctype);
880 my $actual_ctype = $ctype;
881 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
882 $actual_ctype = $actual_ctype->{DATA};
885 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
886 $actual_ctype->{TYPE} eq "SCALAR" and (
887 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
888 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
889 $self->pidl("$target = PyInt_AsLong($cvar);");
893 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
894 my $ctype_name = $self->use_type_variable($ctype);
895 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
896 $self->assign($target, "py_talloc_get_ptr($cvar)");
900 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
901 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
905 if ($actual_ctype->{TYPE} eq "SCALAR" and
906 ($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")) {
907 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
911 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
912 $self->pidl("$target = PyString_AsString($cvar);");
917 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
918 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
922 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
923 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
927 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
928 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
932 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
933 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
937 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
941 sub ConvertObjectFromPythonLevel($$$$$$$$)
943 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
944 my $nl = GetNextLevel($e, $l);
946 if ($l->{TYPE} eq "POINTER") {
947 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
948 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
951 if ($l->{POINTER_TYPE} ne "ref") {
952 $self->pidl("if ($py_var == Py_None) {");
954 $self->pidl("$var_name = NULL;");
956 $self->pidl("} else {");
959 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
960 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
961 if ($l->{POINTER_TYPE} ne "ref") {
965 } elsif ($l->{TYPE} eq "ARRAY") {
966 my $pl = GetPrevLevel($e, $l);
967 if ($pl && $pl->{TYPE} eq "POINTER") {
968 $var_name = get_pointer_to($var_name);
971 if (is_charset_array($e, $l)) {
972 $self->pidl("PY_CHECK_TYPE(&PyUnicode_Type, $py_var, $fail);");
973 # FIXME: Use Unix charset setting rather than utf-8
974 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
976 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
977 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
980 $self->pidl("int $counter;");
981 if (ArrayDynamicallyAllocated($e, $l)) {
982 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
984 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
986 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
992 } elsif ($l->{TYPE} eq "DATA") {
994 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
995 $var_name = get_pointer_to($var_name);
997 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail);
998 } elsif ($l->{TYPE} eq "SWITCH") {
999 $var_name = get_pointer_to($var_name);
1000 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1001 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
1002 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1003 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
1005 die("unknown level type $l->{TYPE}");
1009 sub ConvertObjectFromPython($$$$$$$)
1011 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1013 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1016 sub ConvertScalarToPython($$$)
1018 my ($self, $ctypename, $cvar) = @_;
1020 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1022 $ctypename = expandAlias($ctypename);
1024 if ($ctypename =~ /^(char|u?int[0-9]*|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1025 return "PyInt_FromLong($cvar)";
1028 if ($ctypename eq "DATA_BLOB") {
1029 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1032 if ($ctypename eq "NTSTATUS") {
1033 return "PyErr_FromNTSTATUS($cvar)";
1036 if ($ctypename eq "WERROR") {
1037 return "PyErr_FromWERROR($cvar)";
1040 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1041 return "PyString_FromString($cvar)";
1045 if ($ctypename eq "string_array") { return "PyCObject_FromVoidPtr($cvar)"; }
1046 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
1047 if ($ctypename eq "pointer") {
1048 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
1051 die("Unknown scalar type $ctypename");
1054 sub ConvertObjectToPythonData($$$$$)
1056 my ($self, $mem_ctx, $ctype, $cvar) = @_;
1058 die("undef type for $cvar") unless(defined($ctype));
1060 $ctype = resolveType($ctype);
1062 my $actual_ctype = $ctype;
1063 while ($actual_ctype->{TYPE} eq "TYPEDEF") {
1064 $actual_ctype = $actual_ctype->{DATA};
1067 if ($actual_ctype->{TYPE} eq "ENUM") {
1068 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1069 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1070 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1071 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1072 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1073 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1074 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1075 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1076 my $ctype_name = $self->use_type_variable($ctype);
1077 return "py_talloc_import_ex($ctype_name, $mem_ctx, $cvar)";
1080 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1083 sub fail_on_null($$$)
1085 my ($self, $var, $fail) = @_;
1086 $self->pidl("if ($var == NULL) {");
1093 sub ConvertObjectToPythonLevel($$$$$$)
1095 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1096 my $nl = GetNextLevel($e, $l);
1098 if ($l->{TYPE} eq "POINTER") {
1099 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1100 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1103 if ($l->{POINTER_TYPE} ne "ref") {
1104 $self->pidl("if ($var_name == NULL) {");
1106 $self->pidl("$py_var = Py_None;");
1108 $self->pidl("} else {");
1111 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1112 if ($l->{POINTER_TYPE} ne "ref") {
1116 } elsif ($l->{TYPE} eq "ARRAY") {
1117 my $pl = GetPrevLevel($e, $l);
1118 if ($pl && $pl->{TYPE} eq "POINTER") {
1119 $var_name = get_pointer_to($var_name);
1122 if (is_charset_array($e, $l)) {
1123 # FIXME: Use Unix charset setting rather than utf-8
1124 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1126 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1127 my $length = $l->{SIZE_IS};
1128 if (defined($l->{LENGTH_IS})) {
1129 $length = $l->{LENGTH_IS};
1132 $length = ParseExpr($length, $env, $e);
1133 $self->pidl("$py_var = PyList_New($length);");
1134 $self->fail_on_null($py_var, $fail);
1137 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1138 $self->pidl("int $counter;");
1139 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1141 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1142 $self->pidl("PyObject *$member_var;");
1143 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1144 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1150 } elsif ($l->{TYPE} eq "SWITCH") {
1151 $var_name = get_pointer_to($var_name);
1152 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1153 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1154 $self->fail_on_null($py_var, $fail);
1156 } elsif ($l->{TYPE} eq "DATA") {
1157 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1158 $var_name = get_pointer_to($var_name);
1160 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name);
1161 $self->pidl("$py_var = $conv;");
1162 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1163 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1165 die("Unknown level type $l->{TYPE} $var_name");
1169 sub ConvertObjectToPython($$$$$$)
1171 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1173 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1178 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1180 $self->{BASENAME} = $basename;
1183 /* Python wrapper functions auto-generated by pidl */
1184 #include \"includes.h\"
1186 #include \"librpc/rpc/dcerpc.h\"
1187 #include \"lib/talloc/pytalloc.h\"
1188 #include \"librpc/rpc/pyrpc.h\"
1189 #include \"lib/events/events.h\"
1191 #include \"$ndr_hdr\"
1195 foreach my $x (@$ndr) {
1196 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1197 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1200 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1202 foreach (@{$self->{module_methods}}) {
1203 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1204 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1207 $self->pidl("{ NULL, NULL, 0, NULL }");
1213 $self->pidl("void init$basename(void)");
1216 $self->pidl("PyObject *m;");
1217 foreach (@{$self->{module_imports}}) {
1218 $self->pidl("PyObject *dep_$_;");
1222 foreach (@{$self->{module_imports}}) {
1223 $self->pidl("dep_$_ = PyImport_ImportModule(\"samba.dcerpc.$_\");");
1224 $self->pidl("if (dep_$_ == NULL)");
1225 $self->pidl("\treturn;");
1229 foreach (keys %{$self->{type_imports}}) {
1230 my $basefile = $self->{type_imports}->{$_};
1231 $self->pidl_hdr("static PyTypeObject *$_\_Type;\n");
1232 $self->pidl("$_\_Type = (PyTypeObject *)PyObject_GetAttrString(dep_$basefile, \"$_\");");
1233 $self->pidl("if ($_\_Type == NULL)");
1234 $self->pidl("\treturn;");
1238 foreach (@{$self->{ready_types}}) {
1239 $self->pidl("if (PyType_Ready($_) < 0)");
1240 $self->pidl("\treturn;");
1243 $self->pidl($_) foreach (@{$self->{readycode}});
1245 foreach (@{$self->{patch_type_calls}}) {
1246 my ($typename, $cvar) = @$_;
1247 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1248 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1249 $self->pidl("#endif");
1254 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1255 $self->pidl("if (m == NULL)");
1256 $self->pidl("\treturn;");
1258 foreach my $name (keys %{$self->{constants}}) {
1260 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1261 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1262 $py_obj = "PyInt_FromLong($cvar)";
1263 } elsif ($cvar =~ /^".*"$/) {
1264 $py_obj = "PyString_FromString($cvar)";
1266 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar);
1269 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1272 foreach (@{$self->{module_objects}}) {
1273 my ($object_name, $c_name) = @$_;
1274 $self->pidl("Py_INCREF($c_name);");
1275 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1278 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1279 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1280 $self->pidl("#endif");
1285 return ($self->{res_hdr} . $self->{res});