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

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