pidl/lib/Parse/Pidl/Samba4/NDR/Parser.pm

   1 ###################################################
   2 # Samba4 NDR parser generator for IDL structures
   3 # Copyright tridge@samba.org 2000-2003
   4 # Copyright tpot@samba.org 2001
   5 # Copyright jelmer@samba.org 2004-2006
   6 # released under the GNU GPL
   7
   8 package Parse::Pidl::Samba4::NDR::Parser;
   9
  10 require Exporter;
  11 @ISA = qw(Exporter);
  12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
  13
  14 use strict;
  15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
  16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid unmake_str);
  17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
  18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred is_charset_array);
  19 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
  20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
  21 use Parse::Pidl qw(warning);
  22
  23 use vars qw($VERSION);
  24 $VERSION = '0.01';
  25
  26 # list of known types
  27 my %typefamily;
  28
  29 sub new($$) {
  30         my ($class) = @_;
  31         my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
  32         bless($self, $class);
  33 }
  34
  35 sub get_typefamily($)
  36 {
  37         my $n = shift;
  38         return $typefamily{$n};
  39 }
  40
  41 sub append_prefix($$)
  42 {
  43         my ($e, $var_name) = @_;
  44         my $pointers = 0;
  45         my $arrays = 0;
  46
  47         foreach my $l (@{$e->{LEVELS}}) {
  48                 if ($l->{TYPE} eq "POINTER") {
  49                         $pointers++;
  50                 } elsif ($l->{TYPE} eq "ARRAY") {
  51                         $arrays++;
  52                         if (($pointers == 0) and
  53                             (not $l->{IS_FIXED}) and
  54                             (not $l->{IS_INLINE})) {
  55                                 return get_value_of($var_name);
  56                         }
  57                 } elsif ($l->{TYPE} eq "DATA") {
  58                         if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
  59                                 return get_value_of($var_name) unless ($pointers or $arrays);
  60                         }
  61                 }
  62         }
  63
  64         return $var_name;
  65 }
  66
  67 sub has_fast_array($$)
  68 {
  69         my ($e,$l) = @_;
  70
  71         return 0 if ($l->{TYPE} ne "ARRAY");
  72
  73         my $nl = GetNextLevel($e,$l);
  74         return 0 unless ($nl->{TYPE} eq "DATA");
  75         return 0 unless (hasType($nl->{DATA_TYPE}));
  76
  77         my $t = getType($nl->{DATA_TYPE});
  78
  79         # Only uint8 and string have fast array functions at the moment
  80         return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
  81 }
  82
  83
  84 ####################################
  85 # pidl() is our basic output routine
  86 sub pidl($$)
  87 {
  88         my ($self, $d) = @_;
  89         if ($d) {
  90                 $self->{res} .= $self->{tabs};
  91                 $self->{res} .= $d;
  92         }
  93         $self->{res} .="\n";
  94 }
  95
  96 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
  97
  98 ####################################
  99 # defer() is like pidl(), but adds to
 100 # a deferred buffer which is then added to the
 101 # output buffer at the end of the structure/union/function
 102 # This is needed to cope with code that must be pushed back
 103 # to the end of a block of elements
 104 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
 105 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
 106
 107 sub defer($$)
 108 {
 109         my ($self, $d) = @_;
 110         if ($d) {
 111                 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
 112         }
 113 }
 114
 115 ########################################
 116 # add the deferred content to the current
 117 # output
 118 sub add_deferred($)
 119 {
 120         my ($self) = @_;
 121         $self->pidl($_) foreach (@{$self->{deferred}});
 122         $self->{deferred} = [];
 123         $self->{defer_tabs} = "";
 124 }
 125
 126 sub indent($)
 127 {
 128         my ($self) = @_;
 129         $self->{tabs} .= "\t";
 130 }
 131
 132 sub deindent($)
 133 {
 134         my ($self) = @_;
 135         $self->{tabs} = substr($self->{tabs}, 0, -1);
 136 }
 137
 138 #####################################################################
 139 # declare a function public or static, depending on its attributes
 140 sub fn_declare($$$$)
 141 {
 142         my ($self,$type,$fn,$decl) = @_;
 143
 144         if (has_property($fn, "no$type")) {
 145                 $self->pidl_hdr("$decl;");
 146                 return 0;
 147         }
 148
 149         if (has_property($fn, "public")) {
 150                 $self->pidl_hdr("$decl;");
 151                 $self->pidl("_PUBLIC_ $decl");
 152         } else {
 153                 $self->pidl("static $decl");
 154         }
 155
 156         return 1;
 157 }
 158
 159 ###################################################################
 160 # setup any special flags for an element or structure
 161 sub start_flags($$$)
 162 {
 163         my ($self, $e, $ndr) = @_;
 164         my $flags = has_property($e, "flag");
 165         if (defined $flags) {
 166                 $self->pidl("{");
 167                 $self->indent;
 168                 $self->pidl("uint32_t _flags_save_$e->{TYPE} = $ndr->flags;");
 169                 $self->pidl("ndr_set_flags(&$ndr->flags, $flags);");
 170         }
 171 }
 172
 173 ###################################################################
 174 # end any special flags for an element or structure
 175 sub end_flags($$$)
 176 {
 177         my ($self, $e, $ndr) = @_;
 178         my $flags = has_property($e, "flag");
 179         if (defined $flags) {
 180                 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
 181                 $self->deindent;
 182                 $self->pidl("}");
 183         }
 184 }
 185
 186 #####################################################################
 187 # parse the data of an array - push side
 188 sub ParseArrayPushHeader($$$$$$)
 189 {
 190         my ($self,$e,$l,$ndr,$var_name,$env) = @_;
 191
 192         my $size;
 193         my $length;
 194
 195         if ($l->{IS_ZERO_TERMINATED}) {
 196                 if (has_property($e, "charset")) {
 197                         $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
 198                 } else {
 199                         $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
 200                 }
 201         } else {
 202                 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
 203                 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
 204         }
 205
 206         if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
 207                 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
 208         }
 209
 210         if ($l->{IS_VARYING}) {
 211                 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));");  # array offset
 212                 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
 213         }
 214
 215         return $length;
 216 }
 217
 218 sub check_fully_dereferenced($$)
 219 {
 220         my ($element, $env) = @_;
 221
 222         return sub ($) {
 223                 my $origvar = shift;
 224                 my $check = 0;
 225
 226                 # Figure out the number of pointers in $ptr
 227                 my $expandedvar = $origvar;
 228                 $expandedvar =~ s/^(\**)//;
 229                 my $ptr = $1;
 230
 231                 my $var = undef;
 232                 foreach (keys %$env) {
 233                         if ($env->{$_} eq $expandedvar) {
 234                                 $var = $_;
 235                                 last;
 236                         }
 237                 }
 238
 239                 return($origvar) unless (defined($var));
 240                 my $e;
 241                 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
 242                         if ($_->{NAME} eq $var) {
 243                                 $e = $_;
 244                                 last;
 245                         }
 246                 }
 247
 248                 $e or die("Environment doesn't match siblings");
 249
 250                 # See if pointer at pointer level $level
 251                 # needs to be checked.
 252                 my $nump = 0;
 253                 foreach (@{$e->{LEVELS}}) {
 254                         if ($_->{TYPE} eq "POINTER") {
 255                                 $nump = $_->{POINTER_INDEX}+1;
 256                         }
 257                 }
 258                 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
 259                 return ($origvar);
 260         }
 261 }
 262
 263 sub check_null_pointer($$$$)
 264 {
 265         my ($element, $env, $print_fn, $return) = @_;
 266
 267         return sub ($) {
 268                 my $expandedvar = shift;
 269                 my $check = 0;
 270
 271                 # Figure out the number of pointers in $ptr
 272                 $expandedvar =~ s/^(\**)//;
 273                 my $ptr = $1;
 274
 275                 my $var = undef;
 276                 foreach (keys %$env) {
 277                         if ($env->{$_} eq $expandedvar) {
 278                                 $var = $_;
 279                                 last;
 280                         }
 281                 }
 282
 283                 if (defined($var)) {
 284                         my $e;
 285                         # lookup ptr in $e
 286                         foreach (@{$element->{PARENT}->{ELEMENTS}}) {
 287                                 if ($_->{NAME} eq $var) {
 288                                         $e = $_;
 289                                         last;
 290                                 }
 291                         }
 292
 293                         $e or die("Environment doesn't match siblings");
 294
 295                         # See if pointer at pointer level $level
 296                         # needs to be checked.
 297                         foreach my $l (@{$e->{LEVELS}}) {
 298                                 if ($l->{TYPE} eq "POINTER" and
 299                                         $l->{POINTER_INDEX} == length($ptr)) {
 300                                         # No need to check ref pointers
 301                                         $check = ($l->{POINTER_TYPE} ne "ref");
 302                                         last;
 303                                 }
 304
 305                                 if ($l->{TYPE} eq "DATA") {
 306                                         warning($element, "too much dereferences for `$var'");
 307                                 }
 308                         }
 309                 } else {
 310                         warning($element, "unknown dereferenced expression `$expandedvar'");
 311                         $check = 1;
 312                 }
 313
 314                 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
 315         }
 316 }
 317
 318 #####################################################################
 319 # parse an array - pull side
 320 sub ParseArrayPullHeader($$$$$$)
 321 {
 322         my ($self,$e,$l,$ndr,$var_name,$env) = @_;
 323
 324         my $length;
 325         my $size;
 326
 327         if ($l->{IS_CONFORMANT}) {
 328                 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
 329         } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
 330                 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
 331         } else {
 332                 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
 333                         check_null_pointer($e, $env, sub { $self->pidl(shift); },
 334                                            "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
 335                         check_fully_dereferenced($e, $env));
 336         }
 337
 338         if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
 339                 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
 340         }
 341
 342         if ($l->{IS_VARYING}) {
 343                 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
 344                 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
 345         }
 346
 347         if ($length ne $size) {
 348                 $self->pidl("if ($length > $size) {");
 349                 $self->indent;
 350                 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
 351                 $self->deindent;
 352                 $self->pidl("}");
 353         }
 354
 355         if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
 356                 $self->defer("if ($var_name) {");
 357                 $self->defer_indent;
 358                 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
 359                         check_null_pointer($e, $env, sub { $self->defer(shift); },
 360                                            "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
 361                         check_fully_dereferenced($e, $env));
 362                 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
 363                 $self->defer_deindent;
 364                 $self->defer("}");
 365         }
 366
 367         if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
 368                 $self->defer("if ($var_name) {");
 369                 $self->defer_indent;
 370                 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
 371                         check_null_pointer($e, $env, sub { $self->defer(shift); },
 372                                            "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
 373                         check_fully_dereferenced($e, $env));
 374                 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
 375                 $self->defer_deindent;
 376                 $self->defer("}");
 377         }
 378
 379         if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
 380                 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$size);
 381         }
 382
 383         return $length;
 384 }
 385
 386 sub compression_alg($$)
 387 {
 388         my ($e, $l) = @_;
 389         my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
 390
 391         return $alg;
 392 }
 393
 394 sub compression_clen($$$)
 395 {
 396         my ($e, $l, $env) = @_;
 397         my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
 398
 399         return ParseExpr($clen, $env, $e->{ORIGINAL});
 400 }
 401
 402 sub compression_dlen($$$)
 403 {
 404         my ($e,$l,$env) = @_;
 405         my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
 406
 407         return ParseExpr($dlen, $env, $e->{ORIGINAL});
 408 }
 409
 410 sub ParseCompressionPushStart($$$$$)
 411 {
 412         my ($self,$e,$l,$ndr,$env) = @_;
 413         my $comndr = "$ndr\_compressed";
 414         my $alg = compression_alg($e, $l);
 415         my $dlen = compression_dlen($e, $l, $env);
 416
 417         $self->pidl("{");
 418         $self->indent;
 419         $self->pidl("struct ndr_push *$comndr;");
 420         $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
 421
 422         return $comndr;
 423 }
 424
 425 sub ParseCompressionPushEnd($$$$$)
 426 {
 427         my ($self,$e,$l,$ndr,$env) = @_;
 428         my $comndr = "$ndr\_compressed";
 429         my $alg = compression_alg($e, $l);
 430         my $dlen = compression_dlen($e, $l, $env);
 431
 432         $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
 433         $self->deindent;
 434         $self->pidl("}");
 435 }
 436
 437 sub ParseCompressionPullStart($$$$$)
 438 {
 439         my ($self,$e,$l,$ndr,$env) = @_;
 440         my $comndr = "$ndr\_compressed";
 441         my $alg = compression_alg($e, $l);
 442         my $dlen = compression_dlen($e, $l, $env);
 443
 444         $self->pidl("{");
 445         $self->indent;
 446         $self->pidl("struct ndr_pull *$comndr;");
 447         $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
 448
 449         return $comndr;
 450 }
 451
 452 sub ParseCompressionPullEnd($$$$$)
 453 {
 454         my ($self,$e,$l,$ndr,$env) = @_;
 455         my $comndr = "$ndr\_compressed";
 456         my $alg = compression_alg($e, $l);
 457         my $dlen = compression_dlen($e, $l, $env);
 458
 459         $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
 460         $self->deindent;
 461         $self->pidl("}");
 462 }
 463
 464 sub ParseSubcontextPushStart($$$$$)
 465 {
 466         my ($self,$e,$l,$ndr,$env) = @_;
 467         my $subndr = "_ndr_$e->{NAME}";
 468         my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
 469
 470         $self->pidl("{");
 471         $self->indent;
 472         $self->pidl("struct ndr_push *$subndr;");
 473         $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
 474
 475         if (defined $l->{COMPRESSION}) {
 476                 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
 477         }
 478
 479         return $subndr;
 480 }
 481
 482 sub ParseSubcontextPushEnd($$$$$)
 483 {
 484         my ($self,$e,$l,$ndr,$env) = @_;
 485         my $subndr = "_ndr_$e->{NAME}";
 486         my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
 487
 488         if (defined $l->{COMPRESSION}) {
 489                 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
 490         }
 491
 492         $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
 493         $self->deindent;
 494         $self->pidl("}");
 495 }
 496
 497 sub ParseSubcontextPullStart($$$$$)
 498 {
 499         my ($self,$e,$l,$ndr,$env) = @_;
 500         my $subndr = "_ndr_$e->{NAME}";
 501         my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
 502
 503         $self->pidl("{");
 504         $self->indent;
 505         $self->pidl("struct ndr_pull *$subndr;");
 506         $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
 507
 508         if (defined $l->{COMPRESSION}) {
 509                 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
 510         }
 511
 512         return $subndr;
 513 }
 514
 515 sub ParseSubcontextPullEnd($$$$$)
 516 {
 517         my ($self,$e,$l,$ndr,$env) = @_;
 518         my $subndr = "_ndr_$e->{NAME}";
 519         my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
 520
 521         if (defined $l->{COMPRESSION}) {
 522                 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
 523         }
 524
 525         $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
 526         $self->deindent;
 527         $self->pidl("}");
 528 }
 529
 530 sub ParseElementPushLevel
 531 {
 532         my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
 533
 534         my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
 535
 536         if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
 537                 $var_name = get_pointer_to($var_name);
 538         }
 539
 540         if (defined($ndr_flags)) {
 541                 if ($l->{TYPE} eq "SUBCONTEXT") {
 542                         my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
 543                         $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
 544                         $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
 545                 } elsif ($l->{TYPE} eq "POINTER") {
 546                         $self->ParsePtrPush($e, $l, $ndr, $var_name);
 547                 } elsif ($l->{TYPE} eq "ARRAY") {
 548                         my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
 549
 550                         my $nl = GetNextLevel($e, $l);
 551
 552                         # Allow speedups for arrays of scalar types
 553                         if (is_charset_array($e,$l)) {
 554                                 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
 555                                 return;
 556                         } elsif (has_fast_array($e,$l)) {
 557                                 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
 558                                 return;
 559                         }
 560                 } elsif ($l->{TYPE} eq "SWITCH") {
 561                         $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
 562                 } elsif ($l->{TYPE} eq "DATA") {
 563                         $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
 564                 } elsif ($l->{TYPE} eq "TYPEDEF") {
 565                         $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
 566                 }
 567         }
 568
 569         if ($l->{TYPE} eq "POINTER" and $deferred) {
 570                 my $rel_var_name = $var_name;
 571                 if ($l->{POINTER_TYPE} ne "ref") {
 572                         $self->pidl("if ($var_name) {");
 573                         $self->indent;
 574                         if ($l->{POINTER_TYPE} eq "relative") {
 575                                 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
 576                         }
 577                         if ($l->{POINTER_TYPE} eq "relative_short") {
 578                                 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
 579                         }
 580                 }
 581                 $var_name = get_value_of($var_name);
 582                 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
 583
 584                 if ($l->{POINTER_TYPE} ne "ref") {
 585                         if ($l->{POINTER_TYPE} eq "relative") {
 586                                 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
 587                         }
 588                         $self->deindent;
 589                         $self->pidl("}");
 590                 }
 591         } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
 592                 not is_charset_array($e, $l)) {
 593                 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
 594                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
 595
 596                 my $array_pointless = ($length eq "0");
 597
 598                 if ($array_pointless) {
 599                         warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
 600                 }
 601
 602                 $var_name = get_array_element($var_name, $counter);
 603
 604                 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
 605                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
 606                         $self->indent;
 607                         $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
 608                         $self->deindent;
 609                         $self->pidl("}");
 610                 }
 611
 612                 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
 613                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
 614                         $self->indent;
 615                         $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
 616                         $self->deindent;
 617                         $self->pidl("}");
 618                 }
 619         } elsif ($l->{TYPE} eq "SWITCH") {
 620                 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
 621         }
 622 }
 623
 624 #####################################################################
 625 # parse scalars in a structure element
 626 sub ParseElementPush($$$$$$)
 627 {
 628         my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
 629         my $subndr = undef;
 630
 631         my $var_name = $env->{$e->{NAME}};
 632
 633         return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
 634
 635         # Representation type is different from transmit_as
 636         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
 637                 $self->pidl("{");
 638                 $self->indent;
 639                 my $transmit_name = "_transmit_$e->{NAME}";
 640                 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
 641                 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
 642                 $var_name = $transmit_name;
 643         }
 644
 645         $var_name = append_prefix($e, $var_name);
 646
 647         $self->start_flags($e, $ndr);
 648
 649         if (defined(my $value = has_property($e, "value"))) {
 650                 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
 651         }
 652
 653         $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
 654
 655         $self->end_flags($e, $ndr);
 656
 657         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
 658                 $self->deindent;
 659                 $self->pidl("}");
 660         }
 661 }
 662
 663 #####################################################################
 664 # parse a pointer in a struct element or function
 665 sub ParsePtrPush($$$$$)
 666 {
 667         my ($self,$e,$l,$ndr,$var_name) = @_;
 668
 669         if ($l->{POINTER_TYPE} eq "ref") {
 670                 $self->pidl("if ($var_name == NULL) {");
 671                 $self->indent;
 672                 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
 673                 $self->deindent;
 674                 $self->pidl("}");
 675                 if ($l->{LEVEL} eq "EMBEDDED") {
 676                         $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
 677                 }
 678         } elsif ($l->{POINTER_TYPE} eq "relative") {
 679                 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
 680         } elsif ($l->{POINTER_TYPE} eq "relative_short") {
 681                 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
 682         } elsif ($l->{POINTER_TYPE} eq "unique") {
 683                 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
 684         } elsif ($l->{POINTER_TYPE} eq "full") {
 685                 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
 686         } else {
 687                 die("Unhandled pointer type $l->{POINTER_TYPE}");
 688         }
 689 }
 690
 691 sub need_pointer_to($$$)
 692 {
 693         my ($e, $l, $scalar_only) = @_;
 694
 695         my $t;
 696         if (ref($l->{DATA_TYPE})) {
 697                 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
 698         } else {
 699                 $t = $l->{DATA_TYPE};
 700         }
 701
 702         if (not Parse::Pidl::Typelist::is_scalar($t)) {
 703                 return 1 if $scalar_only;
 704         }
 705
 706         my $arrays = 0;
 707
 708         foreach my $tl (@{$e->{LEVELS}}) {
 709                 last if $l == $tl;
 710                 if ($tl->{TYPE} eq "ARRAY") {
 711                         $arrays++;
 712                 }
 713         }
 714
 715         if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
 716                 return 1 unless $arrays;
 717         }
 718
 719         return 0;
 720 }
 721
 722 sub ParseDataPrint($$$$$)
 723 {
 724         my ($self, $e, $l, $ndr, $var_name) = @_;
 725
 726         if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
 727
 728                 if (need_pointer_to($e, $l, 1)) {
 729                         $var_name = get_pointer_to($var_name);
 730                 }
 731
 732                 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
 733         } else {
 734                 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
 735         }
 736 }
 737
 738 #####################################################################
 739 # print scalars in a structure element
 740 sub ParseElementPrint($$$$$)
 741 {
 742         my($self, $e, $ndr, $var_name, $env) = @_;
 743
 744         return if (has_property($e, "noprint"));
 745
 746         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
 747                 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
 748                 return;
 749         }
 750
 751         $var_name = append_prefix($e, $var_name);
 752
 753         if (defined(my $value = has_property($e, "value"))) {
 754                 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
 755         }
 756
 757         foreach my $l (@{$e->{LEVELS}}) {
 758                 if ($l->{TYPE} eq "POINTER") {
 759                         $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
 760                         $self->pidl("$ndr->depth++;");
 761                         if ($l->{POINTER_TYPE} ne "ref") {
 762                                 $self->pidl("if ($var_name) {");
 763                                 $self->indent;
 764                         }
 765                         $var_name = get_value_of($var_name);
 766                 } elsif ($l->{TYPE} eq "ARRAY") {
 767                         my $length;
 768
 769                         if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
 770                                 $var_name = get_pointer_to($var_name);
 771                         }
 772
 773                         if ($l->{IS_ZERO_TERMINATED}) {
 774                                 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
 775                         } else {
 776                                 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
 777                                                         check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
 778                         }
 779
 780                         if (is_charset_array($e,$l)) {
 781                                 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
 782                                 last;
 783                         } elsif (has_fast_array($e, $l)) {
 784                                 my $nl = GetNextLevel($e, $l);
 785                                 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
 786                                 last;
 787                         } else {
 788                                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
 789
 790                                 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
 791                                 $self->pidl("$ndr->depth++;");
 792                                 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
 793                                 $self->indent;
 794                                 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
 795                                 $self->pidl("if (asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter) != -1) {");
 796                                 $self->indent;
 797
 798                                 $var_name = get_array_element($var_name, $counter);
 799                         }
 800                 } elsif ($l->{TYPE} eq "DATA") {
 801                         $self->ParseDataPrint($e, $l, $ndr, $var_name);
 802                 } elsif ($l->{TYPE} eq "SWITCH") {
 803                         my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
 804                                                 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
 805                         $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
 806                 }
 807         }
 808
 809         foreach my $l (reverse @{$e->{LEVELS}}) {
 810                 if ($l->{TYPE} eq "POINTER") {
 811                         if ($l->{POINTER_TYPE} ne "ref") {
 812                                 $self->deindent;
 813                                 $self->pidl("}");
 814                         }
 815                         $self->pidl("$ndr->depth--;");
 816                 } elsif (($l->{TYPE} eq "ARRAY")
 817                         and not is_charset_array($e,$l)
 818                         and not has_fast_array($e,$l)) {
 819                         $self->pidl("free(idx_$l->{LEVEL_INDEX});");
 820                         $self->deindent;
 821                         $self->pidl("}");
 822                         $self->deindent;
 823                         $self->pidl("}");
 824                         $self->pidl("$ndr->depth--;");
 825                 }
 826         }
 827 }
 828
 829 #####################################################################
 830 # parse scalars in a structure element - pull size
 831 sub ParseSwitchPull($$$$$$)
 832 {
 833         my($self,$e,$l,$ndr,$var_name,$env) = @_;
 834         my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
 835                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
 836                                    "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
 837                 check_fully_dereferenced($e, $env));
 838
 839         $var_name = get_pointer_to($var_name);
 840         $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
 841 }
 842
 843 #####################################################################
 844 # push switch element
 845 sub ParseSwitchPush($$$$$$)
 846 {
 847         my($self,$e,$l,$ndr,$var_name,$env) = @_;
 848         my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
 849                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
 850                                    "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
 851                 check_fully_dereferenced($e, $env));
 852
 853         $var_name = get_pointer_to($var_name);
 854         $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
 855 }
 856
 857 sub ParseDataPull($$$$$$$)
 858 {
 859         my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
 860
 861         if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
 862
 863                 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
 864
 865                 if (need_pointer_to($e, $l, 0)) {
 866                         $var_name = get_pointer_to($var_name);
 867                 }
 868
 869                 $var_name = get_pointer_to($var_name);
 870
 871                 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
 872
 873                 if (my $range = has_property($e, "range")) {
 874                         $var_name = get_value_of($var_name);
 875                         my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
 876                         my ($low, $high) = split(/,/, $range, 2);
 877                         if ($low < 0 and not $signed) {
 878                                 warning(0, "$low is invalid for the range of an unsigned type");
 879                         }
 880                         if ($low == 0 and not $signed) {
 881                                 $self->pidl("if ($var_name > $high) {");
 882                         } else {
 883                                 $self->pidl("if ($var_name < $low || $var_name > $high) {");
 884                         }
 885                         $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
 886                         $self->pidl("}");
 887                 }
 888         } else {
 889                 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
 890         }
 891 }
 892
 893 sub ParseDataPush($$$$$$$)
 894 {
 895         my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
 896
 897         if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
 898
 899                 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
 900
 901                 # strings are passed by value rather than reference
 902                 if (need_pointer_to($e, $l, 1)) {
 903                         $var_name = get_pointer_to($var_name);
 904                 }
 905
 906                 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
 907         } else {
 908                 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
 909         }
 910 }
 911
 912 sub CalcNdrFlags($$$)
 913 {
 914         my ($l,$primitives,$deferred) = @_;
 915
 916         my $scalars = 0;
 917         my $buffers = 0;
 918
 919         # Add NDR_SCALARS if this one is deferred
 920         # and deferreds may be pushed
 921         $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
 922
 923         # Add NDR_SCALARS if this one is not deferred and
 924         # primitives may be pushed
 925         $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
 926
 927         # Add NDR_BUFFERS if this one contains deferred stuff
 928         # and deferreds may be pushed
 929         $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
 930
 931         return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
 932         return "NDR_SCALARS" if ($scalars);
 933         return "NDR_BUFFERS" if ($buffers);
 934         return undef;
 935 }
 936
 937 sub ParseMemCtxPullFlags($$$$)
 938 {
 939         my ($self, $e, $l) = @_;
 940
 941         return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
 942
 943         return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
 944         return undef if has_fast_array($e, $l);
 945         return undef if is_charset_array($e, $l);
 946
 947         my $mem_flags = "0";
 948
 949         if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
 950                 my $nl = GetNextLevel($e, $l);
 951                 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
 952                 my $next_is_string = (($nl->{TYPE} eq "DATA") and
 953                                         ($nl->{DATA_TYPE} eq "string"));
 954                 if ($next_is_array or $next_is_string) {
 955                         return undef;
 956                 } elsif ($l->{LEVEL} eq "TOP") {
 957                         $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
 958                 }
 959         }
 960
 961         return $mem_flags;
 962 }
 963
 964 sub ParseMemCtxPullStart($$$$$)
 965 {
 966         my ($self, $e, $l, $ndr, $ptr_name) = @_;
 967
 968         my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
 969         my $mem_c_ctx = $ptr_name;
 970         my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
 971
 972         return unless defined($mem_c_flags);
 973
 974         $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
 975         $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
 976 }
 977
 978 sub ParseMemCtxPullEnd($$$$)
 979 {
 980         my ($self, $e, $l, $ndr) = @_;
 981
 982         my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
 983         my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
 984
 985         return unless defined($mem_r_flags);
 986
 987         $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
 988 }
 989
 990 sub CheckStringTerminator($$$$$)
 991 {
 992         my ($self,$ndr,$e,$l,$length) = @_;
 993         my $nl = GetNextLevel($e, $l);
 994
 995         # Make sure last element is zero!
 996         $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
 997 }
 998
 999 sub ParseElementPullLevel
1000 {
1001         my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1002
1003         my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1004
1005         if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1006                 $var_name = get_pointer_to($var_name);
1007         }
1008
1009         # Only pull something if there's actually something to be pulled
1010         if (defined($ndr_flags)) {
1011                 if ($l->{TYPE} eq "SUBCONTEXT") {
1012                         my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1013                         $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1014                         $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1015                 } elsif ($l->{TYPE} eq "ARRAY") {
1016                         my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1017
1018                         my $nl = GetNextLevel($e, $l);
1019
1020                         if (is_charset_array($e,$l)) {
1021                                 if ($l->{IS_ZERO_TERMINATED}) {
1022                                         $self->CheckStringTerminator($ndr, $e, $l, $length);
1023                                 }
1024                                 $self->pidl("NDR_CHECK(ndr_pull_charset($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
1025                                 return;
1026                         } elsif (has_fast_array($e, $l)) {
1027                                 if ($l->{IS_ZERO_TERMINATED}) {
1028                                         $self->CheckStringTerminator($ndr,$e,$l,$length);
1029                                 }
1030                                 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1031                                 return;
1032                         }
1033                 } elsif ($l->{TYPE} eq "POINTER") {
1034                         $self->ParsePtrPull($e, $l, $ndr, $var_name);
1035                 } elsif ($l->{TYPE} eq "SWITCH") {
1036                         $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1037                 } elsif ($l->{TYPE} eq "DATA") {
1038                         $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1039                 } elsif ($l->{TYPE} eq "TYPEDEF") {
1040                         $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1041                 }
1042         }
1043
1044         # add additional constructions
1045         if ($l->{TYPE} eq "POINTER" and $deferred) {
1046                 if ($l->{POINTER_TYPE} ne "ref") {
1047                         $self->pidl("if ($var_name) {");
1048                         $self->indent;
1049
1050                         if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1051                                 $self->pidl("uint32_t _relative_save_offset;");
1052                                 $self->pidl("_relative_save_offset = $ndr->offset;");
1053                                 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1054                         }
1055                 }
1056
1057                 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1058
1059                 $var_name = get_value_of($var_name);
1060                 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1061
1062                 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1063
1064                 if ($l->{POINTER_TYPE} ne "ref") {
1065                         if ($l->{POINTER_TYPE} eq "relative") {
1066                                 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1067                                 $self->indent;
1068                                 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1069                                 $self->deindent;
1070                                 $self->pidl("}");
1071                                 $self->pidl("$ndr->offset = _relative_save_offset;");
1072                         }
1073                         $self->deindent;
1074                         $self->pidl("}");
1075                 }
1076         } elsif ($l->{TYPE} eq "ARRAY" and
1077                         not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1078                 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1079                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1080                 my $array_name = $var_name;
1081
1082                 if ($l->{IS_VARYING}) {
1083                         $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
1084                 }
1085
1086                 $var_name = get_array_element($var_name, $counter);
1087
1088                 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1089
1090                 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1091                         my $nl = GetNextLevel($e,$l);
1092
1093                         if ($l->{IS_ZERO_TERMINATED}) {
1094                                 $self->CheckStringTerminator($ndr,$e,$l,$length);
1095                         }
1096
1097                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1098                         $self->indent;
1099                         $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1100                         $self->deindent;
1101                         $self->pidl("}");
1102                 }
1103
1104                 if ($deferred and ContainsDeferred($e, $l)) {
1105                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1106                         $self->indent;
1107                         $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1108                         $self->deindent;
1109                         $self->pidl("}");
1110                 }
1111
1112                 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1113
1114         } elsif ($l->{TYPE} eq "SWITCH") {
1115                 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1116         }
1117 }
1118
1119 #####################################################################
1120 # parse scalars in a structure element - pull size
1121 sub ParseElementPull($$$$$$)
1122 {
1123         my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1124
1125         my $var_name = $env->{$e->{NAME}};
1126         my $represent_name;
1127         my $transmit_name;
1128
1129         return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1130
1131         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1132                 $self->pidl("{");
1133                 $self->indent;
1134                 $represent_name = $var_name;
1135                 $transmit_name = "_transmit_$e->{NAME}";
1136                 $var_name = $transmit_name;
1137                 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1138         }
1139
1140         $var_name = append_prefix($e, $var_name);
1141
1142         $self->start_flags($e, $ndr);
1143
1144         $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1145
1146         $self->end_flags($e, $ndr);
1147
1148         # Representation type is different from transmit_as
1149         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1150                 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1151                 $self->deindent;
1152                 $self->pidl("}");
1153         }
1154 }
1155
1156 #####################################################################
1157 # parse a pointer in a struct element or function
1158 sub ParsePtrPull($$$$$)
1159 {
1160         my($self, $e,$l,$ndr,$var_name) = @_;
1161
1162         my $nl = GetNextLevel($e, $l);
1163         my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1164         my $next_is_string = (($nl->{TYPE} eq "DATA") and
1165                                                  ($nl->{DATA_TYPE} eq "string"));
1166
1167         if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1168
1169                 if (!$next_is_array and !$next_is_string) {
1170                         $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1171                         $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1172                         $self->pidl("}");
1173                 }
1174
1175                 return;
1176         } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1177                 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1178         } elsif (($l->{POINTER_TYPE} eq "unique") or
1179                  ($l->{POINTER_TYPE} eq "relative") or
1180                  ($l->{POINTER_TYPE} eq "full")) {
1181                 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1182         } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1183                 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1184         } else {
1185                 die("Unhandled pointer type $l->{POINTER_TYPE}");
1186         }
1187
1188         $self->pidl("if (_ptr_$e->{NAME}) {");
1189         $self->indent;
1190
1191         # Don't do this for arrays, they're allocated at the actual level
1192         # of the array
1193         unless ($next_is_array or $next_is_string) {
1194                 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1195         } else {
1196                 # FIXME: Yes, this is nasty.
1197                 # We allocate an array twice
1198                 # - once just to indicate that it's there,
1199                 # - then the real allocation...
1200                 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1201         }
1202
1203         #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1204         if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1205                 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1206         }
1207         $self->deindent;
1208         $self->pidl("} else {");
1209         $self->pidl("\t$var_name = NULL;");
1210         $self->pidl("}");
1211 }
1212
1213 sub ParseStructPushPrimitives($$$$$)
1214 {
1215         my ($self, $struct, $ndr, $varname, $env) = @_;
1216
1217         # see if the structure contains a conformant array. If it
1218         # does, then it must be the last element of the structure, and
1219         # we need to push the conformant length early, as it fits on
1220         # the wire before the structure (and even before the structure
1221         # alignment)
1222         if (defined($struct->{SURROUNDING_ELEMENT})) {
1223                 my $e = $struct->{SURROUNDING_ELEMENT};
1224
1225                 if (defined($e->{LEVELS}[0]) and
1226                         $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1227                         my $size;
1228
1229                         if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1230                                 if (has_property($e, "charset")) {
1231                                         $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1232                                 } else {
1233                                         $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1234                                 }
1235                         } else {
1236                                 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1237                         }
1238
1239                         $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1240                 } else {
1241                         $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1242                 }
1243         }
1244
1245         $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1246
1247         if (defined($struct->{PROPERTIES}{relative_base})) {
1248                 # set the current offset as base for relative pointers
1249                 # and store it based on the toplevel struct/union
1250                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1251         }
1252
1253         $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1254
1255         $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1256 }
1257
1258 sub ParseStructPushDeferred($$$$)
1259 {
1260         my ($self, $struct, $ndr, $varname, $env) = @_;
1261         if (defined($struct->{PROPERTIES}{relative_base})) {
1262                 # retrieve the current offset as base for relative pointers
1263                 # based on the toplevel struct/union
1264                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1265         }
1266         $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1267 }
1268
1269 #####################################################################
1270 # parse a struct
1271 sub ParseStructPush($$$$)
1272 {
1273         my ($self, $struct, $ndr, $varname) = @_;
1274
1275         return unless defined($struct->{ELEMENTS});
1276
1277         my $env = GenerateStructEnv($struct, $varname);
1278
1279         EnvSubstituteValue($env, $struct);
1280
1281         $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1282
1283         $self->start_flags($struct, $ndr);
1284
1285         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1286         $self->indent;
1287         $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1288         $self->deindent;
1289         $self->pidl("}");
1290
1291         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1292         $self->indent;
1293         $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1294         $self->deindent;
1295         $self->pidl("}");
1296
1297         $self->end_flags($struct, $ndr);
1298 }
1299
1300 #####################################################################
1301 # generate a push function for an enum
1302 sub ParseEnumPush($$$$)
1303 {
1304         my($self,$enum,$ndr,$varname) = @_;
1305         my($type_fn) = $enum->{BASE_TYPE};
1306
1307         $self->start_flags($enum, $ndr);
1308         $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1309         $self->end_flags($enum, $ndr);
1310 }
1311
1312 #####################################################################
1313 # generate a pull function for an enum
1314 sub ParseEnumPull($$$$)
1315 {
1316         my($self,$enum,$ndr,$varname) = @_;
1317         my($type_fn) = $enum->{BASE_TYPE};
1318         my($type_v_decl) = mapTypeName($type_fn);
1319
1320         $self->pidl("$type_v_decl v;");
1321         $self->start_flags($enum, $ndr);
1322         $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1323         $self->pidl("*$varname = v;");
1324
1325         $self->end_flags($enum, $ndr);
1326 }
1327
1328 #####################################################################
1329 # generate a print function for an enum
1330 sub ParseEnumPrint($$$$$)
1331 {
1332         my($self,$enum,$ndr,$name,$varname) = @_;
1333
1334         $self->pidl("const char *val = NULL;");
1335         $self->pidl("");
1336
1337         $self->start_flags($enum, $ndr);
1338
1339         $self->pidl("switch ($varname) {");
1340         $self->indent;
1341         my $els = \@{$enum->{ELEMENTS}};
1342         foreach my $i (0 .. $#{$els}) {
1343                 my $e = ${$els}[$i];
1344                 chomp $e;
1345                 if ($e =~ /^(.*)=/) {
1346                         $e = $1;
1347                 }
1348                 $self->pidl("case $e: val = \"$e\"; break;");
1349         }
1350
1351         $self->deindent;
1352         $self->pidl("}");
1353
1354         $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1355
1356         $self->end_flags($enum, $ndr);
1357 }
1358
1359 sub DeclEnum($$$$)
1360 {
1361         my ($e,$t,$name,$varname) = @_;
1362         return "enum $name " .
1363                 ($t eq "pull"?"*":"") . $varname;
1364 }
1365
1366 $typefamily{ENUM} = {
1367         DECL => \&DeclEnum,
1368         PUSH_FN_BODY => \&ParseEnumPush,
1369         PULL_FN_BODY => \&ParseEnumPull,
1370         PRINT_FN_BODY => \&ParseEnumPrint,
1371 };
1372
1373 #####################################################################
1374 # generate a push function for a bitmap
1375 sub ParseBitmapPush($$$$)
1376 {
1377         my($self,$bitmap,$ndr,$varname) = @_;
1378         my($type_fn) = $bitmap->{BASE_TYPE};
1379
1380         $self->start_flags($bitmap, $ndr);
1381
1382         $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1383
1384         $self->end_flags($bitmap, $ndr);
1385 }
1386
1387 #####################################################################
1388 # generate a pull function for an bitmap
1389 sub ParseBitmapPull($$$$)
1390 {
1391         my($self,$bitmap,$ndr,$varname) = @_;
1392         my $type_fn = $bitmap->{BASE_TYPE};
1393         my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1394
1395         $self->pidl("$type_decl v;");
1396         $self->start_flags($bitmap, $ndr);
1397         $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1398         $self->pidl("*$varname = v;");
1399
1400         $self->end_flags($bitmap, $ndr);
1401 }
1402
1403 #####################################################################
1404 # generate a print function for an bitmap
1405 sub ParseBitmapPrintElement($$$$$$)
1406 {
1407         my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1408         my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1409         my($type_fn) = $bitmap->{BASE_TYPE};
1410         my($flag);
1411
1412         if ($e =~ /^(\w+) .*$/) {
1413                 $flag = "$1";
1414         } else {
1415                 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1416         }
1417
1418         $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1419 }
1420
1421 #####################################################################
1422 # generate a print function for an bitmap
1423 sub ParseBitmapPrint($$$$$)
1424 {
1425         my($self,$bitmap,$ndr,$name,$varname) = @_;
1426         my($type_decl) = mapTypeName($bitmap->{TYPE});
1427         my($type_fn) = $bitmap->{BASE_TYPE};
1428
1429         $self->start_flags($bitmap, $ndr);
1430
1431         $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1432
1433         $self->pidl("$ndr->depth++;");
1434         foreach my $e (@{$bitmap->{ELEMENTS}}) {
1435                 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1436         }
1437         $self->pidl("$ndr->depth--;");
1438
1439         $self->end_flags($bitmap, $ndr);
1440 }
1441
1442 sub DeclBitmap($$$$)
1443 {
1444         my ($e,$t,$name,$varname) = @_;
1445         return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1446                 ($t eq "pull"?" *":" ") . $varname;
1447 }
1448
1449 $typefamily{BITMAP} = {
1450         DECL => \&DeclBitmap,
1451         PUSH_FN_BODY => \&ParseBitmapPush,
1452         PULL_FN_BODY => \&ParseBitmapPull,
1453         PRINT_FN_BODY => \&ParseBitmapPrint,
1454 };
1455
1456 #####################################################################
1457 # generate a struct print function
1458 sub ParseStructPrint($$$$$)
1459 {
1460         my($self,$struct,$ndr,$name,$varname) = @_;
1461
1462         return unless defined $struct->{ELEMENTS};
1463
1464         my $env = GenerateStructEnv($struct, $varname);
1465
1466         $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1467
1468         $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1469
1470         $self->start_flags($struct, $ndr);
1471
1472         $self->pidl("$ndr->depth++;");
1473
1474         $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1475                 foreach (@{$struct->{ELEMENTS}});
1476         $self->pidl("$ndr->depth--;");
1477
1478         $self->end_flags($struct, $ndr);
1479 }
1480
1481 sub DeclarePtrVariables($$)
1482 {
1483         my ($self,$e) = @_;
1484         foreach my $l (@{$e->{LEVELS}}) {
1485                 my $size = 32;
1486                 if ($l->{TYPE} eq "POINTER" and
1487                         not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1488                         if ($l->{POINTER_TYPE} eq "relative_short") {
1489                                 $size = 16;
1490                         }
1491                         $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1492                         last;
1493                 }
1494         }
1495 }
1496
1497 sub DeclareArrayVariables($$)
1498 {
1499         my ($self,$e) = @_;
1500
1501         foreach my $l (@{$e->{LEVELS}}) {
1502                 next if has_fast_array($e,$l);
1503                 next if is_charset_array($e,$l);
1504                 if ($l->{TYPE} eq "ARRAY") {
1505                         $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1506                 }
1507         }
1508 }
1509
1510 sub DeclareArrayVariablesNoZero($$$)
1511 {
1512         my ($self,$e,$env) = @_;
1513
1514         foreach my $l (@{$e->{LEVELS}}) {
1515                 next if has_fast_array($e,$l);
1516                 next if is_charset_array($e,$l);
1517                 if ($l->{TYPE} eq "ARRAY") {
1518                     my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1519                     if ($length eq "0") {
1520                         warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1521                     } else {
1522                         $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1523                     }
1524                 }
1525         }
1526 }
1527
1528 sub DeclareMemCtxVariables($$)
1529 {
1530         my ($self,$e) = @_;
1531         foreach my $l (@{$e->{LEVELS}}) {
1532                 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1533                 if (defined($mem_flags)) {
1534                         $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1535                 }
1536         }
1537 }
1538
1539 sub ParseStructPullPrimitives($$$$$)
1540 {
1541         my($self,$struct,$ndr,$varname,$env) = @_;
1542
1543         if (defined $struct->{SURROUNDING_ELEMENT}) {
1544                 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1545         }
1546
1547         $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1548
1549         if (defined($struct->{PROPERTIES}{relative_base})) {
1550                 # set the current offset as base for relative pointers
1551                 # and store it based on the toplevel struct/union
1552                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1553         }
1554
1555         $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1556
1557         $self->add_deferred();
1558
1559         $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1560 }
1561
1562 sub ParseStructPullDeferred($$$$$)
1563 {
1564         my ($self,$struct,$ndr,$varname,$env) = @_;
1565
1566         if (defined($struct->{PROPERTIES}{relative_base})) {
1567                 # retrieve the current offset as base for relative pointers
1568                 # based on the toplevel struct/union
1569                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1570         }
1571         foreach my $e (@{$struct->{ELEMENTS}}) {
1572                 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1573         }
1574
1575         $self->add_deferred();
1576 }
1577
1578 #####################################################################
1579 # parse a struct - pull side
1580 sub ParseStructPull($$$$)
1581 {
1582         my($self,$struct,$ndr,$varname) = @_;
1583
1584         return unless defined $struct->{ELEMENTS};
1585
1586         # declare any internal pointers we need
1587         foreach my $e (@{$struct->{ELEMENTS}}) {
1588                 $self->DeclarePtrVariables($e);
1589                 $self->DeclareArrayVariables($e);
1590                 $self->DeclareMemCtxVariables($e);
1591         }
1592
1593         $self->start_flags($struct, $ndr);
1594
1595         my $env = GenerateStructEnv($struct, $varname);
1596
1597         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1598         $self->indent;
1599         $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1600         $self->deindent;
1601         $self->pidl("}");
1602         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1603         $self->indent;
1604         $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1605         $self->deindent;
1606         $self->pidl("}");
1607
1608         $self->end_flags($struct, $ndr);
1609 }
1610
1611 #####################################################################
1612 # calculate size of ndr struct
1613 sub ParseStructNdrSize($$$$)
1614 {
1615         my ($self,$t, $name, $varname) = @_;
1616         my $sizevar;
1617
1618         if (my $flags = has_property($t, "flag")) {
1619                 $self->pidl("flags |= $flags;");
1620         }
1621         $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1622 }
1623
1624 sub DeclStruct($$$$)
1625 {
1626         my ($e,$t,$name,$varname) = @_;
1627         return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1628 }
1629
1630 sub ArgsStructNdrSize($$$)
1631 {
1632         my ($d, $name, $varname) = @_;
1633         return "const struct $name *$varname, struct smb_iconv_convenience *ic, int flags";
1634 }
1635
1636 $typefamily{STRUCT} = {
1637         PUSH_FN_BODY => \&ParseStructPush,
1638         DECL => \&DeclStruct,
1639         PULL_FN_BODY => \&ParseStructPull,
1640         PRINT_FN_BODY => \&ParseStructPrint,
1641         SIZE_FN_BODY => \&ParseStructNdrSize,
1642         SIZE_FN_ARGS => \&ArgsStructNdrSize,
1643 };
1644
1645 #####################################################################
1646 # calculate size of ndr struct
1647 sub ParseUnionNdrSize($$$)
1648 {
1649         my ($self, $t, $name, $varname) = @_;
1650         my $sizevar;
1651
1652         if (my $flags = has_property($t, "flag")) {
1653                 $self->pidl("flags |= $flags;");
1654         }
1655
1656         $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1657 }
1658
1659 sub ParseUnionPushPrimitives($$$$)
1660 {
1661         my ($self, $e, $ndr ,$varname) = @_;
1662
1663         my $have_default = 0;
1664
1665         $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1666
1667         if (defined($e->{SWITCH_TYPE})) {
1668                 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1669         }
1670
1671         if (defined($e->{ALIGN})) {
1672                 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1673         }
1674
1675         $self->pidl("switch (level) {");
1676         $self->indent;
1677         foreach my $el (@{$e->{ELEMENTS}}) {
1678                 if ($el->{CASE} eq "default") {
1679                         $have_default = 1;
1680                 }
1681                 $self->pidl("$el->{CASE}: {");
1682
1683                 if ($el->{TYPE} ne "EMPTY") {
1684                         $self->indent;
1685                         if (defined($e->{PROPERTIES}{relative_base})) {
1686                                 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1687                                 # set the current offset as base for relative pointers
1688                                 # and store it based on the toplevel struct/union
1689                                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1690                         }
1691                         $self->DeclareArrayVariables($el);
1692                         $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1693                         $self->deindent;
1694                 }
1695                 $self->pidl("break; }");
1696                 $self->pidl("");
1697         }
1698         if (! $have_default) {
1699                 $self->pidl("default:");
1700                 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1701         }
1702         $self->deindent;
1703         $self->pidl("}");
1704 }
1705
1706 sub ParseUnionPushDeferred($$$$)
1707 {
1708         my ($self,$e,$ndr,$varname) = @_;
1709
1710         my $have_default = 0;
1711
1712         $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1713         if (defined($e->{PROPERTIES}{relative_base})) {
1714                 # retrieve the current offset as base for relative pointers
1715                 # based on the toplevel struct/union
1716                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1717         }
1718         $self->pidl("switch (level) {");
1719         $self->indent;
1720         foreach my $el (@{$e->{ELEMENTS}}) {
1721                 if ($el->{CASE} eq "default") {
1722                         $have_default = 1;
1723                 }
1724
1725                 $self->pidl("$el->{CASE}:");
1726                 if ($el->{TYPE} ne "EMPTY") {
1727                         $self->indent;
1728                         $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1729                         $self->deindent;
1730                 }
1731                 $self->pidl("break;");
1732                 $self->pidl("");
1733         }
1734         if (! $have_default) {
1735                 $self->pidl("default:");
1736                 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1737         }
1738         $self->deindent;
1739         $self->pidl("}");
1740 }
1741
1742 #####################################################################
1743 # parse a union - push side
1744 sub ParseUnionPush($$$$)
1745 {
1746         my ($self,$e,$ndr,$varname) = @_;
1747         my $have_default = 0;
1748
1749         $self->start_flags($e, $ndr);
1750
1751         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1752         $self->indent;
1753         $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1754         $self->deindent;
1755         $self->pidl("}");
1756         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1757         $self->indent;
1758         $self->ParseUnionPushDeferred($e, $ndr, $varname);
1759         $self->deindent;
1760         $self->pidl("}");
1761         $self->end_flags($e, $ndr);
1762 }
1763
1764 #####################################################################
1765 # print a union
1766 sub ParseUnionPrint($$$$$)
1767 {
1768         my ($self,$e,$ndr,$name,$varname) = @_;
1769         my $have_default = 0;
1770
1771         $self->pidl("int level;");
1772         foreach my $el (@{$e->{ELEMENTS}}) {
1773                 $self->DeclareArrayVariables($el);
1774         }
1775
1776         $self->start_flags($e, $ndr);
1777
1778         $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1779
1780         $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1781
1782         $self->pidl("switch (level) {");
1783         $self->indent;
1784         foreach my $el (@{$e->{ELEMENTS}}) {
1785                 if ($el->{CASE} eq "default") {
1786                         $have_default = 1;
1787                 }
1788                 $self->pidl("$el->{CASE}:");
1789                 if ($el->{TYPE} ne "EMPTY") {
1790                         $self->indent;
1791                         $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1792                         $self->deindent;
1793                 }
1794                 $self->pidl("break;");
1795                 $self->pidl("");
1796         }
1797         if (! $have_default) {
1798                 $self->pidl("default:");
1799                 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1800         }
1801         $self->deindent;
1802         $self->pidl("}");
1803
1804         $self->end_flags($e, $ndr);
1805 }
1806
1807 sub ParseUnionPullPrimitives($$$$$)
1808 {
1809         my ($self,$e,$ndr,$varname,$switch_type) = @_;
1810         my $have_default = 0;
1811
1812         if (defined($switch_type)) {
1813                 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1814                 $self->pidl("if (_level != level) {");
1815                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1816                 $self->pidl("}");
1817         }
1818
1819         if (defined($e->{ALIGN})) {
1820                 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1821         }
1822
1823         $self->pidl("switch (level) {");
1824         $self->indent;
1825         foreach my $el (@{$e->{ELEMENTS}}) {
1826                 if ($el->{CASE} eq "default") {
1827                         $have_default = 1;
1828                 }
1829                 $self->pidl("$el->{CASE}: {");
1830
1831                 if ($el->{TYPE} ne "EMPTY") {
1832                         $self->indent;
1833                         $self->DeclarePtrVariables($el);
1834                         $self->DeclareArrayVariables($el);
1835                         if (defined($e->{PROPERTIES}{relative_base})) {
1836                                 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1837                                 # set the current offset as base for relative pointers
1838                                 # and store it based on the toplevel struct/union
1839                                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1840                         }
1841                         $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1842                         $self->deindent;
1843                 }
1844                 $self->pidl("break; }");
1845                 $self->pidl("");
1846         }
1847         if (! $have_default) {
1848                 $self->pidl("default:");
1849                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1850         }
1851         $self->deindent;
1852         $self->pidl("}");
1853 }
1854
1855 sub ParseUnionPullDeferred($$$$)
1856 {
1857         my ($self,$e,$ndr,$varname) = @_;
1858         my $have_default = 0;
1859
1860         if (defined($e->{PROPERTIES}{relative_base})) {
1861                 # retrieve the current offset as base for relative pointers
1862                 # based on the toplevel struct/union
1863                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1864         }
1865         $self->pidl("switch (level) {");
1866         $self->indent;
1867         foreach my $el (@{$e->{ELEMENTS}}) {
1868                 if ($el->{CASE} eq "default") {
1869                         $have_default = 1;
1870                 }
1871
1872                 $self->pidl("$el->{CASE}:");
1873                 if ($el->{TYPE} ne "EMPTY") {
1874                         $self->indent;
1875                         $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1876                         $self->deindent;
1877                 }
1878                 $self->pidl("break;");
1879                 $self->pidl("");
1880         }
1881         if (! $have_default) {
1882                 $self->pidl("default:");
1883                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1884         }
1885         $self->deindent;
1886         $self->pidl("}");
1887
1888
1889 }
1890
1891 #####################################################################
1892 # parse a union - pull side
1893 sub ParseUnionPull($$$$)
1894 {
1895         my ($self,$e,$ndr,$varname) = @_;
1896         my $switch_type = $e->{SWITCH_TYPE};
1897
1898         $self->pidl("int level;");
1899         if (defined($switch_type)) {
1900                 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1901                         $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1902                 }
1903                 $self->pidl(mapTypeName($switch_type) . " _level;");
1904         }
1905
1906         my %double_cases = ();
1907         foreach my $el (@{$e->{ELEMENTS}}) {
1908                 next if ($el->{TYPE} eq "EMPTY");
1909                 next if ($double_cases{"$el->{NAME}"});
1910                 $self->DeclareMemCtxVariables($el);
1911                 $double_cases{"$el->{NAME}"} = 1;
1912         }
1913
1914         $self->start_flags($e, $ndr);
1915
1916         $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1917
1918         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1919         $self->indent;
1920         $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1921         $self->deindent;
1922         $self->pidl("}");
1923
1924         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1925         $self->indent;
1926         $self->ParseUnionPullDeferred($e,$ndr,$varname);
1927         $self->deindent;
1928         $self->pidl("}");
1929
1930         $self->add_deferred();
1931
1932         $self->end_flags($e, $ndr);
1933 }
1934
1935 sub DeclUnion($$$$)
1936 {
1937         my ($e,$t,$name,$varname) = @_;
1938         return ($t ne "pull"?"const ":"") . "union $name *$varname";
1939 }
1940
1941 sub ArgsUnionNdrSize($$)
1942 {
1943         my ($d,$name) = @_;
1944         return "const union $name *r, uint32_t level, struct smb_iconv_convenience *ic, int flags";
1945 }
1946
1947 $typefamily{UNION} = {
1948         PUSH_FN_BODY => \&ParseUnionPush,
1949         DECL => \&DeclUnion,
1950         PULL_FN_BODY => \&ParseUnionPull,
1951         PRINT_FN_BODY => \&ParseUnionPrint,
1952         SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1953         SIZE_FN_BODY => \&ParseUnionNdrSize,
1954 };
1955
1956 #####################################################################
1957 # parse a typedef - push side
1958 sub ParseTypedefPush($$$$)
1959 {
1960         my($self,$e,$ndr,$varname) = @_;
1961
1962         my $env;
1963
1964         $env->{$e->{NAME}} = $varname;
1965
1966         $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1967 }
1968
1969 #####################################################################
1970 # parse a typedef - pull side
1971 sub ParseTypedefPull($$$$)
1972 {
1973         my($self,$e,$ndr,$varname) = @_;
1974
1975         my $env;
1976
1977         $env->{$e->{NAME}} = $varname;
1978
1979         $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1980 }
1981
1982 #####################################################################
1983 # parse a typedef - print side
1984 sub ParseTypedefPrint($$$$$)
1985 {
1986         my($self,$e,$ndr,$name,$varname) = @_;
1987
1988         $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
1989 }
1990
1991 #####################################################################
1992 ## calculate the size of a structure
1993 sub ParseTypedefNdrSize($$$$)
1994 {
1995         my($self,$t,$name,$varname) = @_;
1996
1997         $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
1998 }
1999
2000 sub DeclTypedef($$$$)
2001 {
2002         my ($e, $t, $name, $varname) = @_;
2003
2004         return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2005 }
2006
2007 sub ArgsTypedefNdrSize($$$)
2008 {
2009         my ($d, $name, $varname) = @_;
2010         return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2011 }
2012
2013 $typefamily{TYPEDEF} = {
2014         PUSH_FN_BODY => \&ParseTypedefPush,
2015         DECL => \&DeclTypedef,
2016         PULL_FN_BODY => \&ParseTypedefPull,
2017         PRINT_FN_BODY => \&ParseTypedefPrint,
2018         SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2019         SIZE_FN_BODY => \&ParseTypedefNdrSize,
2020 };
2021
2022 #####################################################################
2023 # parse a function - print side
2024 sub ParseFunctionPrint($$)
2025 {
2026         my($self, $fn) = @_;
2027         my $ndr = "ndr";
2028
2029         $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2030
2031         return if has_property($fn, "noprint");
2032
2033         $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2034         $self->pidl("{");
2035         $self->indent;
2036
2037         foreach my $e (@{$fn->{ELEMENTS}}) {
2038                 $self->DeclareArrayVariables($e);
2039         }
2040
2041         $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2042         $self->pidl("$ndr->depth++;");
2043
2044         $self->pidl("if (flags & NDR_SET_VALUES) {");
2045         $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2046         $self->pidl("}");
2047
2048         $self->pidl("if (flags & NDR_IN) {");
2049         $self->indent;
2050         $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2051         $self->pidl("$ndr->depth++;");
2052
2053         my $env = GenerateFunctionInEnv($fn);
2054
2055         foreach my $e (@{$fn->{ELEMENTS}}) {
2056                 if (grep(/in/,@{$e->{DIRECTION}})) {
2057                         $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2058                 }
2059         }
2060         $self->pidl("$ndr->depth--;");
2061         $self->deindent;
2062         $self->pidl("}");
2063
2064         $self->pidl("if (flags & NDR_OUT) {");
2065         $self->indent;
2066         $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2067         $self->pidl("$ndr->depth++;");
2068
2069         $env = GenerateFunctionOutEnv($fn);
2070         foreach my $e (@{$fn->{ELEMENTS}}) {
2071                 if (grep(/out/,@{$e->{DIRECTION}})) {
2072                         $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2073                 }
2074         }
2075         if ($fn->{RETURN_TYPE}) {
2076                 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2077         }
2078         $self->pidl("$ndr->depth--;");
2079         $self->deindent;
2080         $self->pidl("}");
2081
2082         $self->pidl("$ndr->depth--;");
2083         $self->deindent;
2084         $self->pidl("}");
2085         $self->pidl("");
2086 }
2087
2088 #####################################################################
2089 # parse a function
2090 sub ParseFunctionPush($$)
2091 {
2092         my($self, $fn) = @_;
2093         my $ndr = "ndr";
2094
2095         $self->fn_declare("push", $fn, "enum ndr_err_code ndr_push_$fn->{NAME}(struct ndr_push *$ndr, int flags, const struct $fn->{NAME} *r)") or return;
2096
2097         return if has_property($fn, "nopush");
2098
2099         $self->pidl("{");
2100         $self->indent;
2101
2102         foreach my $e (@{$fn->{ELEMENTS}}) {
2103                 $self->DeclareArrayVariables($e);
2104         }
2105
2106         $self->pidl("if (flags & NDR_IN) {");
2107         $self->indent;
2108
2109         my $env = GenerateFunctionInEnv($fn);
2110
2111         EnvSubstituteValue($env, $fn);
2112
2113         foreach my $e (@{$fn->{ELEMENTS}}) {
2114                 if (grep(/in/,@{$e->{DIRECTION}})) {
2115                         $self->ParseElementPush($e, $ndr, $env, 1, 1);
2116                 }
2117         }
2118
2119         $self->deindent;
2120         $self->pidl("}");
2121
2122         $self->pidl("if (flags & NDR_OUT) {");
2123         $self->indent;
2124
2125         $env = GenerateFunctionOutEnv($fn);
2126         foreach my $e (@{$fn->{ELEMENTS}}) {
2127                 if (grep(/out/,@{$e->{DIRECTION}})) {
2128                         $self->ParseElementPush($e, $ndr, $env, 1, 1);
2129                 }
2130         }
2131
2132         if ($fn->{RETURN_TYPE}) {
2133                 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2134         }
2135
2136         $self->deindent;
2137         $self->pidl("}");
2138         $self->pidl("return NDR_ERR_SUCCESS;");
2139         $self->deindent;
2140         $self->pidl("}");
2141         $self->pidl("");
2142 }
2143
2144 sub AllocateArrayLevel($$$$$$)
2145 {
2146         my ($self,$e,$l,$ndr,$var,$size) = @_;
2147
2148         my $pl = GetPrevLevel($e, $l);
2149         if (defined($pl) and
2150             $pl->{TYPE} eq "POINTER" and
2151             $pl->{POINTER_TYPE} eq "ref"
2152             and not $l->{IS_ZERO_TERMINATED}) {
2153                 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2154                 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2155                 $self->pidl("}");
2156                 if (grep(/in/,@{$e->{DIRECTION}}) and
2157                     grep(/out/,@{$e->{DIRECTION}})) {
2158                         $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2159                 }
2160                 return;
2161         }
2162
2163         $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2164 }
2165
2166 #####################################################################
2167 # parse a function
2168 sub ParseFunctionPull($$)
2169 {
2170         my($self,$fn) = @_;
2171         my $ndr = "ndr";
2172
2173         # pull function args
2174         $self->fn_declare("pull", $fn, "enum ndr_err_code ndr_pull_$fn->{NAME}(struct ndr_pull *$ndr, int flags, struct $fn->{NAME} *r)") or return;
2175
2176         $self->pidl("{");
2177         $self->indent;
2178
2179         # declare any internal pointers we need
2180         foreach my $e (@{$fn->{ELEMENTS}}) {
2181                 $self->DeclarePtrVariables($e);
2182                 $self->DeclareArrayVariables($e);
2183         }
2184
2185         my %double_cases = ();
2186         foreach my $e (@{$fn->{ELEMENTS}}) {
2187                 next if ($e->{TYPE} eq "EMPTY");
2188                 next if ($double_cases{"$e->{NAME}"});
2189                 $self->DeclareMemCtxVariables($e);
2190                 $double_cases{"$e->{NAME}"} = 1;
2191         }
2192
2193         $self->pidl("if (flags & NDR_IN) {");
2194         $self->indent;
2195
2196         # auto-init the out section of a structure. I originally argued that
2197         # this was a bad idea as it hides bugs, but coping correctly
2198         # with initialisation and not wiping ref vars is turning
2199         # out to be too tricky (tridge)
2200         foreach my $e (@{$fn->{ELEMENTS}}) {
2201                 next unless grep(/out/, @{$e->{DIRECTION}});
2202                 $self->pidl("ZERO_STRUCT(r->out);");
2203                 $self->pidl("");
2204                 last;
2205         }
2206
2207         my $env = GenerateFunctionInEnv($fn);
2208
2209         foreach my $e (@{$fn->{ELEMENTS}}) {
2210                 next unless (grep(/in/, @{$e->{DIRECTION}}));
2211                 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2212         }
2213
2214         # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2215         # own flag rather than be in NDR_IN ?
2216
2217         foreach my $e (@{$fn->{ELEMENTS}}) {
2218                 next unless (grep(/out/, @{$e->{DIRECTION}}));
2219                 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2220                              $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2221                 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2222                                  ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2223                 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2224                         and   $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2225
2226                 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2227                         my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2228                                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2229                                                    "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2230                                 check_fully_dereferenced($e, $env));
2231                         $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2232
2233                         if (grep(/in/, @{$e->{DIRECTION}})) {
2234                                 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2235                         } else {
2236                                 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2237                         }
2238                 } else {
2239                         $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2240
2241                         if (grep(/in/, @{$e->{DIRECTION}})) {
2242                                 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2243                         } else {
2244                                 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2245                         }
2246                 }
2247         }
2248
2249         $self->add_deferred();
2250         $self->deindent;
2251         $self->pidl("}");
2252
2253         $self->pidl("if (flags & NDR_OUT) {");
2254         $self->indent;
2255
2256         $env = GenerateFunctionOutEnv($fn);
2257         foreach my $e (@{$fn->{ELEMENTS}}) {
2258                 next unless grep(/out/, @{$e->{DIRECTION}});
2259                 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2260         }
2261
2262         if ($fn->{RETURN_TYPE}) {
2263                 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2264         }
2265
2266         $self->add_deferred();
2267         $self->deindent;
2268         $self->pidl("}");
2269
2270         $self->pidl("return NDR_ERR_SUCCESS;");
2271         $self->deindent;
2272         $self->pidl("}");
2273         $self->pidl("");
2274 }
2275
2276 sub AuthServiceStruct($$$)
2277 {
2278         my ($self, $ifacename, $authservice) = @_;
2279         my @a = split /,/, $authservice;
2280         my $authservice_count = $#a + 1;
2281
2282         $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2283         foreach my $ap (@a) {
2284                 $self->pidl("\t$ap, ");
2285         }
2286         $self->pidl("};");
2287         $self->pidl("");
2288
2289         $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2290         $self->pidl("\t.count\t= $authservice_count,");
2291         $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2292         $self->pidl("};");
2293         $self->pidl("");
2294 }
2295
2296 sub FunctionCallEntry($$)
2297 {
2298         my ($self, $d) = @_;
2299         return 0 if not defined($d->{OPNUM});
2300         $self->pidl("\t{");
2301         $self->pidl("\t\t\"$d->{NAME}\",");
2302         $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2303         $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2304         $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2305         $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2306         $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2307         $self->pidl("\t},");
2308         return 1;
2309 }
2310
2311 #####################################################################
2312 # produce a function call table
2313 sub FunctionTable($$)
2314 {
2315         my($self,$interface) = @_;
2316         my $count = 0;
2317         my $uname = uc $interface->{NAME};
2318
2319         return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2320         return unless defined ($interface->{PROPERTIES}->{uuid});
2321
2322         $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2323
2324         foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2325                 $count += $self->FunctionCallEntry($d);
2326         }
2327         $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2328         $self->pidl("};");
2329         $self->pidl("");
2330
2331         $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2332         foreach my $ep (@{$interface->{ENDPOINTS}}) {
2333                 $self->pidl("\t$ep, ");
2334         }
2335         my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2336
2337         $self->pidl("};");
2338         $self->pidl("");
2339
2340         $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2341         $self->pidl("\t.count\t= $endpoint_count,");
2342         $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2343         $self->pidl("};");
2344         $self->pidl("");
2345
2346         if (! defined $interface->{PROPERTIES}->{authservice}) {
2347                 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2348         }
2349
2350         $self->AuthServiceStruct($interface->{NAME},
2351                                      $interface->{PROPERTIES}->{authservice});
2352
2353         $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2354         $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2355         $self->pidl("\t.syntax_id\t= {");
2356         $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2357         $self->pidl("\t\tNDR_$uname\_VERSION");
2358         $self->pidl("\t},");
2359         $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2360         $self->pidl("\t.num_calls\t= $count,");
2361         $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2362         $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2363         $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2364         $self->pidl("};");
2365         $self->pidl("");
2366
2367 }
2368
2369 #####################################################################
2370 # generate include statements for imported idl files
2371 sub HeaderImport
2372 {
2373         my $self = shift;
2374         my @imports = @_;
2375         foreach (@imports) {
2376                 $_ = unmake_str($_);
2377                 s/\.idl$//;
2378                 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2379         }
2380 }
2381
2382 #####################################################################
2383 # generate include statements for included header files
2384 sub HeaderInclude
2385 {
2386         my $self = shift;
2387         my @includes = @_;
2388         foreach (@includes) {
2389                 $self->pidl_hdr("#include $_");
2390         }
2391 }
2392
2393 #####################################################################
2394 # generate prototypes and defines for the interface definitions
2395 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2396 # NDR parser and so do not belong here, technically speaking
2397 sub HeaderInterface($$$)
2398 {
2399         my($self,$interface,$needed) = @_;
2400
2401         my $count = 0;
2402
2403         if ($needed->{"compression"}) {
2404                 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2405         }
2406
2407         if (has_property($interface, "object")) {
2408                 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2409         }
2410
2411         if (defined $interface->{PROPERTIES}->{helper}) {
2412                 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2413         }
2414
2415         if (defined $interface->{PROPERTIES}->{uuid}) {
2416                 my $name = uc $interface->{NAME};
2417                 $self->pidl_hdr("#define NDR_$name\_UUID " .
2418                 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2419
2420                 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2421                 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2422
2423                 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2424
2425                 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2426                 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2427
2428                 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2429         }
2430
2431         foreach (@{$interface->{FUNCTIONS}}) {
2432                 next if has_property($_, "noopnum");
2433                 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2434                 my $u_name = uc $_->{NAME};
2435
2436                 my $val = sprintf("0x%02x", $count);
2437                 if (defined($interface->{BASE})) {
2438                         $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2439                 }
2440
2441                 $self->pidl_hdr("#define NDR_$u_name ($val)");
2442
2443                 $self->pidl_hdr("");
2444                 $count++;
2445         }
2446
2447         my $val = $count;
2448
2449         if (defined($interface->{BASE})) {
2450                 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2451         }
2452
2453         $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2454
2455 }
2456
2457 sub ParseTypePush($$$$$$)
2458 {
2459         my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2460
2461         # save the old relative_base_offset
2462         $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2463         $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2464         # restore the old relative_base_offset
2465         $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2466 }
2467
2468 sub ParseTypePushFunction($$$)
2469 {
2470         my ($self, $e, $varname) = @_;
2471         my $ndr = "ndr";
2472
2473         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2474
2475         $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2476
2477         $self->pidl("{");
2478         $self->indent;
2479         $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2480         $self->pidl("return NDR_ERR_SUCCESS;");
2481         $self->deindent;
2482         $self->pidl("}");
2483         $self->pidl("");;
2484 }
2485
2486 sub ParseTypePull($$$$$$)
2487 {
2488         my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2489
2490         # save the old relative_base_offset
2491         $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2492         $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2493         # restore the old relative_base_offset
2494         $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2495 }
2496
2497 sub ParseTypePullFunction($$)
2498 {
2499         my ($self, $e, $varname) = @_;
2500         my $ndr = "ndr";
2501
2502         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2503
2504         $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2505
2506         $self->pidl("{");
2507         $self->indent;
2508         $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2509         $self->pidl("return NDR_ERR_SUCCESS;");
2510         $self->deindent;
2511         $self->pidl("}");
2512         $self->pidl("");
2513 }
2514
2515 sub ParseTypePrint($$$$)
2516 {
2517         my ($self, $e, $ndr, $varname) = @_;
2518
2519         $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2520 }
2521
2522 sub ParseTypePrintFunction($$$)
2523 {
2524         my ($self, $e, $varname) = @_;
2525         my $ndr = "ndr";
2526
2527         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2528
2529         $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2530
2531         return if (has_property($e, "noprint"));
2532
2533         $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2534         $self->pidl("{");
2535         $self->indent;
2536         $self->ParseTypePrint($e, $ndr, $varname);
2537         $self->deindent;
2538         $self->pidl("}");
2539         $self->pidl("");
2540 }
2541
2542 sub ParseTypeNdrSize($$)
2543 {
2544         my ($self,$t) = @_;
2545
2546         my $varname = "r";
2547         my $tf = $typefamily{$t->{TYPE}};
2548         my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2549
2550         $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2551
2552         $self->pidl("{");
2553         $self->indent;
2554         $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2555         $self->deindent;
2556         $self->pidl("}");
2557         $self->pidl("");
2558 }
2559
2560 #####################################################################
2561 # parse the interface definitions
2562 sub ParseInterface($$$)
2563 {
2564         my($self,$interface,$needed) = @_;
2565
2566         $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2567         $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2568
2569         $self->pidl_hdr("");
2570
2571         $self->HeaderInterface($interface, $needed);
2572
2573         # Typedefs
2574         foreach my $d (@{$interface->{TYPES}}) {
2575                 next unless(typeHasBody($d));
2576
2577                 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2578                 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2579                 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2580
2581                 # Make sure we don't generate a function twice...
2582                 $needed->{TypeFunctionName("ndr_push", $d)} =
2583                     $needed->{TypeFunctionName("ndr_pull", $d)} =
2584                         $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2585
2586                 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2587         }
2588
2589         # Functions
2590         foreach my $d (@{$interface->{FUNCTIONS}}) {
2591                 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2592                 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2593                 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2594
2595                 # Make sure we don't generate a function twice...
2596                 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2597                         $needed->{"ndr_print_$d->{NAME}"} = 0;
2598         }
2599
2600         $self->FunctionTable($interface);
2601
2602         $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2603 }
2604
2605 sub GenerateIncludes($)
2606 {
2607         my ($self) = @_;
2608         if (is_intree()) {
2609                 $self->pidl("#include \"includes.h\"");
2610         } else {
2611                 $self->pidl("#ifndef _GNU_SOURCE");
2612                 $self->pidl("#define _GNU_SOURCE");
2613                 $self->pidl("#endif");
2614                 $self->pidl("#include <stdint.h>");
2615                 $self->pidl("#include <stdlib.h>");
2616                 $self->pidl("#include <stdio.h>");
2617                 $self->pidl("#include <stdbool.h>");
2618                 $self->pidl("#include <stdarg.h>");
2619                 $self->pidl("#include <string.h>");
2620         }
2621 }
2622
2623 #####################################################################
2624 # parse a parsed IDL structure back into an IDL file
2625 sub Parse($$$$)
2626 {
2627         my($self, $ndr,$gen_header,$ndr_header) = @_;
2628
2629         $self->pidl_hdr("/* header auto-generated by pidl */");
2630         $self->pidl_hdr("");
2631         $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2632         $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2633         $self->pidl_hdr("");
2634
2635         $self->pidl("/* parser auto-generated by pidl */");
2636         $self->pidl("");
2637         $self->GenerateIncludes();
2638         $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2639         $self->pidl("");
2640
2641         my %needed = ();
2642
2643         foreach (@{$ndr}) {
2644                 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2645         }
2646
2647         foreach (@{$ndr}) {
2648                 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2649                 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2650                 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2651         }
2652
2653         return ($self->{res_hdr}, $self->{res});
2654 }
2655
2656 sub NeededElement($$$)
2657 {
2658         my ($e, $dir, $needed) = @_;
2659
2660         return if ($e->{TYPE} eq "EMPTY");
2661
2662         return if (ref($e->{TYPE}) eq "HASH" and
2663                        not defined($e->{TYPE}->{NAME}));
2664
2665         my ($t, $rt);
2666         if (ref($e->{TYPE}) eq "HASH") {
2667                 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2668         } else {
2669                 $t = $e->{TYPE};
2670         }
2671
2672         if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2673                 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2674         } else {
2675                 $rt = $e->{REPRESENTATION_TYPE};
2676         }
2677
2678         die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2679
2680         my @fn = ();
2681         if ($dir eq "print") {
2682                 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2683         } elsif ($dir eq "pull") {
2684                 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2685                 push (@fn, "ndr_$t\_to_$rt")
2686                         if ($rt ne $t);
2687         } elsif ($dir eq "push") {
2688                 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2689                 push (@fn, "ndr_$rt\_to_$t")
2690                         if ($rt ne $t);
2691         } else {
2692                 die("invalid direction `$dir'");
2693         }
2694
2695         foreach (@fn) {
2696                 unless (defined($needed->{$_})) {
2697                         $needed->{$_} = 1;
2698                 }
2699         }
2700 }
2701
2702 sub NeededFunction($$)
2703 {
2704         my ($fn,$needed) = @_;
2705         $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2706         $needed->{"ndr_push_$fn->{NAME}"} = 1;
2707         $needed->{"ndr_print_$fn->{NAME}"} = 1;
2708         foreach my $e (@{$fn->{ELEMENTS}}) {
2709                 $e->{PARENT} = $fn;
2710                 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2711         }
2712 }
2713
2714 sub NeededType($$$)
2715 {
2716         sub NeededType($$$);
2717         my ($t,$needed,$req) = @_;
2718
2719         NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2720
2721         if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2722                 return unless defined($t->{ELEMENTS});
2723                 for my $e (@{$t->{ELEMENTS}}) {
2724                         $e->{PARENT} = $t;
2725                         if (has_property($e, "compression")) {
2726                                 $needed->{"compression"} = 1;
2727                         }
2728                         NeededElement($e, $req, $needed);
2729                         NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2730                 }
2731         }
2732 }
2733
2734 #####################################################################
2735 # work out what parse functions are needed
2736 sub NeededInterface($$)
2737 {
2738         my ($interface,$needed) = @_;
2739         NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2740         foreach (reverse @{$interface->{TYPES}}) {
2741                 if (has_property($_, "public")) {
2742                         $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2743                                 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2744                 }
2745
2746                 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2747                 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2748                 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2749                 if (has_property($_, "gensize")) {
2750                         $needed->{"ndr_size_$_->{NAME}"} = 1;
2751                 }
2752         }
2753 }
2754
2755 sub TypeFunctionName($$)
2756 {
2757         my ($prefix, $t) = @_;
2758
2759         return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2760                         $t->{TYPE} eq "TYPEDEF");
2761         return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2762         return "$prefix\_$t";
2763 }
2764
2765 1;