pytalloc: Use consistent prefix for functions, add ABI file.
[Samba/gebeck_regimport.git] / pidl / lib / Parse / Pidl / Samba4 / Python.pm
blob63f4b2baefdfe53f22da981457efbe5bd409ff06
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)");
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("if (!PyArg_ParseTuple(args, \"s#:__ndr_unpack__\", &blob.data, &blob_length)) {");
282 $self->indent;
283 $self->pidl("return NULL;");
284 $self->deindent;
285 $self->pidl("}");
286 $self->pidl("blob.length = blob_length;");
287 $self->pidl("");
288 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
289 $self->pidl("if (err != NDR_ERR_SUCCESS) {");
290 $self->indent;
291 $self->pidl("PyErr_SetNdrError(err);");
292 $self->pidl("return NULL;");
293 $self->deindent;
294 $self->pidl("}");
295 $self->pidl("");
296 $self->pidl("Py_RETURN_NONE;");
297 $self->deindent;
298 $self->pidl("}");
299 $self->pidl("");
301 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
302 $self->pidl("{");
303 $self->indent;
304 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
305 $self->pidl("PyObject *ret;");
306 $self->pidl("char *retstr;");
307 $self->pidl("");
308 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
309 $self->pidl("ret = PyString_FromString(retstr);");
310 $self->pidl("talloc_free(retstr);");
311 $self->pidl("");
312 $self->pidl("return ret;");
313 $self->deindent;
314 $self->pidl("}");
315 $self->pidl("");
317 $py_methods = "py_$name\_methods";
318 $self->pidl("static PyMethodDef $py_methods\[] = {");
319 $self->indent;
320 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
321 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS, \"S.ndr_unpack(class, blob) -> None\\nNDR unpack\" },");
322 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_VARARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
323 $self->pidl("{ NULL, NULL, 0, NULL }");
324 $self->deindent;
325 $self->pidl("};");
326 $self->pidl("");
329 $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
330 $self->pidl("");
331 my $docstring = $self->DocString($d, $name);
332 my $typeobject = "$name\_Type";
333 $self->pidl("static PyTypeObject $typeobject = {");
334 $self->indent;
335 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
336 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
337 $self->pidl(".tp_getset = $getsetters,");
338 if ($docstring) {
339 $self->pidl(".tp_doc = $docstring,");
341 $self->pidl(".tp_methods = $py_methods,");
342 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
343 $self->pidl(".tp_basicsize = sizeof(pytalloc_Object),");
344 $self->pidl(".tp_new = py_$name\_new,");
345 $self->deindent;
346 $self->pidl("};");
348 $self->pidl("");
350 my $talloc_typename = $self->import_type_variable("talloc", "Object");
351 $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;", ""]);
353 return "&$typeobject";
356 sub get_metadata_var($)
358 my ($e) = @_;
359 sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
361 if (has_property($e, "length_is")) {
362 return get_var($e->{PROPERTIES}->{length_is});
363 } elsif (has_property($e, "size_is")) {
364 return get_var($e->{PROPERTIES}->{size_is});
367 return undef;
370 sub find_metadata_args($)
372 my ($fn) = @_;
373 my $metadata_args = { in => {}, out => {} };
375 # Determine arguments that are metadata for other arguments (size_is/length_is)
376 foreach my $e (@{$fn->{ELEMENTS}}) {
377 foreach my $dir (@{$e->{DIRECTION}}) {
378 my $main = get_metadata_var($e);
379 if ($main) {
380 $metadata_args->{$dir}->{$main} = $e->{NAME};
385 return $metadata_args;
388 sub PythonFunctionUnpackOut($$$)
390 my ($self, $fn, $fnname) = @_;
392 my $outfnname = "unpack_$fnname\_args_out";
393 my $signature = "";
395 my $metadata_args = find_metadata_args($fn);
397 my $env = GenerateFunctionOutEnv($fn, "r->");
398 my $result_size = 0;
400 $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
401 $self->pidl("{");
402 $self->indent;
403 $self->pidl("PyObject *result;");
404 foreach my $e (@{$fn->{ELEMENTS}}) {
405 next unless (grep(/out/,@{$e->{DIRECTION}}));
406 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
407 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
408 $self->pidl("PyObject *py_$e->{NAME};");
409 $result_size++;
412 if ($fn->{RETURN_TYPE}) {
413 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
416 my $i = 0;
418 if ($result_size > 1) {
419 $self->pidl("result = PyTuple_New($result_size);");
420 $signature .= "(";
421 } elsif ($result_size == 0) {
422 $self->pidl("result = Py_None;");
423 $self->pidl("Py_INCREF(result);");
424 $signature .= "None";
427 foreach my $e (@{$fn->{ELEMENTS}}) {
428 next if ($metadata_args->{out}->{$e->{NAME}});
429 my $py_name = "py_$e->{NAME}";
430 if (grep(/out/,@{$e->{DIRECTION}})) {
431 $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
432 if ($result_size > 1) {
433 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
434 $i++;
435 $signature .= "$e->{NAME}, ";
436 } else {
437 $self->pidl("result = $py_name;");
438 $signature .= $e->{NAME};
443 if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
444 $self->handle_ntstatus("r->out.result", "NULL", undef);
445 } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
446 $self->handle_werror("r->out.result", "NULL", undef);
447 } elsif (defined($fn->{RETURN_TYPE})) {
448 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
449 if ($result_size > 1) {
450 $self->pidl("PyTuple_SetItem(result, $i, $conv);");
451 } else {
452 $self->pidl("result = $conv;");
454 $signature .= "result";
457 if (substr($signature, -2) eq ", ") {
458 $signature = substr($signature, 0, -2);
460 if ($result_size > 1) {
461 $signature .= ")";
464 $self->pidl("return result;");
465 $self->deindent;
466 $self->pidl("}");
467 $self->pidl("");
469 return ($outfnname, $signature);
472 sub PythonFunctionPackIn($$$)
474 my ($self, $fn, $fnname) = @_;
475 my $metadata_args = find_metadata_args($fn);
477 my $infnname = "pack_$fnname\_args_in";
479 $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
480 $self->pidl("{");
481 $self->indent;
482 my $args_format = "";
483 my $args_string = "";
484 my $args_names = "";
485 my $signature = "";
487 foreach my $e (@{$fn->{ELEMENTS}}) {
488 next unless (grep(/in/,@{$e->{DIRECTION}}));
489 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
490 ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
491 $self->pidl("PyObject *py_$e->{NAME};");
492 $args_format .= "O";
493 $args_string .= ", &py_$e->{NAME}";
494 $args_names .= "\"$e->{NAME}\", ";
495 $signature .= "$e->{NAME}, ";
497 if (substr($signature, -2) eq ", ") {
498 $signature = substr($signature, 0, -2);
500 $self->pidl("const char *kwnames[] = {");
501 $self->indent;
502 $self->pidl($args_names . "NULL");
503 $self->deindent;
504 $self->pidl("};");
506 $self->pidl("");
507 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
508 $self->indent;
509 $self->pidl("return false;");
510 $self->deindent;
511 $self->pidl("}");
512 $self->pidl("");
514 my $env = GenerateFunctionInEnv($fn, "r->");
516 my $fail = "return false;";
517 foreach my $e (@{$fn->{ELEMENTS}}) {
518 next unless (grep(/in/,@{$e->{DIRECTION}}));
519 if ($metadata_args->{in}->{$e->{NAME}}) {
520 my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
521 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
522 my $val = "PyList_GET_SIZE($py_var)";
523 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
524 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
525 $self->pidl("*r->in.$e->{NAME} = $val;");
526 } else {
527 $self->pidl("r->in.$e->{NAME} = $val;");
529 } else {
530 $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
533 $self->pidl("return true;");
534 $self->deindent;
535 $self->pidl("}");
536 $self->pidl("");
537 return ($infnname, $signature);
540 sub PythonFunction($$$)
542 my ($self, $fn, $iface, $prettyname) = @_;
544 my $fnname = "py_$fn->{NAME}";
545 my $docstring = $self->DocString($fn, $fn->{NAME});
547 my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
548 my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
549 my $signature = "S.$prettyname($insignature) -> $outsignature";
550 if ($docstring) {
551 $docstring = "\"$signature\\n\\n\"$docstring";
552 } else {
553 $docstring = "\"$signature\"";
556 return ($infn, $outfn, $docstring);
559 sub handle_werror($$$$)
561 my ($self, $var, $retval, $mem_ctx) = @_;
563 $self->pidl("if (!W_ERROR_IS_OK($var)) {");
564 $self->indent;
565 $self->pidl("PyErr_SetWERROR($var);");
566 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
567 $self->pidl("return $retval;");
568 $self->deindent;
569 $self->pidl("}");
570 $self->pidl("");
573 sub handle_ntstatus($$$$)
575 my ($self, $var, $retval, $mem_ctx) = @_;
577 $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
578 $self->indent;
579 $self->pidl("PyErr_SetNTSTATUS($var);");
580 $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
581 $self->pidl("return $retval;");
582 $self->deindent;
583 $self->pidl("}");
584 $self->pidl("");
587 sub PythonType($$$$)
589 my ($self, $modulename, $d, $interface, $basename) = @_;
591 my $actual_ctype = $d;
592 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
593 $actual_ctype = $actual_ctype->{DATA};
596 if ($actual_ctype->{TYPE} eq "STRUCT") {
597 my $typeobject;
598 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
600 if ($d->{TYPE} eq "STRUCT") {
601 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
602 } else {
603 $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
606 $self->register_module_typeobject($fn_name, $typeobject);
609 if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
610 $self->EnumAndBitmapConsts($d->{NAME}, $d);
613 if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
614 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
617 if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
618 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
619 $self->pidl("{");
620 $self->indent;
621 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
622 $self->deindent;
623 $self->pidl("}");
624 $self->pidl("");
626 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
627 $self->pidl("{");
628 $self->indent;
629 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
630 $self->deindent;
631 $self->pidl("}");
632 $self->pidl("");
636 sub DocString($$$)
638 my ($self, $d, $name) = @_;
639 if (has_property($d, "helpstring")) {
640 my $docstring = uc("py_doc_$name");
641 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
642 return $docstring;
645 return undef;
648 sub Interface($$$)
650 my($self,$interface,$basename) = @_;
652 if (has_property($interface, "pyhelper")) {
653 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
656 $self->Const($_) foreach (@{$interface->{CONSTS}});
658 foreach my $d (@{$interface->{TYPES}}) {
659 next if has_property($d, "nopython");
661 $self->PythonType($basename, $d, $interface, $basename);
664 if (defined $interface->{PROPERTIES}->{uuid}) {
665 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
666 $self->pidl("");
668 my @fns = ();
670 foreach my $d (@{$interface->{FUNCTIONS}}) {
671 next if has_property($d, "noopnum");
672 next if has_property($d, "nopython");
673 next if has_property($d, "todo");
675 my $skip = 0;
676 foreach my $e (@{$d->{ELEMENTS}}) {
677 if (ContainsPipe($e, $e->{LEVELS}[0])) {
678 $skip = 1;
679 last;
682 next if $skip;
684 my $prettyname = $d->{NAME};
686 $prettyname =~ s/^$interface->{NAME}_//;
687 $prettyname =~ s/^$basename\_//;
689 my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
691 push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
694 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
695 $self->indent;
696 foreach my $d (@fns) {
697 my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
698 $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
700 $self->pidl("{ NULL }");
701 $self->deindent;
702 $self->pidl("};");
703 $self->pidl("");
705 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
706 $self->pidl("{");
707 $self->indent;
708 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
709 $self->deindent;
710 $self->pidl("}");
712 $self->pidl("");
714 my $signature =
715 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
716 \"\\n\"
717 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
718 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
719 \"credentials should be a credentials.Credentials object.\\n\\n\"";
721 my $docstring = $self->DocString($interface, $interface->{NAME});
723 if ($docstring) {
724 $docstring = "$signature$docstring";
725 } else {
726 $docstring = $signature;
729 my $if_typename = "$interface->{NAME}_InterfaceType";
731 $self->pidl("static PyTypeObject $if_typename = {");
732 $self->indent;
733 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
734 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
735 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
736 $self->pidl(".tp_doc = $docstring,");
737 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
738 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
739 $self->deindent;
740 $self->pidl("};");
742 $self->pidl("");
744 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
745 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
746 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
747 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
750 $self->pidl_hdr("\n");
753 sub register_module_method($$$$$)
755 my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
757 push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
760 sub register_module_typeobject($$$)
762 my ($self, $name, $py_name) = @_;
764 $self->register_module_object($name, "(PyObject *)(void *)$py_name");
766 $self->check_ready_type($py_name);
768 $self->register_patch_type_call($name, $py_name);
771 sub check_ready_type($$)
773 my ($self, $py_name) = @_;
774 push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
777 sub register_module_import($$)
779 my ($self, $module_path) = @_;
781 my $var_name = $module_path;
782 $var_name =~ s/\./_/g;
783 $var_name = "dep_$var_name";
785 $self->{module_imports}->{$var_name} = $module_path;
787 return $var_name;
790 sub import_type_variable($$$)
792 my ($self, $module, $name) = @_;
794 $self->register_module_import($module);
795 unless (defined($self->{type_imports}->{$name})) {
796 $self->{type_imports}->{$name} = $module;
798 return "$name\_Type";
801 sub use_type_variable($$)
803 my ($self, $orig_ctype) = @_;
804 # FIXME: Have a global lookup table for types that look different on the
805 # wire than they are named in C?
806 if ($orig_ctype->{NAME} eq "dom_sid2" or $orig_ctype->{NAME} eq "dom_sid28") {
807 $orig_ctype->{NAME} = "dom_sid";
809 my $ctype = resolveType($orig_ctype);
810 unless (defined($ctype->{BASEFILE})) {
811 return undef;
813 # If this is an external type, make sure we do the right imports.
814 if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
815 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
817 return "&$ctype->{NAME}_Type";
820 sub register_patch_type_call($$$)
822 my ($self, $typename, $cvar) = @_;
824 push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
828 sub register_module_prereadycode($$)
830 my ($self, $code) = @_;
832 push (@{$self->{prereadycode}}, @$code);
835 sub register_module_postreadycode($$)
837 my ($self, $code) = @_;
839 push (@{$self->{postreadycode}}, @$code);
842 sub register_module_object($$$)
844 my ($self, $name, $py_name) = @_;
846 push (@{$self->{module_objects}}, [$name, $py_name])
849 sub assign($$$)
851 my ($self, $dest, $src) = @_;
852 if ($dest =~ /^\&/ and $src eq "NULL") {
853 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
854 } elsif ($dest =~ /^\&/) {
855 my $destvar = get_value_of($dest);
856 $self->pidl("$destvar = *$src;");
857 } else {
858 $self->pidl("$dest = $src;");
862 sub ConvertObjectFromPythonData($$$$$$;$)
864 my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
866 fatal($location, "undef type for $cvar") unless(defined($ctype));
868 $ctype = resolveType($ctype);
870 my $actual_ctype = $ctype;
871 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
872 $actual_ctype = $actual_ctype->{DATA};
875 if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
876 $self->pidl("if (PyLong_Check($cvar)) {");
877 $self->indent;
878 $self->pidl("$target = PyLong_AsLongLong($cvar);");
879 $self->deindent;
880 $self->pidl("} else if (PyInt_Check($cvar)) {");
881 $self->indent;
882 $self->pidl("$target = PyInt_AsLong($cvar);");
883 $self->deindent;
884 $self->pidl("} else {");
885 $self->indent;
886 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
887 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
888 $self->pidl($fail);
889 $self->deindent;
890 $self->pidl("}");
891 return;
893 if ($actual_ctype->{TYPE} eq "SCALAR" ) {
894 if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
895 $self->pidl("if (PyLong_Check($cvar)) {");
896 $self->indent;
897 $self->pidl("$target = PyLong_AsLongLong($cvar);");
898 $self->deindent;
899 $self->pidl("} else if (PyInt_Check($cvar)) {");
900 $self->indent;
901 $self->pidl("$target = PyInt_AsLong($cvar);");
902 $self->deindent;
903 $self->pidl("} else {");
904 $self->indent;
905 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
906 $self->pidl(" PyInt_Type.tp_name, PyLong_Type.tp_name);");
907 $self->pidl($fail);
908 $self->deindent;
909 $self->pidl("}");
910 return;
912 if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t|uid_t|gid_t)$/) {
913 $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
914 $self->pidl("$target = PyInt_AsLong($cvar);");
915 return;
919 if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
920 my $ctype_name = $self->use_type_variable($ctype);
921 unless (defined ($ctype_name)) {
922 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
923 $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
924 return;
926 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
927 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
928 $self->indent;
929 $self->pidl("PyErr_NoMemory();");
930 $self->pidl("$fail");
931 $self->deindent;
932 $self->pidl("}");
933 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
934 return;
937 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
938 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
939 return;
942 if ($actual_ctype->{TYPE} eq "SCALAR" and
943 ($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")) {
944 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
945 return;
948 if ($actual_ctype->{TYPE} eq "SCALAR" and ($actual_ctype->{NAME} eq "dns_string" or $actual_ctype->{NAME} eq "dns_name")) {
949 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
950 return;
953 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
954 $self->pidl("$target = PyString_AS_STRING($cvar);");
955 return;
958 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv6address") {
959 $self->pidl("$target = PyString_AsString($cvar);");
960 return;
963 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
964 $self->pidl("$target = PyString_AS_STRING($cvar);");
965 return;
968 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_string") {
969 $self->pidl("$target = PyString_AS_STRING($cvar);");
970 return;
973 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
974 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
975 return;
978 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
979 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
980 return;
983 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
984 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
985 return;
988 if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
989 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
990 return;
993 fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
997 sub ConvertObjectFromPythonLevel($$$$$$$$)
999 my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1000 my $nl = GetNextLevel($e, $l);
1001 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1002 $nl = GetNextLevel($e, $nl);
1004 my $pl = GetPrevLevel($e, $l);
1005 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1006 $pl = GetPrevLevel($e, $pl);
1009 if ($l->{TYPE} eq "POINTER") {
1010 if ($l->{POINTER_TYPE} ne "ref") {
1011 $self->pidl("if ($py_var == Py_None) {");
1012 $self->indent;
1013 $self->pidl("$var_name = NULL;");
1014 $self->deindent;
1015 $self->pidl("} else {");
1016 $self->indent;
1018 # if we want to handle more than one level of pointer in python interfaces
1019 # then this is where we would need to allocate it
1020 if ($l->{POINTER_TYPE} eq "ref") {
1021 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1022 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1023 and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1024 $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1025 } else {
1026 $self->pidl("$var_name = NULL;");
1028 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1029 $var_name = get_value_of($var_name);
1031 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1032 if ($l->{POINTER_TYPE} ne "ref") {
1033 $self->deindent;
1034 $self->pidl("}");
1036 } elsif ($l->{TYPE} eq "ARRAY") {
1037 if ($pl && $pl->{TYPE} eq "POINTER") {
1038 $var_name = get_pointer_to($var_name);
1041 if (is_charset_array($e, $l)) {
1042 $self->pidl("if (PyUnicode_Check($py_var)) {");
1043 $self->indent;
1044 # FIXME: Use Unix charset setting rather than utf-8
1045 $self->pidl($var_name . " = PyString_AS_STRING(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
1046 $self->deindent;
1047 $self->pidl("} else if (PyString_Check($py_var)) {");
1048 $self->indent;
1049 $self->pidl($var_name . " = PyString_AS_STRING($py_var);");
1050 $self->deindent;
1051 $self->pidl("} else {");
1052 $self->indent;
1053 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1054 $self->pidl("$fail");
1055 $self->deindent;
1056 $self->pidl("}");
1057 } else {
1058 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1059 $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1060 $self->pidl("{");
1061 $self->indent;
1062 $self->pidl("int $counter;");
1063 if (ArrayDynamicallyAllocated($e, $l)) {
1064 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1065 $self->pidl("if (!$var_name) { $fail; }");
1066 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1068 $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1069 $self->indent;
1070 $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
1071 $self->deindent;
1072 $self->pidl("}");
1073 $self->deindent;
1074 $self->pidl("}");
1076 } elsif ($l->{TYPE} eq "DATA") {
1077 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1078 $var_name = get_pointer_to($var_name);
1080 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1081 } elsif ($l->{TYPE} eq "SWITCH") {
1082 $var_name = get_pointer_to($var_name);
1083 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1084 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1085 $self->pidl("{");
1086 $self->indent;
1087 my $union_type = mapTypeName($nl->{DATA_TYPE});
1088 $self->pidl("$union_type *$switch_ptr;");
1089 $self->pidl("$switch_ptr = py_export_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1090 $self->fail_on_null($switch_ptr, $fail);
1091 $self->assign($var_name, "$switch_ptr");
1092 $self->deindent;
1093 $self->pidl("}");
1094 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1095 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1096 } else {
1097 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1101 sub ConvertObjectFromPython($$$$$$$)
1103 my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1105 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1108 sub ConvertScalarToPython($$$)
1110 my ($self, $ctypename, $cvar) = @_;
1112 die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1114 $ctypename = expandAlias($ctypename);
1116 if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1117 return "PyLong_FromLongLong($cvar)";
1120 if ($ctypename =~ /^(char|u?int[0-9]*|time_t|uid_t|gid_t)$/) {
1121 return "PyInt_FromLong($cvar)";
1124 if ($ctypename eq "DATA_BLOB") {
1125 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1128 if ($ctypename eq "NTSTATUS") {
1129 return "PyErr_FromNTSTATUS($cvar)";
1132 if ($ctypename eq "WERROR") {
1133 return "PyErr_FromWERROR($cvar)";
1136 if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1137 return "PyString_FromStringOrNULL($cvar)";
1140 if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1141 return "PyString_FromStringOrNULL($cvar)";
1144 # Not yet supported
1145 if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
1146 if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
1147 if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
1148 if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
1149 if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
1150 if ($ctypename eq "pointer") {
1151 return "pytalloc_CObject_FromTallocPtr($cvar)";
1154 die("Unknown scalar type $ctypename");
1157 sub ConvertObjectToPythonData($$$$$;$)
1159 my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1161 die("undef type for $cvar") unless(defined($ctype));
1163 $ctype = resolveType($ctype);
1165 my $actual_ctype = $ctype;
1166 if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1167 $actual_ctype = $actual_ctype->{DATA};
1170 if ($actual_ctype->{TYPE} eq "ENUM") {
1171 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1172 } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1173 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1174 } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1175 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1176 } elsif ($actual_ctype->{TYPE} eq "UNION") {
1177 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1178 } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1179 my $ctype_name = $self->use_type_variable($ctype);
1180 unless (defined($ctype_name)) {
1181 error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1182 return "NULL"; # FIXME!
1184 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1187 fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1190 sub fail_on_null($$$)
1192 my ($self, $var, $fail) = @_;
1193 $self->pidl("if ($var == NULL) {");
1194 $self->indent;
1195 $self->pidl($fail);
1196 $self->deindent;
1197 $self->pidl("}");
1200 sub ConvertObjectToPythonLevel($$$$$$)
1202 my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1203 my $nl = GetNextLevel($e, $l);
1204 if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1205 $nl = GetNextLevel($e, $nl);
1207 my $pl = GetPrevLevel($e, $l);
1208 if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1209 $pl = GetPrevLevel($e, $pl);
1212 if ($l->{TYPE} eq "POINTER") {
1213 if ($l->{POINTER_TYPE} ne "ref") {
1214 $self->pidl("if ($var_name == NULL) {");
1215 $self->indent;
1216 $self->pidl("$py_var = Py_None;");
1217 $self->pidl("Py_INCREF($py_var);");
1218 $self->deindent;
1219 $self->pidl("} else {");
1220 $self->indent;
1222 my $var_name2 = $var_name;
1223 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1224 $var_name2 = get_value_of($var_name);
1226 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
1227 if ($l->{POINTER_TYPE} ne "ref") {
1228 $self->deindent;
1229 $self->pidl("}");
1231 } elsif ($l->{TYPE} eq "ARRAY") {
1232 if ($pl && $pl->{TYPE} eq "POINTER") {
1233 $var_name = get_pointer_to($var_name);
1236 if (is_charset_array($e, $l)) {
1237 # FIXME: Use Unix charset setting rather than utf-8
1238 $self->pidl("if ($var_name == NULL) {");
1239 $self->indent;
1240 $self->pidl("$py_var = Py_None;");
1241 $self->pidl("Py_INCREF($py_var);");
1242 $self->deindent;
1243 $self->pidl("} else {");
1244 $self->indent;
1245 $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1246 $self->deindent;
1247 $self->pidl("}");
1248 } else {
1249 die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1250 my $length = $l->{SIZE_IS};
1251 if (defined($l->{LENGTH_IS})) {
1252 $length = $l->{LENGTH_IS};
1255 $length = ParseExpr($length, $env, $e);
1256 $self->pidl("$py_var = PyList_New($length);");
1257 $self->fail_on_null($py_var, $fail);
1258 $self->pidl("{");
1259 $self->indent;
1260 my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1261 $self->pidl("int $counter;");
1262 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1263 $self->indent;
1264 my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1265 $self->pidl("PyObject *$member_var;");
1266 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
1267 $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1268 $self->deindent;
1269 $self->pidl("}");
1270 $self->deindent;
1271 $self->pidl("}");
1273 } elsif ($l->{TYPE} eq "SWITCH") {
1274 $var_name = get_pointer_to($var_name);
1275 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1276 $self->pidl("$py_var = py_import_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1277 $self->fail_on_null($py_var, $fail);
1279 } elsif ($l->{TYPE} eq "DATA") {
1280 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1281 $var_name = get_pointer_to($var_name);
1283 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1284 $self->pidl("$py_var = $conv;");
1285 } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1286 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
1287 } else {
1288 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1292 sub ConvertObjectToPython($$$$$$)
1294 my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1296 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1299 sub Parse($$$$$)
1301 my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1303 $self->{BASENAME} = $basename;
1305 $self->pidl_hdr("
1306 /* Python wrapper functions auto-generated by pidl */
1307 #include <Python.h>
1308 #include \"includes.h\"
1309 #include <pytalloc.h>
1310 #include \"librpc/rpc/pyrpc.h\"
1311 #include \"librpc/rpc/pyrpc_util.h\"
1312 #include \"$hdr\"
1313 #include \"$ndr_hdr\"
1317 foreach my $x (@$ndr) {
1318 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1319 ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1322 $self->pidl("static PyMethodDef $basename\_methods[] = {");
1323 $self->indent;
1324 foreach (@{$self->{module_methods}}) {
1325 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1326 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1329 $self->pidl("{ NULL, NULL, 0, NULL }");
1330 $self->deindent;
1331 $self->pidl("};");
1333 $self->pidl("");
1335 $self->pidl_hdr("void init$basename(void);");
1336 $self->pidl("void init$basename(void)");
1337 $self->pidl("{");
1338 $self->indent;
1339 $self->pidl("PyObject *m;");
1340 foreach (keys %{$self->{module_imports}}) {
1341 $self->pidl("PyObject *$_;");
1343 $self->pidl("");
1345 foreach (keys %{$self->{module_imports}}) {
1346 my $var_name = $_;
1347 my $module_path = $self->{module_imports}->{$var_name};
1348 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
1349 $self->pidl("if ($var_name == NULL)");
1350 $self->pidl("\treturn;");
1351 $self->pidl("");
1354 foreach (keys %{$self->{type_imports}}) {
1355 my $type_var = "$_\_Type";
1356 my $module_path = $self->{type_imports}->{$_};
1357 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
1358 my $pretty_name = PrettifyTypeName($_, $module_path);
1359 my $module_var = "dep_$module_path";
1360 $module_var =~ s/\./_/g;
1361 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
1362 $self->pidl("if ($type_var == NULL)");
1363 $self->pidl("\treturn;");
1364 $self->pidl("");
1367 $self->pidl($_) foreach (@{$self->{prereadycode}});
1369 foreach (@{$self->{ready_types}}) {
1370 $self->pidl("if (PyType_Ready($_) < 0)");
1371 $self->pidl("\treturn;");
1374 $self->pidl($_) foreach (@{$self->{postreadycode}});
1376 foreach (@{$self->{patch_type_calls}}) {
1377 my ($typename, $cvar) = @$_;
1378 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1379 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1380 $self->pidl("#endif");
1383 $self->pidl("");
1385 $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1386 $self->pidl("if (m == NULL)");
1387 $self->pidl("\treturn;");
1388 $self->pidl("");
1389 foreach my $name (keys %{$self->{constants}}) {
1390 my $py_obj;
1391 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1392 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1393 $py_obj = "PyInt_FromLong($cvar)";
1394 } elsif ($cvar =~ /^".*"$/) {
1395 $py_obj = "PyString_FromString($cvar)";
1396 } else {
1397 $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1400 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1403 foreach (@{$self->{module_objects}}) {
1404 my ($object_name, $c_name) = @$_;
1405 $self->pidl("Py_INCREF($c_name);");
1406 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1409 $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1410 $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1411 $self->pidl("#endif");
1413 $self->pidl("");
1414 $self->deindent;
1415 $self->pidl("}");
1416 return ($self->{res_hdr} . $self->{res});