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 = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1115                 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1116                 my $array_name = $var_name;
1117
1118                 if (my $range = has_property($e, "range")) {
1119                         my ($low, $high) = split(/,/, $range, 2);
1120                         if ($low < 0) {
1121                                 warning(0, "$low is invalid for the range of an array size");
1122                         }
1123                         if ($low == 0) {
1124                                 $self->pidl("if ($length > $high) {");
1125                         } else {
1126                                 $self->pidl("if ($length < $low || $length > $high) {");
1127                         }
1128                         $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1129                         $self->pidl("}");
1130                 }
1131
1132                 $var_name = get_array_element($var_name, $counter);
1133
1134                 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1135
1136                 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1137                         my $nl = GetNextLevel($e,$l);
1138
1139                         if ($l->{IS_ZERO_TERMINATED}) {
1140                                 $self->CheckStringTerminator($ndr,$e,$l,$length);
1141                         }
1142
1143                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1144                         $self->indent;
1145                         $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1146                         $self->deindent;
1147                         $self->pidl("}");
1148                 }
1149
1150                 if ($deferred and ContainsDeferred($e, $l)) {
1151                         $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1152                         $self->indent;
1153                         $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1154                         $self->deindent;
1155                         $self->pidl("}");
1156                 }
1157
1158                 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1159
1160         } elsif ($l->{TYPE} eq "SWITCH") {
1161                 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1162         }
1163 }
1164
1165 #####################################################################
1166 # parse scalars in a structure element - pull size
1167 sub ParseElementPull($$$$$$)
1168 {
1169         my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1170
1171         my $var_name = $env->{$e->{NAME}};
1172         my $represent_name;
1173         my $transmit_name;
1174
1175         return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1176
1177         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1178                 $self->pidl("{");
1179                 $self->indent;
1180                 $represent_name = $var_name;
1181                 $transmit_name = "_transmit_$e->{NAME}";
1182                 $var_name = $transmit_name;
1183                 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1184         }
1185
1186         $var_name = append_prefix($e, $var_name);
1187
1188         $self->start_flags($e, $ndr);
1189
1190         $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1191
1192         $self->end_flags($e, $ndr);
1193
1194         # Representation type is different from transmit_as
1195         if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1196                 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1197                 $self->deindent;
1198                 $self->pidl("}");
1199         }
1200 }
1201
1202 #####################################################################
1203 # parse a pointer in a struct element or function
1204 sub ParsePtrPull($$$$$)
1205 {
1206         my($self, $e,$l,$ndr,$var_name) = @_;
1207
1208         my $nl = GetNextLevel($e, $l);
1209         my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1210         my $next_is_string = (($nl->{TYPE} eq "DATA") and
1211                                                  ($nl->{DATA_TYPE} eq "string"));
1212
1213         if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1214
1215                 if (!$next_is_array and !$next_is_string) {
1216                         $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1217                         $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1218                         $self->pidl("}");
1219                 }
1220
1221                 return;
1222         } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1223                 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1224         } elsif (($l->{POINTER_TYPE} eq "unique") or
1225                  ($l->{POINTER_TYPE} eq "relative") or
1226                  ($l->{POINTER_TYPE} eq "full")) {
1227                 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1228         } else {
1229                 die("Unhandled pointer type $l->{POINTER_TYPE}");
1230         }
1231
1232         $self->pidl("if (_ptr_$e->{NAME}) {");
1233         $self->indent;
1234
1235         # Don't do this for arrays, they're allocated at the actual level
1236         # of the array
1237         unless ($next_is_array or $next_is_string) {
1238                 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1239         } else {
1240                 # FIXME: Yes, this is nasty.
1241                 # We allocate an array twice
1242                 # - once just to indicate that it's there,
1243                 # - then the real allocation...
1244                 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1245         }
1246
1247         #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1248         if ($l->{POINTER_TYPE} eq "relative") {
1249                 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1250         }
1251         $self->deindent;
1252         $self->pidl("} else {");
1253         $self->pidl("\t$var_name = NULL;");
1254         $self->pidl("}");
1255 }
1256
1257 sub ParseStructPushPrimitives($$$$$)
1258 {
1259         my ($self, $struct, $ndr, $varname, $env) = @_;
1260
1261         # see if the structure contains a conformant array. If it
1262         # does, then it must be the last element of the structure, and
1263         # we need to push the conformant length early, as it fits on
1264         # the wire before the structure (and even before the structure
1265         # alignment)
1266         if (defined($struct->{SURROUNDING_ELEMENT})) {
1267                 my $e = $struct->{SURROUNDING_ELEMENT};
1268
1269                 if (defined($e->{LEVELS}[0]) and
1270                         $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1271                         my $size;
1272
1273                         if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1274                                 if (has_property($e, "charset")) {
1275                                         $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1276                                 } else {
1277                                         $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1278                                 }
1279                         } else {
1280                                 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1281                         }
1282
1283                         $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1284                 } else {
1285                         $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1286                 }
1287         }
1288
1289         $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1290
1291         if (defined($struct->{PROPERTIES}{relative_base})) {
1292                 # set the current offset as base for relative pointers
1293                 # and store it based on the toplevel struct/union
1294                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1295         }
1296
1297         $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1298
1299         $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1300 }
1301
1302 sub ParseStructPushDeferred($$$$)
1303 {
1304         my ($self, $struct, $ndr, $varname, $env) = @_;
1305         if (defined($struct->{PROPERTIES}{relative_base})) {
1306                 # retrieve the current offset as base for relative pointers
1307                 # based on the toplevel struct/union
1308                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1309         }
1310         $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1311 }
1312
1313 #####################################################################
1314 # parse a struct
1315 sub ParseStructPush($$$$)
1316 {
1317         my ($self, $struct, $ndr, $varname) = @_;
1318
1319         return unless defined($struct->{ELEMENTS});
1320
1321         my $env = GenerateStructEnv($struct, $varname);
1322
1323         EnvSubstituteValue($env, $struct);
1324
1325         $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1326
1327         $self->start_flags($struct, $ndr);
1328
1329         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1330         $self->indent;
1331         $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1332         $self->deindent;
1333         $self->pidl("}");
1334
1335         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1336         $self->indent;
1337         $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1338         $self->deindent;
1339         $self->pidl("}");
1340
1341         $self->end_flags($struct, $ndr);
1342 }
1343
1344 #####################################################################
1345 # generate a push function for an enum
1346 sub ParseEnumPush($$$$)
1347 {
1348         my($self,$enum,$ndr,$varname) = @_;
1349         my($type_fn) = $enum->{BASE_TYPE};
1350
1351         $self->start_flags($enum, $ndr);
1352         $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1353         $self->end_flags($enum, $ndr);
1354 }
1355
1356 #####################################################################
1357 # generate a pull function for an enum
1358 sub ParseEnumPull($$$$)
1359 {
1360         my($self,$enum,$ndr,$varname) = @_;
1361         my($type_fn) = $enum->{BASE_TYPE};
1362         my($type_v_decl) = mapTypeName($type_fn);
1363
1364         $self->pidl("$type_v_decl v;");
1365         $self->start_flags($enum, $ndr);
1366         $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1367         $self->pidl("*$varname = v;");
1368
1369         $self->end_flags($enum, $ndr);
1370 }
1371
1372 #####################################################################
1373 # generate a print function for an enum
1374 sub ParseEnumPrint($$$$$)
1375 {
1376         my($self,$enum,$ndr,$name,$varname) = @_;
1377
1378         $self->pidl("const char *val = NULL;");
1379         $self->pidl("");
1380
1381         $self->start_flags($enum, $ndr);
1382
1383         $self->pidl("switch ($varname) {");
1384         $self->indent;
1385         my $els = \@{$enum->{ELEMENTS}};
1386         foreach my $i (0 .. $#{$els}) {
1387                 my $e = ${$els}[$i];
1388                 chomp $e;
1389                 if ($e =~ /^(.*)=/) {
1390                         $e = $1;
1391                 }
1392                 $self->pidl("case $e: val = \"$e\"; break;");
1393         }
1394
1395         $self->deindent;
1396         $self->pidl("}");
1397
1398         $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1399
1400         $self->end_flags($enum, $ndr);
1401 }
1402
1403 sub DeclEnum($$$$)
1404 {
1405         my ($e,$t,$name,$varname) = @_;
1406         return "enum $name " .
1407                 ($t eq "pull"?"*":"") . $varname;
1408 }
1409
1410 $typefamily{ENUM} = {
1411         DECL => \&DeclEnum,
1412         PUSH_FN_BODY => \&ParseEnumPush,
1413         PULL_FN_BODY => \&ParseEnumPull,
1414         PRINT_FN_BODY => \&ParseEnumPrint,
1415 };
1416
1417 #####################################################################
1418 # generate a push function for a bitmap
1419 sub ParseBitmapPush($$$$)
1420 {
1421         my($self,$bitmap,$ndr,$varname) = @_;
1422         my($type_fn) = $bitmap->{BASE_TYPE};
1423
1424         $self->start_flags($bitmap, $ndr);
1425
1426         $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1427
1428         $self->end_flags($bitmap, $ndr);
1429 }
1430
1431 #####################################################################
1432 # generate a pull function for an bitmap
1433 sub ParseBitmapPull($$$$)
1434 {
1435         my($self,$bitmap,$ndr,$varname) = @_;
1436         my $type_fn = $bitmap->{BASE_TYPE};
1437         my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1438
1439         $self->pidl("$type_decl v;");
1440         $self->start_flags($bitmap, $ndr);
1441         $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1442         $self->pidl("*$varname = v;");
1443
1444         $self->end_flags($bitmap, $ndr);
1445 }
1446
1447 #####################################################################
1448 # generate a print function for an bitmap
1449 sub ParseBitmapPrintElement($$$$$$)
1450 {
1451         my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1452         my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1453         my($type_fn) = $bitmap->{BASE_TYPE};
1454         my($flag);
1455
1456         if ($e =~ /^(\w+) .*$/) {
1457                 $flag = "$1";
1458         } else {
1459                 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1460         }
1461
1462         $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1463 }
1464
1465 #####################################################################
1466 # generate a print function for an bitmap
1467 sub ParseBitmapPrint($$$$$)
1468 {
1469         my($self,$bitmap,$ndr,$name,$varname) = @_;
1470         my($type_decl) = mapTypeName($bitmap->{TYPE});
1471         my($type_fn) = $bitmap->{BASE_TYPE};
1472
1473         $self->start_flags($bitmap, $ndr);
1474
1475         $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1476
1477         $self->pidl("$ndr->depth++;");
1478         foreach my $e (@{$bitmap->{ELEMENTS}}) {
1479                 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1480         }
1481         $self->pidl("$ndr->depth--;");
1482
1483         $self->end_flags($bitmap, $ndr);
1484 }
1485
1486 sub DeclBitmap($$$$)
1487 {
1488         my ($e,$t,$name,$varname) = @_;
1489         return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1490                 ($t eq "pull"?" *":" ") . $varname;
1491 }
1492
1493 $typefamily{BITMAP} = {
1494         DECL => \&DeclBitmap,
1495         PUSH_FN_BODY => \&ParseBitmapPush,
1496         PULL_FN_BODY => \&ParseBitmapPull,
1497         PRINT_FN_BODY => \&ParseBitmapPrint,
1498 };
1499
1500 #####################################################################
1501 # generate a struct print function
1502 sub ParseStructPrint($$$$$)
1503 {
1504         my($self,$struct,$ndr,$name,$varname) = @_;
1505
1506         return unless defined $struct->{ELEMENTS};
1507
1508         my $env = GenerateStructEnv($struct, $varname);
1509
1510         $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1511
1512         $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1513
1514         $self->start_flags($struct, $ndr);
1515
1516         $self->pidl("$ndr->depth++;");
1517
1518         $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1519                 foreach (@{$struct->{ELEMENTS}});
1520         $self->pidl("$ndr->depth--;");
1521
1522         $self->end_flags($struct, $ndr);
1523 }
1524
1525 sub DeclarePtrVariables($$)
1526 {
1527         my ($self,$e) = @_;
1528         foreach my $l (@{$e->{LEVELS}}) {
1529                 if ($l->{TYPE} eq "POINTER" and
1530                         not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1531                         $self->pidl("uint32_t _ptr_$e->{NAME};");
1532                         last;
1533                 }
1534         }
1535 }
1536
1537 sub DeclareArrayVariables($$)
1538 {
1539         my ($self,$e) = @_;
1540
1541         foreach my $l (@{$e->{LEVELS}}) {
1542                 next if ($l->{TYPE} ne "ARRAY");
1543                 next if has_fast_array($e,$l);
1544                 next if is_charset_array($e,$l);
1545                 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1546         }
1547 }
1548
1549 sub DeclareArrayVariablesNoZero($$$)
1550 {
1551         my ($self,$e,$env) = @_;
1552
1553         foreach my $l (@{$e->{LEVELS}}) {
1554                 next if ($l->{TYPE} ne "ARRAY");
1555                 next if has_fast_array($e,$l);
1556                 next if is_charset_array($e,$l);
1557                 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1558                 if ($length eq "0") {
1559                         warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1560                 } else {
1561                         $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1562                 }
1563         }
1564 }
1565
1566 sub DeclareMemCtxVariables($$)
1567 {
1568         my ($self,$e) = @_;
1569         foreach my $l (@{$e->{LEVELS}}) {
1570                 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1571                 if (defined($mem_flags)) {
1572                         $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1573                 }
1574         }
1575 }
1576
1577 sub ParseStructPullPrimitives($$$$$)
1578 {
1579         my($self,$struct,$ndr,$varname,$env) = @_;
1580
1581         if (defined $struct->{SURROUNDING_ELEMENT}) {
1582                 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1583         }
1584
1585         $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1586
1587         if (defined($struct->{PROPERTIES}{relative_base})) {
1588                 # set the current offset as base for relative pointers
1589                 # and store it based on the toplevel struct/union
1590                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1591         }
1592
1593         $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1594
1595         $self->add_deferred();
1596
1597         $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1598 }
1599
1600 sub ParseStructPullDeferred($$$$$)
1601 {
1602         my ($self,$struct,$ndr,$varname,$env) = @_;
1603
1604         if (defined($struct->{PROPERTIES}{relative_base})) {
1605                 # retrieve the current offset as base for relative pointers
1606                 # based on the toplevel struct/union
1607                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1608         }
1609         foreach my $e (@{$struct->{ELEMENTS}}) {
1610                 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1611         }
1612
1613         $self->add_deferred();
1614 }
1615
1616 #####################################################################
1617 # parse a struct - pull side
1618 sub ParseStructPull($$$$)
1619 {
1620         my($self,$struct,$ndr,$varname) = @_;
1621
1622         return unless defined $struct->{ELEMENTS};
1623
1624         # declare any internal pointers we need
1625         foreach my $e (@{$struct->{ELEMENTS}}) {
1626                 $self->DeclarePtrVariables($e);
1627                 $self->DeclareArrayVariables($e);
1628                 $self->DeclareMemCtxVariables($e);
1629         }
1630
1631         $self->start_flags($struct, $ndr);
1632
1633         my $env = GenerateStructEnv($struct, $varname);
1634
1635         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1636         $self->indent;
1637         $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1638         $self->deindent;
1639         $self->pidl("}");
1640         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1641         $self->indent;
1642         $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1643         $self->deindent;
1644         $self->pidl("}");
1645
1646         $self->end_flags($struct, $ndr);
1647 }
1648
1649 #####################################################################
1650 # calculate size of ndr struct
1651 sub ParseStructNdrSize($$$$)
1652 {
1653         my ($self,$t, $name, $varname) = @_;
1654         my $sizevar;
1655
1656         if (my $flags = has_property($t, "flag")) {
1657                 $self->pidl("flags |= $flags;");
1658         }
1659         $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1660 }
1661
1662 sub DeclStruct($$$$)
1663 {
1664         my ($e,$t,$name,$varname) = @_;
1665         return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1666 }
1667
1668 sub ArgsStructNdrSize($$$)
1669 {
1670         my ($d, $name, $varname) = @_;
1671         return "const struct $name *$varname, struct smb_iconv_convenience *ic, int flags";
1672 }
1673
1674 $typefamily{STRUCT} = {
1675         PUSH_FN_BODY => \&ParseStructPush,
1676         DECL => \&DeclStruct,
1677         PULL_FN_BODY => \&ParseStructPull,
1678         PRINT_FN_BODY => \&ParseStructPrint,
1679         SIZE_FN_BODY => \&ParseStructNdrSize,
1680         SIZE_FN_ARGS => \&ArgsStructNdrSize,
1681 };
1682
1683 #####################################################################
1684 # calculate size of ndr struct
1685 sub ParseUnionNdrSize($$$)
1686 {
1687         my ($self, $t, $name, $varname) = @_;
1688         my $sizevar;
1689
1690         if (my $flags = has_property($t, "flag")) {
1691                 $self->pidl("flags |= $flags;");
1692         }
1693
1694         $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1695 }
1696
1697 sub ParseUnionPushPrimitives($$$$)
1698 {
1699         my ($self, $e, $ndr ,$varname) = @_;
1700
1701         my $have_default = 0;
1702
1703         $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1704
1705         if (defined($e->{SWITCH_TYPE})) {
1706                 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1707         }
1708
1709         if (defined($e->{ALIGN})) {
1710                 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1711         }
1712
1713         $self->pidl("switch (level) {");
1714         $self->indent;
1715         foreach my $el (@{$e->{ELEMENTS}}) {
1716                 if ($el->{CASE} eq "default") {
1717                         $have_default = 1;
1718                 }
1719                 $self->pidl("$el->{CASE}: {");
1720
1721                 if ($el->{TYPE} ne "EMPTY") {
1722                         $self->indent;
1723                         if (defined($e->{PROPERTIES}{relative_base})) {
1724                                 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1725                                 # set the current offset as base for relative pointers
1726                                 # and store it based on the toplevel struct/union
1727                                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1728                         }
1729                         $self->DeclareArrayVariables($el);
1730                         $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1731                         $self->deindent;
1732                 }
1733                 $self->pidl("break; }");
1734                 $self->pidl("");
1735         }
1736         if (! $have_default) {
1737                 $self->pidl("default:");
1738                 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1739         }
1740         $self->deindent;
1741         $self->pidl("}");
1742 }
1743
1744 sub ParseUnionPushDeferred($$$$)
1745 {
1746         my ($self,$e,$ndr,$varname) = @_;
1747
1748         my $have_default = 0;
1749
1750         $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1751         if (defined($e->{PROPERTIES}{relative_base})) {
1752                 # retrieve the current offset as base for relative pointers
1753                 # based on the toplevel struct/union
1754                 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1755         }
1756         $self->pidl("switch (level) {");
1757         $self->indent;
1758         foreach my $el (@{$e->{ELEMENTS}}) {
1759                 if ($el->{CASE} eq "default") {
1760                         $have_default = 1;
1761                 }
1762
1763                 $self->pidl("$el->{CASE}:");
1764                 if ($el->{TYPE} ne "EMPTY") {
1765                         $self->indent;
1766                         $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1767                         $self->deindent;
1768                 }
1769                 $self->pidl("break;");
1770                 $self->pidl("");
1771         }
1772         if (! $have_default) {
1773                 $self->pidl("default:");
1774                 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1775         }
1776         $self->deindent;
1777         $self->pidl("}");
1778 }
1779
1780 #####################################################################
1781 # parse a union - push side
1782 sub ParseUnionPush($$$$)
1783 {
1784         my ($self,$e,$ndr,$varname) = @_;
1785         my $have_default = 0;
1786
1787         $self->start_flags($e, $ndr);
1788
1789         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1790         $self->indent;
1791         $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1792         $self->deindent;
1793         $self->pidl("}");
1794         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1795         $self->indent;
1796         $self->ParseUnionPushDeferred($e, $ndr, $varname);
1797         $self->deindent;
1798         $self->pidl("}");
1799         $self->end_flags($e, $ndr);
1800 }
1801
1802 #####################################################################
1803 # print a union
1804 sub ParseUnionPrint($$$$$)
1805 {
1806         my ($self,$e,$ndr,$name,$varname) = @_;
1807         my $have_default = 0;
1808
1809         $self->pidl("int level;");
1810         foreach my $el (@{$e->{ELEMENTS}}) {
1811                 $self->DeclareArrayVariables($el);
1812         }
1813
1814         $self->start_flags($e, $ndr);
1815
1816         $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1817
1818         $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1819
1820         $self->pidl("switch (level) {");
1821         $self->indent;
1822         foreach my $el (@{$e->{ELEMENTS}}) {
1823                 if ($el->{CASE} eq "default") {
1824                         $have_default = 1;
1825                 }
1826                 $self->pidl("$el->{CASE}:");
1827                 if ($el->{TYPE} ne "EMPTY") {
1828                         $self->indent;
1829                         $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1830                         $self->deindent;
1831                 }
1832                 $self->pidl("break;");
1833                 $self->pidl("");
1834         }
1835         if (! $have_default) {
1836                 $self->pidl("default:");
1837                 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1838         }
1839         $self->deindent;
1840         $self->pidl("}");
1841
1842         $self->end_flags($e, $ndr);
1843 }
1844
1845 sub ParseUnionPullPrimitives($$$$$)
1846 {
1847         my ($self,$e,$ndr,$varname,$switch_type) = @_;
1848         my $have_default = 0;
1849
1850         if (defined($switch_type)) {
1851                 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1852                 $self->pidl("if (_level != level) {");
1853                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1854                 $self->pidl("}");
1855         }
1856
1857         if (defined($e->{ALIGN})) {
1858                 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1859         }
1860
1861         $self->pidl("switch (level) {");
1862         $self->indent;
1863         foreach my $el (@{$e->{ELEMENTS}}) {
1864                 if ($el->{CASE} eq "default") {
1865                         $have_default = 1;
1866                 }
1867                 $self->pidl("$el->{CASE}: {");
1868
1869                 if ($el->{TYPE} ne "EMPTY") {
1870                         $self->indent;
1871                         if (defined($e->{PROPERTIES}{relative_base})) {
1872                                 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1873                                 # set the current offset as base for relative pointers
1874                                 # and store it based on the toplevel struct/union
1875                                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1876                         }
1877                         $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1878                         $self->deindent;
1879                 }
1880                 $self->pidl("break; }");
1881                 $self->pidl("");
1882         }
1883         if (! $have_default) {
1884                 $self->pidl("default:");
1885                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1886         }
1887         $self->deindent;
1888         $self->pidl("}");
1889 }
1890
1891 sub ParseUnionPullDeferred($$$$)
1892 {
1893         my ($self,$e,$ndr,$varname) = @_;
1894         my $have_default = 0;
1895
1896         if (defined($e->{PROPERTIES}{relative_base})) {
1897                 # retrieve the current offset as base for relative pointers
1898                 # based on the toplevel struct/union
1899                 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1900         }
1901         $self->pidl("switch (level) {");
1902         $self->indent;
1903         foreach my $el (@{$e->{ELEMENTS}}) {
1904                 if ($el->{CASE} eq "default") {
1905                         $have_default = 1;
1906                 }
1907
1908                 $self->pidl("$el->{CASE}:");
1909                 if ($el->{TYPE} ne "EMPTY") {
1910                         $self->indent;
1911                         $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1912                         $self->deindent;
1913                 }
1914                 $self->pidl("break;");
1915                 $self->pidl("");
1916         }
1917         if (! $have_default) {
1918                 $self->pidl("default:");
1919                 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1920         }
1921         $self->deindent;
1922         $self->pidl("}");
1923
1924
1925 }
1926
1927 #####################################################################
1928 # parse a union - pull side
1929 sub ParseUnionPull($$$$)
1930 {
1931         my ($self,$e,$ndr,$varname) = @_;
1932         my $switch_type = $e->{SWITCH_TYPE};
1933
1934         $self->pidl("int level;");
1935         if (defined($switch_type)) {
1936                 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1937                         $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1938                 }
1939                 $self->pidl(mapTypeName($switch_type) . " _level;");
1940         }
1941
1942         my %double_cases = ();
1943         foreach my $el (@{$e->{ELEMENTS}}) {
1944                 next if ($el->{TYPE} eq "EMPTY");
1945                 next if ($double_cases{"$el->{NAME}"});
1946                 $self->DeclareMemCtxVariables($el);
1947                 $self->DeclarePtrVariables($el);
1948                 $self->DeclareArrayVariables($el);
1949                 $double_cases{"$el->{NAME}"} = 1;
1950         }
1951
1952         $self->start_flags($e, $ndr);
1953
1954         $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1955
1956         $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1957         $self->indent;
1958         $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1959         $self->deindent;
1960         $self->pidl("}");
1961
1962         $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1963         $self->indent;
1964         $self->ParseUnionPullDeferred($e,$ndr,$varname);
1965         $self->deindent;
1966         $self->pidl("}");
1967
1968         $self->add_deferred();
1969
1970         $self->end_flags($e, $ndr);
1971 }
1972
1973 sub DeclUnion($$$$)
1974 {
1975         my ($e,$t,$name,$varname) = @_;
1976         return ($t ne "pull"?"const ":"") . "union $name *$varname";
1977 }
1978
1979 sub ArgsUnionNdrSize($$)
1980 {
1981         my ($d,$name) = @_;
1982         return "const union $name *r, uint32_t level, struct smb_iconv_convenience *ic, int flags";
1983 }
1984
1985 $typefamily{UNION} = {
1986         PUSH_FN_BODY => \&ParseUnionPush,
1987         DECL => \&DeclUnion,
1988         PULL_FN_BODY => \&ParseUnionPull,
1989         PRINT_FN_BODY => \&ParseUnionPrint,
1990         SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1991         SIZE_FN_BODY => \&ParseUnionNdrSize,
1992 };
1993
1994 #####################################################################
1995 # parse a typedef - push side
1996 sub ParseTypedefPush($$$$)
1997 {
1998         my($self,$e,$ndr,$varname) = @_;
1999
2000         my $env;
2001
2002         $env->{$e->{NAME}} = $varname;
2003
2004         $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2005 }
2006
2007 #####################################################################
2008 # parse a typedef - pull side
2009 sub ParseTypedefPull($$$$)
2010 {
2011         my($self,$e,$ndr,$varname) = @_;
2012
2013         my $env;
2014
2015         $env->{$e->{NAME}} = $varname;
2016
2017         $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2018 }
2019
2020 #####################################################################
2021 # parse a typedef - print side
2022 sub ParseTypedefPrint($$$$$)
2023 {
2024         my($self,$e,$ndr,$name,$varname) = @_;
2025
2026         $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2027 }
2028
2029 #####################################################################
2030 ## calculate the size of a structure
2031 sub ParseTypedefNdrSize($$$$)
2032 {
2033         my($self,$t,$name,$varname) = @_;
2034
2035         $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2036 }
2037
2038 sub DeclTypedef($$$$)
2039 {
2040         my ($e, $t, $name, $varname) = @_;
2041
2042         return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2043 }
2044
2045 sub ArgsTypedefNdrSize($$$)
2046 {
2047         my ($d, $name, $varname) = @_;
2048         return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2049 }
2050
2051 $typefamily{TYPEDEF} = {
2052         PUSH_FN_BODY => \&ParseTypedefPush,
2053         DECL => \&DeclTypedef,
2054         PULL_FN_BODY => \&ParseTypedefPull,
2055         PRINT_FN_BODY => \&ParseTypedefPrint,
2056         SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2057         SIZE_FN_BODY => \&ParseTypedefNdrSize,
2058 };
2059
2060 #####################################################################
2061 # parse a function - print side
2062 sub ParseFunctionPrint($$)
2063 {
2064         my($self, $fn) = @_;
2065         my $ndr = "ndr";
2066
2067         $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2068
2069         return if has_property($fn, "noprint");
2070
2071         $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2072         $self->pidl("{");
2073         $self->indent;
2074
2075         foreach my $e (@{$fn->{ELEMENTS}}) {
2076                 $self->DeclareArrayVariables($e);
2077         }
2078
2079         $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2080         $self->pidl("$ndr->depth++;");
2081
2082         $self->pidl("if (flags & NDR_SET_VALUES) {");
2083         $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2084         $self->pidl("}");
2085
2086         $self->pidl("if (flags & NDR_IN) {");
2087         $self->indent;
2088         $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2089         $self->pidl("$ndr->depth++;");
2090
2091         my $env = GenerateFunctionInEnv($fn);
2092
2093         foreach my $e (@{$fn->{ELEMENTS}}) {
2094                 if (grep(/in/,@{$e->{DIRECTION}})) {
2095                         $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2096                 }
2097         }
2098         $self->pidl("$ndr->depth--;");
2099         $self->deindent;
2100         $self->pidl("}");
2101
2102         $self->pidl("if (flags & NDR_OUT) {");
2103         $self->indent;
2104         $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2105         $self->pidl("$ndr->depth++;");
2106
2107         $env = GenerateFunctionOutEnv($fn);
2108         foreach my $e (@{$fn->{ELEMENTS}}) {
2109                 if (grep(/out/,@{$e->{DIRECTION}})) {
2110                         $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2111                 }
2112         }
2113         if ($fn->{RETURN_TYPE}) {
2114                 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2115         }
2116         $self->pidl("$ndr->depth--;");
2117         $self->deindent;
2118         $self->pidl("}");
2119
2120         $self->pidl("$ndr->depth--;");
2121         $self->deindent;
2122         $self->pidl("}");
2123         $self->pidl("");
2124 }
2125
2126 #####################################################################
2127 # parse a function
2128 sub ParseFunctionPush($$)
2129 {
2130         my($self, $fn) = @_;
2131         my $ndr = "ndr";
2132
2133         $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;
2134
2135         return if has_property($fn, "nopush");
2136
2137         $self->pidl("{");
2138         $self->indent;
2139
2140         foreach my $e (@{$fn->{ELEMENTS}}) {
2141                 $self->DeclareArrayVariables($e);
2142         }
2143
2144         $self->pidl("if (flags & NDR_IN) {");
2145         $self->indent;
2146
2147         my $env = GenerateFunctionInEnv($fn);
2148
2149         EnvSubstituteValue($env, $fn);
2150
2151         foreach my $e (@{$fn->{ELEMENTS}}) {
2152                 if (grep(/in/,@{$e->{DIRECTION}})) {
2153                         $self->ParseElementPush($e, $ndr, $env, 1, 1);
2154                 }
2155         }
2156
2157         $self->deindent;
2158         $self->pidl("}");
2159
2160         $self->pidl("if (flags & NDR_OUT) {");
2161         $self->indent;
2162
2163         $env = GenerateFunctionOutEnv($fn);
2164         foreach my $e (@{$fn->{ELEMENTS}}) {
2165                 if (grep(/out/,@{$e->{DIRECTION}})) {
2166                         $self->ParseElementPush($e, $ndr, $env, 1, 1);
2167                 }
2168         }
2169
2170         if ($fn->{RETURN_TYPE}) {
2171                 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2172         }
2173
2174         $self->deindent;
2175         $self->pidl("}");
2176         $self->pidl("return NDR_ERR_SUCCESS;");
2177         $self->deindent;
2178         $self->pidl("}");
2179         $self->pidl("");
2180 }
2181
2182 sub AllocateArrayLevel($$$$$$)
2183 {
2184         my ($self,$e,$l,$ndr,$var,$size) = @_;
2185
2186         my $pl = GetPrevLevel($e, $l);
2187         if (defined($pl) and
2188             $pl->{TYPE} eq "POINTER" and
2189             $pl->{POINTER_TYPE} eq "ref"
2190             and not $l->{IS_ZERO_TERMINATED}) {
2191                 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2192                 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2193                 $self->pidl("}");
2194                 if (grep(/in/,@{$e->{DIRECTION}}) and
2195                     grep(/out/,@{$e->{DIRECTION}})) {
2196                         $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2197                 }
2198                 return;
2199         }
2200
2201         $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2202 }
2203
2204 #####################################################################
2205 # parse a function
2206 sub ParseFunctionPull($$)
2207 {
2208         my($self,$fn) = @_;
2209         my $ndr = "ndr";
2210
2211         # pull function args
2212         $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;
2213
2214         $self->pidl("{");
2215         $self->indent;
2216
2217         # declare any internal pointers we need
2218         foreach my $e (@{$fn->{ELEMENTS}}) {
2219                 $self->DeclarePtrVariables($e);
2220                 $self->DeclareArrayVariables($e);
2221         }
2222
2223         my %double_cases = ();
2224         foreach my $e (@{$fn->{ELEMENTS}}) {
2225                 next if ($e->{TYPE} eq "EMPTY");
2226                 next if ($double_cases{"$e->{NAME}"});
2227                 $self->DeclareMemCtxVariables($e);
2228                 $double_cases{"$e->{NAME}"} = 1;
2229         }
2230
2231         $self->pidl("if (flags & NDR_IN) {");
2232         $self->indent;
2233
2234         # auto-init the out section of a structure. I originally argued that
2235         # this was a bad idea as it hides bugs, but coping correctly
2236         # with initialisation and not wiping ref vars is turning
2237         # out to be too tricky (tridge)
2238         foreach my $e (@{$fn->{ELEMENTS}}) {
2239                 next unless grep(/out/, @{$e->{DIRECTION}});
2240                 $self->pidl("ZERO_STRUCT(r->out);");
2241                 $self->pidl("");
2242                 last;
2243         }
2244
2245         my $env = GenerateFunctionInEnv($fn);
2246
2247         foreach my $e (@{$fn->{ELEMENTS}}) {
2248                 next unless (grep(/in/, @{$e->{DIRECTION}}));
2249                 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2250         }
2251
2252         # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2253         # own flag rather than be in NDR_IN ?
2254
2255         foreach my $e (@{$fn->{ELEMENTS}}) {
2256                 next unless (grep(/out/, @{$e->{DIRECTION}}));
2257                 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2258                              $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2259                 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2260                                  ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2261                 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2262                         and   $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2263
2264                 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2265                         my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2266                                 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2267                                                    "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2268                                 check_fully_dereferenced($e, $env));
2269                         $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2270
2271                         if (grep(/in/, @{$e->{DIRECTION}})) {
2272                                 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2273                         } else {
2274                                 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2275                         }
2276                 } else {
2277                         $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2278
2279                         if (grep(/in/, @{$e->{DIRECTION}})) {
2280                                 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2281                         } else {
2282                                 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2283                         }
2284                 }
2285         }
2286
2287         $self->add_deferred();
2288         $self->deindent;
2289         $self->pidl("}");
2290
2291         $self->pidl("if (flags & NDR_OUT) {");
2292         $self->indent;
2293
2294         $env = GenerateFunctionOutEnv($fn);
2295         foreach my $e (@{$fn->{ELEMENTS}}) {
2296                 next unless grep(/out/, @{$e->{DIRECTION}});
2297                 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2298         }
2299
2300         if ($fn->{RETURN_TYPE}) {
2301                 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2302         }
2303
2304         $self->add_deferred();
2305         $self->deindent;
2306         $self->pidl("}");
2307
2308         $self->pidl("return NDR_ERR_SUCCESS;");
2309         $self->deindent;
2310         $self->pidl("}");
2311         $self->pidl("");
2312 }
2313
2314 sub AuthServiceStruct($$$)
2315 {
2316         my ($self, $ifacename, $authservice) = @_;
2317         my @a = split /,/, $authservice;
2318         my $authservice_count = $#a + 1;
2319
2320         $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2321         foreach my $ap (@a) {
2322                 $self->pidl("\t$ap, ");
2323         }
2324         $self->pidl("};");
2325         $self->pidl("");
2326
2327         $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2328         $self->pidl("\t.count\t= $authservice_count,");
2329         $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2330         $self->pidl("};");
2331         $self->pidl("");
2332 }
2333
2334 sub FunctionCallEntry($$)
2335 {
2336         my ($self, $d) = @_;
2337         return 0 if not defined($d->{OPNUM});
2338         $self->pidl("\t{");
2339         $self->pidl("\t\t\"$d->{NAME}\",");
2340         $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2341         $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2342         $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2343         $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2344         $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2345         $self->pidl("\t},");
2346         return 1;
2347 }
2348
2349 #####################################################################
2350 # produce a function call table
2351 sub FunctionTable($$)
2352 {
2353         my($self,$interface) = @_;
2354         my $count = 0;
2355         my $uname = uc $interface->{NAME};
2356
2357         return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2358         return unless defined ($interface->{PROPERTIES}->{uuid});
2359
2360         $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2361
2362         foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2363                 $count += $self->FunctionCallEntry($d);
2364         }
2365         $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2366         $self->pidl("};");
2367         $self->pidl("");
2368
2369         $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2370         foreach my $ep (@{$interface->{ENDPOINTS}}) {
2371                 $self->pidl("\t$ep, ");
2372         }
2373         my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2374
2375         $self->pidl("};");
2376         $self->pidl("");
2377
2378         $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2379         $self->pidl("\t.count\t= $endpoint_count,");
2380         $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2381         $self->pidl("};");
2382         $self->pidl("");
2383
2384         if (! defined $interface->{PROPERTIES}->{authservice}) {
2385                 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2386         }
2387
2388         $self->AuthServiceStruct($interface->{NAME},
2389                                      $interface->{PROPERTIES}->{authservice});
2390
2391         $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2392         $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2393         $self->pidl("\t.syntax_id\t= {");
2394         $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2395         $self->pidl("\t\tNDR_$uname\_VERSION");
2396         $self->pidl("\t},");
2397         $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2398         $self->pidl("\t.num_calls\t= $count,");
2399         $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2400         $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2401         $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2402         $self->pidl("};");
2403         $self->pidl("");
2404
2405 }
2406
2407 #####################################################################
2408 # generate include statements for imported idl files
2409 sub HeaderImport
2410 {
2411         my $self = shift;
2412         my @imports = @_;
2413         foreach (@imports) {
2414                 $_ = unmake_str($_);
2415                 s/\.idl$//;
2416                 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2417         }
2418 }
2419
2420 #####################################################################
2421 # generate include statements for included header files
2422 sub HeaderInclude
2423 {
2424         my $self = shift;
2425         my @includes = @_;
2426         foreach (@includes) {
2427                 $self->pidl_hdr("#include $_");
2428         }
2429 }
2430
2431 #####################################################################
2432 # generate prototypes and defines for the interface definitions
2433 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2434 # NDR parser and so do not belong here, technically speaking
2435 sub HeaderInterface($$$)
2436 {
2437         my($self,$interface,$needed) = @_;
2438
2439         my $count = 0;
2440
2441         if ($needed->{"compression"}) {
2442                 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2443         }
2444
2445         if (has_property($interface, "object")) {
2446                 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2447         }
2448
2449         if (defined $interface->{PROPERTIES}->{helper}) {
2450                 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2451         }
2452
2453         if (defined $interface->{PROPERTIES}->{uuid}) {
2454                 my $name = uc $interface->{NAME};
2455                 $self->pidl_hdr("#define NDR_$name\_UUID " .
2456                 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2457
2458                 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2459                 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2460
2461                 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2462
2463                 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2464                 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2465
2466                 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2467         }
2468
2469         foreach (@{$interface->{FUNCTIONS}}) {
2470                 next if has_property($_, "noopnum");
2471                 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2472                 my $u_name = uc $_->{NAME};
2473
2474                 my $val = sprintf("0x%02x", $count);
2475                 if (defined($interface->{BASE})) {
2476                         $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2477                 }
2478
2479                 $self->pidl_hdr("#define NDR_$u_name ($val)");
2480
2481                 $self->pidl_hdr("");
2482                 $count++;
2483         }
2484
2485         my $val = $count;
2486
2487         if (defined($interface->{BASE})) {
2488                 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2489         }
2490
2491         $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2492
2493 }
2494
2495 sub ParseTypePush($$$$$$)
2496 {
2497         my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2498
2499         # save the old relative_base_offset
2500         $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2501         $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2502         # restore the old relative_base_offset
2503         $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2504 }
2505
2506 sub ParseTypePushFunction($$$)
2507 {
2508         my ($self, $e, $varname) = @_;
2509         my $ndr = "ndr";
2510
2511         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2512
2513         $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2514
2515         $self->pidl("{");
2516         $self->indent;
2517         $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2518         $self->pidl("return NDR_ERR_SUCCESS;");
2519         $self->deindent;
2520         $self->pidl("}");
2521         $self->pidl("");;
2522 }
2523
2524 sub ParseTypePull($$$$$$)
2525 {
2526         my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2527
2528         # save the old relative_base_offset
2529         $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2530         $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2531         # restore the old relative_base_offset
2532         $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2533 }
2534
2535 sub ParseTypePullFunction($$)
2536 {
2537         my ($self, $e, $varname) = @_;
2538         my $ndr = "ndr";
2539
2540         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2541
2542         $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2543
2544         $self->pidl("{");
2545         $self->indent;
2546         $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2547         $self->pidl("return NDR_ERR_SUCCESS;");
2548         $self->deindent;
2549         $self->pidl("}");
2550         $self->pidl("");
2551 }
2552
2553 sub ParseTypePrint($$$$)
2554 {
2555         my ($self, $e, $ndr, $varname) = @_;
2556
2557         $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2558 }
2559
2560 sub ParseTypePrintFunction($$$)
2561 {
2562         my ($self, $e, $varname) = @_;
2563         my $ndr = "ndr";
2564
2565         my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2566
2567         $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2568
2569         return if (has_property($e, "noprint"));
2570
2571         $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2572         $self->pidl("{");
2573         $self->indent;
2574         $self->ParseTypePrint($e, $ndr, $varname);
2575         $self->deindent;
2576         $self->pidl("}");
2577         $self->pidl("");
2578 }
2579
2580 sub ParseTypeNdrSize($$)
2581 {
2582         my ($self,$t) = @_;
2583
2584         my $varname = "r";
2585         my $tf = $typefamily{$t->{TYPE}};
2586         my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2587
2588         $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2589
2590         $self->pidl("{");
2591         $self->indent;
2592         $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2593         $self->deindent;
2594         $self->pidl("}");
2595         $self->pidl("");
2596 }
2597
2598 #####################################################################
2599 # parse the interface definitions
2600 sub ParseInterface($$$)
2601 {
2602         my($self,$interface,$needed) = @_;
2603
2604         $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2605         $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2606
2607         $self->pidl_hdr("");
2608
2609         $self->HeaderInterface($interface, $needed);
2610
2611         # Typedefs
2612         foreach my $d (@{$interface->{TYPES}}) {
2613                 next unless(typeHasBody($d));
2614
2615                 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2616                 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2617                 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2618
2619                 # Make sure we don't generate a function twice...
2620                 $needed->{TypeFunctionName("ndr_push", $d)} =
2621                     $needed->{TypeFunctionName("ndr_pull", $d)} =
2622                         $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2623
2624                 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2625         }
2626
2627         # Functions
2628         foreach my $d (@{$interface->{FUNCTIONS}}) {
2629                 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2630                 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2631                 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2632
2633                 # Make sure we don't generate a function twice...
2634                 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2635                         $needed->{"ndr_print_$d->{NAME}"} = 0;
2636         }
2637
2638         $self->FunctionTable($interface);
2639
2640         $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2641 }
2642
2643 sub GenerateIncludes($)
2644 {
2645         my ($self) = @_;
2646         if (is_intree()) {
2647                 $self->pidl("#include \"includes.h\"");
2648         } else {
2649                 $self->pidl("#ifndef _GNU_SOURCE");
2650                 $self->pidl("#define _GNU_SOURCE");
2651                 $self->pidl("#endif");
2652                 $self->pidl("#include <stdint.h>");
2653                 $self->pidl("#include <stdlib.h>");
2654                 $self->pidl("#include <stdio.h>");
2655                 $self->pidl("#include <stdbool.h>");
2656                 $self->pidl("#include <stdarg.h>");
2657                 $self->pidl("#include <string.h>");
2658         }
2659 }
2660
2661 #####################################################################
2662 # parse a parsed IDL structure back into an IDL file
2663 sub Parse($$$$)
2664 {
2665         my($self, $ndr,$gen_header,$ndr_header) = @_;
2666
2667         $self->pidl_hdr("/* header auto-generated by pidl */");
2668         $self->pidl_hdr("");
2669         $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2670         $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2671         $self->pidl_hdr("");
2672
2673         $self->pidl("/* parser auto-generated by pidl */");
2674         $self->pidl("");
2675         $self->GenerateIncludes();
2676         $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2677         $self->pidl("");
2678
2679         my %needed = ();
2680
2681         foreach (@{$ndr}) {
2682                 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2683         }
2684
2685         foreach (@{$ndr}) {
2686                 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2687                 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2688                 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2689         }
2690
2691         return ($self->{res_hdr}, $self->{res});
2692 }
2693
2694 sub NeededElement($$$)
2695 {
2696         my ($e, $dir, $needed) = @_;
2697
2698         return if ($e->{TYPE} eq "EMPTY");
2699
2700         return if (ref($e->{TYPE}) eq "HASH" and
2701                        not defined($e->{TYPE}->{NAME}));
2702
2703         my ($t, $rt);
2704         if (ref($e->{TYPE}) eq "HASH") {
2705                 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2706         } else {
2707                 $t = $e->{TYPE};
2708         }
2709
2710         if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2711                 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2712         } else {
2713                 $rt = $e->{REPRESENTATION_TYPE};
2714         }
2715
2716         die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2717
2718         my @fn = ();
2719         if ($dir eq "print") {
2720                 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2721         } elsif ($dir eq "pull") {
2722                 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2723                 push (@fn, "ndr_$t\_to_$rt")
2724                         if ($rt ne $t);
2725         } elsif ($dir eq "push") {
2726                 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2727                 push (@fn, "ndr_$rt\_to_$t")
2728                         if ($rt ne $t);
2729         } else {
2730                 die("invalid direction `$dir'");
2731         }
2732
2733         foreach (@fn) {
2734                 unless (defined($needed->{$_})) {
2735                         $needed->{$_} = 1;
2736                 }
2737         }
2738 }
2739
2740 sub NeededFunction($$)
2741 {
2742         my ($fn,$needed) = @_;
2743         $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2744         $needed->{"ndr_push_$fn->{NAME}"} = 1;
2745         $needed->{"ndr_print_$fn->{NAME}"} = 1;
2746         foreach my $e (@{$fn->{ELEMENTS}}) {
2747                 $e->{PARENT} = $fn;
2748                 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2749         }
2750 }
2751
2752 sub NeededType($$$)
2753 {
2754         sub NeededType($$$);
2755         my ($t,$needed,$req) = @_;
2756
2757         NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2758
2759         if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2760                 return unless defined($t->{ELEMENTS});
2761                 for my $e (@{$t->{ELEMENTS}}) {
2762                         $e->{PARENT} = $t;
2763                         if (has_property($e, "compression")) {
2764                                 $needed->{"compression"} = 1;
2765                         }
2766                         NeededElement($e, $req, $needed);
2767                         NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2768                 }
2769         }
2770 }
2771
2772 #####################################################################
2773 # work out what parse functions are needed
2774 sub NeededInterface($$)
2775 {
2776         my ($interface,$needed) = @_;
2777         NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2778         foreach (reverse @{$interface->{TYPES}}) {
2779                 if (has_property($_, "public")) {
2780                         $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2781                                 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2782                 }
2783
2784                 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2785                 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2786                 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2787                 if (has_property($_, "gensize")) {
2788                         $needed->{"ndr_size_$_->{NAME}"} = 1;
2789                 }
2790         }
2791 }
2792
2793 sub TypeFunctionName($$)
2794 {
2795         my ($prefix, $t) = @_;
2796
2797         return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2798                         $t->{TYPE} eq "TYPEDEF");
2799         return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2800         return "$prefix\_$t";
2801 }
2802
2803 1;