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