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_uint32($ndr, NDR_SCALARS, $size));");
 208         }
 209
 210         if ($l->{IS_VARYING}) {
 211                 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));");  # array offset
 212                 $self->pidl("NDR_CHECK(ndr_push_uint32($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                 if ($l->{POINTER_TYPE} ne "ref") {
 571                         $self->pidl("if ($var_name) {");
 572                         $self->indent;
 573                         if ($l->{POINTER_TYPE} eq "relative") {
 574                                 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2($ndr, $var_name));");
 575                         }
 576                 }
 577                 $var_name = get_value_of($var_name);
 578                 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
 579
 580                 if ($l->{POINTER_TYPE} ne "ref") {
 581                         $self->deindent;
 582                         $self->pidl("}");
 583                 }
 584         } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
 585                 not is_charset_array($e, $l)) {
 586                 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
 587                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
 588
 589                 my $array_pointless = ($length eq "0");
 590
 591                 if ($array_pointless) {
 592                         warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
 593                 }
 594
 595                 $var_name = get_array_element($var_name, $counter);
 596
 597                 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
 598                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
 599                         $self->indent;
 600                         $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
 601                         $self->deindent;
 602                         $self->pidl("}");
 603                 }
 604
 605                 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
 606                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
 607                         $self->indent;
 608                         $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
 609                         $self->deindent;
 610                         $self->pidl("}");
 611                 }
 612         } elsif ($l->{TYPE} eq "SWITCH") {
 613                 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
 614         }
 615 }
 616
 617 #####################################################################
 618 # parse scalars in a structure element
 619 sub ParseElementPush($$$$$$)
 620 {
 621         my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
 622         my $subndr = undef;
 623
 624         my $var_name = $env->{$e->{NAME}};
 625
 626         return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
 627
 628         # Representation type is different from transmit_as
 629         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
 630                 $self->pidl("{");
 631                 $self->indent;
 632                 my $transmit_name = "_transmit_$e->{NAME}";
 633                 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
 634                 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
 635                 $var_name = $transmit_name;
 636         }
 637
 638         $var_name = append_prefix($e, $var_name);
 639
 640         $self->start_flags($e, $ndr);
 641
 642         if (defined(my $value = has_property($e, "value"))) {
 643                 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
 644         }
 645
 646         $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
 647
 648         $self->end_flags($e, $ndr);
 649
 650         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
 651                 $self->deindent;
 652                 $self->pidl("}");
 653         }
 654 }
 655
 656 #####################################################################
 657 # parse a pointer in a struct element or function
 658 sub ParsePtrPush($$$$$)
 659 {
 660         my ($self,$e,$l,$ndr,$var_name) = @_;
 661
 662         if ($l->{POINTER_TYPE} eq "ref") {
 663                 $self->pidl("if ($var_name == NULL) {");
 664                 $self->indent;
 665                 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
 666                 $self->deindent;
 667                 $self->pidl("}");
 668                 if ($l->{LEVEL} eq "EMBEDDED") {
 669                         $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
 670                 }
 671         } elsif ($l->{POINTER_TYPE} eq "relative") {
 672                 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
 673         } elsif ($l->{POINTER_TYPE} eq "unique") {
 674                 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
 675         } elsif ($l->{POINTER_TYPE} eq "full") {
 676                 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
 677         } else {
 678                 die("Unhandled pointer type $l->{POINTER_TYPE}");
 679         }
 680 }
 681
 682 sub need_pointer_to($$$)
 683 {
 684         my ($e, $l, $scalar_only) = @_;
 685
 686         my $t;
 687         if (ref($l->{DATA_TYPE})) {
 688                 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
 689         } else {
 690                 $t = $l->{DATA_TYPE};
 691         }
 692
 693         if (not Parse::Pidl::Typelist::is_scalar($t)) {
 694                 return 1 if $scalar_only;
 695         }
 696
 697         my $arrays = 0;
 698
 699         foreach my $tl (@{$e->{LEVELS}}) {
 700                 last if $l == $tl;
 701                 if ($tl->{TYPE} eq "ARRAY") {
 702                         $arrays++;
 703                 }
 704         }
 705
 706         if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
 707                 return 1 unless $arrays;
 708         }
 709
 710         return 0;
 711 }
 712
 713 sub ParseDataPrint($$$$$)
 714 {
 715         my ($self, $e, $l, $ndr, $var_name) = @_;
 716
 717         if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
 718
 719                 if (need_pointer_to($e, $l, 1)) {
 720                         $var_name = get_pointer_to($var_name);
 721                 }
 722
 723                 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
 724         } else {
 725                 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
 726         }
 727 }
 728
 729 #####################################################################
 730 # print scalars in a structure element
 731 sub ParseElementPrint($$$$$)
 732 {
 733         my($self, $e, $ndr, $var_name, $env) = @_;
 734
 735         return if (has_property($e, "noprint"));
 736
 737         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
 738                 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
 739                 return;
 740         }
 741
 742         $var_name = append_prefix($e, $var_name);
 743
 744         if (defined(my $value = has_property($e, "value"))) {
 745                 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
 746         }
 747
 748         foreach my $l (@{$e->{LEVELS}}) {
 749                 if ($l->{TYPE} eq "POINTER") {
 750                         $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
 751                         $self->pidl("$ndr->depth++;");
 752                         if ($l->{POINTER_TYPE} ne "ref") {
 753                                 $self->pidl("if ($var_name) {");
 754                                 $self->indent;
 755                         }
 756                         $var_name = get_value_of($var_name);
 757                 } elsif ($l->{TYPE} eq "ARRAY") {
 758                         my $length;
 759
 760                         if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
 761                                 $var_name = get_pointer_to($var_name);
 762                         }
 763
 764                         if ($l->{IS_ZERO_TERMINATED}) {
 765                                 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
 766                         } else {
 767                                 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
 768                                                         check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
 769                         }
 770
 771                         if (is_charset_array($e,$l)) {
 772                                 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
 773                                 last;
 774                         } elsif (has_fast_array($e, $l)) {
 775                                 my $nl = GetNextLevel($e, $l);
 776                                 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
 777                                 last;
 778                         } else {
 779                                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
 780
 781                                 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
 782                                 $self->pidl("$ndr->depth++;");
 783                                 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
 784                                 $self->indent;
 785                                 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
 786                                 $self->pidl("if (asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter) != -1) {");
 787                                 $self->indent;
 788
 789                                 $var_name = get_array_element($var_name, $counter);
 790                         }
 791                 } elsif ($l->{TYPE} eq "DATA") {
 792                         $self->ParseDataPrint($e, $l, $ndr, $var_name);
 793                 } elsif ($l->{TYPE} eq "SWITCH") {
 794                         my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
 795                                                 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
 796                         $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
 797                 }
 798         }
 799
 800         foreach my $l (reverse @{$e->{LEVELS}}) {
 801                 if ($l->{TYPE} eq "POINTER") {
 802                         if ($l->{POINTER_TYPE} ne "ref") {
 803                                 $self->deindent;
 804                                 $self->pidl("}");
 805                         }
 806                         $self->pidl("$ndr->depth--;");
 807                 } elsif (($l->{TYPE} eq "ARRAY")
 808                         and not is_charset_array($e,$l)
 809                         and not has_fast_array($e,$l)) {
 810                         $self->pidl("free(idx_$l->{LEVEL_INDEX});");
 811                         $self->deindent;
 812                         $self->pidl("}");
 813                         $self->deindent;
 814                         $self->pidl("}");
 815                         $self->pidl("$ndr->depth--;");
 816                 }
 817         }
 818 }
 819
 820 #####################################################################
 821 # parse scalars in a structure element - pull size
 822 sub ParseSwitchPull($$$$$$)
 823 {
 824         my($self,$e,$l,$ndr,$var_name,$env) = @_;
 825         my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
 826                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
 827                                    "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
 828                 check_fully_dereferenced($e, $env));
 829
 830         $var_name = get_pointer_to($var_name);
 831         $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
 832 }
 833
 834 #####################################################################
 835 # push switch element
 836 sub ParseSwitchPush($$$$$$)
 837 {
 838         my($self,$e,$l,$ndr,$var_name,$env) = @_;
 839         my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
 840                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
 841                                    "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
 842                 check_fully_dereferenced($e, $env));
 843
 844         $var_name = get_pointer_to($var_name);
 845         $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
 846 }
 847
 848 sub ParseDataPull($$$$$$$)
 849 {
 850         my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
 851
 852         if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
 853
 854                 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
 855
 856                 if (need_pointer_to($e, $l, 0)) {
 857                         $var_name = get_pointer_to($var_name);
 858                 }
 859
 860                 $var_name = get_pointer_to($var_name);
 861
 862                 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
 863
 864                 if (my $range = has_property($e, "range")) {
 865                         $var_name = get_value_of($var_name);
 866                         my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
 867                         my ($low, $high) = split(/,/, $range, 2);
 868                         if ($low < 0 and not $signed) {
 869                                 warning(0, "$low is invalid for the range of an unsigned type");
 870                         }
 871                         if ($low == 0 and not $signed) {
 872                                 $self->pidl("if ($var_name > $high) {");
 873                         } else {
 874                                 $self->pidl("if ($var_name < $low || $var_name > $high) {");
 875                         }
 876                         $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
 877                         $self->pidl("}");
 878                 }
 879         } else {
 880                 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
 881         }
 882 }
 883
 884 sub ParseDataPush($$$$$$$)
 885 {
 886         my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
 887
 888         if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
 889
 890                 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
 891
 892                 # strings are passed by value rather than reference
 893                 if (need_pointer_to($e, $l, 1)) {
 894                         $var_name = get_pointer_to($var_name);
 895                 }
 896
 897                 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
 898         } else {
 899                 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
 900         }
 901 }
 902
 903 sub CalcNdrFlags($$$)
 904 {
 905         my ($l,$primitives,$deferred) = @_;
 906
 907         my $scalars = 0;
 908         my $buffers = 0;
 909
 910         # Add NDR_SCALARS if this one is deferred
 911         # and deferreds may be pushed
 912         $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
 913
 914         # Add NDR_SCALARS if this one is not deferred and
 915         # primitives may be pushed
 916         $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
 917
 918         # Add NDR_BUFFERS if this one contains deferred stuff
 919         # and deferreds may be pushed
 920         $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
 921
 922         return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
 923         return "NDR_SCALARS" if ($scalars);
 924         return "NDR_BUFFERS" if ($buffers);
 925         return undef;
 926 }
 927
 928 sub ParseMemCtxPullFlags($$$$)
 929 {
 930         my ($self, $e, $l) = @_;
 931
 932         return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
 933
 934         return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
 935         return undef if has_fast_array($e, $l);
 936         return undef if is_charset_array($e, $l);
 937
 938         my $mem_flags = "0";
 939
 940         if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
 941                 my $nl = GetNextLevel($e, $l);
 942                 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
 943                 my $next_is_string = (($nl->{TYPE} eq "DATA") and
 944                                         ($nl->{DATA_TYPE} eq "string"));
 945                 if ($next_is_array or $next_is_string) {
 946                         return undef;
 947                 } elsif ($l->{LEVEL} eq "TOP") {
 948                         $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
 949                 }
 950         }
 951
 952         return $mem_flags;
 953 }
 954
 955 sub ParseMemCtxPullStart($$$$$)
 956 {
 957         my ($self, $e, $l, $ndr, $ptr_name) = @_;
 958
 959         my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
 960         my $mem_c_ctx = $ptr_name;
 961         my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
 962
 963         return unless defined($mem_c_flags);
 964
 965         $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
 966         $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
 967 }
 968
 969 sub ParseMemCtxPullEnd($$$$)
 970 {
 971         my ($self, $e, $l, $ndr) = @_;
 972
 973         my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
 974         my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
 975
 976         return unless defined($mem_r_flags);
 977
 978         $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
 979 }
 980
 981 sub CheckStringTerminator($$$$$)
 982 {
 983         my ($self,$ndr,$e,$l,$length) = @_;
 984         my $nl = GetNextLevel($e, $l);
 985
 986         # Make sure last element is zero!
 987         $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
 988 }
 989
 990 sub ParseElementPullLevel
 991 {
 992         my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
 993
 994         my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
 995
 996         if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
 997                 $var_name = get_pointer_to($var_name);
 998         }
 999
1000         # Only pull something if there's actually something to be pulled
1001         if (defined($ndr_flags)) {
1002                 if ($l->{TYPE} eq "SUBCONTEXT") {
1003                         my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1004                         $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1005                         $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1006                 } elsif ($l->{TYPE} eq "ARRAY") {
1007                         my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1008
1009                         my $nl = GetNextLevel($e, $l);
1010
1011                         if (is_charset_array($e,$l)) {
1012                                 if ($l->{IS_ZERO_TERMINATED}) {
1013                                         $self->CheckStringTerminator($ndr, $e, $l, $length);
1014                                 }
1015                                 $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}));");
1016                                 return;
1017                         } elsif (has_fast_array($e, $l)) {
1018                                 if ($l->{IS_ZERO_TERMINATED}) {
1019                                         $self->CheckStringTerminator($ndr,$e,$l,$length);
1020                                 }
1021                                 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1022                                 return;
1023                         }
1024                 } elsif ($l->{TYPE} eq "POINTER") {
1025                         $self->ParsePtrPull($e, $l, $ndr, $var_name);
1026                 } elsif ($l->{TYPE} eq "SWITCH") {
1027                         $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1028                 } elsif ($l->{TYPE} eq "DATA") {
1029                         $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1030                 } elsif ($l->{TYPE} eq "TYPEDEF") {
1031                         $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1032                 }
1033         }
1034
1035         # add additional constructions
1036         if ($l->{TYPE} eq "POINTER" and $deferred) {
1037                 if ($l->{POINTER_TYPE} ne "ref") {
1038                         $self->pidl("if ($var_name) {");
1039                         $self->indent;
1040
1041                         if ($l->{POINTER_TYPE} eq "relative") {
1042                                 $self->pidl("uint32_t _relative_save_offset;");
1043                                 $self->pidl("_relative_save_offset = $ndr->offset;");
1044                                 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1045                         }
1046                 }
1047
1048                 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1049
1050                 $var_name = get_value_of($var_name);
1051                 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1052
1053                 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1054
1055                 if ($l->{POINTER_TYPE} ne "ref") {
1056                         if ($l->{POINTER_TYPE} eq "relative") {
1057                                 $self->pidl("$ndr->offset = _relative_save_offset;");
1058                         }
1059                         $self->deindent;
1060                         $self->pidl("}");
1061                 }
1062         } elsif ($l->{TYPE} eq "ARRAY" and
1063                         not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1064                 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1065                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1066                 my $array_name = $var_name;
1067
1068                 $var_name = get_array_element($var_name, $counter);
1069
1070                 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1071
1072                 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1073                         my $nl = GetNextLevel($e,$l);
1074
1075                         if ($l->{IS_ZERO_TERMINATED}) {
1076                                 $self->CheckStringTerminator($ndr,$e,$l,$length);
1077                         }
1078
1079                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1080                         $self->indent;
1081                         $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1082                         $self->deindent;
1083                         $self->pidl("}");
1084                 }
1085
1086                 if ($deferred and ContainsDeferred($e, $l)) {
1087                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1088                         $self->indent;
1089                         $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1090                         $self->deindent;
1091                         $self->pidl("}");
1092                 }
1093
1094                 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1095
1096         } elsif ($l->{TYPE} eq "SWITCH") {
1097                 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1098         }
1099 }
1100
1101 #####################################################################
1102 # parse scalars in a structure element - pull size
1103 sub ParseElementPull($$$$$$)
1104 {
1105         my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1106
1107         my $var_name = $env->{$e->{NAME}};
1108         my $represent_name;
1109         my $transmit_name;
1110
1111         return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1112
1113         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1114                 $self->pidl("{");
1115                 $self->indent;
1116                 $represent_name = $var_name;
1117                 $transmit_name = "_transmit_$e->{NAME}";
1118                 $var_name = $transmit_name;
1119                 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1120         }
1121
1122         $var_name = append_prefix($e, $var_name);
1123
1124         $self->start_flags($e, $ndr);
1125
1126         $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1127
1128         $self->end_flags($e, $ndr);
1129
1130         # Representation type is different from transmit_as
1131         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1132                 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1133                 $self->deindent;
1134                 $self->pidl("}");
1135         }
1136 }
1137
1138 #####################################################################
1139 # parse a pointer in a struct element or function
1140 sub ParsePtrPull($$$$$)
1141 {
1142         my($self, $e,$l,$ndr,$var_name) = @_;
1143
1144         my $nl = GetNextLevel($e, $l);
1145         my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1146         my $next_is_string = (($nl->{TYPE} eq "DATA") and
1147                                                  ($nl->{DATA_TYPE} eq "string"));
1148
1149         if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1150
1151                 if (!$next_is_array and !$next_is_string) {
1152                         $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1153                         $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1154                         $self->pidl("}");
1155                 }
1156
1157                 return;
1158         } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1159                 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1160         } elsif (($l->{POINTER_TYPE} eq "unique") or
1161                  ($l->{POINTER_TYPE} eq "relative") or
1162                  ($l->{POINTER_TYPE} eq "full")) {
1163                 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1164         } else {
1165                 die("Unhandled pointer type $l->{POINTER_TYPE}");
1166         }
1167
1168         $self->pidl("if (_ptr_$e->{NAME}) {");
1169         $self->indent;
1170
1171         # Don't do this for arrays, they're allocated at the actual level
1172         # of the array
1173         unless ($next_is_array or $next_is_string) {
1174                 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1175         } else {
1176                 # FIXME: Yes, this is nasty.
1177                 # We allocate an array twice
1178                 # - once just to indicate that it's there,
1179                 # - then the real allocation...
1180                 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1181         }
1182
1183         #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1184         if ($l->{POINTER_TYPE} eq "relative") {
1185                 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1186         }
1187         $self->deindent;
1188         $self->pidl("} else {");
1189         $self->pidl("\t$var_name = NULL;");
1190         $self->pidl("}");
1191 }
1192
1193 sub ParseStructPushPrimitives($$$$$)
1194 {
1195         my ($self, $struct, $ndr, $varname, $env) = @_;
1196
1197         # see if the structure contains a conformant array. If it
1198         # does, then it must be the last element of the structure, and
1199         # we need to push the conformant length early, as it fits on
1200         # the wire before the structure (and even before the structure
1201         # alignment)
1202         if (defined($struct->{SURROUNDING_ELEMENT})) {
1203                 my $e = $struct->{SURROUNDING_ELEMENT};
1204
1205                 if (defined($e->{LEVELS}[0]) and
1206                         $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1207                         my $size;
1208
1209                         if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1210                                 if (has_property($e, "charset")) {
1211                                         $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1212                                 } else {
1213                                         $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1214                                 }
1215                         } else {
1216                                 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1217                         }
1218
1219                         $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
1220                 } else {
1221                         $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1222                 }
1223         }
1224
1225         $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1226
1227         if (defined($struct->{PROPERTIES}{relative_base})) {
1228                 # set the current offset as base for relative pointers
1229                 # and store it based on the toplevel struct/union
1230                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1231         }
1232
1233         $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1234 }
1235
1236 sub ParseStructPushDeferred($$$$)
1237 {
1238         my ($self, $struct, $ndr, $varname, $env) = @_;
1239         if (defined($struct->{PROPERTIES}{relative_base})) {
1240                 # retrieve the current offset as base for relative pointers
1241                 # based on the toplevel struct/union
1242                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1243         }
1244         $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1245 }
1246
1247 #####################################################################
1248 # parse a struct
1249 sub ParseStructPush($$$$)
1250 {
1251         my ($self, $struct, $ndr, $varname) = @_;
1252
1253         return unless defined($struct->{ELEMENTS});
1254
1255         my $env = GenerateStructEnv($struct, $varname);
1256
1257         EnvSubstituteValue($env, $struct);
1258
1259         $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1260
1261         $self->start_flags($struct, $ndr);
1262
1263         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1264         $self->indent;
1265         $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1266         $self->deindent;
1267         $self->pidl("}");
1268
1269         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1270         $self->indent;
1271         $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1272         $self->deindent;
1273         $self->pidl("}");
1274
1275         $self->end_flags($struct, $ndr);
1276 }
1277
1278 #####################################################################
1279 # generate a push function for an enum
1280 sub ParseEnumPush($$$$)
1281 {
1282         my($self,$enum,$ndr,$varname) = @_;
1283         my($type_fn) = $enum->{BASE_TYPE};
1284
1285         $self->start_flags($enum, $ndr);
1286         $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1287         $self->end_flags($enum, $ndr);
1288 }
1289
1290 #####################################################################
1291 # generate a pull function for an enum
1292 sub ParseEnumPull($$$$)
1293 {
1294         my($self,$enum,$ndr,$varname) = @_;
1295         my($type_fn) = $enum->{BASE_TYPE};
1296         my($type_v_decl) = mapTypeName($type_fn);
1297
1298         $self->pidl("$type_v_decl v;");
1299         $self->start_flags($enum, $ndr);
1300         $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1301         $self->pidl("*$varname = v;");
1302
1303         $self->end_flags($enum, $ndr);
1304 }
1305
1306 #####################################################################
1307 # generate a print function for an enum
1308 sub ParseEnumPrint($$$$$)
1309 {
1310         my($self,$enum,$ndr,$name,$varname) = @_;
1311
1312         $self->pidl("const char *val = NULL;");
1313         $self->pidl("");
1314
1315         $self->start_flags($enum, $ndr);
1316
1317         $self->pidl("switch ($varname) {");
1318         $self->indent;
1319         my $els = \@{$enum->{ELEMENTS}};
1320         foreach my $i (0 .. $#{$els}) {
1321                 my $e = ${$els}[$i];
1322                 chomp $e;
1323                 if ($e =~ /^(.*)=/) {
1324                         $e = $1;
1325                 }
1326                 $self->pidl("case $e: val = \"$e\"; break;");
1327         }
1328
1329         $self->deindent;
1330         $self->pidl("}");
1331
1332         $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1333
1334         $self->end_flags($enum, $ndr);
1335 }
1336
1337 sub DeclEnum($$$$)
1338 {
1339         my ($e,$t,$name,$varname) = @_;
1340         return "enum $name " .
1341                 ($t eq "pull"?"*":"") . $varname;
1342 }
1343
1344 $typefamily{ENUM} = {
1345         DECL => \&DeclEnum,
1346         PUSH_FN_BODY => \&ParseEnumPush,
1347         PULL_FN_BODY => \&ParseEnumPull,
1348         PRINT_FN_BODY => \&ParseEnumPrint,
1349 };
1350
1351 #####################################################################
1352 # generate a push function for a bitmap
1353 sub ParseBitmapPush($$$$)
1354 {
1355         my($self,$bitmap,$ndr,$varname) = @_;
1356         my($type_fn) = $bitmap->{BASE_TYPE};
1357
1358         $self->start_flags($bitmap, $ndr);
1359
1360         $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1361
1362         $self->end_flags($bitmap, $ndr);
1363 }
1364
1365 #####################################################################
1366 # generate a pull function for an bitmap
1367 sub ParseBitmapPull($$$$)
1368 {
1369         my($self,$bitmap,$ndr,$varname) = @_;
1370         my $type_fn = $bitmap->{BASE_TYPE};
1371         my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1372
1373         $self->pidl("$type_decl v;");
1374         $self->start_flags($bitmap, $ndr);
1375         $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1376         $self->pidl("*$varname = v;");
1377
1378         $self->end_flags($bitmap, $ndr);
1379 }
1380
1381 #####################################################################
1382 # generate a print function for an bitmap
1383 sub ParseBitmapPrintElement($$$$$$)
1384 {
1385         my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1386         my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1387         my($type_fn) = $bitmap->{BASE_TYPE};
1388         my($flag);
1389
1390         if ($e =~ /^(\w+) .*$/) {
1391                 $flag = "$1";
1392         } else {
1393                 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1394         }
1395
1396         $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1397 }
1398
1399 #####################################################################
1400 # generate a print function for an bitmap
1401 sub ParseBitmapPrint($$$$$)
1402 {
1403         my($self,$bitmap,$ndr,$name,$varname) = @_;
1404         my($type_decl) = mapTypeName($bitmap->{TYPE});
1405         my($type_fn) = $bitmap->{BASE_TYPE};
1406
1407         $self->start_flags($bitmap, $ndr);
1408
1409         $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1410
1411         $self->pidl("$ndr->depth++;");
1412         foreach my $e (@{$bitmap->{ELEMENTS}}) {
1413                 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1414         }
1415         $self->pidl("$ndr->depth--;");
1416
1417         $self->end_flags($bitmap, $ndr);
1418 }
1419
1420 sub DeclBitmap($$$$)
1421 {
1422         my ($e,$t,$name,$varname) = @_;
1423         return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1424                 ($t eq "pull"?" *":" ") . $varname;
1425 }
1426
1427 $typefamily{BITMAP} = {
1428         DECL => \&DeclBitmap,
1429         PUSH_FN_BODY => \&ParseBitmapPush,
1430         PULL_FN_BODY => \&ParseBitmapPull,
1431         PRINT_FN_BODY => \&ParseBitmapPrint,
1432 };
1433
1434 #####################################################################
1435 # generate a struct print function
1436 sub ParseStructPrint($$$$$)
1437 {
1438         my($self,$struct,$ndr,$name,$varname) = @_;
1439
1440         return unless defined $struct->{ELEMENTS};
1441
1442         my $env = GenerateStructEnv($struct, $varname);
1443
1444         $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1445
1446         $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1447
1448         $self->start_flags($struct, $ndr);
1449
1450         $self->pidl("$ndr->depth++;");
1451
1452         $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1453                 foreach (@{$struct->{ELEMENTS}});
1454         $self->pidl("$ndr->depth--;");
1455
1456         $self->end_flags($struct, $ndr);
1457 }
1458
1459 sub DeclarePtrVariables($$)
1460 {
1461         my ($self,$e) = @_;
1462         foreach my $l (@{$e->{LEVELS}}) {
1463                 if ($l->{TYPE} eq "POINTER" and
1464                         not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1465                         $self->pidl("uint32_t _ptr_$e->{NAME};");
1466                         last;
1467                 }
1468         }
1469 }
1470
1471 sub DeclareArrayVariables($$)
1472 {
1473         my ($self,$e) = @_;
1474
1475         foreach my $l (@{$e->{LEVELS}}) {
1476                 next if has_fast_array($e,$l);
1477                 next if is_charset_array($e,$l);
1478                 if ($l->{TYPE} eq "ARRAY") {
1479                         $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1480                 }
1481         }
1482 }
1483
1484 sub DeclareArrayVariablesNoZero($$$)
1485 {
1486         my ($self,$e,$env) = @_;
1487
1488         foreach my $l (@{$e->{LEVELS}}) {
1489                 next if has_fast_array($e,$l);
1490                 next if is_charset_array($e,$l);
1491                 if ($l->{TYPE} eq "ARRAY") {
1492                     my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1493                     if ($length eq "0") {
1494                         warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1495                     } else {
1496                         $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1497                     }
1498                 }
1499         }
1500 }
1501
1502 sub DeclareMemCtxVariables($$)
1503 {
1504         my ($self,$e) = @_;
1505         foreach my $l (@{$e->{LEVELS}}) {
1506                 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1507                 if (defined($mem_flags)) {
1508                         $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1509                 }
1510         }
1511 }
1512
1513 sub ParseStructPullPrimitives($$$$$)
1514 {
1515         my($self,$struct,$ndr,$varname,$env) = @_;
1516
1517         if (defined $struct->{SURROUNDING_ELEMENT}) {
1518                 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1519         }
1520
1521         $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1522
1523         if (defined($struct->{PROPERTIES}{relative_base})) {
1524                 # set the current offset as base for relative pointers
1525                 # and store it based on the toplevel struct/union
1526                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1527         }
1528
1529         $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1530
1531         $self->add_deferred();
1532 }
1533
1534 sub ParseStructPullDeferred($$$$$)
1535 {
1536         my ($self,$struct,$ndr,$varname,$env) = @_;
1537
1538         if (defined($struct->{PROPERTIES}{relative_base})) {
1539                 # retrieve the current offset as base for relative pointers
1540                 # based on the toplevel struct/union
1541                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1542         }
1543         foreach my $e (@{$struct->{ELEMENTS}}) {
1544                 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1545         }
1546
1547         $self->add_deferred();
1548 }
1549
1550 #####################################################################
1551 # parse a struct - pull side
1552 sub ParseStructPull($$$$)
1553 {
1554         my($self,$struct,$ndr,$varname) = @_;
1555
1556         return unless defined $struct->{ELEMENTS};
1557
1558         # declare any internal pointers we need
1559         foreach my $e (@{$struct->{ELEMENTS}}) {
1560                 $self->DeclarePtrVariables($e);
1561                 $self->DeclareArrayVariables($e);
1562                 $self->DeclareMemCtxVariables($e);
1563         }
1564
1565         $self->start_flags($struct, $ndr);
1566
1567         my $env = GenerateStructEnv($struct, $varname);
1568
1569         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1570         $self->indent;
1571         $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1572         $self->deindent;
1573         $self->pidl("}");
1574         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1575         $self->indent;
1576         $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1577         $self->deindent;
1578         $self->pidl("}");
1579
1580         $self->end_flags($struct, $ndr);
1581 }
1582
1583 #####################################################################
1584 # calculate size of ndr struct
1585 sub ParseStructNdrSize($$$$)
1586 {
1587         my ($self,$t, $name, $varname) = @_;
1588         my $sizevar;
1589
1590         if (my $flags = has_property($t, "flag")) {
1591                 $self->pidl("flags |= $flags;");
1592         }
1593         $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1594 }
1595
1596 sub DeclStruct($$$$)
1597 {
1598         my ($e,$t,$name,$varname) = @_;
1599         return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1600 }
1601
1602 sub ArgsStructNdrSize($$$)
1603 {
1604         my ($d, $name, $varname) = @_;
1605         return "const struct $name *$varname, struct smb_iconv_convenience *ic, int flags";
1606 }
1607
1608 $typefamily{STRUCT} = {
1609         PUSH_FN_BODY => \&ParseStructPush,
1610         DECL => \&DeclStruct,
1611         PULL_FN_BODY => \&ParseStructPull,
1612         PRINT_FN_BODY => \&ParseStructPrint,
1613         SIZE_FN_BODY => \&ParseStructNdrSize,
1614         SIZE_FN_ARGS => \&ArgsStructNdrSize,
1615 };
1616
1617 #####################################################################
1618 # calculate size of ndr struct
1619 sub ParseUnionNdrSize($$$)
1620 {
1621         my ($self, $t, $name, $varname) = @_;
1622         my $sizevar;
1623
1624         if (my $flags = has_property($t, "flag")) {
1625                 $self->pidl("flags |= $flags;");
1626         }
1627
1628         $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1629 }
1630
1631 sub ParseUnionPushPrimitives($$$$)
1632 {
1633         my ($self, $e, $ndr ,$varname) = @_;
1634
1635         my $have_default = 0;
1636
1637         $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1638
1639         if (defined($e->{SWITCH_TYPE})) {
1640                 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1641         }
1642
1643         $self->pidl("switch (level) {");
1644         $self->indent;
1645         foreach my $el (@{$e->{ELEMENTS}}) {
1646                 if ($el->{CASE} eq "default") {
1647                         $have_default = 1;
1648                 }
1649                 $self->pidl("$el->{CASE}: {");
1650
1651                 if ($el->{TYPE} ne "EMPTY") {
1652                         $self->indent;
1653                         if (defined($e->{PROPERTIES}{relative_base})) {
1654                                 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1655                                 # set the current offset as base for relative pointers
1656                                 # and store it based on the toplevel struct/union
1657                                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1658                         }
1659                         $self->DeclareArrayVariables($el);
1660                         $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1661                         $self->deindent;
1662                 }
1663                 $self->pidl("break; }");
1664                 $self->pidl("");
1665         }
1666         if (! $have_default) {
1667                 $self->pidl("default:");
1668                 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1669         }
1670         $self->deindent;
1671         $self->pidl("}");
1672 }
1673
1674 sub ParseUnionPushDeferred($$$$)
1675 {
1676         my ($self,$e,$ndr,$varname) = @_;
1677
1678         my $have_default = 0;
1679
1680         $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1681         if (defined($e->{PROPERTIES}{relative_base})) {
1682                 # retrieve the current offset as base for relative pointers
1683                 # based on the toplevel struct/union
1684                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1685         }
1686         $self->pidl("switch (level) {");
1687         $self->indent;
1688         foreach my $el (@{$e->{ELEMENTS}}) {
1689                 if ($el->{CASE} eq "default") {
1690                         $have_default = 1;
1691                 }
1692
1693                 $self->pidl("$el->{CASE}:");
1694                 if ($el->{TYPE} ne "EMPTY") {
1695                         $self->indent;
1696                         $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1697                         $self->deindent;
1698                 }
1699                 $self->pidl("break;");
1700                 $self->pidl("");
1701         }
1702         if (! $have_default) {
1703                 $self->pidl("default:");
1704                 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1705         }
1706         $self->deindent;
1707         $self->pidl("}");
1708 }
1709
1710 #####################################################################
1711 # parse a union - push side
1712 sub ParseUnionPush($$$$)
1713 {
1714         my ($self,$e,$ndr,$varname) = @_;
1715         my $have_default = 0;
1716
1717         $self->start_flags($e, $ndr);
1718
1719         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1720         $self->indent;
1721         $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1722         $self->deindent;
1723         $self->pidl("}");
1724         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1725         $self->indent;
1726         $self->ParseUnionPushDeferred($e, $ndr, $varname);
1727         $self->deindent;
1728         $self->pidl("}");
1729         $self->end_flags($e, $ndr);
1730 }
1731
1732 #####################################################################
1733 # print a union
1734 sub ParseUnionPrint($$$$$)
1735 {
1736         my ($self,$e,$ndr,$name,$varname) = @_;
1737         my $have_default = 0;
1738
1739         $self->pidl("int level;");
1740         foreach my $el (@{$e->{ELEMENTS}}) {
1741                 $self->DeclareArrayVariables($el);
1742         }
1743
1744         $self->start_flags($e, $ndr);
1745
1746         $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1747
1748         $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1749
1750         $self->pidl("switch (level) {");
1751         $self->indent;
1752         foreach my $el (@{$e->{ELEMENTS}}) {
1753                 if ($el->{CASE} eq "default") {
1754                         $have_default = 1;
1755                 }
1756                 $self->pidl("$el->{CASE}:");
1757                 if ($el->{TYPE} ne "EMPTY") {
1758                         $self->indent;
1759                         $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1760                         $self->deindent;
1761                 }
1762                 $self->pidl("break;");
1763                 $self->pidl("");
1764         }
1765         if (! $have_default) {
1766                 $self->pidl("default:");
1767                 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1768         }
1769         $self->deindent;
1770         $self->pidl("}");
1771
1772         $self->end_flags($e, $ndr);
1773 }
1774
1775 sub ParseUnionPullPrimitives($$$$$)
1776 {
1777         my ($self,$e,$ndr,$varname,$switch_type) = @_;
1778         my $have_default = 0;
1779
1780         if (defined($switch_type)) {
1781                 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1782                 $self->pidl("if (_level != level) {");
1783                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname\", _level);");
1784                 $self->pidl("}");
1785         }
1786
1787         $self->pidl("switch (level) {");
1788         $self->indent;
1789         foreach my $el (@{$e->{ELEMENTS}}) {
1790                 if ($el->{CASE} eq "default") {
1791                         $have_default = 1;
1792                 }
1793                 $self->pidl("$el->{CASE}: {");
1794
1795                 if ($el->{TYPE} ne "EMPTY") {
1796                         $self->indent;
1797                         $self->DeclarePtrVariables($el);
1798                         $self->DeclareArrayVariables($el);
1799                         if (defined($e->{PROPERTIES}{relative_base})) {
1800                                 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1801                                 # set the current offset as base for relative pointers
1802                                 # and store it based on the toplevel struct/union
1803                                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1804                         }
1805                         $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1806                         $self->deindent;
1807                 }
1808                 $self->pidl("break; }");
1809                 $self->pidl("");
1810         }
1811         if (! $have_default) {
1812                 $self->pidl("default:");
1813                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1814         }
1815         $self->deindent;
1816         $self->pidl("}");
1817 }
1818
1819 sub ParseUnionPullDeferred($$$$)
1820 {
1821         my ($self,$e,$ndr,$varname) = @_;
1822         my $have_default = 0;
1823
1824         if (defined($e->{PROPERTIES}{relative_base})) {
1825                 # retrieve the current offset as base for relative pointers
1826                 # based on the toplevel struct/union
1827                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1828         }
1829         $self->pidl("switch (level) {");
1830         $self->indent;
1831         foreach my $el (@{$e->{ELEMENTS}}) {
1832                 if ($el->{CASE} eq "default") {
1833                         $have_default = 1;
1834                 }
1835
1836                 $self->pidl("$el->{CASE}:");
1837                 if ($el->{TYPE} ne "EMPTY") {
1838                         $self->indent;
1839                         $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1840                         $self->deindent;
1841                 }
1842                 $self->pidl("break;");
1843                 $self->pidl("");
1844         }
1845         if (! $have_default) {
1846                 $self->pidl("default:");
1847                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1848         }
1849         $self->deindent;
1850         $self->pidl("}");
1851
1852
1853 }
1854
1855 #####################################################################
1856 # parse a union - pull side
1857 sub ParseUnionPull($$$$)
1858 {
1859         my ($self,$e,$ndr,$varname) = @_;
1860         my $switch_type = $e->{SWITCH_TYPE};
1861
1862         $self->pidl("int level;");
1863         if (defined($switch_type)) {
1864                 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1865                         $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1866                 }
1867                 $self->pidl(mapTypeName($switch_type) . " _level;");
1868         }
1869
1870         my %double_cases = ();
1871         foreach my $el (@{$e->{ELEMENTS}}) {
1872                 next if ($el->{TYPE} eq "EMPTY");
1873                 next if ($double_cases{"$el->{NAME}"});
1874                 $self->DeclareMemCtxVariables($el);
1875                 $double_cases{"$el->{NAME}"} = 1;
1876         }
1877
1878         $self->start_flags($e, $ndr);
1879
1880         $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1881
1882         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1883         $self->indent;
1884         $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1885         $self->deindent;
1886         $self->pidl("}");
1887
1888         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1889         $self->indent;
1890         $self->ParseUnionPullDeferred($e,$ndr,$varname);
1891         $self->deindent;
1892         $self->pidl("}");
1893
1894         $self->add_deferred();
1895
1896         $self->end_flags($e, $ndr);
1897 }
1898
1899 sub DeclUnion($$$$)
1900 {
1901         my ($e,$t,$name,$varname) = @_;
1902         return ($t ne "pull"?"const ":"") . "union $name *$varname";
1903 }
1904
1905 sub ArgsUnionNdrSize($$)
1906 {
1907         my ($d,$name) = @_;
1908         return "const union $name *r, uint32_t level, struct smb_iconv_convenience *ic, int flags";
1909 }
1910
1911 $typefamily{UNION} = {
1912         PUSH_FN_BODY => \&ParseUnionPush,
1913         DECL => \&DeclUnion,
1914         PULL_FN_BODY => \&ParseUnionPull,
1915         PRINT_FN_BODY => \&ParseUnionPrint,
1916         SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1917         SIZE_FN_BODY => \&ParseUnionNdrSize,
1918 };
1919
1920 #####################################################################
1921 # parse a typedef - push side
1922 sub ParseTypedefPush($$$$)
1923 {
1924         my($self,$e,$ndr,$varname) = @_;
1925
1926         my $env;
1927
1928         $env->{$e->{NAME}} = $varname;
1929
1930         $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1931 }
1932
1933 #####################################################################
1934 # parse a typedef - pull side
1935 sub ParseTypedefPull($$$$)
1936 {
1937         my($self,$e,$ndr,$varname) = @_;
1938
1939         my $env;
1940
1941         $env->{$e->{NAME}} = $varname;
1942
1943         $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1944 }
1945
1946 #####################################################################
1947 # parse a typedef - print side
1948 sub ParseTypedefPrint($$$$$)
1949 {
1950         my($self,$e,$ndr,$name,$varname) = @_;
1951
1952         $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
1953 }
1954
1955 #####################################################################
1956 ## calculate the size of a structure
1957 sub ParseTypedefNdrSize($$$$)
1958 {
1959         my($self,$t,$name,$varname) = @_;
1960
1961         $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
1962 }
1963
1964 sub DeclTypedef($$$$)
1965 {
1966         my ($e, $t, $name, $varname) = @_;
1967
1968         return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
1969 }
1970
1971 sub ArgsTypedefNdrSize($$$)
1972 {
1973         my ($d, $name, $varname) = @_;
1974         return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
1975 }
1976
1977 $typefamily{TYPEDEF} = {
1978         PUSH_FN_BODY => \&ParseTypedefPush,
1979         DECL => \&DeclTypedef,
1980         PULL_FN_BODY => \&ParseTypedefPull,
1981         PRINT_FN_BODY => \&ParseTypedefPrint,
1982         SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
1983         SIZE_FN_BODY => \&ParseTypedefNdrSize,
1984 };
1985
1986 #####################################################################
1987 # parse a function - print side
1988 sub ParseFunctionPrint($$)
1989 {
1990         my($self, $fn) = @_;
1991         my $ndr = "ndr";
1992
1993         $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
1994
1995         return if has_property($fn, "noprint");
1996
1997         $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
1998         $self->pidl("{");
1999         $self->indent;
2000
2001         foreach my $e (@{$fn->{ELEMENTS}}) {
2002                 $self->DeclareArrayVariables($e);
2003         }
2004
2005         $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2006         $self->pidl("$ndr->depth++;");
2007
2008         $self->pidl("if (flags & NDR_SET_VALUES) {");
2009         $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2010         $self->pidl("}");
2011
2012         $self->pidl("if (flags & NDR_IN) {");
2013         $self->indent;
2014         $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2015         $self->pidl("$ndr->depth++;");
2016
2017         my $env = GenerateFunctionInEnv($fn);
2018
2019         foreach my $e (@{$fn->{ELEMENTS}}) {
2020                 if (grep(/in/,@{$e->{DIRECTION}})) {
2021                         $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2022                 }
2023         }
2024         $self->pidl("$ndr->depth--;");
2025         $self->deindent;
2026         $self->pidl("}");
2027
2028         $self->pidl("if (flags & NDR_OUT) {");
2029         $self->indent;
2030         $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2031         $self->pidl("$ndr->depth++;");
2032
2033         $env = GenerateFunctionOutEnv($fn);
2034         foreach my $e (@{$fn->{ELEMENTS}}) {
2035                 if (grep(/out/,@{$e->{DIRECTION}})) {
2036                         $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2037                 }
2038         }
2039         if ($fn->{RETURN_TYPE}) {
2040                 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2041         }
2042         $self->pidl("$ndr->depth--;");
2043         $self->deindent;
2044         $self->pidl("}");
2045
2046         $self->pidl("$ndr->depth--;");
2047         $self->deindent;
2048         $self->pidl("}");
2049         $self->pidl("");
2050 }
2051
2052 #####################################################################
2053 # parse a function
2054 sub ParseFunctionPush($$)
2055 {
2056         my($self, $fn) = @_;
2057         my $ndr = "ndr";
2058
2059         $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;
2060
2061         return if has_property($fn, "nopush");
2062
2063         $self->pidl("{");
2064         $self->indent;
2065
2066         foreach my $e (@{$fn->{ELEMENTS}}) {
2067                 $self->DeclareArrayVariables($e);
2068         }
2069
2070         $self->pidl("if (flags & NDR_IN) {");
2071         $self->indent;
2072
2073         my $env = GenerateFunctionInEnv($fn);
2074
2075         EnvSubstituteValue($env, $fn);
2076
2077         foreach my $e (@{$fn->{ELEMENTS}}) {
2078                 if (grep(/in/,@{$e->{DIRECTION}})) {
2079                         $self->ParseElementPush($e, $ndr, $env, 1, 1);
2080                 }
2081         }
2082
2083         $self->deindent;
2084         $self->pidl("}");
2085
2086         $self->pidl("if (flags & NDR_OUT) {");
2087         $self->indent;
2088
2089         $env = GenerateFunctionOutEnv($fn);
2090         foreach my $e (@{$fn->{ELEMENTS}}) {
2091                 if (grep(/out/,@{$e->{DIRECTION}})) {
2092                         $self->ParseElementPush($e, $ndr, $env, 1, 1);
2093                 }
2094         }
2095
2096         if ($fn->{RETURN_TYPE}) {
2097                 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2098         }
2099
2100         $self->deindent;
2101         $self->pidl("}");
2102         $self->pidl("return NDR_ERR_SUCCESS;");
2103         $self->deindent;
2104         $self->pidl("}");
2105         $self->pidl("");
2106 }
2107
2108 sub AllocateArrayLevel($$$$$$)
2109 {
2110         my ($self,$e,$l,$ndr,$var,$size) = @_;
2111
2112         my $pl = GetPrevLevel($e, $l);
2113         if (defined($pl) and
2114             $pl->{TYPE} eq "POINTER" and
2115             $pl->{POINTER_TYPE} eq "ref"
2116             and not $l->{IS_ZERO_TERMINATED}) {
2117                 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2118                 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2119                 $self->pidl("}");
2120                 if (grep(/in/,@{$e->{DIRECTION}}) and
2121                     grep(/out/,@{$e->{DIRECTION}})) {
2122                         $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2123                 }
2124                 return;
2125         }
2126
2127         $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2128 }
2129
2130 #####################################################################
2131 # parse a function
2132 sub ParseFunctionPull($$)
2133 {
2134         my($self,$fn) = @_;
2135         my $ndr = "ndr";
2136
2137         # pull function args
2138         $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;
2139
2140         $self->pidl("{");
2141         $self->indent;
2142
2143         # declare any internal pointers we need
2144         foreach my $e (@{$fn->{ELEMENTS}}) {
2145                 $self->DeclarePtrVariables($e);
2146                 $self->DeclareArrayVariables($e);
2147         }
2148
2149         my %double_cases = ();
2150         foreach my $e (@{$fn->{ELEMENTS}}) {
2151                 next if ($e->{TYPE} eq "EMPTY");
2152                 next if ($double_cases{"$e->{NAME}"});
2153                 $self->DeclareMemCtxVariables($e);
2154                 $double_cases{"$e->{NAME}"} = 1;
2155         }
2156
2157         $self->pidl("if (flags & NDR_IN) {");
2158         $self->indent;
2159
2160         # auto-init the out section of a structure. I originally argued that
2161         # this was a bad idea as it hides bugs, but coping correctly
2162         # with initialisation and not wiping ref vars is turning
2163         # out to be too tricky (tridge)
2164         foreach my $e (@{$fn->{ELEMENTS}}) {
2165                 next unless grep(/out/, @{$e->{DIRECTION}});
2166                 $self->pidl("ZERO_STRUCT(r->out);");
2167                 $self->pidl("");
2168                 last;
2169         }
2170
2171         my $env = GenerateFunctionInEnv($fn);
2172
2173         foreach my $e (@{$fn->{ELEMENTS}}) {
2174                 next unless (grep(/in/, @{$e->{DIRECTION}}));
2175                 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2176         }
2177
2178         # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2179         # own flag rather than be in NDR_IN ?
2180
2181         foreach my $e (@{$fn->{ELEMENTS}}) {
2182                 next unless (grep(/out/, @{$e->{DIRECTION}}));
2183                 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2184                              $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2185                 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2186                                  ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2187                 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2188                         and   $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2189
2190                 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2191                         my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2192                                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2193                                                    "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2194                                 check_fully_dereferenced($e, $env));
2195                         $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2196
2197                         if (grep(/in/, @{$e->{DIRECTION}})) {
2198                                 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2199                         } else {
2200                                 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2201                         }
2202                 } else {
2203                         $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2204
2205                         if (grep(/in/, @{$e->{DIRECTION}})) {
2206                                 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2207                         } else {
2208                                 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2209                         }
2210                 }
2211         }
2212
2213         $self->add_deferred();
2214         $self->deindent;
2215         $self->pidl("}");
2216
2217         $self->pidl("if (flags & NDR_OUT) {");
2218         $self->indent;
2219
2220         $env = GenerateFunctionOutEnv($fn);
2221         foreach my $e (@{$fn->{ELEMENTS}}) {
2222                 next unless grep(/out/, @{$e->{DIRECTION}});
2223                 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2224         }
2225
2226         if ($fn->{RETURN_TYPE}) {
2227                 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2228         }
2229
2230         $self->add_deferred();
2231         $self->deindent;
2232         $self->pidl("}");
2233
2234         $self->pidl("return NDR_ERR_SUCCESS;");
2235         $self->deindent;
2236         $self->pidl("}");
2237         $self->pidl("");
2238 }
2239
2240 sub AuthServiceStruct($$$)
2241 {
2242         my ($self, $ifacename, $authservice) = @_;
2243         my @a = split /,/, $authservice;
2244         my $authservice_count = $#a + 1;
2245
2246         $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2247         foreach my $ap (@a) {
2248                 $self->pidl("\t$ap, ");
2249         }
2250         $self->pidl("};");
2251         $self->pidl("");
2252
2253         $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2254         $self->pidl("\t.count\t= $authservice_count,");
2255         $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2256         $self->pidl("};");
2257         $self->pidl("");
2258 }
2259
2260 sub FunctionCallEntry($$)
2261 {
2262         my ($self, $d) = @_;
2263         return 0 if not defined($d->{OPNUM});
2264         $self->pidl("\t{");
2265         $self->pidl("\t\t\"$d->{NAME}\",");
2266         $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2267         $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2268         $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2269         $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2270         $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2271         $self->pidl("\t},");
2272         return 1;
2273 }
2274
2275 #####################################################################
2276 # produce a function call table
2277 sub FunctionTable($$)
2278 {
2279         my($self,$interface) = @_;
2280         my $count = 0;
2281         my $uname = uc $interface->{NAME};
2282
2283         return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2284         return unless defined ($interface->{PROPERTIES}->{uuid});
2285
2286         $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2287
2288         foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2289                 $count += $self->FunctionCallEntry($d);
2290         }
2291         $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2292         $self->pidl("};");
2293         $self->pidl("");
2294
2295         $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2296         foreach my $ep (@{$interface->{ENDPOINTS}}) {
2297                 $self->pidl("\t$ep, ");
2298         }
2299         my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2300
2301         $self->pidl("};");
2302         $self->pidl("");
2303
2304         $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2305         $self->pidl("\t.count\t= $endpoint_count,");
2306         $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2307         $self->pidl("};");
2308         $self->pidl("");
2309
2310         if (! defined $interface->{PROPERTIES}->{authservice}) {
2311                 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2312         }
2313
2314         $self->AuthServiceStruct($interface->{NAME},
2315                                      $interface->{PROPERTIES}->{authservice});
2316
2317         $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2318         $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2319         $self->pidl("\t.syntax_id\t= {");
2320         $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2321         $self->pidl("\t\tNDR_$uname\_VERSION");
2322         $self->pidl("\t},");
2323         $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2324         $self->pidl("\t.num_calls\t= $count,");
2325         $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2326         $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2327         $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2328         $self->pidl("};");
2329         $self->pidl("");
2330
2331 }
2332
2333 #####################################################################
2334 # generate include statements for imported idl files
2335 sub HeaderImport
2336 {
2337         my $self = shift;
2338         my @imports = @_;
2339         foreach (@imports) {
2340                 $_ = unmake_str($_);
2341                 s/\.idl$//;
2342                 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2343         }
2344 }
2345
2346 #####################################################################
2347 # generate include statements for included header files
2348 sub HeaderInclude
2349 {
2350         my $self = shift;
2351         my @includes = @_;
2352         foreach (@includes) {
2353                 $self->pidl_hdr("#include $_");
2354         }
2355 }
2356
2357 #####################################################################
2358 # generate prototypes and defines for the interface definitions
2359 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2360 # NDR parser and so do not belong here, technically speaking
2361 sub HeaderInterface($$$)
2362 {
2363         my($self,$interface,$needed) = @_;
2364
2365         my $count = 0;
2366
2367         if ($needed->{"compression"}) {
2368                 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2369         }
2370
2371         if (has_property($interface, "object")) {
2372                 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2373         }
2374
2375         if (defined $interface->{PROPERTIES}->{helper}) {
2376                 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2377         }
2378
2379         if (defined $interface->{PROPERTIES}->{uuid}) {
2380                 my $name = uc $interface->{NAME};
2381                 $self->pidl_hdr("#define NDR_$name\_UUID " .
2382                 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2383
2384                 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2385                 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2386
2387                 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2388
2389                 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2390                 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2391
2392                 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2393         }
2394
2395         foreach (@{$interface->{FUNCTIONS}}) {
2396                 next if has_property($_, "noopnum");
2397                 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2398                 my $u_name = uc $_->{NAME};
2399
2400                 my $val = sprintf("0x%02x", $count);
2401                 if (defined($interface->{BASE})) {
2402                         $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2403                 }
2404
2405                 $self->pidl_hdr("#define NDR_$u_name ($val)");
2406
2407                 $self->pidl_hdr("");
2408                 $count++;
2409         }
2410
2411         my $val = $count;
2412
2413         if (defined($interface->{BASE})) {
2414                 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2415         }
2416
2417         $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2418
2419 }
2420
2421 sub ParseTypePush($$$$$$)
2422 {
2423         my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2424
2425         # save the old relative_base_offset
2426         $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2427         $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2428         # restore the old relative_base_offset
2429         $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2430 }
2431
2432 sub ParseTypePushFunction($$$)
2433 {
2434         my ($self, $e, $varname) = @_;
2435         my $ndr = "ndr";
2436
2437         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2438
2439         $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2440
2441         $self->pidl("{");
2442         $self->indent;
2443         $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2444         $self->pidl("return NDR_ERR_SUCCESS;");
2445         $self->deindent;
2446         $self->pidl("}");
2447         $self->pidl("");;
2448 }
2449
2450 sub ParseTypePull($$$$$$)
2451 {
2452         my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2453
2454         # save the old relative_base_offset
2455         $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2456         $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2457         # restore the old relative_base_offset
2458         $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2459 }
2460
2461 sub ParseTypePullFunction($$)
2462 {
2463         my ($self, $e, $varname) = @_;
2464         my $ndr = "ndr";
2465
2466         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2467
2468         $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2469
2470         $self->pidl("{");
2471         $self->indent;
2472         $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2473         $self->pidl("return NDR_ERR_SUCCESS;");
2474         $self->deindent;
2475         $self->pidl("}");
2476         $self->pidl("");
2477 }
2478
2479 sub ParseTypePrint($$$$)
2480 {
2481         my ($self, $e, $ndr, $varname) = @_;
2482
2483         $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2484 }
2485
2486 sub ParseTypePrintFunction($$$)
2487 {
2488         my ($self, $e, $varname) = @_;
2489         my $ndr = "ndr";
2490
2491         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2492
2493         $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2494
2495         return if (has_property($e, "noprint"));
2496
2497         $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2498         $self->pidl("{");
2499         $self->indent;
2500         $self->ParseTypePrint($e, $ndr, $varname);
2501         $self->deindent;
2502         $self->pidl("}");
2503         $self->pidl("");
2504 }
2505
2506 sub ParseTypeNdrSize($$)
2507 {
2508         my ($self,$t) = @_;
2509
2510         my $varname = "r";
2511         my $tf = $typefamily{$t->{TYPE}};
2512         my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2513
2514         $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2515
2516         $self->pidl("{");
2517         $self->indent;
2518         $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2519         $self->deindent;
2520         $self->pidl("}");
2521         $self->pidl("");
2522 }
2523
2524 #####################################################################
2525 # parse the interface definitions
2526 sub ParseInterface($$$)
2527 {
2528         my($self,$interface,$needed) = @_;
2529
2530         $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2531         $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2532
2533         $self->pidl_hdr("");
2534
2535         $self->HeaderInterface($interface, $needed);
2536
2537         # Typedefs
2538         foreach my $d (@{$interface->{TYPES}}) {
2539                 next unless(typeHasBody($d));
2540
2541                 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2542                 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2543                 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2544
2545                 # Make sure we don't generate a function twice...
2546                 $needed->{TypeFunctionName("ndr_push", $d)} =
2547                     $needed->{TypeFunctionName("ndr_pull", $d)} =
2548                         $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2549
2550                 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2551         }
2552
2553         # Functions
2554         foreach my $d (@{$interface->{FUNCTIONS}}) {
2555                 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2556                 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2557                 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2558
2559                 # Make sure we don't generate a function twice...
2560                 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2561                         $needed->{"ndr_print_$d->{NAME}"} = 0;
2562         }
2563
2564         $self->FunctionTable($interface);
2565
2566         $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2567 }
2568
2569 sub GenerateIncludes($)
2570 {
2571         my ($self) = @_;
2572         if (is_intree()) {
2573                 $self->pidl("#include \"includes.h\"");
2574         } else {
2575                 $self->pidl("#ifndef _GNU_SOURCE");
2576                 $self->pidl("#define _GNU_SOURCE");
2577                 $self->pidl("#endif");
2578                 $self->pidl("#include <stdint.h>");
2579                 $self->pidl("#include <stdlib.h>");
2580                 $self->pidl("#include <stdio.h>");
2581                 $self->pidl("#include <stdbool.h>");
2582                 $self->pidl("#include <stdarg.h>");
2583                 $self->pidl("#include <string.h>");
2584         }
2585 }
2586
2587 #####################################################################
2588 # parse a parsed IDL structure back into an IDL file
2589 sub Parse($$$$)
2590 {
2591         my($self, $ndr,$gen_header,$ndr_header) = @_;
2592
2593         $self->pidl_hdr("/* header auto-generated by pidl */");
2594         $self->pidl_hdr("");
2595         $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2596         $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2597         $self->pidl_hdr("");
2598
2599         $self->pidl("/* parser auto-generated by pidl */");
2600         $self->pidl("");
2601         $self->GenerateIncludes();
2602         $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2603         $self->pidl("");
2604
2605         my %needed = ();
2606
2607         foreach (@{$ndr}) {
2608                 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2609         }
2610
2611         foreach (@{$ndr}) {
2612                 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2613                 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2614                 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2615         }
2616
2617         return ($self->{res_hdr}, $self->{res});
2618 }
2619
2620 sub NeededElement($$$)
2621 {
2622         my ($e, $dir, $needed) = @_;
2623
2624         return if ($e->{TYPE} eq "EMPTY");
2625
2626         return if (ref($e->{TYPE}) eq "HASH" and
2627                        not defined($e->{TYPE}->{NAME}));
2628
2629         my ($t, $rt);
2630         if (ref($e->{TYPE}) eq "HASH") {
2631                 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2632         } else {
2633                 $t = $e->{TYPE};
2634         }
2635
2636         if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2637                 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2638         } else {
2639                 $rt = $e->{REPRESENTATION_TYPE};
2640         }
2641
2642         die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2643
2644         my @fn = ();
2645         if ($dir eq "print") {
2646                 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2647         } elsif ($dir eq "pull") {
2648                 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2649                 push (@fn, "ndr_$t\_to_$rt")
2650                         if ($rt ne $t);
2651         } elsif ($dir eq "push") {
2652                 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2653                 push (@fn, "ndr_$rt\_to_$t")
2654                         if ($rt ne $t);
2655         } else {
2656                 die("invalid direction `$dir'");
2657         }
2658
2659         foreach (@fn) {
2660                 unless (defined($needed->{$_})) {
2661                         $needed->{$_} = 1;
2662                 }
2663         }
2664 }
2665
2666 sub NeededFunction($$)
2667 {
2668         my ($fn,$needed) = @_;
2669         $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2670         $needed->{"ndr_push_$fn->{NAME}"} = 1;
2671         $needed->{"ndr_print_$fn->{NAME}"} = 1;
2672         foreach my $e (@{$fn->{ELEMENTS}}) {
2673                 $e->{PARENT} = $fn;
2674                 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2675         }
2676 }
2677
2678 sub NeededType($$$)
2679 {
2680         sub NeededType($$$);
2681         my ($t,$needed,$req) = @_;
2682
2683         NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2684
2685         if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2686                 return unless defined($t->{ELEMENTS});
2687                 for my $e (@{$t->{ELEMENTS}}) {
2688                         $e->{PARENT} = $t;
2689                         if (has_property($e, "compression")) {
2690                                 $needed->{"compression"} = 1;
2691                         }
2692                         NeededElement($e, $req, $needed);
2693                         NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2694                 }
2695         }
2696 }
2697
2698 #####################################################################
2699 # work out what parse functions are needed
2700 sub NeededInterface($$)
2701 {
2702         my ($interface,$needed) = @_;
2703         NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2704         foreach (reverse @{$interface->{TYPES}}) {
2705                 if (has_property($_, "public")) {
2706                         $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2707                                 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2708                 }
2709
2710                 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2711                 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2712                 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2713                 if (has_property($_, "gensize")) {
2714                         $needed->{"ndr_size_$_->{NAME}"} = 1;
2715                 }
2716         }
2717 }
2718
2719 sub TypeFunctionName($$)
2720 {
2721         my ($prefix, $t) = @_;
2722
2723         return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2724                         $t->{TYPE} eq "TYPEDEF");
2725         return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2726         return "$prefix\_$t";
2727 }
2728
2729 1;