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