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 bitmap_type_fn enum_type_fn);
  14 use Parse::Pidl::Util qw(has_property ParseExpr unmake_str);
  15 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
  16 use Parse::Pidl::CUtil qw(get_value_of get_pointer_to);
  17 use Parse::Pidl::Samba4 qw(ArrayDynamicallyAllocated);
  18 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
  19
  20 use vars qw($VERSION);
  21 $VERSION = '0.01';
  22
  23 sub new($) {
  24         my ($class) = @_;
  25         my $self = { res => "", res_hdr => "", tabs => "",
  26                                  constants => [], constants_uniq => {},
  27                                  module_methods => [],
  28                                  module_objects => [], module_objects_uniq => {},
  29                                  ready_types => [],
  30                                  module_imports => [], module_imports_uniq => {},
  31                                  type_imports => [], type_imports_uniq => {},
  32                                  patch_type_calls => [], prereadycode => [],
  33                                  postreadycode => []};
  34         bless($self, $class);
  35 }
  36
  37 sub pidl_hdr ($$)
  38 {
  39         my $self = shift;
  40         $self->{res_hdr} .= shift;
  41 }
  42
  43 sub pidl($$)
  44 {
  45         my ($self, $d) = @_;
  46         if ($d) {
  47                 if ((!($d =~ /^#/))) {
  48                         $self->{res} .= $self->{tabs};
  49                 }
  50                 $self->{res} .= $d;
  51         }
  52         $self->{res} .= "\n";
  53 }
  54
  55 sub indent($)
  56 {
  57         my ($self) = @_;
  58         $self->{tabs} .= "\t";
  59 }
  60
  61 sub deindent($)
  62 {
  63         my ($self) = @_;
  64         $self->{tabs} = substr($self->{tabs}, 0, -1);
  65 }
  66
  67 sub PrettifyTypeName($$)
  68 {
  69         my ($name, $basename) = @_;
  70
  71         $basename =~ s/^.*\.([^.]+)$/\1/;
  72
  73         $name =~ s/^$basename\_//;
  74
  75
  76         return $name;
  77 }
  78
  79 sub Import
  80 {
  81         my $self = shift;
  82         my @imports = @_;
  83         foreach (@imports) {
  84                 $_ = unmake_str($_);
  85                 s/\.idl$//;
  86                 $self->pidl_hdr("#include \"librpc/gen_ndr/$_\.h\"\n");
  87                 $self->register_module_import("samba.dcerpc.$_");
  88         }
  89 }
  90
  91 sub Const($$)
  92 {
  93     my ($self, $const) = @_;
  94         $self->register_constant($const->{NAME}, $const->{DTYPE}, $const->{VALUE});
  95 }
  96
  97 sub register_constant($$$$)
  98 {
  99         my ($self, $name, $type, $value) = @_;
 100
 101         unless (defined $self->{constants_uniq}->{$name}) {
 102                 my $h = {"key" => $name, "val" => [$type, $value]};
 103                 push @{$self->{constants}}, $h;
 104                 $self->{constants_uniq}->{$name} = $h;
 105         }
 106 }
 107
 108 sub EnumAndBitmapConsts($$$)
 109 {
 110         my ($self, $name, $d) = @_;
 111
 112         return unless (defined($d->{ELEMENTS}));
 113
 114         foreach my $e (@{$d->{ELEMENTS}}) {
 115                 $e =~ /^([A-Za-z0-9_]+)/;
 116                 my $cname = $1;
 117
 118                 $self->register_constant($cname, $d, $cname);
 119         }
 120 }
 121
 122 sub FromUnionToPythonFunction($$$$)
 123 {
 124         my ($self, $mem_ctx, $type, $switch, $name) = @_;
 125
 126         $self->pidl("PyObject *ret;");
 127         $self->pidl("");
 128
 129         $self->pidl("switch ($switch) {");
 130         $self->indent;
 131
 132         foreach my $e (@{$type->{ELEMENTS}}) {
 133                 $self->pidl("$e->{CASE}:");
 134
 135                 $self->indent;
 136
 137                 if ($e->{NAME}) {
 138                         $self->ConvertObjectToPython($mem_ctx, {}, $e, "$name->$e->{NAME}", "ret", "return NULL;");
 139                 } else {
 140                         $self->pidl("ret = Py_None;");
 141                         $self->pidl("Py_INCREF(ret);");
 142                 }
 143
 144                 $self->pidl("return ret;");
 145                 $self->pidl("");
 146
 147                 $self->deindent;
 148         }
 149
 150         $self->deindent;
 151         $self->pidl("}");
 152
 153         $self->pidl("PyErr_SetString(PyExc_TypeError, \"unknown union level\");");
 154         $self->pidl("return NULL;");
 155 }
 156
 157 sub FromPythonToUnionFunction($$$$$)
 158 {
 159         my ($self, $type, $typename, $switch, $mem_ctx, $name) = @_;
 160
 161         my $has_default = 0;
 162
 163         $self->pidl("$typename *ret = talloc_zero($mem_ctx, $typename);");
 164
 165         $self->pidl("switch ($switch) {");
 166         $self->indent;
 167
 168         foreach my $e (@{$type->{ELEMENTS}}) {
 169                 $self->pidl("$e->{CASE}:");
 170                 if ($e->{CASE} eq "default") { $has_default = 1; }
 171                 $self->indent;
 172                 if ($e->{NAME}) {
 173                         $self->ConvertObjectFromPython({}, $mem_ctx, $e, $name, "ret->$e->{NAME}", "talloc_free(ret); return NULL;");
 174                 }
 175                 $self->pidl("break;");
 176                 $self->deindent;
 177                 $self->pidl("");
 178         }
 179
 180         if (!$has_default) {
 181                 $self->pidl("default:");
 182                 $self->indent;
 183                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"invalid union level value\");");
 184                 $self->pidl("talloc_free(ret);");
 185                 $self->pidl("ret = NULL;");
 186                 $self->deindent;
 187         }
 188
 189         $self->deindent;
 190         $self->pidl("}");
 191         $self->pidl("");
 192         $self->pidl("return ret;");
 193 }
 194
 195 sub PythonStruct($$$$$$)
 196 {
 197         my ($self, $modulename, $prettyname, $name, $cname, $d) = @_;
 198
 199         my $env = GenerateStructEnv($d, "object");
 200
 201         $self->pidl("");
 202
 203         my $getsetters = "NULL";
 204
 205         if ($#{$d->{ELEMENTS}} > -1) {
 206                 foreach my $e (@{$d->{ELEMENTS}}) {
 207                         my $varname = "object->$e->{NAME}";
 208                         $self->pidl("static PyObject *py_$name\_get_$e->{NAME}(PyObject *obj, void *closure)");
 209                         $self->pidl("{");
 210                         $self->indent;
 211                         $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(obj);");
 212                         $self->pidl("PyObject *py_$e->{NAME};");
 213                         $self->ConvertObjectToPython("pytalloc_get_mem_ctx(obj)", $env, $e, $varname, "py_$e->{NAME}", "return NULL;");
 214                         $self->pidl("return py_$e->{NAME};");
 215                         $self->deindent;
 216                         $self->pidl("}");
 217                         $self->pidl("");
 218
 219                         $self->pidl("static int py_$name\_set_$e->{NAME}(PyObject *py_obj, PyObject *value, void *closure)");
 220                         $self->pidl("{");
 221                         $self->indent;
 222                         $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
 223                         my $mem_ctx = "pytalloc_get_mem_ctx(py_obj)";
 224                         my $l = $e->{LEVELS}[0];
 225                         my $nl = GetNextLevel($e, $l);
 226                         if ($l->{TYPE} eq "POINTER" and
 227                                 not ($nl->{TYPE} eq "ARRAY" and ($nl->{IS_FIXED} or is_charset_array($e, $nl))) and
 228                                 not ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE}))) {
 229                                 $self->pidl("talloc_unlink($mem_ctx, discard_const($varname));");
 230                         }
 231                         $self->ConvertObjectFromPython($env, $mem_ctx, $e, "value", $varname, "return -1;");
 232                         $self->pidl("return 0;");
 233                         $self->deindent;
 234                         $self->pidl("}");
 235                         $self->pidl("");
 236                 }
 237
 238                 $getsetters = "py_$name\_getsetters";
 239                 $self->pidl("static PyGetSetDef ".$getsetters."[] = {");
 240                 $self->indent;
 241                 foreach my $e (@{$d->{ELEMENTS}}) {
 242                         $self->pidl("{");
 243                         $self->indent;
 244                         $self->pidl(".name = discard_const_p(char, \"$e->{NAME}\"),");
 245                         $self->pidl(".get = py_$name\_get_$e->{NAME},");
 246                         $self->pidl(".set = py_$name\_set_$e->{NAME},");
 247                         $self->pidl(".doc = discard_const_p(char, \"PIDL-generated element of base type $e->{TYPE}\")");
 248                         $self->deindent;
 249                         $self->pidl("},");
 250                 }
 251                 $self->pidl("{ .name = NULL }");
 252                 $self->deindent;
 253                 $self->pidl("};");
 254                 $self->pidl("");
 255         }
 256
 257         $self->pidl("static PyObject *py_$name\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 258         $self->pidl("{");
 259         $self->indent;
 260         $self->pidl("return pytalloc_new($cname, type);");
 261         $self->deindent;
 262         $self->pidl("}");
 263         $self->pidl("");
 264
 265         my $py_methods = "NULL";
 266
 267         # If the struct is not public there ndr_pull/ndr_push functions will
 268         # be static so not callable from here
 269         if (has_property($d, "public")) {
 270                 $self->pidl("static PyObject *py_$name\_ndr_pack(PyObject *py_obj)");
 271                 $self->pidl("{");
 272                 $self->indent;
 273                 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
 274                 $self->pidl("PyObject *ret = NULL;");
 275                 $self->pidl("DATA_BLOB blob;");
 276                 $self->pidl("enum ndr_err_code err;");
 277                 $self->pidl("TALLOC_CTX *tmp_ctx = talloc_new(pytalloc_get_mem_ctx(py_obj));");
 278                 $self->pidl("if (tmp_ctx == NULL) {");
 279                 $self->indent;
 280                 $self->pidl("PyErr_SetNdrError(NDR_ERR_ALLOC);");
 281                 $self->pidl("return NULL;");
 282                 $self->deindent;
 283                 $self->pidl("}");
 284                 $self->pidl("err = ndr_push_struct_blob(&blob, tmp_ctx, object, (ndr_push_flags_fn_t)ndr_push_$name);");
 285                 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
 286                 $self->indent;
 287                 $self->pidl("TALLOC_FREE(tmp_ctx);");
 288                 $self->pidl("PyErr_SetNdrError(err);");
 289                 $self->pidl("return NULL;");
 290                 $self->deindent;
 291                 $self->pidl("}");
 292                 $self->pidl("");
 293                 $self->pidl("ret = PyString_FromStringAndSize((char *)blob.data, blob.length);");
 294                 $self->pidl("TALLOC_FREE(tmp_ctx);");
 295                 $self->pidl("return ret;");
 296                 $self->deindent;
 297                 $self->pidl("}");
 298                 $self->pidl("");
 299
 300                 $self->pidl("static PyObject *py_$name\_ndr_unpack(PyObject *py_obj, PyObject *args, PyObject *kwargs)");
 301                 $self->pidl("{");
 302                 $self->indent;
 303                 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
 304                 $self->pidl("DATA_BLOB blob;");
 305                 $self->pidl("Py_ssize_t blob_length = 0;");
 306                 $self->pidl("enum ndr_err_code err;");
 307                 $self->pidl("const char * const kwnames[] = { \"data_blob\", \"allow_remaining\", NULL };");
 308                 $self->pidl("PyObject *allow_remaining_obj = NULL;");
 309                 $self->pidl("bool allow_remaining = false;");
 310                 $self->pidl("");
 311                 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"s#|O:__ndr_unpack__\",");
 312                 $self->indent;
 313                 $self->pidl("discard_const_p(char *, kwnames),");
 314                 $self->pidl("&blob.data, &blob_length,");
 315                 $self->pidl("&allow_remaining_obj)) {");
 316                 $self->deindent;
 317                 $self->indent;
 318                 $self->pidl("return NULL;");
 319                 $self->deindent;
 320                 $self->pidl("}");
 321                 $self->pidl("blob.length = blob_length;");
 322                 $self->pidl("");
 323                 $self->pidl("if (allow_remaining_obj && PyObject_IsTrue(allow_remaining_obj)) {");
 324                 $self->indent;
 325                 $self->pidl("allow_remaining = true;");
 326                 $self->deindent;
 327                 $self->pidl("}");
 328                 $self->pidl("");
 329                 $self->pidl("if (allow_remaining) {");
 330                 $self->indent;
 331                 $self->pidl("err = ndr_pull_struct_blob(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
 332                 $self->deindent;
 333                 $self->pidl("} else {");
 334                 $self->indent;
 335                 $self->pidl("err = ndr_pull_struct_blob_all(&blob, pytalloc_get_mem_ctx(py_obj), object, (ndr_pull_flags_fn_t)ndr_pull_$name);");
 336                 $self->deindent;
 337                 $self->pidl("}");
 338                 $self->pidl("if (!NDR_ERR_CODE_IS_SUCCESS(err)) {");
 339                 $self->indent;
 340                 $self->pidl("PyErr_SetNdrError(err);");
 341                 $self->pidl("return NULL;");
 342                 $self->deindent;
 343                 $self->pidl("}");
 344                 $self->pidl("");
 345                 $self->pidl("Py_RETURN_NONE;");
 346                 $self->deindent;
 347                 $self->pidl("}");
 348                 $self->pidl("");
 349
 350                 $self->pidl("static PyObject *py_$name\_ndr_print(PyObject *py_obj)");
 351                 $self->pidl("{");
 352                 $self->indent;
 353                 $self->pidl("$cname *object = ($cname *)pytalloc_get_ptr(py_obj);");
 354                 $self->pidl("PyObject *ret;");
 355                 $self->pidl("char *retstr;");
 356                 $self->pidl("");
 357                 $self->pidl("retstr = ndr_print_struct_string(pytalloc_get_mem_ctx(py_obj), (ndr_print_fn_t)ndr_print_$name, \"$name\", object);");
 358                 $self->pidl("ret = PyString_FromString(retstr);");
 359                 $self->pidl("talloc_free(retstr);");
 360                 $self->pidl("");
 361                 $self->pidl("return ret;");
 362                 $self->deindent;
 363                 $self->pidl("}");
 364                 $self->pidl("");
 365
 366                 $py_methods = "py_$name\_methods";
 367                 $self->pidl("static PyMethodDef $py_methods\[] = {");
 368                 $self->indent;
 369                 $self->pidl("{ \"__ndr_pack__\", (PyCFunction)py_$name\_ndr_pack, METH_NOARGS, \"S.ndr_pack(object) -> blob\\nNDR pack\" },");
 370                 $self->pidl("{ \"__ndr_unpack__\", (PyCFunction)py_$name\_ndr_unpack, METH_VARARGS|METH_KEYWORDS, \"S.ndr_unpack(class, blob, allow_remaining=False) -> None\\nNDR unpack\" },");
 371                 $self->pidl("{ \"__ndr_print__\", (PyCFunction)py_$name\_ndr_print, METH_NOARGS, \"S.ndr_print(object) -> None\\nNDR print\" },");
 372                 $self->pidl("{ NULL, NULL, 0, NULL }");
 373                 $self->deindent;
 374                 $self->pidl("};");
 375                 $self->pidl("");
 376         }
 377
 378         $self->pidl_hdr("static PyTypeObject $name\_Type;\n");
 379         $self->pidl("");
 380         my $docstring = $self->DocString($d, $name);
 381         my $typeobject = "$name\_Type";
 382         $self->pidl("static PyTypeObject $typeobject = {");
 383         $self->indent;
 384         $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
 385         $self->pidl(".tp_name = \"$modulename.$prettyname\",");
 386         $self->pidl(".tp_getset = $getsetters,");
 387         if ($docstring) {
 388                 $self->pidl(".tp_doc = $docstring,");
 389         }
 390         $self->pidl(".tp_methods = $py_methods,");
 391         $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
 392         $self->pidl(".tp_new = py_$name\_new,");
 393         $self->deindent;
 394         $self->pidl("};");
 395
 396         $self->pidl("");
 397
 398         my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
 399         $self->register_module_prereadycode(["$name\_Type.tp_base = $talloc_typename;",
 400                                              "$name\_Type.tp_basicsize = pytalloc_BaseObject_size();",
 401                                              ""]);
 402
 403         return "&$typeobject";
 404 }
 405
 406 sub get_metadata_var($)
 407 {
 408         my ($e) = @_;
 409         sub get_var($) { my $x = shift; $x =~ s/\*//g; return $x; }
 410
 411          if (has_property($e, "length_is")) {
 412                 return get_var($e->{PROPERTIES}->{length_is});
 413          } elsif (has_property($e, "size_is")) {
 414                 return get_var($e->{PROPERTIES}->{size_is});
 415          }
 416
 417          return undef;
 418 }
 419
 420 sub find_metadata_args($)
 421 {
 422         my ($fn) = @_;
 423         my $metadata_args = { in => {}, out => {} };
 424
 425         # Determine arguments that are metadata for other arguments (size_is/length_is)
 426         foreach my $e (@{$fn->{ELEMENTS}}) {
 427                 foreach my $dir (@{$e->{DIRECTION}}) {
 428                          my $main = get_metadata_var($e);
 429                          if ($main) {
 430                                  $metadata_args->{$dir}->{$main} = $e->{NAME};
 431                          }
 432                  }
 433         }
 434
 435         return $metadata_args;
 436 }
 437
 438 sub PythonFunctionUnpackOut($$$)
 439 {
 440         my ($self, $fn, $fnname) = @_;
 441
 442         my $outfnname = "unpack_$fnname\_args_out";
 443         my $signature = "";
 444
 445         my $metadata_args = find_metadata_args($fn);
 446
 447         my $env = GenerateFunctionOutEnv($fn, "r->");
 448         my $result_size = 0;
 449
 450         $self->pidl("static PyObject *$outfnname(struct $fn->{NAME} *r)");
 451         $self->pidl("{");
 452         $self->indent;
 453         $self->pidl("PyObject *result;");
 454         foreach my $e (@{$fn->{ELEMENTS}}) {
 455                 next unless (grep(/out/,@{$e->{DIRECTION}}));
 456                 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
 457                          ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
 458                 $self->pidl("PyObject *py_$e->{NAME};");
 459                 $result_size++;
 460         }
 461
 462         if ($fn->{RETURN_TYPE}) {
 463                 $result_size++ unless ($fn->{RETURN_TYPE} eq "WERROR" or $fn->{RETURN_TYPE} eq "NTSTATUS");
 464         }
 465
 466         my $i = 0;
 467
 468         if ($result_size > 1) {
 469                 $self->pidl("result = PyTuple_New($result_size);");
 470                 $signature .= "(";
 471         } elsif ($result_size == 0) {
 472                 $self->pidl("result = Py_None;");
 473                 $self->pidl("Py_INCREF(result);");
 474                 $signature .= "None";
 475         }
 476
 477         foreach my $e (@{$fn->{ELEMENTS}}) {
 478                 next if ($metadata_args->{out}->{$e->{NAME}});
 479                 my $py_name = "py_$e->{NAME}";
 480                 if (grep(/out/,@{$e->{DIRECTION}})) {
 481                         $self->ConvertObjectToPython("r", $env, $e, "r->out.$e->{NAME}", $py_name, "return NULL;");
 482                         if ($result_size > 1) {
 483                                 $self->pidl("PyTuple_SetItem(result, $i, $py_name);");
 484                                 $i++;
 485                                 $signature .= "$e->{NAME}, ";
 486                         } else {
 487                                 $self->pidl("result = $py_name;");
 488                                 $signature .= $e->{NAME};
 489                         }
 490                 }
 491         }
 492
 493         if (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "NTSTATUS") {
 494                 $self->handle_ntstatus("r->out.result", "NULL", undef);
 495         } elsif (defined($fn->{RETURN_TYPE}) and $fn->{RETURN_TYPE} eq "WERROR") {
 496                 $self->handle_werror("r->out.result", "NULL", undef);
 497         } elsif (defined($fn->{RETURN_TYPE})) {
 498                 my $conv = $self->ConvertObjectToPythonData("r", $fn->{RETURN_TYPE}, "r->out.result", $fn);
 499                 if ($result_size > 1) {
 500                         $self->pidl("PyTuple_SetItem(result, $i, $conv);");
 501                 } else {
 502                         $self->pidl("result = $conv;");
 503                 }
 504                 $signature .= "result";
 505         }
 506
 507         if (substr($signature, -2) eq ", ") {
 508                 $signature = substr($signature, 0, -2);
 509         }
 510         if ($result_size > 1) {
 511                 $signature .= ")";
 512         }
 513
 514         $self->pidl("return result;");
 515         $self->deindent;
 516         $self->pidl("}");
 517         $self->pidl("");
 518
 519         return ($outfnname, $signature);
 520 }
 521
 522 sub PythonFunctionPackIn($$$)
 523 {
 524         my ($self, $fn, $fnname) = @_;
 525         my $metadata_args = find_metadata_args($fn);
 526
 527         my $infnname = "pack_$fnname\_args_in";
 528
 529         $self->pidl("static bool $infnname(PyObject *args, PyObject *kwargs, struct $fn->{NAME} *r)");
 530         $self->pidl("{");
 531         $self->indent;
 532         my $args_format = "";
 533         my $args_string = "";
 534         my $args_names = "";
 535         my $signature = "";
 536
 537         foreach my $e (@{$fn->{ELEMENTS}}) {
 538                 next unless (grep(/in/,@{$e->{DIRECTION}}));
 539                 next if (($metadata_args->{in}->{$e->{NAME}} and grep(/in/, @{$e->{DIRECTION}})) or
 540                                  ($metadata_args->{out}->{$e->{NAME}}) and grep(/out/, @{$e->{DIRECTION}}));
 541                 $self->pidl("PyObject *py_$e->{NAME};");
 542                 $args_format .= "O";
 543                 $args_string .= ", &py_$e->{NAME}";
 544                 $args_names .= "\"$e->{NAME}\", ";
 545                 $signature .= "$e->{NAME}, ";
 546         }
 547         if (substr($signature, -2) eq ", ") {
 548                 $signature = substr($signature, 0, -2);
 549         }
 550         $self->pidl("const char *kwnames[] = {");
 551         $self->indent;
 552         $self->pidl($args_names . "NULL");
 553         $self->deindent;
 554         $self->pidl("};");
 555
 556         $self->pidl("");
 557         $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"$args_format:$fn->{NAME}\", discard_const_p(char *, kwnames)$args_string)) {");
 558         $self->indent;
 559         $self->pidl("return false;");
 560         $self->deindent;
 561         $self->pidl("}");
 562         $self->pidl("");
 563
 564         my $env = GenerateFunctionInEnv($fn, "r->");
 565
 566         my $fail = "return false;";
 567         foreach my $e (@{$fn->{ELEMENTS}}) {
 568                 next unless (grep(/in/,@{$e->{DIRECTION}}));
 569                 if ($metadata_args->{in}->{$e->{NAME}}) {
 570                         my $py_var = "py_".$metadata_args->{in}->{$e->{NAME}};
 571                         $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
 572                         my $val = "PyList_GET_SIZE($py_var)";
 573                         if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
 574                                 $self->pidl("r->in.$e->{NAME} = talloc_ptrtype(r, r->in.$e->{NAME});");
 575                                 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
 576                                 $self->indent;
 577                                 $self->pidl("PyErr_NoMemory();");
 578                                 $self->pidl($fail);
 579                                 $self->deindent;
 580                                 $self->pidl("}");
 581                                 $self->pidl("*r->in.$e->{NAME} = $val;");
 582                         } else {
 583                                 $self->pidl("r->in.$e->{NAME} = $val;");
 584                         }
 585                 } else {
 586                         $self->ConvertObjectFromPython($env, "r", $e, "py_$e->{NAME}", "r->in.$e->{NAME}", $fail);
 587                 }
 588         }
 589         $self->pidl("return true;");
 590         $self->deindent;
 591         $self->pidl("}");
 592         $self->pidl("");
 593         return ($infnname, $signature);
 594 }
 595
 596 sub PythonFunction($$$)
 597 {
 598         my ($self, $fn, $iface, $prettyname) = @_;
 599
 600         my $fnname = "py_$fn->{NAME}";
 601         my $docstring = $self->DocString($fn, $fn->{NAME});
 602
 603         my ($infn, $insignature) = $self->PythonFunctionPackIn($fn, $fnname);
 604         my ($outfn, $outsignature) = $self->PythonFunctionUnpackOut($fn, $fnname);
 605         my $signature = "S.$prettyname($insignature) -> $outsignature";
 606         if ($docstring) {
 607                 $docstring = "\"$signature\\n\\n\"$docstring";
 608         } else {
 609                 $docstring = "\"$signature\"";
 610         }
 611
 612         return ($infn, $outfn, $docstring);
 613 }
 614
 615 sub handle_werror($$$$)
 616 {
 617         my ($self, $var, $retval, $mem_ctx) = @_;
 618
 619         $self->pidl("if (!W_ERROR_IS_OK($var)) {");
 620         $self->indent;
 621         $self->pidl("PyErr_SetWERROR($var);");
 622         $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
 623         $self->pidl("return $retval;");
 624         $self->deindent;
 625         $self->pidl("}");
 626         $self->pidl("");
 627 }
 628
 629 sub handle_ntstatus($$$$)
 630 {
 631         my ($self, $var, $retval, $mem_ctx) = @_;
 632
 633         $self->pidl("if (NT_STATUS_IS_ERR($var)) {");
 634         $self->indent;
 635         $self->pidl("PyErr_SetNTSTATUS($var);");
 636         $self->pidl("talloc_free($mem_ctx);") if ($mem_ctx);
 637         $self->pidl("return $retval;");
 638         $self->deindent;
 639         $self->pidl("}");
 640         $self->pidl("");
 641 }
 642
 643 sub PythonType($$$$)
 644 {
 645         my ($self, $modulename, $d, $interface, $basename) = @_;
 646
 647         my $actual_ctype = $d;
 648         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
 649                 $actual_ctype = $actual_ctype->{DATA};
 650         }
 651
 652         if ($actual_ctype->{TYPE} eq "STRUCT") {
 653                 my $typeobject;
 654                 my $fn_name = PrettifyTypeName($d->{NAME}, $basename);
 655
 656                 if ($d->{TYPE} eq "STRUCT") {
 657                         $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d);
 658                 } else {
 659                         $typeobject = $self->PythonStruct($modulename, $fn_name, $d->{NAME}, mapTypeName($d), $d->{DATA});
 660                 }
 661
 662                 $self->register_module_typeobject($fn_name, $typeobject, $d->{ORIGINAL});
 663         }
 664
 665         if ($d->{TYPE} eq "ENUM" or $d->{TYPE} eq "BITMAP") {
 666                 $self->EnumAndBitmapConsts($d->{NAME}, $d);
 667         }
 668
 669         if ($d->{TYPE} eq "TYPEDEF" and ($d->{DATA}->{TYPE} eq "ENUM" or $d->{DATA}->{TYPE} eq "BITMAP")) {
 670                 $self->EnumAndBitmapConsts($d->{NAME}, $d->{DATA});
 671         }
 672
 673         if ($actual_ctype->{TYPE} eq "UNION" and defined($actual_ctype->{ELEMENTS})) {
 674                 my $prettyname = PrettifyTypeName($d->{NAME}, $basename);
 675                 my $typeobject = "$d->{NAME}\_Type";
 676                 my $docstring = $self->DocString($d, $d->{NAME});
 677                 my $cname = "union $d->{NAME}";
 678
 679                 $self->pidl("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in)");
 680                 $self->pidl_hdr("PyObject *py_import_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, " .mapTypeName($d) . " *in);\n");
 681                 $self->pidl("{");
 682                 $self->indent;
 683                 $self->FromUnionToPythonFunction("mem_ctx", $actual_ctype, "level", "in") if ($actual_ctype->{TYPE} eq "UNION");
 684                 $self->deindent;
 685                 $self->pidl("}");
 686                 $self->pidl("");
 687
 688                 $self->pidl(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in)");
 689                 $self->pidl_hdr(mapTypeName($d) . " *py_export_$d->{NAME}(TALLOC_CTX *mem_ctx, int level, PyObject *in);\n");
 690                 $self->pidl("{");
 691                 $self->indent;
 692                 $self->FromPythonToUnionFunction($actual_ctype, mapTypeName($d), "level", "mem_ctx", "in") if ($actual_ctype->{TYPE} eq "UNION");
 693                 $self->deindent;
 694                 $self->pidl("}");
 695                 $self->pidl("");
 696
 697                 my $getsetters = "NULL";
 698                 my $py_methods = "NULL";
 699                 my $typename = mapTypeName($d);
 700
 701                 ##
 702                 ## PyCapsule (starting with 2.7) vs. PyCObject (up to 3.2)
 703                 ##
 704                 ## As we need to support python 2.6, we can't use PyCapsule yet.
 705                 ##
 706                 ## When we'll get support fpr Python3 we'll have to emulate
 707                 ## PyCObject using PyCapsule and convert these functions to
 708                 ## use PyCapsule.
 709                 ##
 710                 $self->pidl("static PyObject *py_$d->{NAME}\_import(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 711                 $self->pidl("{");
 712                 $self->indent;
 713                 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
 714                 $self->pidl("PyObject *mem_ctx_obj = NULL;");
 715                 $self->pidl("static const char *mem_ctx_type = \"TALLOC_CTX\";");
 716                 $self->pidl("const char *mem_ctx_desc = NULL;");
 717                 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
 718                 $self->pidl("int level = 0;");
 719                 $self->pidl("PyObject *in_obj = NULL;");
 720                 $self->pidl("static const char *in_type = \"$typename\";");
 721                 $self->pidl("const char *in_desc = NULL;");
 722                 $self->pidl("$typename *in = NULL;");
 723                 $self->pidl("int cmp;");
 724                 $self->pidl("");
 725                 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
 726                 $self->indent;
 727                 $self->pidl("discard_const_p(char *, kwnames),");
 728                 $self->pidl("&mem_ctx_obj,");
 729                 $self->pidl("&level,");
 730                 $self->pidl("&in_obj)) {");
 731                 $self->deindent;
 732                 $self->indent;
 733                 $self->pidl("return NULL;");
 734                 $self->deindent;
 735                 $self->pidl("}");
 736                 $self->pidl("if (!PyCObject_Check(mem_ctx_obj)) {");
 737                 $self->indent;
 738                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx needs to be of type PyCObject!\");");
 739                 $self->pidl("return NULL;");
 740                 $self->deindent;
 741                 $self->pidl("}");
 742                 $self->pidl("mem_ctx_desc = (const char *)PyCObject_GetDesc(mem_ctx_obj);");
 743                 $self->indent;
 744                 $self->pidl("if (mem_ctx_desc == NULL) {");
 745                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx hash no PyCObject_GetDesc()!\");");
 746                 $self->pidl("return NULL;");
 747                 $self->deindent;
 748                 $self->pidl("}");
 749                 $self->pidl("cmp = strncmp(mem_ctx_type, mem_ctx_desc, strlen(mem_ctx_type) + 1);");
 750                 $self->pidl("if (cmp != 0) {");
 751                 $self->indent;
 752                 $self->pidl("PyErr_Format(PyExc_TypeError, \"mem_ctx should have PyCObject_GetDesc() = %s!\", mem_ctx_type);");
 753                 $self->pidl("return NULL;");
 754                 $self->deindent;
 755                 $self->pidl("}");
 756                 $self->pidl("mem_ctx = PyCObject_AsVoidPtr(mem_ctx_obj);");
 757                 $self->pidl("if (mem_ctx == NULL) {");
 758                 $self->indent;
 759                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
 760                 $self->pidl("return NULL;");
 761                 $self->deindent;
 762                 $self->pidl("}");
 763                 $self->pidl("if (!PyCObject_Check(in_obj)) {");
 764                 $self->indent;
 765                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"in needs to be of type PyCObject!\");");
 766                 $self->pidl("return NULL;");
 767                 $self->deindent;
 768                 $self->pidl("}");
 769                 $self->pidl("in_desc = (const char *)PyCObject_GetDesc(in_obj);");
 770                 $self->indent;
 771                 $self->pidl("if (in_desc == NULL) {");
 772                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"in hash no PyCObject_GetDesc()!\");");
 773                 $self->pidl("return NULL;");
 774                 $self->deindent;
 775                 $self->pidl("}");
 776                 $self->pidl("cmp = strncmp(in_type, in_desc, strlen(in_type) + 1);");
 777                 $self->pidl("if (cmp != 0) {");
 778                 $self->indent;
 779                 $self->pidl("PyErr_Format(PyExc_TypeError, \"in should have PyCObject_GetDesc() = %s!\", in_type);");
 780                 $self->pidl("return NULL;");
 781                 $self->deindent;
 782                 $self->pidl("}");
 783                 $self->pidl("in = ($typename *)PyCObject_AsVoidPtr(in_obj);");
 784                 $self->pidl("");
 785                 $self->pidl("return py_import_$d->{NAME}(mem_ctx, level, in);");
 786                 $self->deindent;
 787                 $self->pidl("}");
 788                 $self->pidl("");
 789
 790                 $self->pidl("static PyObject *py_$d->{NAME}\_export(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 791                 $self->pidl("{");
 792                 $self->indent;
 793                 $self->pidl("const char * const kwnames[] = { \"mem_ctx\", \"level\", \"in\", NULL };");
 794                 $self->pidl("PyObject *mem_ctx_obj = NULL;");
 795                 $self->pidl("static const char *mem_ctx_type = \"TALLOC_CTX\";");
 796                 $self->pidl("const char *mem_ctx_desc = NULL;");
 797                 $self->pidl("TALLOC_CTX *mem_ctx = NULL;");
 798                 $self->pidl("int level = 0;");
 799                 $self->pidl("PyObject *in = NULL;");
 800                 $self->pidl("static const char *out_type = \"$typename\";");
 801                 $self->pidl("$typename *out = NULL;");
 802                 $self->pidl("int cmp;");
 803                 $self->pidl("");
 804                 $self->pidl("if (!PyArg_ParseTupleAndKeywords(args, kwargs, \"OiO:import\",");
 805                 $self->indent;
 806                 $self->pidl("discard_const_p(char *, kwnames),");
 807                 $self->pidl("&mem_ctx_obj,");
 808                 $self->pidl("&level,");
 809                 $self->pidl("&in)) {");
 810                 $self->deindent;
 811                 $self->indent;
 812                 $self->pidl("return NULL;");
 813                 $self->deindent;
 814                 $self->pidl("}");
 815                 $self->pidl("if (!PyCObject_Check(mem_ctx_obj)) {");
 816                 $self->indent;
 817                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx needs to be of type PyCObject!\");");
 818                 $self->pidl("return NULL;");
 819                 $self->deindent;
 820                 $self->pidl("}");
 821                 $self->pidl("mem_ctx_desc = (const char *)PyCObject_GetDesc(mem_ctx_obj);");
 822                 $self->indent;
 823                 $self->pidl("if (mem_ctx_desc == NULL) {");
 824                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx hash no PyCObject_GetDesc()!\");");
 825                 $self->pidl("return NULL;");
 826                 $self->deindent;
 827                 $self->pidl("}");
 828                 $self->pidl("cmp = strncmp(mem_ctx_type, mem_ctx_desc, strlen(mem_ctx_type) + 1);");
 829                 $self->pidl("if (cmp != 0) {");
 830                 $self->indent;
 831                 $self->pidl("PyErr_Format(PyExc_TypeError, \"mem_ctx should have PyCObject_GetDesc() = %s!\", mem_ctx_type);");
 832                 $self->pidl("return NULL;");
 833                 $self->deindent;
 834                 $self->pidl("}");
 835                 $self->pidl("mem_ctx = PyCObject_AsVoidPtr(mem_ctx_obj);");
 836                 $self->pidl("if (mem_ctx == NULL) {");
 837                 $self->indent;
 838                 $self->pidl("PyErr_SetString(PyExc_TypeError, \"mem_ctx is NULL)!\");");
 839                 $self->pidl("return NULL;");
 840                 $self->deindent;
 841                 $self->pidl("}");
 842                 $self->pidl("");
 843                 $self->pidl("out = py_export_$d->{NAME}(mem_ctx, level, in);");
 844                 $self->pidl("if (out == NULL) {");
 845                 $self->indent;
 846                 $self->pidl("return NULL;");
 847                 $self->deindent;
 848                 $self->pidl("}");
 849                 $self->pidl("return PyCObject_FromVoidPtrAndDesc(out, discard_const_p(char, out_type), NULL);");
 850                 $self->deindent;
 851                 $self->pidl("}");
 852                 $self->pidl("");
 853
 854                 $py_methods = "py_$d->{NAME}_methods";
 855                 $self->pidl("static PyMethodDef $py_methods\[] = {");
 856                 $self->indent;
 857                 $self->pidl("{ \"__import__\", (PyCFunction)py_$d->{NAME}\_import,");
 858                 $self->indent;
 859                 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
 860                 $self->pidl("\"T.__import__(mem_ctx, level, in) => ret.\" },");
 861                 $self->deindent;
 862                 $self->pidl("{ \"__export__\", (PyCFunction)py_$d->{NAME}\_export,");
 863                 $self->indent;
 864                 $self->pidl("METH_VARARGS|METH_KEYWORDS|METH_CLASS,");
 865                 $self->pidl("\"T.__export__(mem_ctx, level, in) => ret.\" },");
 866                 $self->deindent;
 867                 $self->pidl("{ NULL, NULL, 0, NULL }");
 868                 $self->deindent;
 869                 $self->pidl("};");
 870                 $self->pidl("");
 871
 872                 $self->pidl("static PyObject *py_$d->{NAME}\_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 873                 $self->pidl("{");
 874                 $self->indent;
 875                 $self->pidl("PyErr_Format(PyExc_TypeError, \"New %s Objects are not supported\", type->tp_name);");
 876                 $self->pidl("return NULL;");
 877                 $self->deindent;
 878                 $self->pidl("}");
 879                 $self->pidl("");
 880
 881                 $self->pidl("");
 882                 $self->pidl_hdr("static PyTypeObject $typeobject;\n");
 883                 $self->pidl("static PyTypeObject $typeobject = {");
 884                 $self->indent;
 885                 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
 886                 $self->pidl(".tp_name = \"$modulename.$prettyname\",");
 887                 $self->pidl(".tp_getset = $getsetters,");
 888                 if ($docstring) {
 889                         $self->pidl(".tp_doc = $docstring,");
 890                 }
 891                 $self->pidl(".tp_methods = $py_methods,");
 892                 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
 893                 $self->pidl(".tp_new = py_$d->{NAME}\_new,");
 894                 $self->deindent;
 895                 $self->pidl("};");
 896
 897                 $self->pidl("");
 898
 899                 my $talloc_typename = $self->import_type_variable("talloc", "BaseObject");
 900                 $self->register_module_prereadycode(["$typeobject.tp_base = $talloc_typename;",
 901                                                      "$typeobject.tp_basicsize = pytalloc_BaseObject_size();",
 902                                                      ""]);
 903
 904                 $self->register_module_typeobject($prettyname, "&$typeobject", $d->{ORIGINAL});
 905         }
 906 }
 907
 908 sub DocString($$$)
 909 {
 910         my ($self, $d, $name) = @_;
 911         if (has_property($d, "helpstring")) {
 912                 my $docstring = uc("py_doc_$name");
 913                 $self->pidl("#define $docstring ".has_property($d, "helpstring"));
 914                 return $docstring;
 915         }
 916
 917         return undef;
 918 }
 919
 920 sub Interface($$$)
 921 {
 922         my($self,$interface,$basename) = @_;
 923
 924         if (has_property($interface, "pyhelper")) {
 925                 $self->pidl("#include \"".unmake_str($interface->{PROPERTIES}->{pyhelper})."\"\n");
 926         }
 927
 928         $self->Const($_) foreach (@{$interface->{CONSTS}});
 929
 930         foreach my $d (@{$interface->{TYPES}}) {
 931                 next if has_property($d, "nopython");
 932
 933                 $self->PythonType($basename, $d, $interface, $basename);
 934         }
 935
 936         if (defined $interface->{PROPERTIES}->{uuid}) {
 937                 $self->pidl_hdr("static PyTypeObject $interface->{NAME}_InterfaceType;\n");
 938                 $self->pidl("");
 939
 940                 my @fns = ();
 941
 942                 foreach my $d (@{$interface->{FUNCTIONS}}) {
 943                         next if has_property($d, "noopnum");
 944                         next if has_property($d, "nopython");
 945                         next if has_property($d, "todo");
 946
 947                         my $skip = 0;
 948                         foreach my $e (@{$d->{ELEMENTS}}) {
 949                                 if (ContainsPipe($e, $e->{LEVELS}[0])) {
 950                                         $skip = 1;
 951                                         last;
 952                                 }
 953                         }
 954                         next if $skip;
 955
 956                         my $prettyname = $d->{NAME};
 957
 958                         $prettyname =~ s/^$interface->{NAME}_//;
 959                         $prettyname =~ s/^$basename\_//;
 960
 961                         my ($infn, $outfn, $fndocstring) = $self->PythonFunction($d, $interface->{NAME}, $prettyname);
 962
 963                         push (@fns, [$infn, $outfn, "dcerpc_$d->{NAME}_r", $prettyname, $fndocstring, $d->{OPNUM}]);
 964                 }
 965
 966                 $self->pidl("const struct PyNdrRpcMethodDef py_ndr_$interface->{NAME}\_methods[] = {");
 967                 $self->indent;
 968                 foreach my $d (@fns) {
 969                         my ($infn, $outfn, $callfn, $prettyname, $docstring, $opnum) = @$d;
 970                         $self->pidl("{ \"$prettyname\", $docstring, (py_dcerpc_call_fn)$callfn, (py_data_pack_fn)$infn, (py_data_unpack_fn)$outfn, $opnum, &ndr_table_$interface->{NAME} },");
 971                 }
 972                 $self->pidl("{ NULL }");
 973                 $self->deindent;
 974                 $self->pidl("};");
 975                 $self->pidl("");
 976
 977                 $self->pidl("static PyObject *interface_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
 978                 $self->pidl("{");
 979                 $self->indent;
 980                 $self->pidl("return py_dcerpc_interface_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME});");
 981                 $self->deindent;
 982                 $self->pidl("}");
 983
 984                 $self->pidl("");
 985
 986                 my $signature =
 987 "\"$interface->{NAME}(binding, lp_ctx=None, credentials=None) -> connection\\n\"
 988 \"\\n\"
 989 \"binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\\n\"
 990 \"lp_ctx should be a path to a smb.conf file or a param.LoadParm object\\n\"
 991 \"credentials should be a credentials.Credentials object.\\n\\n\"";
 992
 993                 my $docstring = $self->DocString($interface, $interface->{NAME});
 994
 995                 if ($docstring) {
 996                         $docstring = "$signature$docstring";
 997                 } else {
 998                         $docstring = $signature;
 999                 }
1000
1001                 my $if_typename = "$interface->{NAME}_InterfaceType";
1002
1003                 $self->pidl("static PyTypeObject $if_typename = {");
1004                 $self->indent;
1005                 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1006                 $self->pidl(".tp_name = \"$basename.$interface->{NAME}\",");
1007                 $self->pidl(".tp_basicsize = sizeof(dcerpc_InterfaceObject),");
1008                 $self->pidl(".tp_doc = $docstring,");
1009                 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1010                 $self->pidl(".tp_new = interface_$interface->{NAME}_new,");
1011                 $self->deindent;
1012                 $self->pidl("};");
1013
1014                 $self->pidl("");
1015
1016                 $self->register_module_typeobject($interface->{NAME}, "&$if_typename", $interface->{ORIGINAL});
1017                 my $dcerpc_typename = $self->import_type_variable("samba.dcerpc.base", "ClientConnection");
1018                 $self->register_module_prereadycode(["$if_typename.tp_base = $dcerpc_typename;", ""]);
1019                 $self->register_module_postreadycode(["if (!PyInterface_AddNdrRpcMethods(&$if_typename, py_ndr_$interface->{NAME}\_methods))", "\treturn;", ""]);
1020
1021
1022                 $self->pidl("static PyObject *syntax_$interface->{NAME}_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)");
1023                 $self->pidl("{");
1024                 $self->indent;
1025                 $self->pidl("return py_dcerpc_syntax_init_helper(type, args, kwargs, &ndr_table_$interface->{NAME}.syntax_id);");
1026                 $self->deindent;
1027                 $self->pidl("}");
1028
1029                 $self->pidl("");
1030
1031                 my $signature = "\"$interface->{NAME}_abstract_syntax()\\n\"";
1032
1033                 my $docstring = $self->DocString($interface, $interface->{NAME}."_syntax");
1034
1035                 if ($docstring) {
1036                         $docstring = "$signature$docstring";
1037                 } else {
1038                         $docstring = $signature;
1039                 }
1040
1041                 my $syntax_typename = "$interface->{NAME}_SyntaxType";
1042
1043                 $self->pidl("static PyTypeObject $syntax_typename = {");
1044                 $self->indent;
1045                 $self->pidl("PyObject_HEAD_INIT(NULL) 0,");
1046                 $self->pidl(".tp_name = \"$basename.$interface->{NAME}_abstract_syntax\",");
1047                 $self->pidl(".tp_doc = $docstring,");
1048                 $self->pidl(".tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,");
1049                 $self->pidl(".tp_new = syntax_$interface->{NAME}_new,");
1050                 $self->deindent;
1051                 $self->pidl("};");
1052
1053                 $self->pidl("");
1054
1055                 $self->register_module_typeobject("$interface->{NAME}_abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1056                 if (not defined($self->existing_module_object("abstract_syntax"))) {
1057                         # Only the first syntax gets registered with the legacy
1058                         # "abstract_syntax" name
1059                         $self->register_module_typeobject("abstract_syntax", "&$syntax_typename", $interface->{ORIGINAL});
1060                 }
1061                 my $ndr_typename = $self->import_type_variable("samba.dcerpc.misc", "ndr_syntax_id");
1062                 $self->register_module_prereadycode(["$syntax_typename.tp_base = $ndr_typename;",
1063                                                      "$syntax_typename.tp_basicsize = pytalloc_BaseObject_size();",
1064                                                      ""]);
1065         }
1066
1067         $self->pidl_hdr("\n");
1068 }
1069
1070 sub register_module_method($$$$$)
1071 {
1072         my ($self, $fn_name, $pyfn_name, $flags, $doc) = @_;
1073
1074         push (@{$self->{module_methods}}, [$fn_name, $pyfn_name, $flags, $doc])
1075 }
1076
1077 sub register_module_typeobject($$$$)
1078 {
1079         my ($self, $name, $py_name, $location) = @_;
1080
1081         $self->register_module_object($name, "(PyObject *)(void *)$py_name", $location);
1082
1083         $self->check_ready_type($py_name);
1084
1085         $self->register_patch_type_call($name, $py_name);
1086 }
1087
1088 sub check_ready_type($$)
1089 {
1090         my ($self, $py_name) = @_;
1091         push (@{$self->{ready_types}}, $py_name) unless (grep(/^$py_name$/,@{$self->{ready_types}}));
1092 }
1093
1094 sub register_module_import($$)
1095 {
1096         my ($self, $module_path) = @_;
1097
1098         my $var_name = $module_path;
1099         $var_name =~ s/\./_/g;
1100         $var_name = "dep_$var_name";
1101
1102         unless (defined $self->{module_imports_uniq}->{$var_name}) {
1103                 my $h = { "key" => $var_name, "val" => $module_path};
1104                 push @{$self->{module_imports}}, $h;
1105                 $self->{module_imports_uniq}->{$var_name} = $h;
1106         }
1107         return $var_name;
1108 }
1109
1110 sub import_type_variable($$$)
1111 {
1112         my ($self, $module, $name) = @_;
1113
1114         $self->register_module_import($module);
1115         unless (defined $self->{type_imports_uniq}->{$name}) {
1116                 my $h = { "key" => $name, "val" => $module};
1117                 push @{$self->{type_imports}}, $h;
1118                 $self->{type_imports_uniq}->{$name} = $h;
1119         }
1120         return "$name\_Type";
1121 }
1122
1123 sub use_type_variable($$)
1124 {
1125         my ($self, $orig_ctype) = @_;
1126         # FIXME: Have a global lookup table for types that look different on the
1127         # wire than they are named in C?
1128         if ($orig_ctype->{NAME} eq "dom_sid2" or
1129             $orig_ctype->{NAME} eq "dom_sid28" or
1130             $orig_ctype->{NAME} eq "dom_sid0") {
1131                 $orig_ctype->{NAME} = "dom_sid";
1132         }
1133         if ($orig_ctype->{NAME} eq "spoolss_security_descriptor") {
1134                 $orig_ctype->{NAME} = "security_descriptor";
1135         }
1136
1137         my $ctype = resolveType($orig_ctype);
1138         unless (defined($ctype->{BASEFILE})) {
1139                 return undef;
1140         }
1141         # If this is an external type, make sure we do the right imports.
1142         if (($ctype->{BASEFILE} ne $self->{BASENAME})) {
1143                 return $self->import_type_variable("samba.dcerpc.$ctype->{BASEFILE}", $ctype->{NAME});
1144         }
1145         return "&$ctype->{NAME}_Type";
1146 }
1147
1148 sub register_patch_type_call($$$)
1149 {
1150         my ($self, $typename, $cvar) = @_;
1151
1152         push(@{$self->{patch_type_calls}}, [$typename, $cvar]);
1153
1154 }
1155
1156 sub register_module_prereadycode($$)
1157 {
1158         my ($self, $code) = @_;
1159
1160         push (@{$self->{prereadycode}}, @$code);
1161 }
1162
1163 sub register_module_postreadycode($$)
1164 {
1165         my ($self, $code) = @_;
1166
1167         push (@{$self->{postreadycode}}, @$code);
1168 }
1169
1170 sub existing_module_object($$)
1171 {
1172         my ($self, $name) = @_;
1173
1174         if (defined($self->{module_object_uniq}->{$name})) {
1175                 return $self->{module_object_uniq}->{$name};
1176         }
1177
1178         return undef;
1179 }
1180
1181 sub register_module_object($$$$)
1182 {
1183         my ($self, $name, $py_name, $location) = @_;
1184
1185         my $existing = $self->existing_module_object($name);
1186         fatal($location, "module_object($name, $py_name) registered twice! $existing.") if defined($existing);
1187
1188         push (@{$self->{module_objects}}, [$name, $py_name]);
1189         $self->{module_object_uniq}->{$name} = $py_name;
1190 }
1191
1192 sub assign($$$)
1193 {
1194         my ($self, $dest, $src) = @_;
1195         if ($dest =~ /^\&/ and $src eq "NULL") {
1196                 $self->pidl("memset($dest, 0, sizeof(" . get_value_of($dest) . "));");
1197         } elsif ($dest =~ /^\&/) {
1198                 my $destvar = get_value_of($dest);
1199                 $self->pidl("$destvar = *$src;");
1200         } else {
1201                 $self->pidl("$dest = $src;");
1202         }
1203 }
1204
1205 sub ConvertStringFromPythonData($$$$$)
1206 {
1207         my ($self, $mem_ctx, $py_var, $target, $fail) = @_;
1208
1209         $self->pidl("{");
1210         $self->indent;
1211         $self->pidl("const char *test_str;");
1212         $self->pidl("const char *talloc_str;");
1213         $self->pidl("PyObject *unicode = NULL;");
1214         $self->pidl("if (PyUnicode_Check($py_var)) {");
1215         $self->indent;
1216         # FIXME: Use Unix charset setting rather than utf-8
1217         $self->pidl("unicode = PyUnicode_AsEncodedString($py_var, \"utf-8\", \"ignore\");");
1218         $self->pidl("if (unicode == NULL) {");
1219         $self->indent;
1220         $self->pidl("PyErr_NoMemory();");
1221         $self->pidl("$fail");
1222         $self->deindent;
1223         $self->pidl("}");
1224
1225         $self->pidl("test_str = PyString_AS_STRING(unicode);");
1226         $self->deindent;
1227         $self->pidl("} else if (PyString_Check($py_var)) {");
1228         $self->indent;
1229         $self->pidl("test_str = PyString_AS_STRING($py_var);");
1230         $self->deindent;
1231         $self->pidl("} else {");
1232         $self->indent;
1233         $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected string or unicode object, got %s\", Py_TYPE($py_var)->tp_name);");
1234         $self->pidl("$fail");
1235         $self->deindent;
1236         $self->pidl("}");
1237         $self->pidl("talloc_str = talloc_strdup($mem_ctx, test_str);");
1238         $self->pidl("if (unicode != NULL) {");
1239         $self->indent;
1240         $self->pidl("Py_DECREF(unicode);");
1241         $self->deindent;
1242         $self->pidl("}");
1243         $self->pidl("if (talloc_str == NULL) {");
1244         $self->indent;
1245         $self->pidl("PyErr_NoMemory();");
1246         $self->pidl("$fail");
1247         $self->deindent;
1248         $self->pidl("}");
1249         $self->pidl("$target = talloc_str;");
1250         $self->deindent;
1251         $self->pidl("}");
1252 }
1253
1254 sub ConvertObjectFromPythonData($$$$$$;$)
1255 {
1256         my ($self, $mem_ctx, $cvar, $ctype, $target, $fail, $location) = @_;
1257
1258         fatal($location, "undef type for $cvar") unless(defined($ctype));
1259
1260         $ctype = resolveType($ctype);
1261
1262         my $actual_ctype = $ctype;
1263         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1264                 $actual_ctype = $actual_ctype->{DATA};
1265         }
1266
1267         # We need to cover ENUMs, BITMAPS and SCALAR values here, as
1268         # all could otherwise be assigned invalid integer values
1269         my $ctype_alias = "";
1270         my $uint_max = "";
1271         if ($actual_ctype->{TYPE} eq "ENUM") {
1272                 # Importantly, ENUM values are unsigned in pidl, and
1273                 # typically map to uint32
1274                 $ctype_alias = enum_type_fn($actual_ctype);
1275         } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1276                 $ctype_alias = bitmap_type_fn($actual_ctype);
1277         } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1278                 $ctype_alias = expandAlias($actual_ctype->{NAME});
1279         }
1280
1281         # This is the unsigned Python Integer -> C integer validation
1282         # case.  The signed case is below.
1283         if ($ctype_alias  =~ /^(uint[0-9]*|hyper|udlong|udlongr
1284                                 |NTTIME_hyper|NTTIME|NTTIME_1sec
1285                                 |uid_t|gid_t)$/x) {
1286                 $self->pidl("{");
1287                 $self->indent;
1288                 $self->pidl("const unsigned long long uint_max = ndr_sizeof2uintmax(sizeof($target));");
1289                 $self->pidl("if (PyLong_Check($cvar)) {");
1290                 $self->indent;
1291                 $self->pidl("unsigned long long test_var;");
1292                 $self->pidl("test_var = PyLong_AsUnsignedLongLong($cvar);");
1293                 $self->pidl("if (PyErr_Occurred() != NULL) {");
1294                 $self->indent;
1295                 $self->pidl($fail);
1296                 $self->deindent;
1297                 $self->pidl("}");
1298                 $self->pidl("if (test_var > uint_max) {");
1299                 $self->indent;
1300                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %llu\",\\");
1301                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1302                 $self->pidl($fail);
1303                 $self->deindent;
1304                 $self->pidl("}");
1305                 $self->pidl("$target = test_var;");
1306                 $self->deindent;
1307                 $self->pidl("} else if (PyInt_Check($cvar)) {");
1308                 $self->indent;
1309                 $self->pidl("long test_var;");
1310                 $self->pidl("test_var = PyInt_AsLong($cvar);");
1311                 $self->pidl("if (test_var < 0 || test_var > uint_max) {");
1312                 $self->indent;
1313                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range 0 - %llu, got %ld\",\\");
1314                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, uint_max, test_var);");
1315                 $self->pidl($fail);
1316                 $self->deindent;
1317                 $self->pidl("}");
1318                 $self->pidl("$target = test_var;");
1319                 $self->deindent;
1320                 $self->pidl("} else {");
1321                 $self->indent;
1322                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1323                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
1324                 $self->pidl($fail);
1325                 $self->deindent;
1326                 $self->pidl("}");
1327                 $self->deindent;
1328                 $self->pidl("}");
1329                 return;
1330         }
1331
1332         # Confirm the signed python integer fits in the C type
1333         # correctly.  It is subtly different from the unsigned case
1334         # above, so while it looks like a duplicate, it is not
1335         # actually a duplicate.
1336         if ($ctype_alias  =~ /^(dlong|char|int[0-9]*|time_t)$/x) {
1337                 $self->pidl("{");
1338                 $self->indent;
1339                 $self->pidl("const long long int_max = ndr_sizeof2intmax(sizeof($target));");
1340                 $self->pidl("const long long int_min = -int_max - 1;");
1341                 $self->pidl("if (PyLong_Check($cvar)) {");
1342                 $self->indent;
1343                 $self->pidl("long long test_var;");
1344                 $self->pidl("test_var = PyLong_AsLongLong($cvar);");
1345                 $self->pidl("if (PyErr_Occurred() != NULL) {");
1346                 $self->indent;
1347                 $self->pidl($fail);
1348                 $self->deindent;
1349                 $self->pidl("}");
1350                 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1351                 $self->indent;
1352                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %lld\",\\");
1353                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1354                 $self->pidl($fail);
1355                 $self->deindent;
1356                 $self->pidl("}");
1357                 $self->pidl("$target = test_var;");
1358                 $self->deindent;
1359                 $self->pidl("} else if (PyInt_Check($cvar)) {");
1360                 $self->indent;
1361                 $self->pidl("long test_var;");
1362                 $self->pidl("test_var = PyInt_AsLong($cvar);");
1363                 $self->pidl("if (test_var < int_min || test_var > int_max) {");
1364                 $self->indent;
1365                 $self->pidl("PyErr_Format(PyExc_OverflowError, \"Expected type %s or %s within range %lld - %lld, got %ld\",\\");
1366                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name, int_min, int_max, test_var);");
1367                 $self->pidl($fail);
1368                 $self->deindent;
1369                 $self->pidl("}");
1370                 $self->pidl("$target = test_var;");
1371                 $self->deindent;
1372                 $self->pidl("} else {");
1373                 $self->indent;
1374                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected type %s or %s\",\\");
1375                 $self->pidl("  PyInt_Type.tp_name, PyLong_Type.tp_name);");
1376                 $self->pidl($fail);
1377                 $self->deindent;
1378                 $self->pidl("}");
1379                 $self->deindent;
1380                 $self->pidl("}");
1381                 return;
1382         }
1383
1384         if ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1385                 my $ctype_name = $self->use_type_variable($ctype);
1386                 unless (defined ($ctype_name)) {
1387                         error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1388                         $self->pidl("PyErr_SetString(PyExc_TypeError, \"Can not convert C Type " . mapTypeName($ctype) . " from Python\");");
1389                         return;
1390                 }
1391                 $self->pidl("PY_CHECK_TYPE($ctype_name, $cvar, $fail);");
1392                 $self->pidl("if (talloc_reference($mem_ctx, pytalloc_get_mem_ctx($cvar)) == NULL) {");
1393                 $self->indent;
1394                 $self->pidl("PyErr_NoMemory();");
1395                 $self->pidl("$fail");
1396                 $self->deindent;
1397                 $self->pidl("}");
1398                 $self->assign($target, "(".mapTypeName($ctype)." *)pytalloc_get_ptr($cvar)");
1399                 return;
1400         }
1401
1402         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "DATA_BLOB") {
1403                 $self->pidl("$target = data_blob_talloc($mem_ctx, PyString_AS_STRING($cvar), PyString_GET_SIZE($cvar));");
1404                 return;
1405         }
1406
1407         if ($actual_ctype->{TYPE} eq "SCALAR" and
1408                 ($actual_ctype->{NAME} eq "string"
1409                  or $actual_ctype->{NAME} eq "nbt_string"
1410                  or $actual_ctype->{NAME} eq "nbt_name"
1411                  or $actual_ctype->{NAME} eq "wrepl_nbt_name"
1412                  or $actual_ctype->{NAME} eq "dns_string"
1413                  or $actual_ctype->{NAME} eq "dnsp_string"
1414                  or $actual_ctype->{NAME} eq "dns_name"
1415                  or $actual_ctype->{NAME} eq "ipv4address"
1416                  or $actual_ctype->{NAME} eq "ipv6address"
1417                  or $actual_ctype->{NAME} eq "dnsp_name")) {
1418                 $self->ConvertStringFromPythonData($mem_ctx, $cvar, $target, $fail);
1419                 return;
1420         }
1421
1422         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "NTSTATUS") {
1423                 $self->pidl("$target = NT_STATUS(PyInt_AsLong($cvar));");
1424                 return;
1425         }
1426
1427         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "WERROR") {
1428                 $self->pidl("$target = W_ERROR(PyInt_AsLong($cvar));");
1429                 return;
1430         }
1431
1432         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "HRESULT") {
1433                 $self->pidl("$target = HRES_ERROR(PyInt_AsLong($cvar));");
1434                 return;
1435         }
1436
1437         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "string_array") {
1438                 $self->pidl("$target = PyCObject_AsVoidPtr($cvar);");
1439                 return;
1440         }
1441
1442         if ($actual_ctype->{TYPE} eq "SCALAR" and $actual_ctype->{NAME} eq "pointer") {
1443                 $self->assign($target, "PyCObject_AsVoidPtr($cvar)");
1444                 return;
1445         }
1446
1447         fatal($location, "unknown type `$actual_ctype->{TYPE}' for ".mapTypeName($ctype) . ": $cvar");
1448
1449 }
1450
1451 sub ConvertObjectFromPythonLevel($$$$$$$$)
1452 {
1453         my ($self, $env, $mem_ctx, $py_var, $e, $l, $var_name, $fail) = @_;
1454         my $nl = GetNextLevel($e, $l);
1455         if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1456                 $nl = GetNextLevel($e, $nl);
1457         }
1458         my $pl = GetPrevLevel($e, $l);
1459         if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1460                 $pl = GetPrevLevel($e, $pl);
1461         }
1462
1463         $self->pidl("if ($py_var == NULL) {");
1464         $self->indent;
1465         $self->pidl("PyErr_Format(PyExc_AttributeError, \"Cannot delete NDR object: " .
1466                     mapTypeName($var_name) . "\");");
1467         $self->pidl($fail);
1468         $self->deindent;
1469         $self->pidl("}");
1470
1471         if ($l->{TYPE} eq "POINTER") {
1472                 if ($l->{POINTER_TYPE} ne "ref") {
1473                         $self->pidl("if ($py_var == Py_None) {");
1474                         $self->indent;
1475                         $self->pidl("$var_name = NULL;");
1476                         $self->deindent;
1477                         $self->pidl("} else {");
1478                         $self->indent;
1479                 }
1480                 # if we want to handle more than one level of pointer in python interfaces
1481                 # then this is where we would need to allocate it
1482                 if ($l->{POINTER_TYPE} eq "ref") {
1483                         $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1484                         $self->pidl("if ($var_name == NULL) {");
1485                         $self->indent;
1486                         $self->pidl("PyErr_NoMemory();");
1487                         $self->pidl($fail);
1488                         $self->deindent;
1489                         $self->pidl("}");
1490                 } elsif ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::is_scalar($nl->{DATA_TYPE})
1491                          and not Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1492                         $self->pidl("$var_name = talloc_ptrtype($mem_ctx, $var_name);");
1493                         $self->pidl("if ($var_name == NULL) {");
1494                         $self->indent;
1495                         $self->pidl("PyErr_NoMemory();");
1496                         $self->pidl($fail);
1497                         $self->deindent;
1498                         $self->pidl("}");
1499                 } else {
1500                         $self->pidl("$var_name = NULL;");
1501                 }
1502                 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1503                         $var_name = get_value_of($var_name);
1504                 }
1505                 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1506                 if ($l->{POINTER_TYPE} ne "ref") {
1507                         $self->deindent;
1508                         $self->pidl("}");
1509                 }
1510         } elsif ($l->{TYPE} eq "ARRAY") {
1511                 if ($pl && $pl->{TYPE} eq "POINTER") {
1512                         $var_name = get_pointer_to($var_name);
1513                 }
1514
1515                 if (is_charset_array($e, $l)) {
1516                         $self->ConvertStringFromPythonData($mem_ctx, $py_var, $var_name, $fail);
1517                 } else {
1518                         my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1519                         $self->pidl("PY_CHECK_TYPE(&PyList_Type, $py_var, $fail);");
1520                         $self->pidl("{");
1521                         $self->indent;
1522                         $self->pidl("int $counter;");
1523                         if (ArrayDynamicallyAllocated($e, $l)) {
1524                                 $self->pidl("$var_name = talloc_array_ptrtype($mem_ctx, $var_name, PyList_GET_SIZE($py_var));");
1525                                 $self->pidl("if (!$var_name) { $fail; }");
1526                                 $self->pidl("talloc_set_name_const($var_name, \"ARRAY: $var_name\");");
1527                         } else {
1528                                 $self->pidl("if (ARRAY_SIZE($var_name) != PyList_GET_SIZE($py_var)) {");
1529                                 $self->indent;
1530                                 $self->pidl("PyErr_Format(PyExc_TypeError, \"Expected list of type %s, length %zu, got %zd\", Py_TYPE($py_var)->tp_name, ARRAY_SIZE($var_name),  PyList_GET_SIZE($py_var));");
1531                                 $self->pidl("$fail");
1532                                 $self->deindent;
1533                                 $self->pidl("}");
1534                         }
1535                         $self->pidl("for ($counter = 0; $counter < PyList_GET_SIZE($py_var); $counter++) {");
1536                         $self->indent;
1537                         $self->ConvertObjectFromPythonLevel($env, $var_name, "PyList_GET_ITEM($py_var, $counter)", $e, $nl, $var_name."[$counter]", $fail);
1538                         $self->deindent;
1539                         $self->pidl("}");
1540                         $self->deindent;
1541                         $self->pidl("}");
1542                 }
1543         } elsif ($l->{TYPE} eq "DATA") {
1544                 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1545                         $var_name = get_pointer_to($var_name);
1546                 }
1547                 $self->ConvertObjectFromPythonData($mem_ctx, $py_var, $l->{DATA_TYPE}, $var_name, $fail, $e->{ORIGINAL});
1548         } elsif ($l->{TYPE} eq "SWITCH") {
1549                 $var_name = get_pointer_to($var_name);
1550                 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1551                 my $switch_ptr = "$e->{NAME}_switch_$l->{LEVEL_INDEX}";
1552                 $self->pidl("{");
1553                 $self->indent;
1554                 my $union_type = mapTypeName($nl->{DATA_TYPE});
1555                 $self->pidl("$union_type *$switch_ptr;");
1556                 $self->pidl("$switch_ptr = py_export_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $py_var);");
1557                 $self->fail_on_null($switch_ptr, $fail);
1558                 $self->assign($var_name, "$switch_ptr");
1559                 $self->deindent;
1560                 $self->pidl("}");
1561         } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1562                 $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $py_var, $e, $nl, $var_name, $fail);
1563         } else {
1564                 fatal($e->{ORIGINAL}, "unknown level type $l->{TYPE}");
1565         }
1566 }
1567
1568 sub ConvertObjectFromPython($$$$$$$)
1569 {
1570         my ($self, $env, $mem_ctx, $ctype, $cvar, $target, $fail) = @_;
1571
1572         $self->ConvertObjectFromPythonLevel($env, $mem_ctx, $cvar, $ctype, $ctype->{LEVELS}[0], $target, $fail);
1573 }
1574
1575 sub ConvertScalarToPython($$$)
1576 {
1577         my ($self, $ctypename, $cvar) = @_;
1578
1579         die("expected string for $cvar, not $ctypename") if (ref($ctypename) eq "HASH");
1580
1581         $ctypename = expandAlias($ctypename);
1582
1583         if ($ctypename =~ /^(int64|dlong)$/) {
1584                 return "ndr_PyLong_FromLongLong($cvar)";
1585         }
1586
1587         if ($ctypename =~ /^(uint64|hyper|NTTIME_hyper|NTTIME|NTTIME_1sec|udlong|udlongr|uid_t|gid_t)$/) {
1588                 return "ndr_PyLong_FromUnsignedLongLong($cvar)";
1589         }
1590
1591         if ($ctypename =~ /^(char|int|int8|int16|int32|time_t)$/) {
1592                 return "PyInt_FromLong($cvar)";
1593         }
1594
1595         # Needed to ensure unsigned values in a 32 or 16 bit enum is
1596         # cast correctly to a uint32_t, not sign extended to a a
1597         # possibly 64 bit unsigned long.  (enums are signed in C,
1598         # unsigned in NDR)
1599         if ($ctypename =~ /^(uint32|uint3264)$/) {
1600                 return "ndr_PyLong_FromUnsignedLongLong((uint32_t)$cvar)";
1601         }
1602
1603         if ($ctypename =~ /^(uint|uint8|uint16|uint1632)$/) {
1604                 return "PyInt_FromLong((uint16_t)$cvar)";
1605         }
1606
1607         if ($ctypename eq "DATA_BLOB") {
1608                 return "PyString_FromStringAndSize((char *)($cvar).data, ($cvar).length)";
1609         }
1610
1611         if ($ctypename eq "NTSTATUS") {
1612                 return "PyErr_FromNTSTATUS($cvar)";
1613         }
1614
1615         if ($ctypename eq "WERROR") {
1616                 return "PyErr_FromWERROR($cvar)";
1617         }
1618
1619         if ($ctypename eq "HRESULT") {
1620                 return "PyErr_FromHRESULT($cvar)";
1621         }
1622
1623         if (($ctypename eq "string" or $ctypename eq "nbt_string" or $ctypename eq "nbt_name" or $ctypename eq "wrepl_nbt_name")) {
1624                 return "PyString_FromStringOrNULL($cvar)";
1625         }
1626
1627         if (($ctypename eq "dns_string" or $ctypename eq "dns_name")) {
1628                 return "PyString_FromStringOrNULL($cvar)";
1629         }
1630
1631         # Not yet supported
1632         if ($ctypename eq "string_array") { return "pytalloc_CObject_FromTallocPtr($cvar)"; }
1633         if ($ctypename eq "ipv4address") { return "PyString_FromStringOrNULL($cvar)"; }
1634         if ($ctypename eq "ipv6address") { return "PyString_FromStringOrNULL($cvar)"; }
1635         if ($ctypename eq "dnsp_name") { return "PyString_FromStringOrNULL($cvar)"; }
1636         if ($ctypename eq "dnsp_string") { return "PyString_FromStringOrNULL($cvar)"; }
1637         if ($ctypename eq "pointer") {
1638                 return "pytalloc_CObject_FromTallocPtr($cvar)";
1639         }
1640
1641         die("Unknown scalar type $ctypename");
1642 }
1643
1644 sub ConvertObjectToPythonData($$$$$;$)
1645 {
1646         my ($self, $mem_ctx, $ctype, $cvar, $location) = @_;
1647
1648         die("undef type for $cvar") unless(defined($ctype));
1649
1650         $ctype = resolveType($ctype);
1651
1652         my $actual_ctype = $ctype;
1653         if ($actual_ctype->{TYPE} eq "TYPEDEF") {
1654                 $actual_ctype = $actual_ctype->{DATA};
1655         }
1656
1657         if ($actual_ctype->{TYPE} eq "ENUM") {
1658                 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::enum_type_fn($actual_ctype), $cvar);
1659         } elsif ($actual_ctype->{TYPE} eq "BITMAP") {
1660                 return $self->ConvertScalarToPython(Parse::Pidl::Typelist::bitmap_type_fn($actual_ctype), $cvar);
1661         } elsif ($actual_ctype->{TYPE} eq "SCALAR") {
1662                 return $self->ConvertScalarToPython($actual_ctype->{NAME}, $cvar);
1663         } elsif ($actual_ctype->{TYPE} eq "UNION") {
1664                 fatal($ctype, "union without discriminant: " . mapTypeName($ctype) . ": $cvar");
1665         } elsif ($actual_ctype->{TYPE} eq "STRUCT" or $actual_ctype->{TYPE} eq "INTERFACE") {
1666                 my $ctype_name = $self->use_type_variable($ctype);
1667                 unless (defined($ctype_name)) {
1668                         error($location, "Unable to determine origin of type `" . mapTypeName($ctype) . "'");
1669                         return "NULL"; # FIXME!
1670                 }
1671                 return "pytalloc_reference_ex($ctype_name, $mem_ctx, $cvar)";
1672         }
1673
1674         fatal($location, "unknown type $actual_ctype->{TYPE} for ".mapTypeName($ctype) . ": $cvar");
1675 }
1676
1677 sub fail_on_null($$$)
1678 {
1679         my ($self, $var, $fail) = @_;
1680         $self->pidl("if ($var == NULL) {");
1681         $self->indent;
1682         $self->pidl($fail);
1683         $self->deindent;
1684         $self->pidl("}");
1685 }
1686
1687 sub ConvertObjectToPythonLevel($$$$$$)
1688 {
1689         my ($self, $mem_ctx, $env, $e, $l, $var_name, $py_var, $fail) = @_;
1690         my $nl = GetNextLevel($e, $l);
1691         if ($nl and $nl->{TYPE} eq "SUBCONTEXT") {
1692                 $nl = GetNextLevel($e, $nl);
1693         }
1694         my $pl = GetPrevLevel($e, $l);
1695         if ($pl and $pl->{TYPE} eq "SUBCONTEXT") {
1696                 $pl = GetPrevLevel($e, $pl);
1697         }
1698
1699         if ($l->{TYPE} eq "POINTER") {
1700                 if ($l->{POINTER_TYPE} ne "ref") {
1701                         $self->pidl("if ($var_name == NULL) {");
1702                         $self->indent;
1703                         $self->pidl("$py_var = Py_None;");
1704                         $self->pidl("Py_INCREF($py_var);");
1705                         $self->deindent;
1706                         $self->pidl("} else {");
1707                         $self->indent;
1708                 }
1709                 my $var_name2 = $var_name;
1710                 unless ($nl->{TYPE} eq "DATA" and Parse::Pidl::Typelist::scalar_is_reference($nl->{DATA_TYPE})) {
1711                         $var_name2 = get_value_of($var_name);
1712                 }
1713                 $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name2, $py_var, $fail);
1714                 if ($l->{POINTER_TYPE} ne "ref") {
1715                         $self->deindent;
1716                         $self->pidl("}");
1717                 }
1718         } elsif ($l->{TYPE} eq "ARRAY") {
1719                 if ($pl && $pl->{TYPE} eq "POINTER") {
1720                         $var_name = get_pointer_to($var_name);
1721                 }
1722
1723                 if (is_charset_array($e, $l)) {
1724                         # FIXME: Use Unix charset setting rather than utf-8
1725                         $self->pidl("if ($var_name == NULL) {");
1726                         $self->indent;
1727                         $self->pidl("$py_var = Py_None;");
1728                         $self->pidl("Py_INCREF($py_var);");
1729                         $self->deindent;
1730                         $self->pidl("} else {");
1731                         $self->indent;
1732                         $self->pidl("$py_var = PyUnicode_Decode($var_name, strlen($var_name), \"utf-8\", \"ignore\");");
1733                         $self->deindent;
1734                         $self->pidl("}");
1735                 } else {
1736                         die("No SIZE_IS for array $var_name") unless (defined($l->{SIZE_IS}));
1737                         my $length = $l->{SIZE_IS};
1738                         if (defined($l->{LENGTH_IS})) {
1739                                 $length = $l->{LENGTH_IS};
1740                         }
1741
1742                         $length = ParseExpr($length, $env, $e);
1743                         $self->pidl("$py_var = PyList_New($length);");
1744                         $self->fail_on_null($py_var, $fail);
1745                         $self->pidl("{");
1746                         $self->indent;
1747                         my $counter = "$e->{NAME}_cntr_$l->{LEVEL_INDEX}";
1748                         $self->pidl("int $counter;");
1749                         $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1750                         $self->indent;
1751                         my $member_var = "py_$e->{NAME}_$l->{LEVEL_INDEX}";
1752                         $self->pidl("PyObject *$member_var;");
1753                         $self->ConvertObjectToPythonLevel($var_name, $env, $e, $nl, $var_name."[$counter]", $member_var, $fail);
1754                         $self->pidl("PyList_SetItem($py_var, $counter, $member_var);");
1755                         $self->deindent;
1756                         $self->pidl("}");
1757                         $self->deindent;
1758                         $self->pidl("}");
1759                 }
1760         } elsif ($l->{TYPE} eq "SWITCH") {
1761                 $var_name = get_pointer_to($var_name);
1762                 my $switch = ParseExpr($l->{SWITCH_IS}, $env, $e);
1763                 $self->pidl("$py_var = py_import_" . $nl->{DATA_TYPE} . "($mem_ctx, $switch, $var_name);");
1764                 $self->fail_on_null($py_var, $fail);
1765
1766         } elsif ($l->{TYPE} eq "DATA") {
1767                 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE})) {
1768                         $var_name = get_pointer_to($var_name);
1769                 }
1770                 my $conv = $self->ConvertObjectToPythonData($mem_ctx, $l->{DATA_TYPE}, $var_name, $e->{ORIGINAL});
1771                 $self->pidl("$py_var = $conv;");
1772         } elsif ($l->{TYPE} eq "SUBCONTEXT") {
1773                 $self->ConvertObjectToPythonLevel($mem_ctx, $env, $e, $nl, $var_name, $py_var, $fail);
1774         } else {
1775                 fatal($e->{ORIGINAL}, "Unknown level type $l->{TYPE} $var_name");
1776         }
1777 }
1778
1779 sub ConvertObjectToPython($$$$$$)
1780 {
1781         my ($self, $mem_ctx, $env, $ctype, $cvar, $py_var, $fail) = @_;
1782
1783         $self->ConvertObjectToPythonLevel($mem_ctx, $env, $ctype, $ctype->{LEVELS}[0], $cvar, $py_var, $fail);
1784 }
1785
1786 sub Parse($$$$$)
1787 {
1788     my($self,$basename,$ndr,$ndr_hdr,$hdr) = @_;
1789
1790         $self->{BASENAME} = $basename;
1791
1792     $self->pidl_hdr("
1793 /* Python wrapper functions auto-generated by pidl */
1794 #define PY_SSIZE_T_CLEAN 1 /* We use Py_ssize_t for PyArg_ParseTupleAndKeywords */
1795 #include <Python.h>
1796 #include \"includes.h\"
1797 #include <pytalloc.h>
1798 #include \"librpc/rpc/pyrpc.h\"
1799 #include \"librpc/rpc/pyrpc_util.h\"
1800 #include \"$hdr\"
1801 #include \"$ndr_hdr\"
1802
1803 /*
1804  * These functions are here to ensure they can be optimized out by
1805  * the compiler based on the constant input values
1806  */
1807
1808 static inline unsigned long long ndr_sizeof2uintmax(size_t var_size)
1809 {
1810         switch (var_size) {
1811         case 8:
1812                 return UINT64_MAX;
1813         case 4:
1814                 return UINT32_MAX;
1815         case 2:
1816                 return UINT16_MAX;
1817         case 1:
1818                 return UINT8_MAX;
1819         }
1820
1821         return 0;
1822 }
1823
1824 static inline long long ndr_sizeof2intmax(size_t var_size)
1825 {
1826         switch (var_size) {
1827         case 8:
1828                 return INT64_MAX;
1829         case 4:
1830                 return INT32_MAX;
1831         case 2:
1832                 return INT16_MAX;
1833         case 1:
1834                 return INT8_MAX;
1835         }
1836
1837         return 0;
1838 }
1839
1840 static inline PyObject *ndr_PyLong_FromLongLong(long long v)
1841 {
1842         if (v > LONG_MAX || v < LONG_MIN) {
1843                 return PyLong_FromLongLong(v);
1844         } else {
1845                 return PyInt_FromLong(v);
1846         }
1847 }
1848
1849 static inline PyObject *ndr_PyLong_FromUnsignedLongLong(unsigned long long v)
1850 {
1851         if (v > LONG_MAX) {
1852                 return PyLong_FromUnsignedLongLong(v);
1853         } else {
1854                 return PyInt_FromLong(v);
1855         }
1856 }
1857
1858 ");
1859
1860         foreach my $x (@$ndr) {
1861                 ($x->{TYPE} eq "IMPORT") && $self->Import(@{$x->{PATHS}});
1862             ($x->{TYPE} eq "INTERFACE") && $self->Interface($x, $basename);
1863         }
1864
1865         $self->pidl("static PyMethodDef $basename\_methods[] = {");
1866         $self->indent;
1867         foreach (@{$self->{module_methods}}) {
1868                 my ($fn_name, $pyfn_name, $flags, $doc) = @$_;
1869                 $self->pidl("{ \"$fn_name\", (PyCFunction)$pyfn_name, $flags, $doc },");
1870         }
1871
1872         $self->pidl("{ NULL, NULL, 0, NULL }");
1873         $self->deindent;
1874         $self->pidl("};");
1875
1876         $self->pidl("");
1877
1878         $self->pidl_hdr("void init$basename(void);");
1879         $self->pidl("void init$basename(void)");
1880         $self->pidl("{");
1881         $self->indent;
1882         $self->pidl("PyObject *m;");
1883         foreach my $h (@{$self->{module_imports}}) {
1884                 $self->pidl("PyObject *$h->{'key'};");
1885         }
1886         $self->pidl("");
1887
1888         foreach my $h (@{$self->{module_imports}}) {
1889                 my $var_name = $h->{'key'};
1890                 my $module_path = $h->{'val'};
1891                 $self->pidl("$var_name = PyImport_ImportModule(\"$module_path\");");
1892                 $self->pidl("if ($var_name == NULL)");
1893                 $self->pidl("\treturn;");
1894                 $self->pidl("");
1895         }
1896
1897         foreach my $h (@{$self->{type_imports}}) {
1898                 my $type_var = "$h->{'key'}\_Type";
1899                 my $module_path = $h->{'val'};
1900                 $self->pidl_hdr("static PyTypeObject *$type_var;\n");
1901                 my $pretty_name = PrettifyTypeName($h->{'key'}, $module_path);
1902                 my $module_var = "dep_$module_path";
1903                 $module_var =~ s/\./_/g;
1904                 $self->pidl("$type_var = (PyTypeObject *)PyObject_GetAttrString($module_var, \"$pretty_name\");");
1905                 $self->pidl("if ($type_var == NULL)");
1906                 $self->pidl("\treturn;");
1907                 $self->pidl("");
1908         }
1909
1910         $self->pidl($_) foreach (@{$self->{prereadycode}});
1911
1912         foreach (@{$self->{ready_types}}) {
1913                 $self->pidl("if (PyType_Ready($_) < 0)");
1914                 $self->pidl("\treturn;");
1915         }
1916
1917         $self->pidl($_) foreach (@{$self->{postreadycode}});
1918
1919         foreach (@{$self->{patch_type_calls}}) {
1920                 my ($typename, $cvar) = @$_;
1921                 $self->pidl("#ifdef PY_".uc($typename)."_PATCH");
1922                 $self->pidl("PY_".uc($typename)."_PATCH($cvar);");
1923                 $self->pidl("#endif");
1924         }
1925
1926         $self->pidl("");
1927
1928         $self->pidl("m = Py_InitModule3(\"$basename\", $basename\_methods, \"$basename DCE/RPC\");");
1929         $self->pidl("if (m == NULL)");
1930         $self->pidl("\treturn;");
1931         $self->pidl("");
1932         foreach my $h (@{$self->{constants}}) {
1933                 my $pretty_name = PrettifyTypeName($h->{'key'}, $basename);
1934                 my $py_obj;
1935                 my ($ctype, $cvar) = @{$h->{'val'}};
1936                 if ($cvar =~ /^[0-9]+$/ or $cvar =~ /^0x[0-9a-fA-F]+$/) {
1937                         $py_obj = "ndr_PyLong_FromUnsignedLongLong($cvar)";
1938                 } elsif ($cvar =~ /^".*"$/) {
1939                         $py_obj = "PyString_FromString($cvar)";
1940                 } else {
1941                         $py_obj = $self->ConvertObjectToPythonData("NULL", expandAlias($ctype), $cvar, undef);
1942                 }
1943
1944                 $self->pidl("PyModule_AddObject(m, \"$pretty_name\", $py_obj);");
1945         }
1946
1947         foreach (@{$self->{module_objects}}) {
1948                 my ($object_name, $c_name) = @$_;
1949                 $self->pidl("Py_INCREF($c_name);");
1950                 $self->pidl("PyModule_AddObject(m, \"$object_name\", $c_name);");
1951         }
1952
1953         $self->pidl("#ifdef PY_MOD_".uc($basename)."_PATCH");
1954         $self->pidl("PY_MOD_".uc($basename)."_PATCH(m);");
1955         $self->pidl("#endif");
1956
1957         $self->pidl("");
1958         $self->deindent;
1959         $self->pidl("}");
1960     return ($self->{res_hdr} . $self->{res});
1961 }
1962
1963 1;