librpc: Shorten dcerpc_binding_handle_call a bit
[Samba/gebeck_regimport.git] / pidl / lib / Parse / Pidl / Samba4 / Python.pm
blob39884ab278d24913f7ad7c200dd8789c87888a14
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;
8 use Exporter;
9 @ISA = qw(Exporter);
11 use strict;
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 ContainsPipe 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);
21 $VERSION = '0.01';
23 sub new($) {
24 my ($class) = @_;
25 my $self = { res => "", res_hdr => "", tabs => "", constants => {},
26 module_methods => [], module_objects => [], ready_types => [],
27 module_imports => {}, type_imports => {},
28 patch_type_calls => [], prereadycode => [],
29 postreadycode => []};
30 bless($self, $class);
33 sub pidl_hdr ($$)
35 my $self = shift;
36 $self->{res_hdr} .= shift;
39 sub pidl($$)
41 my ($self, $d) = @_;
42 if ($d) {
43 if ((!($d =~ /^#/))) {
44 $self->{res} .= $self->{tabs};
46 $self->{res} .= $d;
48 $self->{res} .= "\n";
51 sub indent($)
53 my ($self) = @_;
54 $self->{tabs} .= "\t";
57 sub deindent($)
59 my ($self) = @_;
60 $self->{tabs} = substr($self->{tabs}, 0, -1);
63 sub PrettifyTypeName($$)
65 my ($name, $basename) = @_;
67 $basename =~ s/^.*\.([^.]+)$/\1/;
69 $name =~ s/^$basename\_//;
72 return $name;
75 sub Import
77 my $self = shift;
78 my @imports = @_;
79 foreach (@imports) {
80 $_ = unmake_str($_);
81 s/\.idl$//;
82 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
83 $self->register_module_import("samba.dcerpc.$_");
87 sub Const($$)
89 my ($self, $const) = @_;
90 $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
93 sub register_constant($$$$)
95 my ($self, $name, $type, $value) = @_;
97 $self->{constants}->{$name} = [$type, $value];
100 sub EnumAndBitmapConsts($$$)
102 my ($self, $name, $d) = @_;
104 return unless (defined($d->{ELEMENTS}));
106 foreach my $e (@{$d->{ELEMENTS}}) {
107 $e =~ /^([A-Za-z0-9_]+)/;
108 my $cname = $1;
110 $self->register_constant($cname, $d, $cname);
114 sub FromUnionToPythonFunction($$$$)
116 my ($self, $mem_ctx, $type, $switch, $name) = @_;
118 $self->pidl("PyObject *ret;");
119 $self->pidl("");
121 $self->pidl("switch ($switch) {");
122 $self->indent;
124 foreach my $e (@{$type->{ELEMENTS}}) {
125 $self->pidl("$e->{CASE}:");
127 $self->indent;
129 if ($e->{NAME}) {
130 $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
131 } else {
132 $self->pidl("ret = Py_None;");
133 $self->pidl("Py_INCREF(ret);");
136 $self->pidl("return ret;");
137 $self->pidl("");
139 $self->deindent;
142 $self->deindent;
143 $self->pidl("}");
145 $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
146 $self->pidl("return NULL;");
149 sub FromPythonToUnionFunction($$$$$)
151 my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
153 my $has_default = 0;
155 $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
157 $self->pidl("switch ($switch) {");
158 $self->indent;
160 foreach my $e (@{$type->{ELEMENTS}}) {
161 $self->pidl("$e->{CASE}:");
162 if ($e->{CASE} eq "default") { $has_default = 1; }
163 $self->indent;
164 if ($e->{NAME}) {
165 $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
167 $self->pidl("break;");
168 $self->deindent;
169 $self->pidl("");
172 if (!$has_default) {
173 $self->pidl("default:");
174 $self->indent;
175 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
176 $self->pidl("talloc_free(ret);");
177 $self->pidl("ret = NULL;");
178 $self->deindent;
181 $self->deindent;
182 $self->pidl("}");
183 $self->pidl("");
184 $self->pidl("return ret;");
187 sub PythonStruct($$$$$$)
189 my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
191 my $env = GenerateStructEnv($d, "object");
193 $self->pidl("");
195 my $getsetters = "NULL";
197 if ($#{$d->{ELEMENTS}} > -1) {
198 foreach my $e (@{$d->{ELEMENTS}}) {
199 my $varname = "object->$e->{NAME}";
200 $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
201 $self->pidl("{");
202 $self->indent;
203 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
204 $self->pidl("PyObject *py_$e->{NAME};");
205 $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
206 $self->pidl("return py_$e->{NAME};");
207 $self->deindent;
208 $self->pidl("}");
209 $self->pidl("");
211 $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
212 $self->pidl("{");
213 $self->indent;
214 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
215 my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
216 my $l = $e->{LEVELS}[0];
217 my $nl = GetNextLevel($e, $l);
218 if ($l->{TYPE} eq "POINTER" and
219 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
220 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
221 $self->pidl("talloc_unlink(pytalloc_get_mem_ctx(py_obj), $varname);");
223 $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
224 $self->pidl("return 0;");
225 $self->deindent;
226 $self->pidl("}");
227 $self->pidl("");
230 $getsetters = "py_$name\_getsetters";
231 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
232 $self->indent;
233 foreach my $e (@{$d->{ELEMENTS}}) {
234 $self->pidl("{ discard_const_p(char, \"$e->{NAME}\"), py_$name\_get_$e->{NAME}, py_$name\_set_$e->{NAME} },");
236 $self->pidl("{ NULL }");
237 $self->deindent;
238 $self->pidl("};");
239 $self->pidl("");
242 $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
243 $self->pidl("{");
244 $self->indent;
245 $self->pidl("return pytalloc_new($cname, type);");
246 $self->deindent;
247 $self->pidl("}");
248 $self->pidl("");
250 my $py_methods = "NULL";
252 # If the struct is not public there ndr_pull/ndr_push functions will
253 # be static so not callable from here
254 if (has_property($d, "public")) {
255 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
256 $self->pidl("{");
257 $self->indent;
258 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
259 $self->pidl("DATA_BLOB blob;");
260 $self->pidl("enum ndr_err_code err;");
261 $self->pidl("err = ndr_push_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_push_flags_fn_t)ndr_push_$name);");
262 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
263 $self->indent;
264 $self->pidl("PyErr_SetNdrError(err);");
265 $self->pidl("return NULL;");
266 $self->deindent;
267 $self->pidl("}");
268 $self->pidl("");
269 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
270 $self->deindent;
271 $self->pidl("}");
272 $self->pidl("");
274 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
275 $self->pidl("{");
276 $self->indent;
277 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
278 $self->pidl("DATA_BLOB blob;");
279 $self->pidl("int blob_length = 0;");
280 $self->pidl("enum ndr_err_code err;");
281 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
282 $self->pidl("PyObject *allow_remaining_obj = NULL;");
283 $self->pidl("bool allow_remaining = false;");
284 $self->pidl("");
285 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|O:__ndr_unpack__\",");
286 $self->indent;
287 $self->pidl("discard_const_p(char *, kwnames),");
288 $self->pidl("&blob.data, &blob_length,");
289 $self->pidl("&allow_remaining_obj)) {");
290 $self->deindent;
291 $self->indent;
292 $self->pidl("return NULL;");
293 $self->deindent;
294 $self->pidl("}");
295 $self->pidl("blob.length = blob_length;");
296 $self->pidl("");
297 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
298 $self->indent;
299 $self->pidl("allow_remaining = true;");
300 $self->deindent;
301 $self->pidl("}");
302 $self->pidl("");
303 $self->pidl("if (allow_remaining) {");
304 $self->indent;
305 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
306 $self->deindent;
307 $self->pidl("} else {");
308 $self->indent;
309 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
310 $self->deindent;
311 $self->pidl("}");
312 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
313 $self->indent;
314 $self->pidl("PyErr_SetNdrError(err);");
315 $self->pidl("return NULL;");
316 $self->deindent;
317 $self->pidl("}");
318 $self->pidl("");
319 $self->pidl("Py_RETURN_NONE;");
320 $self->deindent;
321 $self->pidl("}");
322 $self->pidl("");
324 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
325 $self->pidl("{");
326 $self->indent;
327 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
328 $self->pidl("PyObject *ret;");
329 $self->pidl("char *retstr;");
330 $self->pidl("");
331 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
332 $self->pidl("ret = PyString_FromString(retstr);");
333 $self->pidl("talloc_free(retstr);");
334 $self->pidl("");
335 $self->pidl("return ret;");
336 $self->deindent;
337 $self->pidl("}");
338 $self->pidl("");
340 $py_methods = "py_$name\_methods";
341 $self->pidl("static PyMethodDef $py_methods\[] = {");
342 $self->indent;
343 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
344 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
345 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
346 $self->pidl("{ NULL, NULL, 0, NULL }");
347 $self->deindent;
348 $self->pidl("};");
349 $self->pidl("");
352 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
353 $self->pidl("");
354 my $docstring = $self->DocString($d, $name);
355 my $typeobject = "$name\_Type";
356 $self->pidl("static PyTypeObject $typeobject = {");
357 $self->indent;
358 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
359 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
360 $self->pidl(".tp_getset = $getsetters,");
361 if ($docstring) {
362 $self->pidl(".tp_doc = $docstring,");
364 $self->pidl(".tp_methods = $py_methods,");
365 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
366 $self->pidl(".tp_basicsize = sizeof(pytalloc_Object),");
367 $self->pidl(".tp_new = py_$name\_new,");
368 $self->deindent;
369 $self->pidl("};");
371 $self->pidl("");
373 my $talloc_typename = $self->import_type_variable("talloc", "Object");
374 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;", ""]);
376 return "&$typeobject";
379 sub get_metadata_var($)
381 my ($e) = @_;
382 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
384 if (has_property($e, "length_is")) {
385 return get_var($e->{PROPERTIES}->{length_is});
386 } elsif (has_property($e, "size_is")) {
387 return get_var($e->{PROPERTIES}->{size_is});
390 return undef;
393 sub find_metadata_args($)
395 my ($fn) = @_;
396 my $metadata_args = { in => {}, out => {} };
398 # Determine arguments that are metadata for other arguments (size_is/length_is)
399 foreach my $e (@{$fn->{ELEMENTS}}) {
400 foreach my $dir (@{$e->{DIRECTION}}) {
401 my $main = get_metadata_var($e);
402 if ($main) {
403 $metadata_args->{$dir}->{$main} = $e->{NAME};
408 return $metadata_args;
411 sub PythonFunctionUnpackOut($$$)
413 my ($self, $fn, $fnname) = @_;
415 my $outfnname = "unpack_$fnname\_args_out";
416 my $signature = "";
418 my $metadata_args = find_metadata_args($fn);
420 my $env = GenerateFunctionOutEnv($fn, "r->");
421 my $result_size = 0;
423 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
424 $self->pidl("{");
425 $self->indent;
426 $self->pidl("PyObject *result;");
427 foreach my $e (@{$fn->{ELEMENTS}}) {
428 next unless (grep(/out/,@{$e->{DIRECTION}}));
429 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
430 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
431 $self->pidl("PyObject *py_$e->{NAME};");
432 $result_size++;
435 if ($fn->{RETURN_TYPE}) {
436 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
439 my $i = 0;
441 if ($result_size > 1) {
442 $self->pidl("result = PyTuple_New($result_size);");
443 $signature .= "(";
444 } elsif ($result_size == 0) {
445 $self->pidl("result = Py_None;");
446 $self->pidl("Py_INCREF(result);");
447 $signature .= "None";
450 foreach my $e (@{$fn->{ELEMENTS}}) {
451 next if ($metadata_args->{out}->{$e->{NAME}});
452 my $py_name = "py_$e->{NAME}";
453 if (grep(/out/,@{$e->{DIRECTION}})) {
454 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
455 if ($result_size > 1) {
456 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
457 $i++;
458 $signature .= "$e->{NAME}, ";
459 } else {
460 $self->pidl("result = $py_name;");
461 $signature .= $e->{NAME};
466 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
467 $self->handle_ntstatus("r->out.result", "NULL", undef);
468 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
469 $self->handle_werror("r->out.result", "NULL", undef);
470 } elsif (defined($fn->{RETURN_TYPE})) {
471 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
472 if ($result_size > 1) {
473 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
474 } else {
475 $self->pidl("result = $conv;");
477 $signature .= "result";
480 if (substr($signature, -2) eq ", ") {
481 $signature = substr($signature, 0, -2);
483 if ($result_size > 1) {
484 $signature .= ")";
487 $self->pidl("return result;");
488 $self->deindent;
489 $self->pidl("}");
490 $self->pidl("");
492 return ($outfnname, $signature);
495 sub PythonFunctionPackIn($$$)
497 my ($self, $fn, $fnname) = @_;
498 my $metadata_args = find_metadata_args($fn);
500 my $infnname = "pack_$fnname\_args_in";
502 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
503 $self->pidl("{");
504 $self->indent;
505 my $args_format = "";
506 my $args_string = "";
507 my $args_names = "";
508 my $signature = "";
510 foreach my $e (@{$fn->{ELEMENTS}}) {
511 next unless (grep(/in/,@{$e->{DIRECTION}}));
512 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
513 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
514 $self->pidl("PyObject *py_$e->{NAME};");
515 $args_format .= "O";
516 $args_string .= ", &py_$e->{NAME}";
517 $args_names .= "\"$e->{NAME}\", ";
518 $signature .= "$e->{NAME}, ";
520 if (substr($signature, -2) eq ", ") {
521 $signature = substr($signature, 0, -2);
523 $self->pidl("const char *kwnames[] = {");
524 $self->indent;
525 $self->pidl($args_names . "NULL");
526 $self->deindent;
527 $self->pidl("};");
529 $self->pidl("");
530 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
531 $self->indent;
532 $self->pidl("return false;");
533 $self->deindent;
534 $self->pidl("}");
535 $self->pidl("");
537 my $env = GenerateFunctionInEnv($fn, "r->");
539 my $fail = "return false;";
540 foreach my $e (@{$fn->{ELEMENTS}}) {
541 next unless (grep(/in/,@{$e->{DIRECTION}}));
542 if ($metadata_args->{in}->{$e->{NAME}}) {
543 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
544 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
545 my $val = "PyList_GET_SIZE($py_var)";
546 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
547 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
548 $self->pidl("*r->in.$e->{NAME} = $val;");
549 } else {
550 $self->pidl("r->in.$e->{NAME} = $val;");
552 } else {
553 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
556 $self->pidl("return true;");
557 $self->deindent;
558 $self->pidl("}");
559 $self->pidl("");
560 return ($infnname, $signature);
563 sub PythonFunction($$$)
565 my ($self, $fn, $iface, $prettyname) = @_;
567 my $fnname = "py_$fn->{NAME}";
568 my $docstring = $self->DocString($fn, $fn->{NAME});
570 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
571 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
572 my $signature = "S.$prettyname($insignature) -> $outsignature";
573 if ($docstring) {
574 $docstring = "\"$signature\\n\\n\"$docstring";
575 } else {
576 $docstring = "\"$signature\"";
579 return ($infn, $outfn, $docstring);
582 sub handle_werror($$$$)
584 my ($self, $var, $retval, $mem_ctx) = @_;
586 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
587 $self->indent;
588 $self->pidl("PyErr_SetWERROR($var);");
589 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
590 $self->pidl("return $retval;");
591 $self->deindent;
592 $self->pidl("}");
593 $self->pidl("");
596 sub handle_ntstatus($$$$)
598 my ($self, $var, $retval, $mem_ctx) = @_;
600 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
601 $self->indent;
602 $self->pidl("PyErr_SetNTSTATUS($var);");
603 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
604 $self->pidl("return $retval;");
605 $self->deindent;
606 $self->pidl("}");
607 $self->pidl("");
610 sub PythonType($$$$)
612 my ($self, $modulename, $d, $interface, $basename) = @_;
614 my $actual_ctype = $d;
615 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
616 $actual_ctype = $actual_ctype->{DATA};
619 if ($actual_ctype->{TYPE} eq "STRUCT") {
620 my $typeobject;
621 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
623 if ($d->{TYPE} eq "STRUCT") {
624 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
625 } else {
626 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
629 $self->register_module_typeobject($fn_name, $typeobject);
632 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
633 $self->EnumAndBitmapConsts($d->{NAME}, $d);
636 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
637 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
640 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
641 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
642 $self->pidl("{");
643 $self->indent;
644 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
645 $self->deindent;
646 $self->pidl("}");
647 $self->pidl("");
649 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
650 $self->pidl("{");
651 $self->indent;
652 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
653 $self->deindent;
654 $self->pidl("}");
655 $self->pidl("");
659 sub DocString($$$)
661 my ($self, $d, $name) = @_;
662 if (has_property($d, "helpstring")) {
663 my $docstring = uc("py_doc_$name");
664 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
665 return $docstring;
668 return undef;
671 sub Interface($$$)
673 my($self,$interface,$basename) = @_;
675 if (has_property($interface, "pyhelper")) {
676 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
679 $self->Const($_) foreach (@{$interface->{CONSTS}});
681 foreach my $d (@{$interface->{TYPES}}) {
682 next if has_property($d, "nopython");
684 $self->PythonType($basename, $d, $interface, $basename);
687 if (defined $interface->{PROPERTIES}->{uuid}) {
688 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
689 $self->pidl("");
691 my @fns = ();
693 foreach my $d (@{$interface->{FUNCTIONS}}) {
694 next if has_property($d, "noopnum");
695 next if has_property($d, "nopython");
696 next if has_property($d, "todo");
698 my $skip = 0;
699 foreach my $e (@{$d->{ELEMENTS}}) {
700 if (ContainsPipe($e, $e->{LEVELS}[0])) {
701 $skip = 1;
702 last;
705 next if $skip;
707 my $prettyname = $d->{NAME};
709 $prettyname =~ s/^$interface->{NAME}_//;
710 $prettyname =~ s/^$basename\_//;
712 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
714 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
717 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
718 $self->indent;
719 foreach my $d (@fns) {
720 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
721 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
723 $self->pidl("{ NULL }");
724 $self->deindent;
725 $self->pidl("};");
726 $self->pidl("");
728 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
729 $self->pidl("{");
730 $self->indent;
731 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
732 $self->deindent;
733 $self->pidl("}");
735 $self->pidl("");
737 my $signature =
738 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
739 \"\\n\"
740 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
741 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
742 \"credentials should be a credentials.Credentials object.\\n\\n\"";
744 my $docstring = $self->DocString($interface, $interface->{NAME});
746 if ($docstring) {
747 $docstring = "$signature$docstring";
748 } else {
749 $docstring = $signature;
752 my $if_typename = "$interface->{NAME}_InterfaceType";
754 $self->pidl("static PyTypeObject $if_typename = {");
755 $self->indent;
756 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
757 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
758 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
759 $self->pidl(".tp_doc = $docstring,");
760 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
761 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
762 $self->deindent;
763 $self->pidl("};");
765 $self->pidl("");
767 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
768 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
769 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
770 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
773 $self->pidl_hdr("\n");
776 sub register_module_method($$$$$)
778 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
780 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
783 sub register_module_typeobject($$$)
785 my ($self, $name, $py_name) = @_;
787 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
789 $self->check_ready_type($py_name);
791 $self->register_patch_type_call($name, $py_name);
794 sub check_ready_type($$)
796 my ($self, $py_name) = @_;
797 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
800 sub register_module_import($$)
802 my ($self, $module_path) = @_;
804 my $var_name = $module_path;
805 $var_name =~ s/\./_/g;
806 $var_name = "dep_$var_name";
808 $self->{module_imports}->{$var_name} = $module_path;
810 return $var_name;
813 sub import_type_variable($$$)
815 my ($self, $module, $name) = @_;
817 $self->register_module_import($module);
818 unless (defined($self->{type_imports}->{$name})) {
819 $self->{type_imports}->{$name} = $module;
821 return "$name\_Type";
824 sub use_type_variable($$)
826 my ($self, $orig_ctype) = @_;
827 # FIXME: Have a global lookup table for types that look different on the
828 # wire than they are named in C?
829 if ($orig_ctype->{NAME} eq "dom_sid2" or
830 $orig_ctype->{NAME} eq "dom_sid28" or
831 $orig_ctype->{NAME} eq "dom_sid0") {
832 $orig_ctype->{NAME} = "dom_sid";
834 if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
835 $orig_ctype->{NAME} = "security_descriptor";
838 my $ctype = resolveType($orig_ctype);
839 unless (defined($ctype->{BASEFILE})) {
840 return undef;
842 # If this is an external type, make sure we do the right imports.
843 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
844 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
846 return "&$ctype->{NAME}_Type";
849 sub register_patch_type_call($$$)
851 my ($self, $typename, $cvar) = @_;
853 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
857 sub register_module_prereadycode($$)
859 my ($self, $code) = @_;
861 push (@{$self->{prereadycode}}, @$code);
864 sub register_module_postreadycode($$)
866 my ($self, $code) = @_;
868 push (@{$self->{postreadycode}}, @$code);
871 sub register_module_object($$$)
873 my ($self, $name, $py_name) = @_;
875 push (@{$self->{module_objects}}, [$name, $py_name])
878 sub assign($$$)
880 my ($self, $dest, $src) = @_;
881 if ($dest =~ /^\&/ and $src eq "NULL") {
882 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
883 } elsif ($dest =~ /^\&/) {
884 my $destvar = get_value_of($dest);
885 $self->pidl("$destvar = *$src;");
886 } else {
887 $self->pidl("$dest = $src;");
891 sub ConvertObjectFromPythonData($$$$$$;$)
893 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
895 fatal($location, "undef type for $cvar") unless(defined($ctype));
897 $ctype = resolveType($ctype);
899 my $actual_ctype = $ctype;
900 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
901 $actual_ctype = $actual_ctype->{DATA};
904 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
905 $self->pidl("if (PyLong_Check($cvar)) {");
906 $self->indent;
907 $self->pidl("$target = PyLong_AsLongLong($cvar);");
908 $self->deindent;
909 $self->pidl("} else if (PyInt_Check($cvar)) {");
910 $self->indent;
911 $self->pidl("$target = PyInt_AsLong($cvar);");
912 $self->deindent;
913 $self->pidl("} else {");
914 $self->indent;
915 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
916 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
917 $self->pidl($fail);
918 $self->deindent;
919 $self->pidl("}");
920 return;
922 if ($actual_ctype->{TYPE} eq "SCALAR" ) {
923 if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
924 $self->pidl("if (PyLong_Check($cvar)) {");
925 $self->indent;
926 $self->pidl("$target = PyLong_AsLongLong($cvar);");
927 $self->deindent;
928 $self->pidl("} else if (PyInt_Check($cvar)) {");
929 $self->indent;
930 $self->pidl("$target = PyInt_AsLong($cvar);");
931 $self->deindent;
932 $self->pidl("} else {");
933 $self->indent;
934 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
935 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
936 $self->pidl($fail);
937 $self->deindent;
938 $self->pidl("}");
939 return;
941 if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t|uid_t|gid_t)$/) {
942 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
943 $self->pidl("$target = PyInt_AsLong($cvar);");
944 return;
948 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
949 my $ctype_name = $self->use_type_variable($ctype);
950 unless (defined ($ctype_name)) {
951 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
952 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
953 return;
955 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
956 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
957 $self->indent;
958 $self->pidl("PyErr_NoMemory();");
959 $self->pidl("$fail");
960 $self->deindent;
961 $self->pidl("}");
962 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
963 return;
966 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
967 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
968 return;
971 if ($actual_ctype->{TYPE} eq "SCALAR" and
972 ($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")) {
973 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
974 return;
977 if ($actual_ctype->{TYPE} eq "SCALAR" and ($actual_ctype->{NAME} eq "dns_string" or $actual_ctype->{NAME} eq "dns_name")) {
978 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
979 return;
982 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
983 $self->pidl("$target = PyString_AS_STRING($cvar);");
984 return;
987 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv6address") {
988 $self->pidl("$target = PyString_AsString($cvar);");
989 return;
992 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
993 $self->pidl("$target = PyString_AS_STRING($cvar);");
994 return;
997 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_string") {
998 $self->pidl("$target = PyString_AS_STRING($cvar);");
999 return;
1002 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1003 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1004 return;
1007 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1008 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1009 return;
1012 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1013 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
1014 return;
1017 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1018 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
1019 return;
1022 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1026 sub ConvertObjectFromPythonLevel($$$$$$$$)
1028 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1029 my $nl = GetNextLevel($e, $l);
1030 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1031 $nl = GetNextLevel($e, $nl);
1033 my $pl = GetPrevLevel($e, $l);
1034 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1035 $pl = GetPrevLevel($e, $pl);
1038 if ($l->{TYPE} eq "POINTER") {
1039 if ($l->{POINTER_TYPE} ne "ref") {
1040 $self->pidl("if ($py_var == Py_None) {");
1041 $self->indent;
1042 $self->pidl("$var_name = NULL;");
1043 $self->deindent;
1044 $self->pidl("} else {");
1045 $self->indent;
1047 # if we want to handle more than one level of pointer in python interfaces
1048 # then this is where we would need to allocate it
1049 if ($l->{POINTER_TYPE} eq "ref") {
1050 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1051 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1052 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1053 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1054 } else {
1055 $self->pidl("$var_name = NULL;");
1057 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1058 $var_name = get_value_of($var_name);
1060 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1061 if ($l->{POINTER_TYPE} ne "ref") {
1062 $self->deindent;
1063 $self->pidl("}");
1065 } elsif ($l->{TYPE} eq "ARRAY") {
1066 if ($pl && $pl->{TYPE} eq "POINTER") {
1067 $var_name = get_pointer_to($var_name);
1070 if (is_charset_array($e, $l)) {
1071 $self->pidl("if (PyUnicode_Check($py_var)) {");
1072 $self->indent;
1073 # FIXME: Use Unix charset setting rather than utf-8
1074 $self->pidl($var_name . " = PyString_AS_STRING(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
1075 $self->deindent;
1076 $self->pidl("} else if (PyString_Check($py_var)) {");
1077 $self->indent;
1078 $self->pidl($var_name . " = PyString_AS_STRING($py_var);");
1079 $self->deindent;
1080 $self->pidl("} else {");
1081 $self->indent;
1082 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1083 $self->pidl("$fail");
1084 $self->deindent;
1085 $self->pidl("}");
1086 } else {
1087 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1088 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1089 $self->pidl("{");
1090 $self->indent;
1091 $self->pidl("int $counter;");
1092 if (ArrayDynamicallyAllocated($e, $l)) {
1093 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1094 $self->pidl("if (!$var_name) { $fail; }");
1095 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1097 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1098 $self->indent;
1099 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
1100 $self->deindent;
1101 $self->pidl("}");
1102 $self->deindent;
1103 $self->pidl("}");
1105 } elsif ($l->{TYPE} eq "DATA") {
1106 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1107 $var_name = get_pointer_to($var_name);
1109 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1110 } elsif ($l->{TYPE} eq "SWITCH") {
1111 $var_name = get_pointer_to($var_name);
1112 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1113 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1114 $self->pidl("{");
1115 $self->indent;
1116 my $union_type = mapTypeName($nl->{DATA_TYPE});
1117 $self->pidl("$union_type *$switch_ptr;");
1118 $self->pidl("$switch_ptr = py_export_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1119 $self->fail_on_null($switch_ptr, $fail);
1120 $self->assign($var_name, "$switch_ptr");
1121 $self->deindent;
1122 $self->pidl("}");
1123 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1124 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1125 } else {
1126 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1130 sub ConvertObjectFromPython($$$$$$$)
1132 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1134 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1137 sub ConvertScalarToPython($$$)
1139 my ($self, $ctypename, $cvar) = @_;
1141 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1143 $ctypename = expandAlias($ctypename);
1145 if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1146 return "PyLong_FromLongLong($cvar)";
1149 if ($ctypename =~ /^(char|u?int[0-9]*|time_t|uid_t|gid_t)$/) {
1150 return "PyInt_FromLong($cvar)";
1153 if ($ctypename eq "DATA_BLOB") {
1154 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1157 if ($ctypename eq "NTSTATUS") {
1158 return "PyErr_FromNTSTATUS($cvar)";
1161 if ($ctypename eq "WERROR") {
1162 return "PyErr_FromWERROR($cvar)";
1165 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1166 return "PyString_FromStringOrNULL($cvar)";
1169 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1170 return "PyString_FromStringOrNULL($cvar)";
1173 # Not yet supported
1174 if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
1175 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
1176 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
1177 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
1178 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
1179 if ($ctypename eq "pointer") {
1180 return "pytalloc_CObject_FromTallocPtr($cvar)";
1183 die("Unknown scalar type $ctypename");
1186 sub ConvertObjectToPythonData($$$$$;$)
1188 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1190 die("undef type for $cvar") unless(defined($ctype));
1192 $ctype = resolveType($ctype);
1194 my $actual_ctype = $ctype;
1195 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1196 $actual_ctype = $actual_ctype->{DATA};
1199 if ($actual_ctype->{TYPE} eq "ENUM") {
1200 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1201 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1202 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1203 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1204 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1205 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1206 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1207 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1208 my $ctype_name = $self->use_type_variable($ctype);
1209 unless (defined($ctype_name)) {
1210 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1211 return "NULL"; # FIXME!
1213 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1216 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1219 sub fail_on_null($$$)
1221 my ($self, $var, $fail) = @_;
1222 $self->pidl("if ($var == NULL) {");
1223 $self->indent;
1224 $self->pidl($fail);
1225 $self->deindent;
1226 $self->pidl("}");
1229 sub ConvertObjectToPythonLevel($$$$$$)
1231 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1232 my $nl = GetNextLevel($e, $l);
1233 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1234 $nl = GetNextLevel($e, $nl);
1236 my $pl = GetPrevLevel($e, $l);
1237 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1238 $pl = GetPrevLevel($e, $pl);
1241 if ($l->{TYPE} eq "POINTER") {
1242 if ($l->{POINTER_TYPE} ne "ref") {
1243 $self->pidl("if ($var_name == NULL) {");
1244 $self->indent;
1245 $self->pidl("$py_var = Py_None;");
1246 $self->pidl("Py_INCREF($py_var);");
1247 $self->deindent;
1248 $self->pidl("} else {");
1249 $self->indent;
1251 my $var_name2 = $var_name;
1252 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1253 $var_name2 = get_value_of($var_name);
1255 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
1256 if ($l->{POINTER_TYPE} ne "ref") {
1257 $self->deindent;
1258 $self->pidl("}");
1260 } elsif ($l->{TYPE} eq "ARRAY") {
1261 if ($pl && $pl->{TYPE} eq "POINTER") {
1262 $var_name = get_pointer_to($var_name);
1265 if (is_charset_array($e, $l)) {
1266 # FIXME: Use Unix charset setting rather than utf-8
1267 $self->pidl("if ($var_name == NULL) {");
1268 $self->indent;
1269 $self->pidl("$py_var = Py_None;");
1270 $self->pidl("Py_INCREF($py_var);");
1271 $self->deindent;
1272 $self->pidl("} else {");
1273 $self->indent;
1274 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1275 $self->deindent;
1276 $self->pidl("}");
1277 } else {
1278 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1279 my $length = $l->{SIZE_IS};
1280 if (defined($l->{LENGTH_IS})) {
1281 $length = $l->{LENGTH_IS};
1284 $length = ParseExpr($length, $env, $e);
1285 $self->pidl("$py_var = PyList_New($length);");
1286 $self->fail_on_null($py_var, $fail);
1287 $self->pidl("{");
1288 $self->indent;
1289 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1290 $self->pidl("int $counter;");
1291 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1292 $self->indent;
1293 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1294 $self->pidl("PyObject *$member_var;");
1295 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
1296 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1297 $self->deindent;
1298 $self->pidl("}");
1299 $self->deindent;
1300 $self->pidl("}");
1302 } elsif ($l->{TYPE} eq "SWITCH") {
1303 $var_name = get_pointer_to($var_name);
1304 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1305 $self->pidl("$py_var = py_import_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1306 $self->fail_on_null($py_var, $fail);
1308 } elsif ($l->{TYPE} eq "DATA") {
1309 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1310 $var_name = get_pointer_to($var_name);
1312 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1313 $self->pidl("$py_var = $conv;");
1314 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1315 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
1316 } else {
1317 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1321 sub ConvertObjectToPython($$$$$$)
1323 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1325 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1328 sub Parse($$$$$)
1330 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1332 $self->{BASENAME} = $basename;
1334 $self->pidl_hdr("
1335 /* Python wrapper functions auto-generated by pidl */
1336 #include <Python.h>
1337 #include \"includes.h\"
1338 #include <pytalloc.h>
1339 #include \"librpc/rpc/pyrpc.h\"
1340 #include \"librpc/rpc/pyrpc_util.h\"
1341 #include \"$hdr\"
1342 #include \"$ndr_hdr\"
1346 foreach my $x (@$ndr) {
1347 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1348 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1351 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1352 $self->indent;
1353 foreach (@{$self->{module_methods}}) {
1354 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1355 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1358 $self->pidl("{ NULL, NULL, 0, NULL }");
1359 $self->deindent;
1360 $self->pidl("};");
1362 $self->pidl("");
1364 $self->pidl_hdr("void init$basename(void);");
1365 $self->pidl("void init$basename(void)");
1366 $self->pidl("{");
1367 $self->indent;
1368 $self->pidl("PyObject *m;");
1369 foreach (keys %{$self->{module_imports}}) {
1370 $self->pidl("PyObject *$_;");
1372 $self->pidl("");
1374 foreach (keys %{$self->{module_imports}}) {
1375 my $var_name = $_;
1376 my $module_path = $self->{module_imports}->{$var_name};
1377 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
1378 $self->pidl("if ($var_name == NULL)");
1379 $self->pidl("\treturn;");
1380 $self->pidl("");
1383 foreach (keys %{$self->{type_imports}}) {
1384 my $type_var = "$_\_Type";
1385 my $module_path = $self->{type_imports}->{$_};
1386 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
1387 my $pretty_name = PrettifyTypeName($_, $module_path);
1388 my $module_var = "dep_$module_path";
1389 $module_var =~ s/\./_/g;
1390 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
1391 $self->pidl("if ($type_var == NULL)");
1392 $self->pidl("\treturn;");
1393 $self->pidl("");
1396 $self->pidl($_) foreach (@{$self->{prereadycode}});
1398 foreach (@{$self->{ready_types}}) {
1399 $self->pidl("if (PyType_Ready($_) < 0)");
1400 $self->pidl("\treturn;");
1403 $self->pidl($_) foreach (@{$self->{postreadycode}});
1405 foreach (@{$self->{patch_type_calls}}) {
1406 my ($typename, $cvar) = @$_;
1407 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1408 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1409 $self->pidl("#endif");
1412 $self->pidl("");
1414 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1415 $self->pidl("if (m == NULL)");
1416 $self->pidl("\treturn;");
1417 $self->pidl("");
1418 foreach my $name (keys %{$self->{constants}}) {
1419 my $py_obj;
1420 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1421 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1422 $py_obj = "PyInt_FromLong($cvar)";
1423 } elsif ($cvar =~ /^".*"$/) {
1424 $py_obj = "PyString_FromString($cvar)";
1425 } else {
1426 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1429 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1432 foreach (@{$self->{module_objects}}) {
1433 my ($object_name, $c_name) = @$_;
1434 $self->pidl("Py_INCREF($c_name);");
1435 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1438 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1439 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1440 $self->pidl("#endif");
1442 $self->pidl("");
1443 $self->deindent;
1444 $self->pidl("}");
1445 return ($self->{res_hdr} . $self->{res});