pidl/lib/Parse/Pidl/Samba4/Python.pm

   1 ###################################################
   2 # Python function wrapper generator
   3 # Copyright jelmer@samba.org 2007-2008
   4 # released under the GNU GPL
   5
   6 package Parse::Pidl::Samba4::Python;
   7
   8 use Exporter;
   9 @ISA = qw(Exporter);
  10
  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 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);
  19
  20 use vars qw($VERSION);
  21 $VERSION = '0.01';
  22
  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);
  31 }
  32
  33 sub pidl_hdr ($$)
  34 {
  35         my $self = shift;
  36         $self->{res_hdr} .= shift;
  37 }
  38
  39 sub pidl($$)
  40 {
  41         my ($self, $d) = @_;
  42         if ($d) {
  43                 if ((!($d =~ /^#/))) {
  44                         $self->{res} .= $self->{tabs};
  45                 }
  46                 $self->{res} .= $d;
  47         }
  48         $self->{res} .= "\n";
  49 }
  50
  51 sub indent($)
  52 {
  53         my ($self) = @_;
  54         $self->{tabs} .= "\t";
  55 }
  56
  57 sub deindent($)
  58 {
  59         my ($self) = @_;
  60         $self->{tabs} = substr($self->{tabs}, 0, -1);
  61 }
  62
  63 sub PrettifyTypeName($$)
  64 {
  65         my ($name, $basename) = @_;
  66
  67         $name =~ s/^$basename\_//;
  68
  69         return $name;
  70 }
  71
  72 sub Import
  73 {
  74         my $self = shift;
  75         my @imports = @_;
  76         foreach (@imports) {
  77                 $_ = unmake_str($_);
  78                 s/\.idl$//;
  79                 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
  80                 $self->register_module_import($_);
  81         }
  82 }
  83
  84 sub Const($$)
  85 {
  86     my ($self, $const) = @_;
  87         $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
  88 }
  89
  90 sub register_constant($$$$)
  91 {
  92         my ($self, $name, $type, $value) = @_;
  93
  94         $self->{constants}->{$name} = [$type, $value];
  95 }
  96
  97 sub EnumAndBitmapConsts($$$)
  98 {
  99         my ($self, $name, $d) = @_;
 100
 101         return unless (defined($d->{ELEMENTS}));
 102
 103         foreach my $e (@{$d->{ELEMENTS}}) {
 104                 $e =~ /^([A-Za-z0-9_]+)/;
 105                 my $cname = $1;
 106
 107                 $self->register_constant($cname, $d, $cname);
 108         }
 109 }
 110
 111 sub FromUnionToPythonFunction($$$$)
 112 {
 113         my ($self, $mem_ctx, $type, $switch, $name) = @_;
 114
 115         $self->pidl("PyObject *ret;");
 116         $self->pidl("");
 117
 118         $self->pidl("switch ($switch) {");
 119         $self->indent;
 120
 121         foreach my $e (@{$type->{ELEMENTS}}) {
 122                 $self->pidl("$e->{CASE}:");
 123
 124                 $self->indent;
 125
 126                 if ($e->{NAME}) {
 127                         $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
 128                 } else {
 129                         $self->pidl("ret = Py_None;");
 130                         $self->pidl("Py_INCREF(ret);");
 131                 }
 132
 133                 $self->pidl("return ret;");
 134                 $self->pidl("");
 135
 136                 $self->deindent;
 137         }
 138
 139         $self->deindent;
 140         $self->pidl("}");
 141
 142         $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
 143         $self->pidl("return NULL;");
 144 }
 145
 146 sub FromPythonToUnionFunction($$$$$)
 147 {
 148         my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
 149
 150         my $has_default = 0;
 151
 152         $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
 153
 154         $self->pidl("switch ($switch) {");
 155         $self->indent;
 156
 157         foreach my $e (@{$type->{ELEMENTS}}) {
 158                 $self->pidl("$e->{CASE}:");
 159                 if ($e->{CASE} eq "default") { $has_default = 1; }
 160                 $self->indent;
 161                 if ($e->{NAME}) {
 162                         $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
 163                 }
 164                 $self->pidl("break;");
 165                 $self->deindent;
 166                 $self->pidl("");
 167         }
 168
 169         if (!$has_default) {
 170                 $self->pidl("default:");
 171                 $self->indent;
 172                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
 173                 $self->pidl("talloc_free(ret);");
 174                 $self->pidl("ret = NULL;");
 175                 $self->deindent;
 176         }
 177
 178         $self->deindent;
 179         $self->pidl("}");
 180         $self->pidl("");
 181         $self->pidl("return ret;");
 182 }
 183
 184 sub PythonStruct($$$$$$)
 185 {
 186         my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
 187
 188         my $env = GenerateStructEnv($d, "object");
 189
 190         $self->pidl("");
 191
 192         my $getsetters = "NULL";
 193
 194         if ($#{$d->{ELEMENTS}} > -1) {
 195                 foreach my $e (@{$d->{ELEMENTS}}) {
 196                         my $varname = "object->$e->{NAME}";
 197                         $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
 198                         $self->pidl("{");
 199                         $self->indent;
 200                         $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(obj);");
 201                         $self->pidl("PyObject *py_$e->{NAME};");
 202                         $self->ConvertObjectToPython("py_talloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
 203                         $self->pidl("return py_$e->{NAME};");
 204                         $self->deindent;
 205                         $self->pidl("}");
 206                         $self->pidl("");
 207
 208                         $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
 209                         $self->pidl("{");
 210                         $self->indent;
 211                         $self->pidl("$cname *object = ($cname *)py_talloc_get_ptr(py_obj);");
 212                         my $mem_ctx = "py_talloc_get_mem_ctx(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);");
 219                         }
 220                         $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
 221                         $self->pidl("return 0;");
 222                         $self->deindent;
 223                         $self->pidl("}");
 224                         $self->pidl("");
 225                 }
 226
 227                 $getsetters = "py_$name\_getsetters";
 228                 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
 229                 $self->indent;
 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} },");
 232                 }
 233                 $self->pidl("{ NULL }");
 234                 $self->deindent;
 235                 $self->pidl("};");
 236                 $self->pidl("");
 237         }
 238
 239         $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 240         $self->pidl("{");
 241         $self->indent;
 242         $self->pidl("return py_talloc_new($cname, type);");
 243         $self->deindent;
 244         $self->pidl("}");
 245         $self->pidl("");
 246
 247         my $py_methods = "NULL";
 248
 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)");
 253                 $self->pidl("{");
 254                 $self->indent;
 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) {");
 260                 $self->indent;
 261                 $self->pidl("PyErr_SetNdrError(err);");
 262                 $self->pidl("return NULL;");
 263                 $self->deindent;
 264                 $self->pidl("}");
 265                 $self->pidl("");
 266                 $self->pidl("return PyString_FromStringAndSize((char *)blob.data, blob.length);");
 267                 $self->deindent;
 268                 $self->pidl("}");
 269                 $self->pidl("");
 270
 271                 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args)");
 272                 $self->pidl("{");
 273                 $self->indent;
 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;");
 279                 $self->pidl("");
 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) {");
 282                 $self->indent;
 283                 $self->pidl("PyErr_SetNdrError(err);");
 284                 $self->pidl("return NULL;");
 285                 $self->deindent;
 286                 $self->pidl("}");
 287                 $self->pidl("");
 288                 $self->pidl("Py_RETURN_NONE;");
 289                 $self->deindent;
 290                 $self->pidl("}");
 291                 $self->pidl("");
 292
 293                 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
 294                 $self->pidl("{");
 295                 $self->indent;
 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);");
 300                 $self->deindent;
 301                 $self->pidl("}");
 302                 $self->pidl("");
 303
 304                 $py_methods = "py_$name\_methods";
 305                 $self->pidl("static PyMethodDef $py_methods\[] = {");
 306                 $self->indent;
 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 }");
 311                 $self->deindent;
 312                 $self->pidl("};");
 313                 $self->pidl("");
 314         }
 315
 316         $self->pidl_hdr("staticforward PyTypeObject $name\_Type;\n");
 317         $self->pidl("");
 318         my $docstring = $self->DocString($d, $name);
 319         my $typeobject = "$name\_Type";
 320         $self->pidl("static PyTypeObject $typeobject = {");
 321         $self->indent;
 322         $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
 323         $self->pidl(".tp_name = \"$modulename.$prettyname\",");
 324         $self->pidl(".tp_getset = $getsetters,");
 325         if ($docstring) {
 326                 $self->pidl(".tp_doc = $docstring,");
 327         }
 328         $self->pidl(".tp_methods = $py_methods,");
 329         $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
 330         $self->pidl(".tp_basicsize = sizeof(py_talloc_Object),");
 331         $self->pidl(".tp_new = py_$name\_new,");
 332         $self->deindent;
 333         $self->pidl("};");
 334
 335         $self->pidl("");
 336
 337         my $talloc_typename = $self->import_type_variable("talloc", "Object");
 338         $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;", ""]);
 339
 340         return "&$typeobject";
 341 }
 342
 343 sub get_metadata_var($)
 344 {
 345         my ($e) = @_;
 346         sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
 347
 348          if (has_property($e, "length_is")) {
 349                 return get_var($e->{PROPERTIES}->{length_is});
 350          } elsif (has_property($e, "size_is")) {
 351                 return get_var($e->{PROPERTIES}->{size_is});
 352          }
 353
 354          return undef;
 355 }
 356
 357 sub find_metadata_args($)
 358 {
 359         my ($fn) = @_;
 360         my $metadata_args = { in => {}, out => {} };
 361
 362         # Determine arguments that are metadata for other arguments (size_is/length_is)
 363         foreach my $e (@{$fn->{ELEMENTS}}) {
 364                 foreach my $dir (@{$e->{DIRECTION}}) {
 365                          my $main = get_metadata_var($e);
 366                          if ($main) {
 367                                  $metadata_args->{$dir}->{$main} = $e->{NAME};
 368                          }
 369                  }
 370         }
 371
 372         return $metadata_args;
 373 }
 374
 375 sub PythonFunctionUnpackOut($$$)
 376 {
 377         my ($self, $fn, $fnname) = @_;
 378
 379         my $outfnname = "unpack_$fnname\_args_out";
 380         my $signature = "";
 381
 382         my $metadata_args = find_metadata_args($fn);
 383
 384         my $env = GenerateFunctionOutEnv($fn, "r->");
 385         my $result_size = 0;
 386
 387         $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
 388         $self->pidl("{");
 389         $self->indent;
 390         $self->pidl("PyObject *result;");
 391         foreach my $e (@{$fn->{ELEMENTS}}) {
 392                 next unless (grep(/out/,@{$e->{DIRECTION}}));
 393                 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
 394                          ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
 395                 $self->pidl("PyObject *py_$e->{NAME};");
 396                 $result_size++;
 397         }
 398
 399         if ($fn->{RETURN_TYPE}) {
 400                 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
 401         }
 402
 403         my $i = 0;
 404
 405         if ($result_size > 1) {
 406                 $self->pidl("result = PyTuple_New($result_size);");
 407                 $signature .= "(";
 408         } elsif ($result_size == 0) {
 409                 $self->pidl("result = Py_None;");
 410                 $self->pidl("Py_INCREF(result);");
 411                 $signature .= "None";
 412         }
 413
 414         foreach my $e (@{$fn->{ELEMENTS}}) {
 415                 next if ($metadata_args->{out}->{$e->{NAME}});
 416                 my $py_name = "py_$e->{NAME}";
 417                 if (grep(/out/,@{$e->{DIRECTION}})) {
 418                         $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
 419                         if ($result_size > 1) {
 420                                 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
 421                                 $i++;
 422                                 $signature .= "$e->{NAME}, ";
 423                         } else {
 424                                 $self->pidl("result = $py_name;");
 425                                 $signature .= $e->{NAME};
 426                         }
 427                 }
 428         }
 429
 430         if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
 431                 $self->handle_ntstatus("r->out.result", "NULL", undef);
 432         } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
 433                 $self->handle_werror("r->out.result", "NULL", undef);
 434         } elsif (defined($fn->{RETURN_TYPE})) {
 435                 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
 436                 if ($result_size > 1) {
 437                         $self->pidl("PyTuple_SetItem(result, $i, $conv);");
 438                 } else {
 439                         $self->pidl("result = $conv;");
 440                 }
 441                 $signature .= "result";
 442         }
 443
 444         if (substr($signature, -2) eq ", ") {
 445                 $signature = substr($signature, 0, -2);
 446         }
 447         if ($result_size > 1) {
 448                 $signature .= ")";
 449         }
 450
 451         $self->pidl("return result;");
 452         $self->deindent;
 453         $self->pidl("}");
 454         $self->pidl("");
 455
 456         return ($outfnname, $signature);
 457 }
 458
 459 sub PythonFunctionPackIn($$$)
 460 {
 461         my ($self, $fn, $fnname) = @_;
 462         my $metadata_args = find_metadata_args($fn);
 463
 464         my $infnname = "pack_$fnname\_args_in";
 465
 466         $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
 467         $self->pidl("{");
 468         $self->indent;
 469         my $args_format = "";
 470         my $args_string = "";
 471         my $args_names = "";
 472         my $signature = "";
 473
 474         foreach my $e (@{$fn->{ELEMENTS}}) {
 475                 next unless (grep(/in/,@{$e->{DIRECTION}}));
 476                 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
 477                                  ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
 478                 $self->pidl("PyObject *py_$e->{NAME};");
 479                 $args_format .= "O";
 480                 $args_string .= ", &py_$e->{NAME}";
 481                 $args_names .= "\"$e->{NAME}\", ";
 482                 $signature .= "$e->{NAME}, ";
 483         }
 484         if (substr($signature, -2) eq ", ") {
 485                 $signature = substr($signature, 0, -2);
 486         }
 487         $self->pidl("const char *kwnames[] = {");
 488         $self->indent;
 489         $self->pidl($args_names . "NULL");
 490         $self->deindent;
 491         $self->pidl("};");
 492
 493         $self->pidl("");
 494         $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
 495         $self->indent;
 496         $self->pidl("return false;");
 497         $self->deindent;
 498         $self->pidl("}");
 499         $self->pidl("");
 500
 501         my $env = GenerateFunctionInEnv($fn, "r->");
 502
 503         my $fail = "return false;";
 504         foreach my $e (@{$fn->{ELEMENTS}}) {
 505                 next unless (grep(/in/,@{$e->{DIRECTION}}));
 506                 if ($metadata_args->{in}->{$e->{NAME}}) {
 507                         my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
 508                         $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
 509                         my $val = "PyList_GET_SIZE($py_var)";
 510                         if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
 511                                 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
 512                                 $self->pidl("*r->in.$e->{NAME} = $val;");
 513                         } else {
 514                                 $self->pidl("r->in.$e->{NAME} = $val;");
 515                         }
 516                 } else {
 517                         $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
 518                 }
 519         }
 520         $self->pidl("return true;");
 521         $self->deindent;
 522         $self->pidl("}");
 523         $self->pidl("");
 524         return ($infnname, $signature);
 525 }
 526
 527 sub PythonFunction($$$)
 528 {
 529         my ($self, $fn, $iface, $prettyname) = @_;
 530
 531         my $fnname = "py_$fn->{NAME}";
 532         my $docstring = $self->DocString($fn, $fn->{NAME});
 533
 534         my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
 535         my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
 536         my $signature = "S.$prettyname($insignature) -> $outsignature";
 537         if ($docstring) {
 538                 $docstring = "\"$signature\\n\\n\"$docstring";
 539         } else {
 540                 $docstring = "\"$signature\"";
 541         }
 542
 543         return ($infn, $outfn, $docstring);
 544 }
 545
 546 sub handle_werror($$$$)
 547 {
 548         my ($self, $var, $retval, $mem_ctx) = @_;
 549
 550         $self->pidl("if (!W_ERROR_IS_OK($var)) {");
 551         $self->indent;
 552         $self->pidl("PyErr_SetWERROR($var);");
 553         $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
 554         $self->pidl("return $retval;");
 555         $self->deindent;
 556         $self->pidl("}");
 557         $self->pidl("");
 558 }
 559
 560 sub handle_ntstatus($$$$)
 561 {
 562         my ($self, $var, $retval, $mem_ctx) = @_;
 563
 564         $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
 565         $self->indent;
 566         $self->pidl("PyErr_SetNTSTATUS($var);");
 567         $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
 568         $self->pidl("return $retval;");
 569         $self->deindent;
 570         $self->pidl("}");
 571         $self->pidl("");
 572 }
 573
 574 sub PythonType($$$$)
 575 {
 576         my ($self, $modulename, $d, $interface, $basename) = @_;
 577
 578         my $actual_ctype = $d;
 579         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
 580                 $actual_ctype = $actual_ctype->{DATA};
 581         }
 582
 583         if ($actual_ctype->{TYPE} eq "STRUCT") {
 584                 my $typeobject;
 585                 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
 586
 587                 if ($d->{TYPE} eq "STRUCT") {
 588                         $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
 589                 } else {
 590                         $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
 591                 }
 592
 593                 $self->register_module_typeobject($fn_name, $typeobject);
 594         }
 595
 596         if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
 597                 $self->EnumAndBitmapConsts($d->{NAME}, $d);
 598         }
 599
 600         if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
 601                 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
 602         }
 603
 604         if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
 605                 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
 606                 $self->pidl("{");
 607                 $self->indent;
 608                 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
 609                 $self->deindent;
 610                 $self->pidl("}");
 611                 $self->pidl("");
 612
 613                 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
 614                 $self->pidl("{");
 615                 $self->indent;
 616                 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
 617                 $self->deindent;
 618                 $self->pidl("}");
 619                 $self->pidl("");
 620         }
 621 }
 622
 623 sub DocString($$$)
 624 {
 625         my ($self, $d, $name) = @_;
 626         if (has_property($d, "helpstring")) {
 627                 my $docstring = uc("py_doc_$name");
 628                 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
 629                 return $docstring;
 630         }
 631
 632         return undef;
 633 }
 634
 635 sub Interface($$$)
 636 {
 637         my($self,$interface,$basename) = @_;
 638
 639         if (has_property($interface, "pyhelper")) {
 640                 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
 641         }
 642
 643         $self->Const($_) foreach (@{$interface->{CONSTS}});
 644
 645         foreach my $d (@{$interface->{TYPES}}) {
 646                 next if has_property($d, "nopython");
 647
 648                 $self->PythonType($basename, $d, $interface, $basename);
 649         }
 650
 651         if (defined $interface->{PROPERTIES}->{uuid}) {
 652                 $self->pidl_hdr("staticforward PyTypeObject $interface->{NAME}_InterfaceType;\n");
 653                 $self->pidl("");
 654
 655                 my @fns = ();
 656
 657                 foreach my $d (@{$interface->{FUNCTIONS}}) {
 658                         next if has_property($d, "noopnum");
 659                         next if has_property($d, "nopython");
 660                         next if has_property($d, "todo");
 661
 662                         my $prettyname = $d->{NAME};
 663
 664                         $prettyname =~ s/^$interface->{NAME}_//;
 665                         $prettyname =~ s/^$basename\_//;
 666
 667                         my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
 668
 669                         push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
 670                 }
 671
 672                 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
 673                 $self->indent;
 674                 foreach my $d (@fns) {
 675                         my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
 676                         $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
 677                 }
 678                 $self->pidl("{ NULL }");
 679                 $self->deindent;
 680                 $self->pidl("};");
 681                 $self->pidl("");
 682
 683                 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 684                 $self->pidl("{");
 685                 $self->indent;
 686                 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
 687                 $self->deindent;
 688                 $self->pidl("}");
 689
 690                 $self->pidl("");
 691
 692                 my $signature =
 693 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
 694 \"\\n\"
 695 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
 696 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
 697 \"credentials should be a credentials.Credentials object.\\n\\n\"";
 698
 699                 my $docstring = $self->DocString($interface, $interface->{NAME});
 700
 701                 if ($docstring) {
 702                         $docstring = "$signature$docstring";
 703                 } else {
 704                         $docstring = $signature;
 705                 }
 706
 707                 my $if_typename = "$interface->{NAME}_InterfaceType";
 708
 709                 $self->pidl("static PyTypeObject $if_typename = {");
 710                 $self->indent;
 711                 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
 712                 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
 713                 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
 714                 $self->pidl(".tp_doc = $docstring,");
 715                 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
 716                 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
 717                 $self->deindent;
 718                 $self->pidl("};");
 719
 720                 $self->pidl("");
 721
 722                 $self->register_module_typeobject($interface->{NAME}, "&$if_typename");
 723                 my $dcerpc_typename = $self->import_type_variable("base", "ClientConnection");
 724                 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
 725                 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
 726         }
 727
 728         $self->pidl_hdr("\n");
 729 }
 730
 731 sub register_module_method($$$$$)
 732 {
 733         my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
 734
 735         push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
 736 }
 737
 738 sub register_module_typeobject($$$)
 739 {
 740         my ($self, $name, $py_name) = @_;
 741
 742         $self->register_module_object($name, "(PyObject *)(void *)$py_name");
 743
 744         $self->check_ready_type($py_name);
 745
 746         $self->register_patch_type_call($name, $py_name);
 747 }
 748
 749 sub check_ready_type($$)
 750 {
 751         my ($self, $py_name) = @_;
 752         push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
 753 }
 754
 755 sub register_module_import($$)
 756 {
 757         my ($self, $basename) = @_;
 758
 759         push (@{$self->{module_imports}}, $basename) unless (grep(/^$basename$/,@{$self->{module_imports}}));
 760 }
 761
 762 sub import_type_variable($$$)
 763 {
 764         my ($self, $module, $name) = @_;
 765
 766         $self->register_module_import($module);
 767         unless (defined($self->{type_imports}->{$name})) {
 768                 $self->{type_imports}->{$name} = $module;
 769         }
 770         return "$name\_Type";
 771 }
 772
 773 sub use_type_variable($$)
 774 {
 775         my ($self, $orig_ctype) = @_;
 776         # FIXME: Have a global lookup table for types that look different on the
 777         # wire than they are named in C?
 778         if ($orig_ctype->{NAME} eq "dom_sid2" or $orig_ctype->{NAME} eq "dom_sid28") {
 779                 $orig_ctype->{NAME} = "dom_sid";
 780         }
 781         my $ctype = resolveType($orig_ctype);
 782         unless (defined($ctype->{BASEFILE})) {
 783                 return undef;
 784         }
 785         # If this is an external type, make sure we do the right imports.
 786         if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
 787                 return $self->import_type_variable($ctype->{BASEFILE}, $ctype->{NAME});
 788         }
 789         return "&$ctype->{NAME}_Type";
 790 }
 791
 792 sub register_patch_type_call($$$)
 793 {
 794         my ($self, $typename, $cvar) = @_;
 795
 796         push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
 797
 798 }
 799
 800 sub register_module_prereadycode($$)
 801 {
 802         my ($self, $code) = @_;
 803
 804         push (@{$self->{prereadycode}}, @$code);
 805 }
 806
 807 sub register_module_postreadycode($$)
 808 {
 809         my ($self, $code) = @_;
 810
 811         push (@{$self->{postreadycode}}, @$code);
 812 }
 813
 814 sub register_module_object($$$)
 815 {
 816         my ($self, $name, $py_name) = @_;
 817
 818         push (@{$self->{module_objects}}, [$name, $py_name])
 819 }
 820
 821 sub assign($$$)
 822 {
 823         my ($self, $dest, $src) = @_;
 824         if ($dest =~ /^\&/ and $src eq "NULL") {
 825                 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
 826         } elsif ($dest =~ /^\&/) {
 827                 my $destvar = get_value_of($dest);
 828                 $self->pidl("$destvar = *$src;");
 829         } else {
 830                 $self->pidl("$dest = $src;");
 831         }
 832 }
 833
 834 sub ConvertObjectFromPythonData($$$$$$;$)
 835 {
 836         my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
 837
 838         fatal($location, "undef type for $cvar") unless(defined($ctype));
 839
 840         $ctype = resolveType($ctype);
 841
 842         my $actual_ctype = $ctype;
 843         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
 844                 $actual_ctype = $actual_ctype->{DATA};
 845         }
 846
 847         if ($actual_ctype->{TYPE} eq "ENUM" or $actual_ctype->{TYPE} eq "BITMAP") {
 848                 $self->pidl("if (PyLong_Check($cvar)) {");
 849                 $self->indent;
 850                 $self->pidl("$target = PyLong_AsLongLong($cvar);");
 851                 $self->deindent;
 852                 $self->pidl("} else if (PyInt_Check($cvar)) {");
 853                 $self->indent;
 854                 $self->pidl("$target = PyInt_AsLong($cvar);");
 855                 $self->deindent;
 856                 $self->pidl("} else {");
 857                 $self->indent;
 858                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
 859                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
 860                 $self->pidl($fail);
 861                 $self->deindent;
 862                 $self->pidl("}");
 863                 return;
 864         }
 865         if ($actual_ctype->{TYPE} eq "SCALAR" ) {
 866                 if (expandAlias($actual_ctype->{NAME}) =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
 867                         $self->pidl("if (PyLong_Check($cvar)) {");
 868                         $self->indent;
 869                         $self->pidl("$target = PyLong_AsLongLong($cvar);");
 870                         $self->deindent;
 871                         $self->pidl("} else if (PyInt_Check($cvar)) {");
 872                         $self->indent;
 873                         $self->pidl("$target = PyInt_AsLong($cvar);");
 874                         $self->deindent;
 875                         $self->pidl("} else {");
 876                         $self->indent;
 877                         $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
 878                         $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
 879                         $self->pidl($fail);
 880                         $self->deindent;
 881                         $self->pidl("}");
 882                         return;
 883                 }
 884                 if (expandAlias($actual_ctype->{NAME}) =~ /^(char|u?int[0-9]*|time_t)$/) {
 885                         $self->pidl("PY_CHECK_TYPE(&PyInt_Type, $cvar, $fail);");
 886                         $self->pidl("$target = PyInt_AsLong($cvar);");
 887                         return;
 888                 }
 889         }
 890
 891         if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
 892                 my $ctype_name = $self->use_type_variable($ctype);
 893                 unless (defined ($ctype_name)) {
 894                         error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
 895                         $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
 896                         return;
 897                 }
 898                 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
 899                 $self->pidl("if (talloc_reference($mem_ctx, py_talloc_get_mem_ctx($cvar)) == NULL) {");
 900                 $self->indent;
 901                 $self->pidl("PyErr_NoMemory();");
 902                 $self->pidl("$fail");
 903                 $self->deindent;
 904                 $self->pidl("}");
 905                 $self->assign($target, "(".mapTypeName($ctype)." *)py_talloc_get_ptr($cvar)");
 906                 return;
 907         }
 908
 909         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
 910                 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
 911                 return;
 912         }
 913
 914         if ($actual_ctype->{TYPE} eq "SCALAR" and
 915                 ($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")) {
 916                 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
 917                 return;
 918         }
 919
 920         if ($actual_ctype->{TYPE} eq "SCALAR" and ($actual_ctype->{NAME} eq "dns_string" or $actual_ctype->{NAME} eq "dns_name")) {
 921                 $self->pidl("$target = talloc_strdup($mem_ctx, PyString_AS_STRING($cvar));");
 922                 return;
 923         }
 924
 925         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv4address") {
 926                 $self->pidl("$target = PyString_AS_STRING($cvar);");
 927                 return;
 928         }
 929
 930         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "ipv6address") {
 931                 $self->pidl("$target = PyString_AsString($cvar);");
 932                 return;
 933         }
 934
 935         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_name") {
 936                 $self->pidl("$target = PyString_AS_STRING($cvar);");
 937                 return;
 938         }
 939
 940         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "dnsp_string") {
 941                 $self->pidl("$target = PyString_AS_STRING($cvar);");
 942                 return;
 943         }
 944
 945         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
 946                 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
 947                 return;
 948         }
 949
 950         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
 951                 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
 952                 return;
 953         }
 954
 955         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
 956                 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
 957                 return;
 958         }
 959
 960         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
 961                 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
 962                 return;
 963         }
 964
 965         fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
 966
 967 }
 968
 969 sub ConvertObjectFromPythonLevel($$$$$$$$)
 970 {
 971         my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
 972         my $nl = GetNextLevel($e, $l);
 973
 974         if ($l->{TYPE} eq "POINTER") {
 975                 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
 976                         $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
 977                         return;
 978                 }
 979                 if ($l->{POINTER_TYPE} ne "ref") {
 980                         $self->pidl("if ($py_var == Py_None) {");
 981                         $self->indent;
 982                         $self->pidl("$var_name = NULL;");
 983                         $self->deindent;
 984                         $self->pidl("} else {");
 985                         $self->indent;
 986                 }
 987                 # if we want to handle more than one level of pointer in python interfaces
 988                 # then this is where we would need to allocate it
 989                 if ($l->{POINTER_TYPE} eq "ref") {
 990                         $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
 991                 } else {
 992                         $self->pidl("$var_name = NULL;");
 993                 }
 994                 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, get_value_of($var_name), $fail);
 995                 if ($l->{POINTER_TYPE} ne "ref") {
 996                         $self->deindent;
 997                         $self->pidl("}");
 998                 }
 999         } elsif ($l->{TYPE} eq "ARRAY") {
1000                 my $pl = GetPrevLevel($e, $l);
1001                 if ($pl && $pl->{TYPE} eq "POINTER") {
1002                         $var_name = get_pointer_to($var_name);
1003                 }
1004
1005                 if (is_charset_array($e, $l)) {
1006                         $self->pidl("if (PyUnicode_Check($py_var)) {");
1007                         $self->indent;
1008                         # FIXME: Use Unix charset setting rather than utf-8
1009                         $self->pidl($var_name . " = PyString_AS_STRING(PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\"));");
1010                         $self->deindent;
1011                         $self->pidl("} else if (PyString_Check($py_var)) {");
1012                         $self->indent;
1013                         $self->pidl($var_name . " = PyString_AS_STRING($py_var);");
1014                         $self->deindent;
1015                         $self->pidl("} else {");
1016                         $self->indent;
1017                         $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1018                         $self->pidl("$fail;");
1019                         $self->deindent;
1020                         $self->pidl("}");
1021                 } else {
1022                         my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1023                         $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1024                         $self->pidl("{");
1025                         $self->indent;
1026                         $self->pidl("int $counter;");
1027                         if (ArrayDynamicallyAllocated($e, $l)) {
1028                                 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1029                                 $self->pidl("if (!$var_name) { $fail; }");
1030                                 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1031                         }
1032                         $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1033                         $self->indent;
1034                         $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, GetNextLevel($e, $l), $var_name."[$counter]", $fail);
1035                         $self->deindent;
1036                         $self->pidl("}");
1037                         $self->deindent;
1038                         $self->pidl("}");
1039                 }
1040         } elsif ($l->{TYPE} eq "DATA") {
1041                 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1042                         $var_name = get_pointer_to($var_name);
1043                 }
1044                 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1045         } elsif ($l->{TYPE} eq "SWITCH") {
1046                 $var_name = get_pointer_to($var_name);
1047                 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1048                 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1049                 $self->pidl("{");
1050                 $self->indent;
1051                 my $union_type = mapTypeName(GetNextLevel($e, $l)->{DATA_TYPE});
1052                 $self->pidl("$union_type *$switch_ptr;");
1053                 $self->pidl("$switch_ptr = py_export_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1054                 $self->pidl("if ($switch_ptr == NULL) { $fail }");
1055                 $self->assign($var_name, "$switch_ptr");
1056                 $self->deindent;
1057                 $self->pidl("}");
1058         } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1059                 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, GetNextLevel($e, $l), $var_name, $fail);
1060         } else {
1061                 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1062         }
1063 }
1064
1065 sub ConvertObjectFromPython($$$$$$$)
1066 {
1067         my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1068
1069         $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1070 }
1071
1072 sub ConvertScalarToPython($$$)
1073 {
1074         my ($self, $ctypename, $cvar) = @_;
1075
1076         die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1077
1078         $ctypename = expandAlias($ctypename);
1079
1080         if ($ctypename =~ /^(u?int64|hyper|dlong|udlong|udlongr|NTTIME_hyper|NTTIME|NTTIME_1sec)$/) {
1081                 return "PyLong_FromLongLong($cvar)";
1082         }
1083
1084         if ($ctypename =~ /^(char|u?int[0-9]*|time_t)$/) {
1085                 return "PyInt_FromLong($cvar)";
1086         }
1087
1088         if ($ctypename eq "DATA_BLOB") {
1089                 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1090         }
1091
1092         if ($ctypename eq "NTSTATUS") {
1093                 return "PyErr_FromNTSTATUS($cvar)";
1094         }
1095
1096         if ($ctypename eq "WERROR") {
1097                 return "PyErr_FromWERROR($cvar)";
1098         }
1099
1100         if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1101                 return "PyString_FromString_check_null($cvar)";
1102         }
1103
1104         if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1105                 return "PyString_FromString_check_null($cvar)";
1106         }
1107
1108         # Not yet supported
1109         if ($ctypename eq "string_array") { return "PyCObject_FromTallocPtr($cvar)"; }
1110         if ($ctypename eq "ipv4address") { return "PyString_FromString_check_null($cvar)"; }
1111         if ($ctypename eq "ipv6address") { return "PyString_FromString_check_null($cvar)"; }
1112         if ($ctypename eq "dnsp_name") { return "PyString_FromString_check_null($cvar)"; }
1113         if ($ctypename eq "dnsp_string") { return "PyString_FromString_check_null($cvar)"; }
1114         if ($ctypename eq "pointer") {
1115                 return "PyCObject_FromTallocPtr($cvar)";
1116         }
1117
1118         die("Unknown scalar type $ctypename");
1119 }
1120
1121 sub ConvertObjectToPythonData($$$$$;$)
1122 {
1123         my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1124
1125         die("undef type for $cvar") unless(defined($ctype));
1126
1127         $ctype = resolveType($ctype);
1128
1129         my $actual_ctype = $ctype;
1130         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1131                 $actual_ctype = $actual_ctype->{DATA};
1132         }
1133
1134         if ($actual_ctype->{TYPE} eq "ENUM") {
1135                 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1136         } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1137                 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1138         } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1139                 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1140         } elsif ($actual_ctype->{TYPE} eq "UNION") {
1141                 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1142         } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1143                 my $ctype_name = $self->use_type_variable($ctype);
1144                 unless (defined($ctype_name)) {
1145                         error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1146                         return "NULL"; # FIXME!
1147                 }
1148                 return "py_talloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1149         }
1150
1151         fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1152 }
1153
1154 sub fail_on_null($$$)
1155 {
1156         my ($self, $var, $fail) = @_;
1157         $self->pidl("if ($var == NULL) {");
1158         $self->indent;
1159         $self->pidl($fail);
1160         $self->deindent;
1161         $self->pidl("}");
1162 }
1163
1164 sub ConvertObjectToPythonLevel($$$$$$)
1165 {
1166         my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1167         my $nl = GetNextLevel($e, $l);
1168
1169         if ($l->{TYPE} eq "POINTER") {
1170                 if ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1171                         $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name, $py_var, $fail);
1172                         return;
1173                 }
1174                 if ($l->{POINTER_TYPE} ne "ref") {
1175                         $self->pidl("if ($var_name == NULL) {");
1176                         $self->indent;
1177                         $self->pidl("$py_var = Py_None;");
1178                         $self->pidl("Py_INCREF($py_var);");
1179                         $self->deindent;
1180                         $self->pidl("} else {");
1181                         $self->indent;
1182                 }
1183                 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, get_value_of($var_name), $py_var, $fail);
1184                 if ($l->{POINTER_TYPE} ne "ref") {
1185                         $self->deindent;
1186                         $self->pidl("}");
1187                 }
1188         } elsif ($l->{TYPE} eq "ARRAY") {
1189                 my $pl = GetPrevLevel($e, $l);
1190                 if ($pl && $pl->{TYPE} eq "POINTER") {
1191                         $var_name = get_pointer_to($var_name);
1192                 }
1193
1194                 if (is_charset_array($e, $l)) {
1195                         # FIXME: Use Unix charset setting rather than utf-8
1196                         $self->pidl("if ($var_name == NULL) {");
1197                         $self->indent;
1198                         $self->pidl("$py_var = Py_None;");
1199                         $self->pidl("Py_INCREF($py_var);");
1200                         $self->deindent;
1201                         $self->pidl("} else {");
1202                         $self->indent;
1203                         $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1204                         $self->deindent;
1205                         $self->pidl("}");
1206                 } else {
1207                         die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1208                         my $length = $l->{SIZE_IS};
1209                         if (defined($l->{LENGTH_IS})) {
1210                                 $length = $l->{LENGTH_IS};
1211                         }
1212
1213                         $length = ParseExpr($length, $env, $e);
1214                         $self->pidl("$py_var = PyList_New($length);");
1215                         $self->fail_on_null($py_var, $fail);
1216                         $self->pidl("{");
1217                         $self->indent;
1218                         my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1219                         $self->pidl("int $counter;");
1220                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1221                         $self->indent;
1222                         my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1223                         $self->pidl("PyObject *$member_var;");
1224                         $self->ConvertObjectToPythonLevel($var_name, $env, $e, GetNextLevel($e, $l), $var_name."[$counter]", $member_var, $fail);
1225                         $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1226                         $self->deindent;
1227                         $self->pidl("}");
1228                         $self->deindent;
1229                         $self->pidl("}");
1230                 }
1231         } elsif ($l->{TYPE} eq "SWITCH") {
1232                 $var_name = get_pointer_to($var_name);
1233                 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1234                 $self->pidl("$py_var = py_import_" . GetNextLevel($e, $l)->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1235                 $self->fail_on_null($py_var, $fail);
1236
1237         } elsif ($l->{TYPE} eq "DATA") {
1238                 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1239                         $var_name = get_pointer_to($var_name);
1240                 }
1241                 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1242                 $self->pidl("$py_var = $conv;");
1243         } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1244                 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, GetNextLevel($e, $l), $var_name, $py_var, $fail);
1245         } else {
1246                 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1247         }
1248 }
1249
1250 sub ConvertObjectToPython($$$$$$)
1251 {
1252         my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1253
1254         $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1255 }
1256
1257 sub Parse($$$$$)
1258 {
1259     my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1260
1261         $self->{BASENAME} = $basename;
1262
1263     $self->pidl_hdr("
1264 /* Python wrapper functions auto-generated by pidl */
1265 #include <Python.h>
1266 #include \"includes.h\"
1267 #include \"lib/talloc/pytalloc.h\"
1268 #include \"librpc/rpc/pyrpc.h\"
1269 #include \"librpc/rpc/pyrpc_util.h\"
1270 #include \"$hdr\"
1271 #include \"$ndr_hdr\"
1272
1273 ");
1274
1275         foreach my $x (@$ndr) {
1276                 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1277             ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1278         }
1279
1280         $self->pidl("static PyMethodDef $basename\_methods[] = {");
1281         $self->indent;
1282         foreach (@{$self->{module_methods}}) {
1283                 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1284                 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1285         }
1286
1287         $self->pidl("{ NULL, NULL, 0, NULL }");
1288         $self->deindent;
1289         $self->pidl("};");
1290
1291         $self->pidl("");
1292
1293         $self->pidl("void init$basename(void)");
1294         $self->pidl("{");
1295         $self->indent;
1296         $self->pidl("PyObject *m;");
1297         foreach (@{$self->{module_imports}}) {
1298                 $self->pidl("PyObject *dep_$_;");
1299         }
1300         $self->pidl("");
1301
1302         foreach (@{$self->{module_imports}}) {
1303                 $self->pidl("dep_$_ = PyImport_ImportModule(\"samba.dcerpc.$_\");");
1304                 $self->pidl("if (dep_$_ == NULL)");
1305                 $self->pidl("\treturn;");
1306                 $self->pidl("");
1307         }
1308
1309         foreach (keys %{$self->{type_imports}}) {
1310                 my $basefile = $self->{type_imports}->{$_};
1311                 $self->pidl_hdr("static PyTypeObject *$_\_Type;\n");
1312                 my $pretty_name = PrettifyTypeName($_, $basefile);
1313                 $self->pidl("$_\_Type = (PyTypeObject *)PyObject_GetAttrString(dep_$basefile, \"$pretty_name\");");
1314                 $self->pidl("if ($_\_Type == NULL)");
1315                 $self->pidl("\treturn;");
1316                 $self->pidl("");
1317         }
1318
1319         $self->pidl($_) foreach (@{$self->{prereadycode}});
1320
1321         foreach (@{$self->{ready_types}}) {
1322                 $self->pidl("if (PyType_Ready($_) < 0)");
1323                 $self->pidl("\treturn;");
1324         }
1325
1326         $self->pidl($_) foreach (@{$self->{postreadycode}});
1327
1328         foreach (@{$self->{patch_type_calls}}) {
1329                 my ($typename, $cvar) = @$_;
1330                 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1331                 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1332                 $self->pidl("#endif");
1333         }
1334
1335         $self->pidl("");
1336
1337         $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1338         $self->pidl("if (m == NULL)");
1339         $self->pidl("\treturn;");
1340         $self->pidl("");
1341         foreach my $name (keys %{$self->{constants}}) {
1342                 my $py_obj;
1343                 my ($ctype, $cvar) = @{$self->{constants}->{$name}};
1344                 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1345                         $py_obj = "PyInt_FromLong($cvar)";
1346                 } elsif ($cvar =~ /^".*"$/) {
1347                         $py_obj = "PyString_FromString($cvar)";
1348                 } else {
1349                         $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1350                 }
1351
1352                 $self->pidl("PyModule_AddObject(m, \"$name\", $py_obj);");
1353         }
1354
1355         foreach (@{$self->{module_objects}}) {
1356                 my ($object_name, $c_name) = @$_;
1357                 $self->pidl("Py_INCREF($c_name);");
1358                 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1359         }
1360
1361         $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1362         $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1363         $self->pidl("#endif");
1364
1365         $self->pidl("");
1366         $self->deindent;
1367         $self->pidl("}");
1368     return ($self->{res_hdr} . $self->{res});
1369 }
1370
1371 1;