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 *type, PyObject *args, PyObject *kwargs)");
227 $self->pidl("return py_talloc_new($cname, type);");
232 my $py_methods = "NULL";
234 # If the struct is not public there ndr_pull/ndr_push functions will
235 # be static so not callable from here
236 if (has_property($d, "public")) {
237 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
240 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
241 $self->pidl("DATA_BLOB blob;");
242 $self->pidl("enum ndr_err_code err;");
243 $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);");
244 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
246 $self->pidl("PyErr_SetNdrError(err);");
247 $self->pidl("return NULL;");
251 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
256 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
259 $self->pidl("$cname *object = py_talloc_get_ptr(py_obj);");
260 $self->pidl("DATA_BLOB blob;");
261 $self->pidl("enum ndr_err_code err;");
262 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
263 $self->pidl("\treturn NULL;");
265 $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);");
266 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
268 $self->pidl("PyErr_SetNdrError(err);");
269 $self->pidl("return NULL;");
273 $self->pidl("return Py_None;");
277 $py_methods = "py_$name\_methods";
278 $self->pidl("static PyMethodDef $py_methods\[] = {");
280 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.pack() -> blob\\nNDR pack\" },");
281 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.unpack(blob) -> None\\nNDR unpack\" },");
283 $self->pidl("#ifdef ".uc("py_$name\_extra_methods"));
284 $self->pidl("\t" .uc("py_$name\_extra_methods"));
285 $self->pidl("#endif");
287 $self->pidl("{ NULL, NULL, 0, NULL }");
293 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $name\_Type;\n");
294 $self->pidl_hdr("#define $name\_Check(op) PyObject_TypeCheck(op, &$name\_Type)\n");
295 $self->pidl_hdr("#define $name\_CheckExact(op) ((op)->ob_type == &$name\_Type)\n");
296 $self->pidl_hdr("\n");
297 $self->pidl("#ifndef ".uc("py_$name\_repr"));
298 $self->pidl("#define ".uc("py_$name\_repr") . " py_talloc_default_repr");
299 $self->pidl("#endif");
301 my $docstring = ($self->DocString($d, $name) or "NULL");
302 my $typeobject = "$name\_Type";
303 $self->pidl("PyTypeObject $typeobject = {");
305 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
306 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
307 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
308 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
309 $self->pidl(".tp_getset = $getsetters,");
310 $self->pidl(".tp_repr = ".uc("py_$name\_repr").",");
311 $self->pidl(".tp_doc = $docstring,");
312 $self->pidl(".tp_methods = $py_methods,");
313 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
314 $self->pidl(".tp_new = py_$name\_new,");
320 return "&$typeobject";
323 sub get_metadata_var($)
326 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
328 if (has_property($e, "length_is")) {
329 return get_var($e->{PROPERTIES}->{length_is});
330 } elsif (has_property($e, "size_is")) {
331 return get_var($e->{PROPERTIES}->{size_is});
337 sub find_metadata_args($)
340 my $metadata_args = { in => {}, out => {} };
342 # Determine arguments that are metadata for other arguments (size_is/length_is)
343 foreach my $e (@{$fn->{ELEMENTS}}) {
344 foreach my $dir (@{$e->{DIRECTION}}) {
345 my $main = get_metadata_var($e);
347 $metadata_args->{$dir}->{$main} = $e->{NAME};
352 return $metadata_args;
355 sub PythonFunctionUnpackOut($$$)
357 my ($self, $fn, $fnname) = @_;
359 my $outfnname = "unpack_$fnname\_args_out";
362 my $metadata_args = find_metadata_args($fn);
364 my $env = GenerateFunctionOutEnv($fn, "r->");
367 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
370 $self->pidl("PyObject *result = Py_None;");
371 foreach my $e (@{$fn->{ELEMENTS}}) {
372 next unless (grep(/out/,@{$e->{DIRECTION}}));
373 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
374 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
375 $self->pidl("PyObject *py_$e->{NAME};");
379 if ($fn->{RETURN_TYPE}) {
380 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
385 if ($result_size > 1) {
386 $self->pidl("result = PyTuple_New($result_size);");
388 } elsif ($result_size == 0) {
389 $signature .= "None";
392 foreach my $e (@{$fn->{ELEMENTS}}) {
393 next if ($metadata_args->{out}->{$e->{NAME}});
394 my $py_name = "py_$e->{NAME}";
395 if (grep(/out/,@{$e->{DIRECTION}})) {
396 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
397 if ($result_size > 1) {
398 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
400 $signature .= "$e->{NAME}, ";
402 $self->pidl("result = $py_name;");
403 $signature .= $e->{NAME};
408 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
409 $self->handle_ntstatus("r->out.result", "NULL", undef);
410 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
411 $self->handle_werror("r->out.result", "NULL", undef);
412 } elsif (defined($fn->{RETURN_TYPE})) {
413 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result");
414 if ($result_size > 1) {
415 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
417 $self->pidl("result = $conv;");
419 $signature .= "result";
422 if (substr($signature, -2) eq ", ") {
423 $signature = substr($signature, 0, -2);
425 if ($result_size > 1) {
429 $self->pidl("return result;");
434 return ($outfnname, $signature);
437 sub PythonFunctionPackIn($$$)
439 my ($self, $fn, $fnname) = @_;
440 my $metadata_args = find_metadata_args($fn);
442 my $infnname = "pack_$fnname\_args_in";
444 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
447 my $args_format = "";
448 my $args_string = "";
452 foreach my $e (@{$fn->{ELEMENTS}}) {
453 next unless (grep(/in/,@{$e->{DIRECTION}}));
454 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
455 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
456 $self->pidl("PyObject *py_$e->{NAME};");
458 $args_string .= ", &py_$e->{NAME}";
459 $args_names .= "\"$e->{NAME}\", ";
460 $signature .= "$e->{NAME}, ";
462 if (substr($signature, -2) eq ", ") {
463 $signature = substr($signature, 0, -2);
465 $self->pidl("const char *kwnames[] = {");
467 $self->pidl($args_names . "NULL");
472 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
474 $self->pidl("return false;");
479 my $env = GenerateFunctionInEnv($fn, "r->");
481 my $fail = "return false;";
482 foreach my $e (@{$fn->{ELEMENTS}}) {
483 next unless (grep(/in/,@{$e->{DIRECTION}}));
484 if ($metadata_args->{in}->{$e->{NAME}}) {
485 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
486 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
487 my $val = "PyList_Size($py_var)";
488 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
489 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
490 $self->pidl("*r->in.$e->{NAME} = $val;");
492 $self->pidl("r->in.$e->{NAME} = $val;");
495 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
498 $self->pidl("return true;");
502 return ($infnname, $signature);
505 sub PythonFunction($$$)
507 my ($self, $fn, $iface, $prettyname) = @_;
509 my $fnname = "py_$fn->{NAME}";
510 my $docstring = $self->DocString($fn, $fn->{NAME});
512 my ($insignature, $outsignature);
515 if (has_property($fn, "todo")) {
516 unless ($docstring) { $docstring = "NULL"; }
520 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
521 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
522 my $signature = "S.$prettyname($insignature) -> $outsignature";
524 $docstring = "\"$signature\\n\\n\"$docstring";
526 $docstring = "\"$signature\"";
530 return ($infn, $outfn, $docstring);
533 sub handle_werror($$$$)
535 my ($self, $var, $retval, $mem_ctx) = @_;
537 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
539 $self->pidl("PyErr_SetWERROR($var);");
540 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
541 $self->pidl("return $retval;");
547 sub handle_ntstatus($$$$)
549 my ($self, $var, $retval, $mem_ctx) = @_;
551 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
553 $self->pidl("PyErr_SetNTSTATUS($var);");
554 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
555 $self->pidl("return $retval;");
563 my ($self, $modulename, $d, $interface, $basename) = @_;
565 my $actual_ctype = $d;
566 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
567 $actual_ctype = $actual_ctype->{DATA};
570 if ($actual_ctype->{TYPE} eq "STRUCT") {
572 my $fn_name = $d->{NAME};
574 $fn_name =~ s/^$interface->{NAME}_//;
575 $fn_name =~ s/^$basename\_//;
578 if ($d->{TYPE} eq "STRUCT") {
579 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
581 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
584 $self->register_module_typeobject($fn_name, $typeobject);
587 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
588 $self->EnumAndBitmapConsts($d->{NAME}, $d);
591 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
592 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
595 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
596 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
599 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
604 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
607 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
616 my ($self, $d, $name) = @_;
617 if (has_property($d, "helpstring")) {
618 my $docstring = uc("py_doc_$name");
619 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
628 my($self,$interface,$basename) = @_;
630 $self->pidl_hdr("#ifndef _HEADER_PYTHON_$interface->{NAME}\n");
631 $self->pidl_hdr("#define _HEADER_PYTHON_$interface->{NAME}\n\n");
633 $self->pidl_hdr("\n");
635 if (has_property($interface, "pyhelper")) {
636 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
639 $self->Const($_) foreach (@{$interface->{CONSTS}});
641 foreach my $d (@{$interface->{TYPES}}) {
642 next if has_property($d, "nopython");
644 $self->PythonType($basename, $d, $interface, $basename);
647 if (defined $interface->{PROPERTIES}->{uuid}) {
648 $self->pidl_hdr("PyAPI_DATA(PyTypeObject) $interface->{NAME}_InterfaceType;\n");
653 foreach my $d (@{$interface->{FUNCTIONS}}) {
654 next if not defined($d->{OPNUM});
655 next if has_property($d, "nopython");
657 my $prettyname = $d->{NAME};
659 $prettyname =~ s/^$interface->{NAME}_//;
660 $prettyname =~ s/^$basename\_//;
662 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
664 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}", $prettyname, $fndocstring, $d->{OPNUM}]);
667 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
668 $self->pidl_hdr("extern const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[];");
670 foreach my $d (@fns) {
671 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
672 $self->pidl("{ \"$prettyname\", $docstring, (dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
674 $self->pidl("{ NULL }");
679 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
682 $self->pidl("dcerpc_InterfaceObject *ret;");
683 $self->pidl("const char *binding_string;");
684 $self->pidl("struct cli_credentials *credentials;");
685 $self->pidl("struct loadparm_context *lp_ctx = NULL;");
686 $self->pidl("PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;");
687 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
688 $self->pidl("struct event_context *event_ctx;");
689 $self->pidl("NTSTATUS status;");
691 $self->pidl("const char *kwnames[] = {");
693 $self->pidl("\"binding\", \"lp_ctx\", \"credentials\", \"basis_connection\", NULL");
696 $self->pidl("extern struct loadparm_context *lp_from_py_object(PyObject *py_obj);");
697 $self->pidl("extern struct cli_credentials *cli_credentials_from_py_object(PyObject *py_obj);");
699 $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)) {");
701 $self->pidl("return NULL;");
705 $self->pidl("lp_ctx = lp_from_py_object(py_lp_ctx);");
706 $self->pidl("if (lp_ctx == NULL) {");
708 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected loadparm context\");");
709 $self->pidl("return NULL;");
714 $self->pidl("status = dcerpc_init(lp_ctx);");
715 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
717 $self->pidl("PyErr_SetNTSTATUS(status);");
718 $self->pidl("return NULL;");
722 $self->pidl("credentials = cli_credentials_from_py_object(py_credentials);");
723 $self->pidl("if (credentials == NULL) {");
725 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Expected credentials\");");
726 $self->pidl("return NULL;");
730 $self->pidl("ret = PyObject_New(dcerpc_InterfaceObject, type);");
732 $self->pidl("event_ctx = event_context_init(mem_ctx);");
735 $self->pidl("if (py_basis != Py_None) {");
737 $self->pidl("struct dcerpc_pipe *base_pipe;");
739 $self->pidl("if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {");
741 $self->pidl("PyErr_SetString(PyExc_ValueError, \"basis_connection must be a DCE/RPC connection\");");
742 $self->pidl("talloc_free(mem_ctx);");
743 $self->pidl("return NULL;");
747 $self->pidl("base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;");
749 $self->pidl("status = dcerpc_secondary_context(base_pipe, &ret->pipe, &ndr_table_$interface->{NAME});");
751 $self->pidl("} else {");
753 $self->pidl("status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string, ");
754 $self->pidl(" &ndr_table_$interface->{NAME}, credentials, event_ctx, lp_ctx);");
757 $self->handle_ntstatus("status", "NULL", "mem_ctx");
759 $self->pidl("ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;");
761 $self->pidl("return (PyObject *)ret;");
768 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
770 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
771 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
772 \"credentials should be a credentials.Credentials object.\\n\\n\"";
774 my $docstring = $self->DocString($interface, $interface->{NAME});
777 $docstring = "$signature$docstring";
779 $docstring = $signature;
782 $self->pidl("PyTypeObject $interface->{NAME}_InterfaceType = {");
784 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
785 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
786 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
787 $self->pidl(".tp_base = &dcerpc_InterfaceType,");
788 $self->pidl(".tp_doc = $docstring,");
789 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
790 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
796 $self->register_module_typeobject($interface->{NAME}, "&$interface->{NAME}_InterfaceType");
797 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$interface->{NAME}_InterfaceType, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
800 $self->pidl_hdr("\n");
801 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */\n");
804 sub register_module_method($$$$$)
806 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
808 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
811 sub register_module_typeobject($$$)
813 my ($self, $name, $py_name) = @_;
815 $self->register_module_object($name, "(PyObject *)$py_name");
817 $self->check_ready_type($py_name);
820 sub check_ready_type($$)
822 my ($self, $py_name) = @_;
823 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
826 sub register_module_readycode($$)
828 my ($self, $code) = @_;
830 push (@{$self->{readycode}}, @$code);
833 sub register_module_object($$$)
835 my ($self, $name, $py_name) = @_;
837 push (@{$self->{module_objects}}, [$name, $py_name])
842 my ($self, $dest, $src) = @_;
843 if ($dest =~ /^\&/) {
844 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
846 $self->pidl("$dest = $src;");
850 sub ConvertObjectFromPythonData($$$$$$)
852 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail) = @_;
854 die("undef type for $cvar") unless(defined($ctype));
856 $ctype = resolveType($ctype);
858 my $actual_ctype = $ctype;
859 if ($ctype->{TYPE} eq "TYPEDEF") {
860 $actual_ctype = $ctype->{DATA};
863 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP" or
864 $actual_ctype->{TYPE} eq "SCALAR" and (
865 expandAlias($actual_ctype->{NAME}) =~ /^(u?int[0-9]*|hyper|NTTIME|time_t|NTTIME_hyper|NTTIME_1sec|dlong|udlong|udlongr)$/)) {
866 $self->pidl("PY_CHECK_TYPE(PyInt, $cvar, $fail);");
867 $self->pidl("$target = PyInt_AsLong($cvar);");
871 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
872 $self->pidl("PY_CHECK_TYPE($ctype->{NAME}, $cvar, $fail);");
873 $self->assign($target, "py_talloc_get_ptr($cvar)");
877 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
878 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
882 if ($actual_ctype->{TYPE} eq "SCALAR" and
883 ($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")) {
884 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
888 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
889 $self->pidl("$target = PyString_AsString($cvar);");
894 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
895 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
899 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
900 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
904 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
905 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
909 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
910 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
914 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
918 sub ConvertObjectFromPythonLevel($$$$$$$$)
920 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
921 my $nl = GetNextLevel($e, $l);
923 if ($l->{TYPE} eq "POINTER") {
924 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
925 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
928 if ($l->{POINTER_TYPE} ne "ref") {
929 $self->pidl("if ($py_var == Py_None) {");
931 $self->pidl("$var_name = NULL;");
933 $self->pidl("} else {");
936 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
937 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
938 if ($l->{POINTER_TYPE} ne "ref") {
942 } elsif ($l->{TYPE} eq "ARRAY") {
943 my $pl = GetPrevLevel($e, $l);
944 if ($pl && $pl->{TYPE} eq "POINTER") {
945 $var_name = get_pointer_to($var_name);
948 if (is_charset_array($e, $l)) {
949 $self->pidl("PY_CHECK_TYPE(PyUnicode, $py_var, $fail);");
950 # FIXME: Use Unix charset setting rather than utf-8
951 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
953 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
954 $self->pidl("PY_CHECK_TYPE(PyList, $py_var, $fail);");
957 $self->pidl("int $counter;");
958 if (ArrayDynamicallyAllocated($e, $l)) {
959 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
961 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
963 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
969 } elsif ($l->{TYPE} eq "DATA") {
971 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
972 $var_name = get_pointer_to($var_name);
974 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail);
975 } elsif ($l->{TYPE} eq "SWITCH") {
976 $var_name = get_pointer_to($var_name);
977 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
978 $self->assign($var_name, "py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var)");
979 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
980 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
982 die("unknown level type $l->{TYPE}");
986 sub ConvertObjectFromPython($$$$$$$)
988 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
990 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
993 sub ConvertScalarToPython($$$)
995 my ($self, $ctypename, $cvar) = @_;
997 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
999 $ctypename = expandAlias($ctypename);
1001 if ($ctypename =~ /^(char|u?int[0-9]*|hyper|dlong|udlong|udlongr|time_t|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1002 return "PyInt_FromLong($cvar)";
1005 if ($ctypename eq "DATA_BLOB") {
1006 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1009 if ($ctypename eq "NTSTATUS") {
1010 return "PyErr_FromNTSTATUS($cvar)";
1013 if ($ctypename eq "WERROR") {
1014 return "PyErr_FromWERROR($cvar)";
1017 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1018 return "PyString_FromString($cvar)";
1022 if ($ctypename eq "string_array") { return "PyCObject_FromVoidPtr($cvar)"; }
1023 if ($ctypename eq "ipv4address") { return "PyString_FromString($cvar)"; }
1024 if ($ctypename eq "pointer") {
1025 return "PyCObject_FromVoidPtr($cvar, talloc_free)";
1028 die("Unknown scalar type $ctypename");
1031 sub ConvertObjectToPythonData($$$$$)
1033 my ($self, $mem_ctx, $ctype, $cvar) = @_;
1035 die("undef type for $cvar") unless(defined($ctype));
1037 $ctype = resolveType($ctype);
1039 my $actual_ctype = $ctype;
1040 if ($ctype->{TYPE} eq "TYPEDEF") {
1041 $actual_ctype = $ctype->{DATA};
1044 if ($actual_ctype->{TYPE} eq "ENUM") {
1045 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1046 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1047 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1048 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1049 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1050 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1051 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1052 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1053 return "py_talloc_import_ex(&$ctype->{NAME}_Type, $mem_ctx, $cvar)";
1056 fatal($ctype, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1059 sub fail_on_null($$$)
1061 my ($self, $var, $fail) = @_;
1062 $self->pidl("if ($var == NULL) {");
1069 sub ConvertObjectToPythonLevel($$$$$$)
1071 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1072 my $nl = GetNextLevel($e, $l);
1074 if ($l->{TYPE} eq "POINTER") {
1075 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1076 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1079 if ($l->{POINTER_TYPE} ne "ref") {
1080 $self->pidl("if ($var_name == NULL) {");
1082 $self->pidl("$py_var = Py_None;");
1084 $self->pidl("} else {");
1087 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1088 if ($l->{POINTER_TYPE} ne "ref") {
1092 } elsif ($l->{TYPE} eq "ARRAY") {
1093 my $pl = GetPrevLevel($e, $l);
1094 if ($pl && $pl->{TYPE} eq "POINTER") {
1095 $var_name = get_pointer_to($var_name);
1098 if (is_charset_array($e, $l)) {
1099 # FIXME: Use Unix charset setting rather than utf-8
1100 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1102 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1103 my $length = $l->{SIZE_IS};
1104 if (defined($l->{LENGTH_IS})) {
1105 $length = $l->{LENGTH_IS};
1108 $length = ParseExpr($length, $env, $e);
1109 $self->pidl("$py_var = PyList_New($length);");
1110 $self->fail_on_null($py_var, $fail);
1113 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1114 $self->pidl("int $counter;");
1115 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1117 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1118 $self->pidl("PyObject *$member_var;");
1119 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1120 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1126 } elsif ($l->{TYPE} eq "SWITCH") {
1127 $var_name = get_pointer_to($var_name);
1128 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1129 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1130 $self->fail_on_null($py_var, $fail);
1132 } elsif ($l->{TYPE} eq "DATA") {
1133 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1134 $var_name = get_pointer_to($var_name);
1136 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name);
1137 $self->pidl("$py_var = $conv;");
1138 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1139 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1141 die("Unknown level type $l->{TYPE} $var_name");
1145 sub ConvertObjectToPython($$$$$$)
1147 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1149 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1154 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1157 $py_hdr =~ s/ndr_([^\/]+)$/py_$1/g;
1159 $self->pidl_hdr("/* header auto-generated by pidl */\n\n");
1162 /* Python wrapper functions auto-generated by pidl */
1163 #include \"includes.h\"
1165 #include \"librpc/rpc/dcerpc.h\"
1166 #include \"lib/talloc/pytalloc.h\"
1167 #include \"librpc/rpc/pyrpc.h\"
1168 #include \"lib/events/events.h\"
1170 #include \"$ndr_hdr\"
1171 #include \"$py_hdr\"
1175 foreach my $x (@$ndr) {
1176 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1177 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1180 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1182 foreach (@{$self->{module_methods}}) {
1183 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1184 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1187 $self->pidl("{ NULL, NULL, 0, NULL }");
1193 $self->pidl("void init$basename(void)");
1196 $self->pidl("PyObject *m;");
1199 foreach (@{$self->{ready_types}}) {
1200 $self->pidl("if (PyType_Ready($_) < 0)");
1201 $self->pidl("\treturn;");
1204 $self->pidl($_) foreach (@{$self->{readycode}});
1208 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1209 $self->pidl("if (m == NULL)");
1210 $self->pidl("\treturn;");
1212 foreach my $name (keys %{$self->{constants}}) {
1214 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1215 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1216 $py_obj = "PyInt_FromLong($cvar)";
1217 } elsif ($cvar =~ /^".*"$/) {
1218 $py_obj = "PyString_FromString($cvar)";
1220 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar);
1223 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1226 foreach (@{$self->{module_objects}}) {
1227 my ($object_name, $c_name) = @$_;
1228 $self->pidl("Py_INCREF($c_name);");
1229 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1235 return ($self->{res_hdr}, $self->{res});