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

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