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