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