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