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