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 error);
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);
62 sub PrettifyTypeName($$)
64 my ($name, $basename) = @_;
66 $name =~ s/^$basename\_//;
78 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
79 $self->register_module_import($_);
85 my ($self, $const) = @_;
86 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
89 sub register_constant($$$$)
91 my ($self, $name, $type, $value) = @_;
93 $self->{constants}->{$name} = [$type, $value];
96 sub EnumAndBitmapConsts($$$)
98 my ($self, $name, $d) = @_;
100 return unless (defined($d->{ELEMENTS}));
102 foreach my $e (@{$d->{ELEMENTS}}) {
103 $e =~ /^([A-Za-z0-9_]+)/;
106 $self->register_constant($cname, $d, $cname);
110 sub FromUnionToPythonFunction($$$$)
112 my ($self, $mem_ctx, $type, $switch, $name) = @_;
114 $self->pidl("PyObject *ret;");
117 $self->pidl("switch ($switch) {");
120 foreach my $e (@{$type->{ELEMENTS}}) {
121 $self->pidl("$e->{CASE}:");
126 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
128 $self->pidl("ret = Py_None;");
129 $self->pidl("Py_INCREF(ret);");
132 $self->pidl("return ret;");
141 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
142 $self->pidl("return NULL;");
145 sub FromPythonToUnionFunction($$$$$)
147 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
151 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
153 $self->pidl("switch ($switch) {");
156 foreach my $e (@{$type->{ELEMENTS}}) {
157 $self->pidl("$e->{CASE}:");
158 if ($e->{CASE} eq "default") { $has_default = 1; }
161 $self->ConvertObjectFromPython({}, $mem_ctx, undef, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
163 $self->pidl("break;");
169 $self->pidl("default:");
171 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
172 $self->pidl("talloc_free(ret);");
173 $self->pidl("ret = NULL;");
180 $self->pidl("return ret;");
183 sub PythonStruct($$$$$$)
185 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
187 my $env = GenerateStructEnv($d, "object");
191 my $getsetters = "NULL";
193 if ($#{$d->{ELEMENTS}} > -1) {
194 foreach my $e (@{$d->{ELEMENTS}}) {
195 my $varname = "object->$e->{NAME}";
196 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
199 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(obj);");
200 $self->pidl("PyObject *py_$e->{NAME};");
201 $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
202 $self->pidl("return py_$e->{NAME};");
207 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
210 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
211 my $mem_ctx = "py_talloc_get_mem_ctx(py_obj)";
212 my $mem_ref = "py_talloc_get_ptr(py_obj)";
213 my $l = $e->{LEVELS}[0];
214 my $nl = GetNextLevel($e, $l);
215 if ($l->{TYPE} eq "POINTER" and
216 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
217 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
218 $self->pidl("talloc_unlink(py_talloc_get_mem_ctx(py_obj), $varname);");
220 $self->ConvertObjectFromPython($env, $mem_ctx, $mem_ref, $e, "value", $varname, "return -1;");
221 $self->pidl("return 0;");
227 $getsetters = "py_$name\_getsetters";
228 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
230 foreach my $e (@{$d->{ELEMENTS}}) {
231 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
233 $self->pidl("{ NULL }");
239 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
242 $self->pidl("return py_talloc_new($cname, type);");
247 my $py_methods = "NULL";
249 # If the struct is not public there ndr_pull/ndr_push functions will
250 # be static so not callable from here
251 if (has_property($d, "public")) {
252 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
255 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
256 $self->pidl("DATA_BLOB blob;");
257 $self->pidl("enum ndr_err_code err;");
258 $self->pidl("err = ndr_push_struct_blob(&blob, py_talloc_get_mem_ctx(py_obj), object, (ndr_push_flags_fn_t)ndr_push_$name);");
259 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
261 $self->pidl("PyErr_SetNdrError(err);");
262 $self->pidl("return NULL;");
266 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
271 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
274 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
275 $self->pidl("DATA_BLOB blob;");
276 $self->pidl("enum ndr_err_code err;");
277 $self->pidl("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob.length))");
278 $self->pidl("\treturn NULL;");
280 $self->pidl("err = ndr_pull_struct_blob_all(&blob, py_talloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
281 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
283 $self->pidl("PyErr_SetNdrError(err);");
284 $self->pidl("return NULL;");
288 $self->pidl("Py_RETURN_NONE;");
293 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
296 $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
297 $self->pidl("char *retstr;");
298 $self->pidl("retstr = ndr_print_struct_string(py_talloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
299 $self->pidl("return PyString_FromString(retstr);");
304 $py_methods = "py_$name\_methods";
305 $self->pidl("static PyMethodDef $py_methods\[] = {");
307 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
308 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.ndr_unpack(class, blob) -> None\\nNDR unpack\" },");
309 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
310 $self->pidl("{ NULL, NULL, 0, NULL }");
316 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
318 my $docstring = $self->DocString($d, $name);
319 my $typeobject = "$name\_Type";
320 $self->pidl("static PyTypeObject $typeobject = {");
322 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
323 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
324 $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
325 $self->pidl(".tp_dealloc = py_talloc_dealloc,");
326 $self->pidl(".tp_getset = $getsetters,");
327 $self->pidl(".tp_repr = py_talloc_default_repr,");
329 $self->pidl(".tp_doc = $docstring,");
331 $self->pidl(".tp_methods = $py_methods,");
332 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
333 $self->pidl(".tp_new = py_$name\_new,");
339 return "&$typeobject";
342 sub get_metadata_var($)
345 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
347 if (has_property($e, "length_is")) {
348 return get_var($e->{PROPERTIES}->{length_is});
349 } elsif (has_property($e, "size_is")) {
350 return get_var($e->{PROPERTIES}->{size_is});
356 sub find_metadata_args($)
359 my $metadata_args = { in => {}, out => {} };
361 # Determine arguments that are metadata for other arguments (size_is/length_is)
362 foreach my $e (@{$fn->{ELEMENTS}}) {
363 foreach my $dir (@{$e->{DIRECTION}}) {
364 my $main = get_metadata_var($e);
366 $metadata_args->{$dir}->{$main} = $e->{NAME};
371 return $metadata_args;
374 sub PythonFunctionUnpackOut($$$)
376 my ($self, $fn, $fnname) = @_;
378 my $outfnname = "unpack_$fnname\_args_out";
381 my $metadata_args = find_metadata_args($fn);
383 my $env = GenerateFunctionOutEnv($fn, "r->");
386 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
389 $self->pidl("PyObject *result;");
390 foreach my $e (@{$fn->{ELEMENTS}}) {
391 next unless (grep(/out/,@{$e->{DIRECTION}}));
392 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
393 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
394 $self->pidl("PyObject *py_$e->{NAME};");
398 if ($fn->{RETURN_TYPE}) {
399 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
404 if ($result_size > 1) {
405 $self->pidl("result = PyTuple_New($result_size);");
407 } elsif ($result_size == 0) {
408 $self->pidl("result = Py_None;");
409 $self->pidl("Py_INCREF(result);");
410 $signature .= "None";
413 foreach my $e (@{$fn->{ELEMENTS}}) {
414 next if ($metadata_args->{out}->{$e->{NAME}});
415 my $py_name = "py_$e->{NAME}";
416 if (grep(/out/,@{$e->{DIRECTION}})) {
417 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
418 if ($result_size > 1) {
419 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
421 $signature .= "$e->{NAME}, ";
423 $self->pidl("result = $py_name;");
424 $signature .= $e->{NAME};
429 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
430 $self->handle_ntstatus("r->out.result", "NULL", undef);
431 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
432 $self->handle_werror("r->out.result", "NULL", undef);
433 } elsif (defined($fn->{RETURN_TYPE})) {
434 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
435 if ($result_size > 1) {
436 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
438 $self->pidl("result = $conv;");
440 $signature .= "result";
443 if (substr($signature, -2) eq ", ") {
444 $signature = substr($signature, 0, -2);
446 if ($result_size > 1) {
450 $self->pidl("return result;");
455 return ($outfnname, $signature);
458 sub PythonFunctionPackIn($$$)
460 my ($self, $fn, $fnname) = @_;
461 my $metadata_args = find_metadata_args($fn);
463 my $infnname = "pack_$fnname\_args_in";
465 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
468 my $args_format = "";
469 my $args_string = "";
473 foreach my $e (@{$fn->{ELEMENTS}}) {
474 next unless (grep(/in/,@{$e->{DIRECTION}}));
475 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
476 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
477 $self->pidl("PyObject *py_$e->{NAME};");
479 $args_string .= ", &py_$e->{NAME}";
480 $args_names .= "\"$e->{NAME}\", ";
481 $signature .= "$e->{NAME}, ";
483 if (substr($signature, -2) eq ", ") {
484 $signature = substr($signature, 0, -2);
486 $self->pidl("const char *kwnames[] = {");
488 $self->pidl($args_names . "NULL");
493 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
495 $self->pidl("return false;");
500 my $env = GenerateFunctionInEnv($fn, "r->");
502 my $fail = "return false;";
503 foreach my $e (@{$fn->{ELEMENTS}}) {
504 next unless (grep(/in/,@{$e->{DIRECTION}}));
505 if ($metadata_args->{in}->{$e->{NAME}}) {
506 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
507 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
508 my $val = "PyList_Size($py_var)";
509 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
510 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
511 $self->pidl("*r->in.$e->{NAME} = $val;");
513 $self->pidl("r->in.$e->{NAME} = $val;");
516 $self->ConvertObjectFromPython($env, "r", undef, $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
519 $self->pidl("return true;");
523 return ($infnname, $signature);
526 sub PythonFunction($$$)
528 my ($self, $fn, $iface, $prettyname) = @_;
530 my $fnname = "py_$fn->{NAME}";
531 my $docstring = $self->DocString($fn, $fn->{NAME});
533 my ($insignature, $outsignature);
536 if (has_property($fn, "todo")) {
537 unless ($docstring) { $docstring = "NULL"; }
541 ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
542 ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
543 my $signature = "S.$prettyname($insignature) -> $outsignature";
545 $docstring = "\"$signature\\n\\n\"$docstring";
547 $docstring = "\"$signature\"";
551 return ($infn, $outfn, $docstring);
554 sub handle_werror($$$$)
556 my ($self, $var, $retval, $mem_ctx) = @_;
558 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
560 $self->pidl("PyErr_SetWERROR($var);");
561 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
562 $self->pidl("return $retval;");
568 sub handle_ntstatus($$$$)
570 my ($self, $var, $retval, $mem_ctx) = @_;
572 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
574 $self->pidl("PyErr_SetNTSTATUS($var);");
575 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
576 $self->pidl("return $retval;");
584 my ($self, $modulename, $d, $interface, $basename) = @_;
586 my $actual_ctype = $d;
587 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
588 $actual_ctype = $actual_ctype->{DATA};
591 if ($actual_ctype->{TYPE} eq "STRUCT") {
593 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
595 if ($d->{TYPE} eq "STRUCT") {
596 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
598 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
601 $self->register_module_typeobject($fn_name, $typeobject);
604 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
605 $self->EnumAndBitmapConsts($d->{NAME}, $d);
608 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
609 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
612 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
613 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
616 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
621 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
624 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
633 my ($self, $d, $name) = @_;
634 if (has_property($d, "helpstring")) {
635 my $docstring = uc("py_doc_$name");
636 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
645 my($self,$interface,$basename) = @_;
647 if (has_property($interface, "pyhelper")) {
648 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
651 $self->Const($_) foreach (@{$interface->{CONSTS}});
653 foreach my $d (@{$interface->{TYPES}}) {
654 next if has_property($d, "nopython");
656 $self->PythonType($basename, $d, $interface, $basename);
659 if (defined $interface->{PROPERTIES}->{uuid}) {
660 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
665 foreach my $d (@{$interface->{FUNCTIONS}}) {
666 next if not defined($d->{OPNUM});
667 next if has_property($d, "nopython");
668 next if has_property($d, "todo");
670 my $prettyname = $d->{NAME};
672 $prettyname =~ s/^$interface->{NAME}_//;
673 $prettyname =~ s/^$basename\_//;
675 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
677 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
680 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
682 foreach my $d (@fns) {
683 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
684 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
686 $self->pidl("{ NULL }");
691 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
694 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
701 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
703 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
704 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
705 \"credentials should be a credentials.Credentials object.\\n\\n\"";
707 my $docstring = $self->DocString($interface, $interface->{NAME});
710 $docstring = "$signature$docstring";
712 $docstring = $signature;
715 my $if_typename = "$interface->{NAME}_InterfaceType";
717 $self->pidl("static PyTypeObject $if_typename = {");
719 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
720 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
721 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
722 $self->pidl(".tp_doc = $docstring,");
723 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
724 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
730 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
731 $self->register_module_readycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
734 $self->pidl_hdr("\n");
737 sub register_module_method($$$$$)
739 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
741 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
744 sub register_module_typeobject($$$)
746 my ($self, $name, $py_name) = @_;
748 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
750 $self->check_ready_type($py_name);
752 $self->register_patch_type_call($name, $py_name);
755 sub check_ready_type($$)
757 my ($self, $py_name) = @_;
758 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
761 sub register_module_import($$)
763 my ($self, $basename) = @_;
765 push (@{$self->{module_imports}}, $basename) unless (grep(/^$basename$/,@{$self->{module_imports}}));
768 sub use_type_variable($$)
770 my ($self, $orig_ctype) = @_;
771 # FIXME: Have a global lookup table for types that look different on the
772 # wire than they are named in C?
773 if ($orig_ctype->{NAME} eq "dom_sid2" or $orig_ctype->{NAME} eq "dom_sid28") {
774 $orig_ctype->{NAME} = "dom_sid";
776 my $ctype = resolveType($orig_ctype);
777 unless (defined($ctype->{BASEFILE})) {
780 # If this is an external type, make sure we do the right imports.
781 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
782 $self->register_module_import($ctype->{BASEFILE});
783 unless (defined($self->{type_imports}->{$ctype->{NAME}})) {
784 $self->{type_imports}->{$ctype->{NAME}} = $ctype->{BASEFILE};
786 return "$ctype->{NAME}_Type";
788 return "&$ctype->{NAME}_Type";
791 sub register_patch_type_call($$$)
793 my ($self, $typename, $cvar) = @_;
795 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
799 sub register_module_readycode($$)
801 my ($self, $code) = @_;
803 push (@{$self->{readycode}}, @$code);
806 sub register_module_object($$$)
808 my ($self, $name, $py_name) = @_;
810 push (@{$self->{module_objects}}, [$name, $py_name])
815 my ($self, $dest, $src) = @_;
816 if ($dest =~ /^\&/ and $src eq "NULL") {
817 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
818 } elsif ($dest =~ /^\&/) {
819 $self->pidl("memcpy($dest, $src, sizeof(" . get_value_of($dest) . "));");
821 $self->pidl("$dest = $src;");
825 sub ConvertObjectFromPythonData($$$$$$;$)
827 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
829 fatal($location, "undef type for $cvar") unless(defined($ctype));
831 $ctype = resolveType($ctype);
833 my $actual_ctype = $ctype;
834 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
835 $actual_ctype = $actual_ctype->{DATA};
838 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
839 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
840 $self->pidl("$target = PyInt_AsLong($cvar);");
843 if ($actual_ctype->{TYPE} eq "SCALAR" ) {
844 if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
845 $self->pidl("if (PyObject_TypeCheck($cvar, &PyLong_Type)) {");
847 $self->pidl("$target = PyLong_AsLongLong($cvar);");
849 $self->pidl("} else {");
851 $self->pidl("if (PyObject_TypeCheck($cvar, &PyInt_Type)) {");
853 $self->pidl("$target = PyInt_AsLong($cvar);");
855 $self->pidl("} else {");
857 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
858 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
866 if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t)$/) {
867 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
868 $self->pidl("$target = PyInt_AsLong($cvar);");
873 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
874 my $ctype_name = $self->use_type_variable($ctype);
875 unless (defined ($ctype_name)) {
876 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
877 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
880 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
881 $self->assign($target, "talloc_reference($mem_ctx, (".mapTypeName($ctype)." *)py_talloc_get_ptr($cvar))");
885 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
886 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AsString($cvar), PyString_Size($cvar));");
890 if ($actual_ctype->{TYPE} eq "SCALAR" and
891 ($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")) {
892 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AsString($cvar));");
896 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
897 $self->pidl("$target = PyString_AsString($cvar);");
901 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
902 $self->pidl("$target = PyString_AsString($cvar);");
907 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
908 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
912 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
913 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
917 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
918 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
922 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
923 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
927 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
931 sub ConvertObjectFromPythonLevel($$$$$$$$$)
933 my ($self, $env, $mem_ctx, $mem_ref, $py_var, $e, $l, $var_name, $fail) = @_;
934 my $nl = GetNextLevel($e, $l);
936 if ($l->{TYPE} eq "POINTER") {
937 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
938 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $mem_ref, $py_var, $e, $nl, $var_name, $fail);
941 if ($l->{POINTER_TYPE} ne "ref") {
942 $self->pidl("if ($py_var == Py_None) {");
944 $self->pidl("$var_name = NULL;");
946 $self->pidl("} else {");
949 # if we want to handle more than one level of pointer in python interfaces
950 # then this is where we would need to allocate it
951 if ($l->{POINTER_TYPE} eq "ref") {
952 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
954 $self->pidl("$var_name = NULL;");
956 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $mem_ref, $py_var, $e, $nl, get_value_of($var_name), $fail);
957 if ($l->{POINTER_TYPE} ne "ref") {
961 } elsif ($l->{TYPE} eq "ARRAY") {
962 my $pl = GetPrevLevel($e, $l);
963 if ($pl && $pl->{TYPE} eq "POINTER") {
964 $var_name = get_pointer_to($var_name);
967 if (is_charset_array($e, $l)) {
968 $self->pidl("PY_CHECK_TYPE(&PyUnicode_Type, $py_var, $fail);");
969 # FIXME: Use Unix charset setting rather than utf-8
970 $self->pidl($var_name . " = PyString_AsString(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
972 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
973 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
976 $self->pidl("int $counter;");
977 if (ArrayDynamicallyAllocated($e, $l)) {
978 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_Size($py_var));");
979 $self->pidl("if (!$var_name) { $fail; }");
980 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
982 $self->pidl("if (!talloc_reference($mem_ref, $var_name)) { $fail }");
985 $self->pidl("for ($counter = 0; $counter < PyList_Size($py_var); $counter++) {");
987 $self->ConvertObjectFromPythonLevel($env, $var_name, undef, "PyList_GetItem($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
993 } elsif ($l->{TYPE} eq "DATA") {
995 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
996 $var_name = get_pointer_to($var_name);
998 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
999 } elsif ($l->{TYPE} eq "SWITCH") {
1000 $var_name = get_pointer_to($var_name);
1001 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1002 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1005 $self->pidl("void *$switch_ptr;");
1006 $self->pidl("$switch_ptr = py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1007 $self->pidl("if ($switch_ptr == NULL) { $fail }");
1008 $self->assign($var_name, "$switch_ptr");
1011 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1012 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, undef, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
1014 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1018 sub ConvertObjectFromPython($$$$$$$$)
1020 my ($self, $env, $mem_ctx, $mem_ref, $ctype, $cvar, $target, $fail) = @_;
1022 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $mem_ref, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1025 sub ConvertScalarToPython($$$)
1027 my ($self, $ctypename, $cvar) = @_;
1029 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1031 $ctypename = expandAlias($ctypename);
1033 if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1034 return "PyLong_FromLongLong($cvar)";
1037 if ($ctypename =~ /^(char|u?int[0-9]*|time_t)$/) {
1038 return "PyInt_FromLong($cvar)";
1041 if ($ctypename eq "DATA_BLOB") {
1042 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1045 if ($ctypename eq "NTSTATUS") {
1046 return "PyErr_FromNTSTATUS($cvar)";
1049 if ($ctypename eq "WERROR") {
1050 return "PyErr_FromWERROR($cvar)";
1053 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1054 return "PyString_FromString_check_null($cvar)";
1058 if ($ctypename eq "string_array") { return "PyCObject_FromTallocPtr($cvar)"; }
1059 if ($ctypename eq "ipv4address") { return "PyString_FromString_check_null($cvar)"; }
1060 if ($ctypename eq "dnsp_name") { return "PyString_FromString_check_null($cvar)"; }
1061 if ($ctypename eq "pointer") {
1062 return "PyCObject_FromTallocPtr($cvar)";
1065 die("Unknown scalar type $ctypename");
1068 sub ConvertObjectToPythonData($$$$$;$)
1070 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1072 die("undef type for $cvar") unless(defined($ctype));
1074 $ctype = resolveType($ctype);
1076 my $actual_ctype = $ctype;
1077 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1078 $actual_ctype = $actual_ctype->{DATA};
1081 if ($actual_ctype->{TYPE} eq "ENUM") {
1082 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1083 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1084 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1085 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1086 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1087 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1088 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1089 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1090 my $ctype_name = $self->use_type_variable($ctype);
1091 unless (defined($ctype_name)) {
1092 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1093 return "NULL"; # FIXME!
1095 return "py_talloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1098 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1101 sub fail_on_null($$$)
1103 my ($self, $var, $fail) = @_;
1104 $self->pidl("if ($var == NULL) {");
1111 sub ConvertObjectToPythonLevel($$$$$$)
1113 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1114 my $nl = GetNextLevel($e, $l);
1116 if ($l->{TYPE} eq "POINTER") {
1117 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1118 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1121 if ($l->{POINTER_TYPE} ne "ref") {
1122 $self->pidl("if ($var_name == NULL) {");
1124 $self->pidl("$py_var = Py_None;");
1125 $self->pidl("Py_INCREF($py_var);");
1127 $self->pidl("} else {");
1130 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1131 if ($l->{POINTER_TYPE} ne "ref") {
1135 } elsif ($l->{TYPE} eq "ARRAY") {
1136 my $pl = GetPrevLevel($e, $l);
1137 if ($pl && $pl->{TYPE} eq "POINTER") {
1138 $var_name = get_pointer_to($var_name);
1141 if (is_charset_array($e, $l)) {
1142 # FIXME: Use Unix charset setting rather than utf-8
1143 $self->pidl("$py_var = PyUnicode_Decode_check_null($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1145 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1146 my $length = $l->{SIZE_IS};
1147 if (defined($l->{LENGTH_IS})) {
1148 $length = $l->{LENGTH_IS};
1151 $length = ParseExpr($length, $env, $e);
1152 $self->pidl("$py_var = PyList_New($length);");
1153 $self->fail_on_null($py_var, $fail);
1156 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1157 $self->pidl("int $counter;");
1158 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1160 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1161 $self->pidl("PyObject *$member_var;");
1162 $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1163 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1169 } elsif ($l->{TYPE} eq "SWITCH") {
1170 $var_name = get_pointer_to($var_name);
1171 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1172 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1173 $self->fail_on_null($py_var, $fail);
1175 } elsif ($l->{TYPE} eq "DATA") {
1176 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1177 $var_name = get_pointer_to($var_name);
1179 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1180 $self->pidl("$py_var = $conv;");
1181 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1182 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1184 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1188 sub ConvertObjectToPython($$$$$$)
1190 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1192 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1197 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1199 $self->{BASENAME} = $basename;
1202 /* Python wrapper functions auto-generated by pidl */
1204 #include \"includes.h\"
1205 #include \"lib/talloc/pytalloc.h\"
1206 #include \"librpc/rpc/pyrpc.h\"
1208 #include \"$ndr_hdr\"
1212 foreach my $x (@$ndr) {
1213 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1214 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1217 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1219 foreach (@{$self->{module_methods}}) {
1220 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1221 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1224 $self->pidl("{ NULL, NULL, 0, NULL }");
1230 $self->pidl("void init$basename(void)");
1233 $self->pidl("PyObject *m;");
1234 foreach (@{$self->{module_imports}}) {
1235 $self->pidl("PyObject *dep_$_;");
1239 foreach (@{$self->{module_imports}}) {
1240 $self->pidl("dep_$_ = PyImport_ImportModule(\"samba.dcerpc.$_\");");
1241 $self->pidl("if (dep_$_ == NULL)");
1242 $self->pidl("\treturn;");
1246 foreach (keys %{$self->{type_imports}}) {
1247 my $basefile = $self->{type_imports}->{$_};
1248 $self->pidl_hdr("static PyTypeObject *$_\_Type;\n");
1249 my $pretty_name = PrettifyTypeName($_, $basefile);
1250 $self->pidl("$_\_Type = (PyTypeObject *)PyObject_GetAttrString(dep_$basefile, \"$pretty_name\");");
1251 $self->pidl("if ($_\_Type == NULL)");
1252 $self->pidl("\treturn;");
1256 foreach (@{$self->{ready_types}}) {
1257 $self->pidl("if (PyType_Ready($_) < 0)");
1258 $self->pidl("\treturn;");
1261 $self->pidl($_) foreach (@{$self->{readycode}});
1263 foreach (@{$self->{patch_type_calls}}) {
1264 my ($typename, $cvar) = @$_;
1265 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1266 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1267 $self->pidl("#endif");
1272 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1273 $self->pidl("if (m == NULL)");
1274 $self->pidl("\treturn;");
1276 foreach my $name (keys %{$self->{constants}}) {
1278 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1279 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1280 $py_obj = "PyInt_FromLong($cvar)";
1281 } elsif ($cvar =~ /^".*"$/) {
1282 $py_obj = "PyString_FromString($cvar)";
1284 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1287 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1290 foreach (@{$self->{module_objects}}) {
1291 my ($object_name, $c_name) = @$_;
1292 $self->pidl("Py_INCREF($c_name);");
1293 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1296 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1297 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1298 $self->pidl("#endif");
1303 return ($self->{res_hdr} . $self->{res});