pidl: add pidl in order to be able to regenerate librpc functions.
[Samba.git] / source / pidl / lib / Parse / Pidl / Samba4 / NDR / Parser.pm
bloba494a114707129537f450e601d81f22f9c273088
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
8 package Parse::Pidl::Samba4::NDR::Parser;
10 require Exporter;
11 @ISA = qw(Exporter);
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
14 use strict;
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
21 use Parse::Pidl qw(warning);
23 use vars qw($VERSION);
24 $VERSION = '0.01';
26 # list of known types
27 my %typefamily;
29 sub new($$) {
30 my ($class) = @_;
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
32 bless($self, $class);
35 sub get_typefamily($)
37 my $n = shift;
38 return $typefamily{$n};
41 sub append_prefix($$)
43 my ($e, $var_name) = @_;
44 my $pointers = 0;
45 my $arrays = 0;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
49 $pointers++;
50 } elsif ($l->{TYPE} eq "ARRAY") {
51 $arrays++;
52 if (($pointers == 0) and
53 (not $l->{IS_FIXED}) and
54 (not $l->{IS_INLINE})) {
55 return get_value_of($var_name);
57 } elsif ($l->{TYPE} eq "DATA") {
58 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
59 return get_value_of($var_name) unless ($pointers or $arrays);
64 return $var_name;
67 sub has_fast_array($$)
69 my ($e,$l) = @_;
71 return 0 if ($l->{TYPE} ne "ARRAY");
73 my $nl = GetNextLevel($e,$l);
74 return 0 unless ($nl->{TYPE} eq "DATA");
75 return 0 unless (hasType($nl->{DATA_TYPE}));
77 my $t = getType($nl->{DATA_TYPE});
79 # Only uint8 and string have fast array functions at the moment
80 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
84 ####################################
85 # pidl() is our basic output routine
86 sub pidl($$)
88 my ($self, $d) = @_;
89 if ($d) {
90 $self->{res} .= $self->{tabs};
91 $self->{res} .= $d;
93 $self->{res} .="\n";
96 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
98 ####################################
99 # defer() is like pidl(), but adds to
100 # a deferred buffer which is then added to the
101 # output buffer at the end of the structure/union/function
102 # This is needed to cope with code that must be pushed back
103 # to the end of a block of elements
104 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
105 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
107 sub defer($$)
109 my ($self, $d) = @_;
110 if ($d) {
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
117 # output
118 sub add_deferred($)
120 my ($self) = @_;
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
126 sub indent($)
128 my ($self) = @_;
129 $self->{tabs} .= "\t";
132 sub deindent($)
134 my ($self) = @_;
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
140 sub fn_declare($$$$)
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
146 return 0;
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
152 } else {
153 $self->pidl("static $decl");
156 return 1;
159 ###################################################################
160 # setup any special flags for an element or structure
161 sub start_flags($$)
163 my ($self, $e) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
166 $self->pidl("{");
167 $self->indent;
168 $self->pidl("uint32_t _flags_save_$e->{TYPE} = ndr->flags;");
169 $self->pidl("ndr_set_flags(&ndr->flags, $flags);");
173 ###################################################################
174 # end any special flags for an element or structure
175 sub end_flags($$)
177 my ($self, $e) = @_;
178 my $flags = has_property($e, "flag");
179 if (defined $flags) {
180 $self->pidl("ndr->flags = _flags_save_$e->{TYPE};");
181 $self->deindent;
182 $self->pidl("}");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
192 my $size;
193 my $length;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
198 } else {
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
201 } else {
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
203 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
206 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
207 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
210 if ($l->{IS_VARYING}) {
211 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"); # array offset
212 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));");
215 return $length;
218 sub check_fully_dereferenced($$)
220 my ($element, $env) = @_;
222 return sub ($) {
223 my $origvar = shift;
224 my $check = 0;
226 # Figure out the number of pointers in $ptr
227 my $expandedvar = $origvar;
228 $expandedvar =~ s/^(\**)//;
229 my $ptr = $1;
231 my $var = undef;
232 foreach (keys %$env) {
233 if ($env->{$_} eq $expandedvar) {
234 $var = $_;
235 last;
239 return($origvar) unless (defined($var));
240 my $e;
241 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
242 if ($_->{NAME} eq $var) {
243 $e = $_;
244 last;
248 $e or die("Environment doesn't match siblings");
250 # See if pointer at pointer level $level
251 # needs to be checked.
252 my $nump = 0;
253 foreach (@{$e->{LEVELS}}) {
254 if ($_->{TYPE} eq "POINTER") {
255 $nump = $_->{POINTER_INDEX}+1;
258 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
259 return ($origvar);
263 sub check_null_pointer($$$$)
265 my ($element, $env, $print_fn, $return) = @_;
267 return sub ($) {
268 my $expandedvar = shift;
269 my $check = 0;
271 # Figure out the number of pointers in $ptr
272 $expandedvar =~ s/^(\**)//;
273 my $ptr = $1;
275 my $var = undef;
276 foreach (keys %$env) {
277 if ($env->{$_} eq $expandedvar) {
278 $var = $_;
279 last;
283 if (defined($var)) {
284 my $e;
285 # lookup ptr in $e
286 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
287 if ($_->{NAME} eq $var) {
288 $e = $_;
289 last;
293 $e or die("Environment doesn't match siblings");
295 # See if pointer at pointer level $level
296 # needs to be checked.
297 foreach my $l (@{$e->{LEVELS}}) {
298 if ($l->{TYPE} eq "POINTER" and
299 $l->{POINTER_INDEX} == length($ptr)) {
300 # No need to check ref pointers
301 $check = ($l->{POINTER_TYPE} ne "ref");
302 last;
305 if ($l->{TYPE} eq "DATA") {
306 warning($element, "too much dereferences for `$var'");
309 } else {
310 warning($element, "unknown dereferenced expression `$expandedvar'");
311 $check = 1;
314 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
318 #####################################################################
319 # parse an array - pull side
320 sub ParseArrayPullHeader($$$$$$)
322 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
324 my $length;
325 my $size;
327 if ($l->{IS_CONFORMANT}) {
328 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
329 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
330 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
331 } else {
332 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
333 check_null_pointer($e, $env, sub { $self->pidl(shift); },
334 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
335 check_fully_dereferenced($e, $env));
338 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
339 $self->pidl("NDR_CHECK(ndr_pull_array_size(ndr, " . get_pointer_to($var_name) . "));");
342 if ($l->{IS_VARYING}) {
343 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
344 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
347 if ($length ne $size) {
348 $self->pidl("if ($length > $size) {");
349 $self->indent;
350 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
351 $self->deindent;
352 $self->pidl("}");
355 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
356 $self->defer("if ($var_name) {");
357 $self->defer_indent;
358 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
359 check_null_pointer($e, $env, sub { $self->defer(shift); },
360 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
361 check_fully_dereferenced($e, $env));
362 $self->defer("NDR_CHECK(ndr_check_array_size(ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
363 $self->defer_deindent;
364 $self->defer("}");
367 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
368 $self->defer("if ($var_name) {");
369 $self->defer_indent;
370 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
371 check_null_pointer($e, $env, sub { $self->defer(shift); },
372 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
373 check_fully_dereferenced($e, $env));
374 $self->defer("NDR_CHECK(ndr_check_array_length(ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
375 $self->defer_deindent;
376 $self->defer("}");
379 if (not $l->{IS_FIXED} and not is_charset_array($e, $l)) {
380 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$size);
383 return $length;
386 sub compression_alg($$)
388 my ($e, $l) = @_;
389 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
391 return $alg;
394 sub compression_clen($$$)
396 my ($e, $l, $env) = @_;
397 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
399 return ParseExpr($clen, $env, $e->{ORIGINAL});
402 sub compression_dlen($$$)
404 my ($e,$l,$env) = @_;
405 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
407 return ParseExpr($dlen, $env, $e->{ORIGINAL});
410 sub ParseCompressionPushStart($$$$$)
412 my ($self,$e,$l,$ndr,$env) = @_;
413 my $comndr = "$ndr\_compressed";
414 my $alg = compression_alg($e, $l);
415 my $dlen = compression_dlen($e, $l, $env);
417 $self->pidl("{");
418 $self->indent;
419 $self->pidl("struct ndr_push *$comndr;");
420 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
422 return $comndr;
425 sub ParseCompressionPushEnd($$$$$)
427 my ($self,$e,$l,$ndr,$env) = @_;
428 my $comndr = "$ndr\_compressed";
429 my $alg = compression_alg($e, $l);
430 my $dlen = compression_dlen($e, $l, $env);
432 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
433 $self->deindent;
434 $self->pidl("}");
437 sub ParseCompressionPullStart($$$$$)
439 my ($self,$e,$l,$ndr,$env) = @_;
440 my $comndr = "$ndr\_compressed";
441 my $alg = compression_alg($e, $l);
442 my $dlen = compression_dlen($e, $l, $env);
444 $self->pidl("{");
445 $self->indent;
446 $self->pidl("struct ndr_pull *$comndr;");
447 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
449 return $comndr;
452 sub ParseCompressionPullEnd($$$$$)
454 my ($self,$e,$l,$ndr,$env) = @_;
455 my $comndr = "$ndr\_compressed";
456 my $alg = compression_alg($e, $l);
457 my $dlen = compression_dlen($e, $l, $env);
459 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
460 $self->deindent;
461 $self->pidl("}");
464 sub ParseSubcontextPushStart($$$$$)
466 my ($self,$e,$l,$ndr,$env) = @_;
467 my $subndr = "_ndr_$e->{NAME}";
468 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
470 $self->pidl("{");
471 $self->indent;
472 $self->pidl("struct ndr_push *$subndr;");
473 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
475 if (defined $l->{COMPRESSION}) {
476 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
479 return $subndr;
482 sub ParseSubcontextPushEnd($$$$$)
484 my ($self,$e,$l,$ndr,$env) = @_;
485 my $subndr = "_ndr_$e->{NAME}";
486 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
488 if (defined $l->{COMPRESSION}) {
489 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
492 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
493 $self->deindent;
494 $self->pidl("}");
497 sub ParseSubcontextPullStart($$$$$)
499 my ($self,$e,$l,$ndr,$env) = @_;
500 my $subndr = "_ndr_$e->{NAME}";
501 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
503 $self->pidl("{");
504 $self->indent;
505 $self->pidl("struct ndr_pull *$subndr;");
506 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
508 if (defined $l->{COMPRESSION}) {
509 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
512 return $subndr;
515 sub ParseSubcontextPullEnd($$$$$)
517 my ($self,$e,$l,$ndr,$env) = @_;
518 my $subndr = "_ndr_$e->{NAME}";
519 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
521 if (defined $l->{COMPRESSION}) {
522 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
525 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
526 $self->deindent;
527 $self->pidl("}");
530 sub ParseElementPushLevel
532 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
534 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
536 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
537 $var_name = get_pointer_to($var_name);
540 if (defined($ndr_flags)) {
541 if ($l->{TYPE} eq "SUBCONTEXT") {
542 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
543 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
544 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
545 } elsif ($l->{TYPE} eq "POINTER") {
546 $self->ParsePtrPush($e, $l, $var_name);
547 } elsif ($l->{TYPE} eq "ARRAY") {
548 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
550 my $nl = GetNextLevel($e, $l);
552 # Allow speedups for arrays of scalar types
553 if (is_charset_array($e,$l)) {
554 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
555 return;
556 } elsif (has_fast_array($e,$l)) {
557 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
558 return;
560 } elsif ($l->{TYPE} eq "SWITCH") {
561 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
562 } elsif ($l->{TYPE} eq "DATA") {
563 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
567 if ($l->{TYPE} eq "POINTER" and $deferred) {
568 if ($l->{POINTER_TYPE} ne "ref") {
569 $self->pidl("if ($var_name) {");
570 $self->indent;
571 if ($l->{POINTER_TYPE} eq "relative") {
572 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_name));");
575 $var_name = get_value_of($var_name);
576 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
578 if ($l->{POINTER_TYPE} ne "ref") {
579 $self->deindent;
580 $self->pidl("}");
582 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
583 not is_charset_array($e, $l)) {
584 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
585 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
587 $var_name = get_array_element($var_name, $counter);
589 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
590 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
591 $self->indent;
592 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
593 $self->deindent;
594 $self->pidl("}");
597 if ($deferred and ContainsDeferred($e, $l)) {
598 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
599 $self->indent;
600 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
601 $self->deindent;
602 $self->pidl("}");
604 } elsif ($l->{TYPE} eq "SWITCH") {
605 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
609 #####################################################################
610 # parse scalars in a structure element
611 sub ParseElementPush($$$$$$)
613 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
614 my $subndr = undef;
616 my $var_name = $env->{$e->{NAME}};
618 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
620 # Representation type is different from transmit_as
621 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
622 $self->pidl("{");
623 $self->indent;
624 my $transmit_name = "_transmit_$e->{NAME}";
625 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
626 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
627 $var_name = $transmit_name;
630 $var_name = append_prefix($e, $var_name);
632 $self->start_flags($e);
634 if (defined(my $value = has_property($e, "value"))) {
635 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
638 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
640 $self->end_flags($e);
642 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
643 $self->deindent;
644 $self->pidl("}");
648 #####################################################################
649 # parse a pointer in a struct element or function
650 sub ParsePtrPush($$$$)
652 my ($self,$e,$l,$var_name) = @_;
654 if ($l->{POINTER_TYPE} eq "ref") {
655 $self->pidl("if ($var_name == NULL) {");
656 $self->indent;
657 $self->pidl("return ndr_push_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
658 $self->deindent;
659 $self->pidl("}");
660 if ($l->{LEVEL} eq "EMBEDDED") {
661 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
663 } elsif ($l->{POINTER_TYPE} eq "relative") {
664 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_name));");
665 } elsif ($l->{POINTER_TYPE} eq "unique") {
666 $self->pidl("NDR_CHECK(ndr_push_unique_ptr(ndr, $var_name));");
667 } elsif ($l->{POINTER_TYPE} eq "full") {
668 $self->pidl("NDR_CHECK(ndr_push_full_ptr(ndr, $var_name));");
669 } else {
670 die("Unhandled pointer type $l->{POINTER_TYPE}");
674 sub need_pointer_to($$$)
676 my ($e, $l, $scalar_only) = @_;
678 my $t;
679 if (ref($l->{DATA_TYPE})) {
680 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
681 } else {
682 $t = $l->{DATA_TYPE};
685 if (not Parse::Pidl::Typelist::is_scalar($t)) {
686 return 1 if $scalar_only;
689 my $arrays = 0;
691 foreach my $tl (@{$e->{LEVELS}}) {
692 last if $l == $tl;
693 if ($tl->{TYPE} eq "ARRAY") {
694 $arrays++;
698 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
699 return 1 unless $arrays;
702 return 0;
705 sub ParseDataPrint($$$$)
707 my ($self, $e, $l, $var_name) = @_;
709 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
711 if (need_pointer_to($e, $l, 1)) {
712 $var_name = get_pointer_to($var_name);
715 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."(ndr, \"$e->{NAME}\", $var_name);");
716 } else {
717 $self->ParseTypePrint($l->{DATA_TYPE}, $var_name);
721 #####################################################################
722 # print scalars in a structure element
723 sub ParseElementPrint($$$$)
725 my($self, $e, $var_name, $env) = @_;
727 return if (has_property($e, "noprint"));
729 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
730 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}(ndr, \"$e->{NAME}\", $var_name);");
731 return;
734 $var_name = append_prefix($e, $var_name);
736 if (defined(my $value = has_property($e, "value"))) {
737 $var_name = "(ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
740 foreach my $l (@{$e->{LEVELS}}) {
741 if ($l->{TYPE} eq "POINTER") {
742 $self->pidl("ndr_print_ptr(ndr, \"$e->{NAME}\", $var_name);");
743 $self->pidl("ndr->depth++;");
744 if ($l->{POINTER_TYPE} ne "ref") {
745 $self->pidl("if ($var_name) {");
746 $self->indent;
748 $var_name = get_value_of($var_name);
749 } elsif ($l->{TYPE} eq "ARRAY") {
750 my $length;
752 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
753 $var_name = get_pointer_to($var_name);
756 if ($l->{IS_ZERO_TERMINATED}) {
757 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
758 } else {
759 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
760 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
763 if (is_charset_array($e,$l)) {
764 $self->pidl("ndr_print_string(ndr, \"$e->{NAME}\", $var_name);");
765 last;
766 } elsif (has_fast_array($e, $l)) {
767 my $nl = GetNextLevel($e, $l);
768 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name, $length);");
769 last;
770 } else {
771 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
773 $self->pidl("ndr->print(ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", $length);");
774 $self->pidl("ndr->depth++;");
775 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
776 $self->indent;
777 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
778 $self->pidl("if (asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter) != -1) {");
779 $self->indent;
781 $var_name = get_array_element($var_name, $counter);
783 } elsif ($l->{TYPE} eq "DATA") {
784 $self->ParseDataPrint($e, $l, $var_name);
785 } elsif ($l->{TYPE} eq "SWITCH") {
786 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
787 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
788 $self->pidl("ndr_print_set_switch_value(ndr, " . get_pointer_to($var_name) . ", $switch_var);");
792 foreach my $l (reverse @{$e->{LEVELS}}) {
793 if ($l->{TYPE} eq "POINTER") {
794 if ($l->{POINTER_TYPE} ne "ref") {
795 $self->deindent;
796 $self->pidl("}");
798 $self->pidl("ndr->depth--;");
799 } elsif (($l->{TYPE} eq "ARRAY")
800 and not is_charset_array($e,$l)
801 and not has_fast_array($e,$l)) {
802 $self->pidl("free(idx_$l->{LEVEL_INDEX});");
803 $self->deindent;
804 $self->pidl("}");
805 $self->deindent;
806 $self->pidl("}");
807 $self->pidl("ndr->depth--;");
812 #####################################################################
813 # parse scalars in a structure element - pull size
814 sub ParseSwitchPull($$$$$$)
816 my($self,$e,$l,$ndr,$var_name,$env) = @_;
817 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
818 check_null_pointer($e, $env, sub { $self->pidl(shift); },
819 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
820 check_fully_dereferenced($e, $env));
822 $var_name = get_pointer_to($var_name);
823 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
826 #####################################################################
827 # push switch element
828 sub ParseSwitchPush($$$$$$)
830 my($self,$e,$l,$ndr,$var_name,$env) = @_;
831 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
832 check_null_pointer($e, $env, sub { $self->pidl(shift); },
833 "return ndr_push_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
834 check_fully_dereferenced($e, $env));
836 $var_name = get_pointer_to($var_name);
837 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
840 sub ParseDataPull($$$$$$$)
842 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
844 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
846 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
848 if (need_pointer_to($e, $l, 0)) {
849 $var_name = get_pointer_to($var_name);
852 $var_name = get_pointer_to($var_name);
854 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
856 if (my $range = has_property($e, "range")) {
857 $var_name = get_value_of($var_name);
858 my ($low, $high) = split(/,/, $range, 2);
859 $self->pidl("if ($var_name < $low || $var_name > $high) {");
860 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
861 $self->pidl("}");
863 } else {
864 $self->ParseTypePull($l->{DATA_TYPE}, $var_name, $primitives, $deferred);
868 sub ParseDataPush($$$$$$$)
870 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
872 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
874 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
876 # strings are passed by value rather than reference
877 if (need_pointer_to($e, $l, 1)) {
878 $var_name = get_pointer_to($var_name);
881 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
882 } else {
883 $self->ParseTypePush($l->{DATA_TYPE}, $var_name, $primitives, $deferred);
887 sub CalcNdrFlags($$$)
889 my ($l,$primitives,$deferred) = @_;
891 my $scalars = 0;
892 my $buffers = 0;
894 # Add NDR_SCALARS if this one is deferred
895 # and deferreds may be pushed
896 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
898 # Add NDR_SCALARS if this one is not deferred and
899 # primitives may be pushed
900 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
902 # Add NDR_BUFFERS if this one contains deferred stuff
903 # and deferreds may be pushed
904 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
906 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
907 return "NDR_SCALARS" if ($scalars);
908 return "NDR_BUFFERS" if ($buffers);
909 return undef;
912 sub ParseMemCtxPullFlags($$$$)
914 my ($self, $e, $l) = @_;
916 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
918 return undef if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
919 return undef if has_fast_array($e, $l);
920 return undef if is_charset_array($e, $l);
922 my $mem_flags = "0";
924 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
925 my $nl = GetNextLevel($e, $l);
926 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
927 my $next_is_string = (($nl->{TYPE} eq "DATA") and
928 ($nl->{DATA_TYPE} eq "string"));
929 if ($next_is_array or $next_is_string) {
930 return undef;
931 } elsif ($l->{LEVEL} eq "TOP") {
932 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
936 return $mem_flags;
939 sub ParseMemCtxPullStart($$$$)
941 my ($self, $e, $l, $ptr_name) = @_;
943 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
944 my $mem_c_ctx = $ptr_name;
945 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
947 return unless defined($mem_c_flags);
949 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX(ndr);");
950 $self->pidl("NDR_PULL_SET_MEM_CTX(ndr, $mem_c_ctx, $mem_c_flags);");
953 sub ParseMemCtxPullEnd($$$)
955 my ($self, $e, $l) = @_;
957 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
958 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
960 return unless defined($mem_r_flags);
962 $self->pidl("NDR_PULL_SET_MEM_CTX(ndr, $mem_r_ctx, $mem_r_flags);");
965 sub CheckStringTerminator($$$$$)
967 my ($self,$ndr,$e,$l,$length) = @_;
968 my $nl = GetNextLevel($e, $l);
970 # Make sure last element is zero!
971 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
974 sub ParseElementPullLevel
976 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
978 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
980 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
981 $var_name = get_pointer_to($var_name);
984 # Only pull something if there's actually something to be pulled
985 if (defined($ndr_flags)) {
986 if ($l->{TYPE} eq "SUBCONTEXT") {
987 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
988 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
989 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
990 } elsif ($l->{TYPE} eq "ARRAY") {
991 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
993 my $nl = GetNextLevel($e, $l);
995 if (is_charset_array($e,$l)) {
996 if ($l->{IS_ZERO_TERMINATED}) {
997 $self->CheckStringTerminator($ndr, $e, $l, $length);
999 $self->pidl("NDR_CHECK(ndr_pull_charset($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
1000 return;
1001 } elsif (has_fast_array($e, $l)) {
1002 if ($l->{IS_ZERO_TERMINATED}) {
1003 $self->CheckStringTerminator($ndr,$e,$l,$length);
1005 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1006 return;
1008 } elsif ($l->{TYPE} eq "POINTER") {
1009 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1010 } elsif ($l->{TYPE} eq "SWITCH") {
1011 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1012 } elsif ($l->{TYPE} eq "DATA") {
1013 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1017 # add additional constructions
1018 if ($l->{TYPE} eq "POINTER" and $deferred) {
1019 if ($l->{POINTER_TYPE} ne "ref") {
1020 $self->pidl("if ($var_name) {");
1021 $self->indent;
1023 if ($l->{POINTER_TYPE} eq "relative") {
1024 $self->pidl("uint32_t _relative_save_offset;");
1025 $self->pidl("_relative_save_offset = ndr->offset;");
1026 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_name));");
1030 $self->ParseMemCtxPullStart($e, $l, $var_name);
1032 $var_name = get_value_of($var_name);
1033 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1035 $self->ParseMemCtxPullEnd($e,$l);
1037 if ($l->{POINTER_TYPE} ne "ref") {
1038 if ($l->{POINTER_TYPE} eq "relative") {
1039 $self->pidl("ndr->offset = _relative_save_offset;");
1041 $self->deindent;
1042 $self->pidl("}");
1044 } elsif ($l->{TYPE} eq "ARRAY" and
1045 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1046 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1047 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1048 my $array_name = $var_name;
1050 $var_name = get_array_element($var_name, $counter);
1052 $self->ParseMemCtxPullStart($e, $l, $array_name);
1054 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1055 my $nl = GetNextLevel($e,$l);
1057 if ($l->{IS_ZERO_TERMINATED}) {
1058 $self->CheckStringTerminator($ndr,$e,$l,$length);
1061 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1062 $self->indent;
1063 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1064 $self->deindent;
1065 $self->pidl("}");
1068 if ($deferred and ContainsDeferred($e, $l)) {
1069 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1070 $self->indent;
1071 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1072 $self->deindent;
1073 $self->pidl("}");
1076 $self->ParseMemCtxPullEnd($e, $l);
1078 } elsif ($l->{TYPE} eq "SWITCH") {
1079 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1083 #####################################################################
1084 # parse scalars in a structure element - pull size
1085 sub ParseElementPull($$$$$$)
1087 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1089 my $var_name = $env->{$e->{NAME}};
1090 my $represent_name;
1091 my $transmit_name;
1093 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1095 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1096 $self->pidl("{");
1097 $self->indent;
1098 $represent_name = $var_name;
1099 $transmit_name = "_transmit_$e->{NAME}";
1100 $var_name = $transmit_name;
1101 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1104 $var_name = append_prefix($e, $var_name);
1106 $self->start_flags($e);
1108 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1110 $self->end_flags($e);
1112 # Representation type is different from transmit_as
1113 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1114 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1115 $self->deindent;
1116 $self->pidl("}");
1120 #####################################################################
1121 # parse a pointer in a struct element or function
1122 sub ParsePtrPull($$$$$)
1124 my($self, $e,$l,$ndr,$var_name) = @_;
1126 my $nl = GetNextLevel($e, $l);
1127 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1128 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1129 ($nl->{DATA_TYPE} eq "string"));
1131 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1133 if (!$next_is_array and !$next_is_string) {
1134 $self->pidl("if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1135 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1136 $self->pidl("}");
1139 return;
1140 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1141 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1142 } elsif (($l->{POINTER_TYPE} eq "unique") or
1143 ($l->{POINTER_TYPE} eq "relative") or
1144 ($l->{POINTER_TYPE} eq "full")) {
1145 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1146 } else {
1147 die("Unhandled pointer type $l->{POINTER_TYPE}");
1150 $self->pidl("if (_ptr_$e->{NAME}) {");
1151 $self->indent;
1153 # Don't do this for arrays, they're allocated at the actual level
1154 # of the array
1155 unless ($next_is_array or $next_is_string) {
1156 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1157 } else {
1158 # FIXME: Yes, this is nasty.
1159 # We allocate an array twice
1160 # - once just to indicate that it's there,
1161 # - then the real allocation...
1162 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1165 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1166 if ($l->{POINTER_TYPE} eq "relative") {
1167 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1169 $self->deindent;
1170 $self->pidl("} else {");
1171 $self->pidl("\t$var_name = NULL;");
1172 $self->pidl("}");
1175 sub ParseStructPushPrimitives($$$$)
1177 my ($self, $struct, $varname, $env) = @_;
1179 # see if the structure contains a conformant array. If it
1180 # does, then it must be the last element of the structure, and
1181 # we need to push the conformant length early, as it fits on
1182 # the wire before the structure (and even before the structure
1183 # alignment)
1184 if (defined($struct->{SURROUNDING_ELEMENT})) {
1185 my $e = $struct->{SURROUNDING_ELEMENT};
1187 if (defined($e->{LEVELS}[0]) and
1188 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1189 my $size;
1191 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1192 if (has_property($e, "charset")) {
1193 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1194 } else {
1195 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1197 } else {
1198 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1201 $self->pidl("NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));");
1202 } else {
1203 $self->pidl("NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, $varname->$e->{NAME})));");
1207 $self->pidl("NDR_CHECK(ndr_push_align(ndr, $struct->{ALIGN}));");
1209 if (defined($struct->{PROPERTIES}{relative_base})) {
1210 # set the current offset as base for relative pointers
1211 # and store it based on the toplevel struct/union
1212 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1215 $self->ParseElementPush($_, "ndr", $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1218 sub ParseStructPushDeferred($$$)
1220 my ($self, $struct, $varname, $env) = @_;
1221 if (defined($struct->{PROPERTIES}{relative_base})) {
1222 # retrieve the current offset as base for relative pointers
1223 # based on the toplevel struct/union
1224 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, $varname));");
1226 $self->ParseElementPush($_, "ndr", $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1229 #####################################################################
1230 # parse a struct
1231 sub ParseStructPush($$$)
1233 my ($self, $struct, $varname) = @_;
1235 return unless defined($struct->{ELEMENTS});
1237 my $env = GenerateStructEnv($struct, $varname);
1239 EnvSubstituteValue($env, $struct);
1241 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1243 $self->start_flags($struct);
1245 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1246 $self->indent;
1247 $self->ParseStructPushPrimitives($struct, $varname, $env);
1248 $self->deindent;
1249 $self->pidl("}");
1251 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1252 $self->indent;
1253 $self->ParseStructPushDeferred($struct, $varname, $env);
1254 $self->deindent;
1255 $self->pidl("}");
1257 $self->end_flags($struct);
1260 #####################################################################
1261 # generate a push function for an enum
1262 sub ParseEnumPush($$$)
1264 my($self,$enum,$varname) = @_;
1265 my($type_fn) = $enum->{BASE_TYPE};
1267 $self->start_flags($enum);
1268 $self->pidl("NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, $varname));");
1269 $self->end_flags($enum);
1272 #####################################################################
1273 # generate a pull function for an enum
1274 sub ParseEnumPull($$$)
1276 my($self,$enum,$varname) = @_;
1277 my($type_fn) = $enum->{BASE_TYPE};
1278 my($type_v_decl) = mapTypeName($type_fn);
1280 $self->pidl("$type_v_decl v;");
1281 $self->start_flags($enum);
1282 $self->pidl("NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));");
1283 $self->pidl("*$varname = v;");
1285 $self->end_flags($enum);
1288 #####################################################################
1289 # generate a print function for an enum
1290 sub ParseEnumPrint($$$$)
1292 my($self,$enum,$name,$varname) = @_;
1294 $self->pidl("const char *val = NULL;");
1295 $self->pidl("");
1297 $self->start_flags($enum);
1299 $self->pidl("switch ($varname) {");
1300 $self->indent;
1301 my $els = \@{$enum->{ELEMENTS}};
1302 foreach my $i (0 .. $#{$els}) {
1303 my $e = ${$els}[$i];
1304 chomp $e;
1305 if ($e =~ /^(.*)=/) {
1306 $e = $1;
1308 $self->pidl("case $e: val = \"$e\"; break;");
1311 $self->deindent;
1312 $self->pidl("}");
1314 $self->pidl("ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, $varname);");
1316 $self->end_flags($enum);
1319 sub DeclEnum($$$$)
1321 my ($e,$t,$name,$varname) = @_;
1322 return "enum $name " .
1323 ($t eq "pull"?"*":"") . $varname;
1326 $typefamily{ENUM} = {
1327 DECL => \&DeclEnum,
1328 PUSH_FN_BODY => \&ParseEnumPush,
1329 PULL_FN_BODY => \&ParseEnumPull,
1330 PRINT_FN_BODY => \&ParseEnumPrint,
1333 #####################################################################
1334 # generate a push function for a bitmap
1335 sub ParseBitmapPush($$$)
1337 my($self,$bitmap,$varname) = @_;
1338 my($type_fn) = $bitmap->{BASE_TYPE};
1340 $self->start_flags($bitmap);
1342 $self->pidl("NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, $varname));");
1344 $self->end_flags($bitmap);
1347 #####################################################################
1348 # generate a pull function for an bitmap
1349 sub ParseBitmapPull($$$)
1351 my($self,$bitmap,$varname) = @_;
1352 my $type_fn = $bitmap->{BASE_TYPE};
1353 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1355 $self->pidl("$type_decl v;");
1356 $self->start_flags($bitmap);
1357 $self->pidl("NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));");
1358 $self->pidl("*$varname = v;");
1360 $self->end_flags($bitmap);
1363 #####################################################################
1364 # generate a print function for an bitmap
1365 sub ParseBitmapPrintElement($$$$$)
1367 my($self,$e,$bitmap,$name,$varname) = @_;
1368 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1369 my($type_fn) = $bitmap->{BASE_TYPE};
1370 my($flag);
1372 if ($e =~ /^(\w+) .*$/) {
1373 $flag = "$1";
1374 } else {
1375 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1378 $self->pidl("ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1381 #####################################################################
1382 # generate a print function for an bitmap
1383 sub ParseBitmapPrint($$$$)
1385 my($self,$bitmap,$name,$varname) = @_;
1386 my($type_decl) = mapTypeName($bitmap->{TYPE});
1387 my($type_fn) = $bitmap->{BASE_TYPE};
1389 $self->start_flags($bitmap);
1391 $self->pidl("ndr_print_$type_fn(ndr, name, $varname);");
1393 $self->pidl("ndr->depth++;");
1394 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1395 $self->ParseBitmapPrintElement($e, $bitmap, $name, $varname);
1397 $self->pidl("ndr->depth--;");
1399 $self->end_flags($bitmap);
1402 sub DeclBitmap($$$$)
1404 my ($e,$t,$name,$varname) = @_;
1405 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1406 ($t eq "pull"?" *":" ") . $varname;
1409 $typefamily{BITMAP} = {
1410 DECL => \&DeclBitmap,
1411 PUSH_FN_BODY => \&ParseBitmapPush,
1412 PULL_FN_BODY => \&ParseBitmapPull,
1413 PRINT_FN_BODY => \&ParseBitmapPrint,
1416 #####################################################################
1417 # generate a struct print function
1418 sub ParseStructPrint($$$$)
1420 my($self,$struct,$name,$varname) = @_;
1422 return unless defined $struct->{ELEMENTS};
1424 my $env = GenerateStructEnv($struct, $varname);
1426 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1428 $self->pidl("ndr_print_struct(ndr, name, \"$name\");");
1430 $self->start_flags($struct);
1432 $self->pidl("ndr->depth++;");
1434 $self->ParseElementPrint($_, $env->{$_->{NAME}}, $env)
1435 foreach (@{$struct->{ELEMENTS}});
1436 $self->pidl("ndr->depth--;");
1438 $self->end_flags($struct);
1441 sub DeclarePtrVariables($$)
1443 my ($self,$e) = @_;
1444 foreach my $l (@{$e->{LEVELS}}) {
1445 if ($l->{TYPE} eq "POINTER" and
1446 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1447 $self->pidl("uint32_t _ptr_$e->{NAME};");
1448 last;
1453 sub DeclareArrayVariables($$)
1455 my ($self,$e) = @_;
1457 foreach my $l (@{$e->{LEVELS}}) {
1458 next if has_fast_array($e,$l);
1459 next if is_charset_array($e,$l);
1460 if ($l->{TYPE} eq "ARRAY") {
1461 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1466 sub DeclareMemCtxVariables($$)
1468 my ($self,$e) = @_;
1469 foreach my $l (@{$e->{LEVELS}}) {
1470 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1471 if (defined($mem_flags)) {
1472 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1477 sub ParseStructPullPrimitives($$$$)
1479 my($self,$struct,$varname,$env) = @_;
1481 if (defined $struct->{SURROUNDING_ELEMENT}) {
1482 $self->pidl("NDR_CHECK(ndr_pull_array_size(ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1485 $self->pidl("NDR_CHECK(ndr_pull_align(ndr, $struct->{ALIGN}));");
1487 if (defined($struct->{PROPERTIES}{relative_base})) {
1488 # set the current offset as base for relative pointers
1489 # and store it based on the toplevel struct/union
1490 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1493 $self->ParseElementPull($_, "ndr", $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1495 $self->add_deferred();
1498 sub ParseStructPullDeferred($$$$)
1500 my ($self,$struct,$varname,$env) = @_;
1502 if (defined($struct->{PROPERTIES}{relative_base})) {
1503 # retrieve the current offset as base for relative pointers
1504 # based on the toplevel struct/union
1505 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, $varname));");
1507 foreach my $e (@{$struct->{ELEMENTS}}) {
1508 $self->ParseElementPull($e, "ndr", $env, 0, 1);
1511 $self->add_deferred();
1514 #####################################################################
1515 # parse a struct - pull side
1516 sub ParseStructPull($$$)
1518 my($self,$struct,$varname) = @_;
1520 return unless defined $struct->{ELEMENTS};
1522 # declare any internal pointers we need
1523 foreach my $e (@{$struct->{ELEMENTS}}) {
1524 $self->DeclarePtrVariables($e);
1525 $self->DeclareArrayVariables($e);
1526 $self->DeclareMemCtxVariables($e);
1529 $self->start_flags($struct);
1531 my $env = GenerateStructEnv($struct, $varname);
1533 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1534 $self->indent;
1535 $self->ParseStructPullPrimitives($struct,$varname,$env);
1536 $self->deindent;
1537 $self->pidl("}");
1538 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1539 $self->indent;
1540 $self->ParseStructPullDeferred($struct,$varname,$env);
1541 $self->deindent;
1542 $self->pidl("}");
1544 $self->end_flags($struct);
1547 #####################################################################
1548 # calculate size of ndr struct
1549 sub ParseStructNdrSize($$$$)
1551 my ($self,$t, $name, $varname) = @_;
1552 my $sizevar;
1554 if (my $flags = has_property($t, "flag")) {
1555 $self->pidl("flags |= $flags;");
1557 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1560 sub DeclStruct($$$$)
1562 my ($e,$t,$name,$varname) = @_;
1563 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1566 sub ArgsStructNdrSize($$$)
1568 my ($d, $name, $varname) = @_;
1569 return "const struct $name *$varname, int flags";
1572 $typefamily{STRUCT} = {
1573 PUSH_FN_BODY => \&ParseStructPush,
1574 DECL => \&DeclStruct,
1575 PULL_FN_BODY => \&ParseStructPull,
1576 PRINT_FN_BODY => \&ParseStructPrint,
1577 SIZE_FN_BODY => \&ParseStructNdrSize,
1578 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1581 #####################################################################
1582 # calculate size of ndr struct
1583 sub ParseUnionNdrSize($$$)
1585 my ($self, $t, $name, $varname) = @_;
1586 my $sizevar;
1588 if (my $flags = has_property($t, "flag")) {
1589 $self->pidl("flags |= $flags;");
1592 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1595 sub ParseUnionPushPrimitives($$$)
1597 my ($self, $e, $varname) = @_;
1599 my $have_default = 0;
1601 $self->pidl("int level = ndr_push_get_switch_value(ndr, $varname);");
1603 if (defined($e->{SWITCH_TYPE})) {
1604 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}(ndr, NDR_SCALARS, level));");
1607 $self->pidl("switch (level) {");
1608 $self->indent;
1609 foreach my $el (@{$e->{ELEMENTS}}) {
1610 if ($el->{CASE} eq "default") {
1611 $have_default = 1;
1613 $self->pidl("$el->{CASE}: {");
1615 if ($el->{TYPE} ne "EMPTY") {
1616 $self->indent;
1617 if (defined($e->{PROPERTIES}{relative_base})) {
1618 $self->pidl("NDR_CHECK(ndr_push_align(ndr, $el->{ALIGN}));");
1619 # set the current offset as base for relative pointers
1620 # and store it based on the toplevel struct/union
1621 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1623 $self->DeclareArrayVariables($el);
1624 $self->ParseElementPush($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1625 $self->deindent;
1627 $self->pidl("break; }");
1628 $self->pidl("");
1630 if (! $have_default) {
1631 $self->pidl("default:");
1632 $self->pidl("\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1634 $self->deindent;
1635 $self->pidl("}");
1638 sub ParseUnionPushDeferred($$$)
1640 my ($self,$e,$varname) = @_;
1642 my $have_default = 0;
1644 $self->pidl("int level = ndr_push_get_switch_value(ndr, $varname);");
1645 if (defined($e->{PROPERTIES}{relative_base})) {
1646 # retrieve the current offset as base for relative pointers
1647 # based on the toplevel struct/union
1648 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, $varname));");
1650 $self->pidl("switch (level) {");
1651 $self->indent;
1652 foreach my $el (@{$e->{ELEMENTS}}) {
1653 if ($el->{CASE} eq "default") {
1654 $have_default = 1;
1657 $self->pidl("$el->{CASE}:");
1658 if ($el->{TYPE} ne "EMPTY") {
1659 $self->indent;
1660 $self->ParseElementPush($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1661 $self->deindent;
1663 $self->pidl("break;");
1664 $self->pidl("");
1666 if (! $have_default) {
1667 $self->pidl("default:");
1668 $self->pidl("\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1670 $self->deindent;
1671 $self->pidl("}");
1674 #####################################################################
1675 # parse a union - push side
1676 sub ParseUnionPush($$$)
1678 my ($self,$e,$varname) = @_;
1679 my $have_default = 0;
1681 $self->start_flags($e);
1683 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1684 $self->indent;
1685 $self->ParseUnionPushPrimitives($e, $varname);
1686 $self->deindent;
1687 $self->pidl("}");
1688 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1689 $self->indent;
1690 $self->ParseUnionPushDeferred($e, $varname);
1691 $self->deindent;
1692 $self->pidl("}");
1693 $self->end_flags($e);
1696 #####################################################################
1697 # print a union
1698 sub ParseUnionPrint($$$$)
1700 my ($self,$e,$name,$varname) = @_;
1701 my $have_default = 0;
1703 $self->pidl("int level;");
1704 foreach my $el (@{$e->{ELEMENTS}}) {
1705 $self->DeclareArrayVariables($el);
1708 $self->start_flags($e);
1710 $self->pidl("level = ndr_print_get_switch_value(ndr, $varname);");
1712 $self->pidl("ndr_print_union(ndr, name, level, \"$name\");");
1714 $self->pidl("switch (level) {");
1715 $self->indent;
1716 foreach my $el (@{$e->{ELEMENTS}}) {
1717 if ($el->{CASE} eq "default") {
1718 $have_default = 1;
1720 $self->pidl("$el->{CASE}:");
1721 if ($el->{TYPE} ne "EMPTY") {
1722 $self->indent;
1723 $self->ParseElementPrint($el, "$varname->$el->{NAME}", {});
1724 $self->deindent;
1726 $self->pidl("break;");
1727 $self->pidl("");
1729 if (! $have_default) {
1730 $self->pidl("default:");
1731 $self->pidl("\tndr_print_bad_level(ndr, name, level);");
1733 $self->deindent;
1734 $self->pidl("}");
1736 $self->end_flags($e);
1739 sub ParseUnionPullPrimitives($$$$)
1741 my ($self,$e,$varname,$switch_type) = @_;
1742 my $have_default = 0;
1744 if (defined($switch_type)) {
1745 $self->pidl("NDR_CHECK(ndr_pull_$switch_type(ndr, NDR_SCALARS, &_level));");
1746 $self->pidl("if (_level != level) {");
1747 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname\", _level);");
1748 $self->pidl("}");
1751 $self->pidl("switch (level) {");
1752 $self->indent;
1753 foreach my $el (@{$e->{ELEMENTS}}) {
1754 if ($el->{CASE} eq "default") {
1755 $have_default = 1;
1757 $self->pidl("$el->{CASE}: {");
1759 if ($el->{TYPE} ne "EMPTY") {
1760 $self->indent;
1761 $self->DeclarePtrVariables($el);
1762 $self->DeclareArrayVariables($el);
1763 if (defined($e->{PROPERTIES}{relative_base})) {
1764 $self->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 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1769 $self->ParseElementPull($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1770 $self->deindent;
1772 $self->pidl("break; }");
1773 $self->pidl("");
1775 if (! $have_default) {
1776 $self->pidl("default:");
1777 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1779 $self->deindent;
1780 $self->pidl("}");
1783 sub ParseUnionPullDeferred($$$)
1785 my ($self,$e,$varname) = @_;
1786 my $have_default = 0;
1788 if (defined($e->{PROPERTIES}{relative_base})) {
1789 # retrieve the current offset as base for relative pointers
1790 # based on the toplevel struct/union
1791 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, $varname));");
1793 $self->pidl("switch (level) {");
1794 $self->indent;
1795 foreach my $el (@{$e->{ELEMENTS}}) {
1796 if ($el->{CASE} eq "default") {
1797 $have_default = 1;
1800 $self->pidl("$el->{CASE}:");
1801 if ($el->{TYPE} ne "EMPTY") {
1802 $self->indent;
1803 $self->ParseElementPull($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1804 $self->deindent;
1806 $self->pidl("break;");
1807 $self->pidl("");
1809 if (! $have_default) {
1810 $self->pidl("default:");
1811 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1813 $self->deindent;
1814 $self->pidl("}");
1819 #####################################################################
1820 # parse a union - pull side
1821 sub ParseUnionPull($$$)
1823 my ($self,$e,$varname) = @_;
1824 my $switch_type = $e->{SWITCH_TYPE};
1826 $self->pidl("int level;");
1827 if (defined($switch_type)) {
1828 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1829 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1831 $self->pidl(mapTypeName($switch_type) . " _level;");
1834 my %double_cases = ();
1835 foreach my $el (@{$e->{ELEMENTS}}) {
1836 next if ($el->{TYPE} eq "EMPTY");
1837 next if ($double_cases{"$el->{NAME}"});
1838 $self->DeclareMemCtxVariables($el);
1839 $double_cases{"$el->{NAME}"} = 1;
1842 $self->start_flags($e);
1844 $self->pidl("level = ndr_pull_get_switch_value(ndr, $varname);");
1846 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1847 $self->indent;
1848 $self->ParseUnionPullPrimitives($e,$varname,$switch_type);
1849 $self->deindent;
1850 $self->pidl("}");
1852 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1853 $self->indent;
1854 $self->ParseUnionPullDeferred($e,$varname);
1855 $self->deindent;
1856 $self->pidl("}");
1858 $self->add_deferred();
1860 $self->end_flags($e);
1863 sub DeclUnion($$$$)
1865 my ($e,$t,$name,$varname) = @_;
1866 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1869 sub ArgsUnionNdrSize($$)
1871 my ($d,$name) = @_;
1872 return "const union $name *r, uint32_t level, int flags";
1875 $typefamily{UNION} = {
1876 PUSH_FN_BODY => \&ParseUnionPush,
1877 DECL => \&DeclUnion,
1878 PULL_FN_BODY => \&ParseUnionPull,
1879 PRINT_FN_BODY => \&ParseUnionPrint,
1880 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1881 SIZE_FN_BODY => \&ParseUnionNdrSize,
1884 #####################################################################
1885 # parse a typedef - push side
1886 sub ParseTypedefPush($$$)
1888 my($self,$e,$varname) = @_;
1890 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $varname);
1893 #####################################################################
1894 # parse a typedef - pull side
1895 sub ParseTypedefPull($$$)
1897 my($self,$e,$varname) = @_;
1899 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $varname);
1902 #####################################################################
1903 # parse a typedef - print side
1904 sub ParseTypedefPrint($$$$)
1906 my($self,$e,$name,$varname) = @_;
1908 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $name, $varname);
1911 #####################################################################
1912 ## calculate the size of a structure
1913 sub ParseTypedefNdrSize($$$$)
1915 my($self,$t,$name,$varname) = @_;
1917 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
1920 sub DeclTypedef($$$$)
1922 my ($e, $t, $name, $varname) = @_;
1924 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
1927 sub ArgsTypedefNdrSize($$$)
1929 my ($d, $name, $varname) = @_;
1930 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
1933 $typefamily{TYPEDEF} = {
1934 PUSH_FN_BODY => \&ParseTypedefPush,
1935 DECL => \&DeclTypedef,
1936 PULL_FN_BODY => \&ParseTypedefPull,
1937 PRINT_FN_BODY => \&ParseTypedefPrint,
1938 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
1939 SIZE_FN_BODY => \&ParseTypedefNdrSize,
1942 #####################################################################
1943 # parse a function - print side
1944 sub ParseFunctionPrint($$)
1946 my($self, $fn) = @_;
1948 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
1950 return if has_property($fn, "noprint");
1952 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
1953 $self->pidl("{");
1954 $self->indent;
1956 foreach my $e (@{$fn->{ELEMENTS}}) {
1957 $self->DeclareArrayVariables($e);
1960 $self->pidl("ndr_print_struct(ndr, name, \"$fn->{NAME}\");");
1961 $self->pidl("ndr->depth++;");
1963 $self->pidl("if (flags & NDR_SET_VALUES) {");
1964 $self->pidl("\tndr->flags |= LIBNDR_PRINT_SET_VALUES;");
1965 $self->pidl("}");
1967 $self->pidl("if (flags & NDR_IN) {");
1968 $self->indent;
1969 $self->pidl("ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");");
1970 $self->pidl("ndr->depth++;");
1972 my $env = GenerateFunctionInEnv($fn);
1974 foreach my $e (@{$fn->{ELEMENTS}}) {
1975 if (grep(/in/,@{$e->{DIRECTION}})) {
1976 $self->ParseElementPrint($e, $env->{$e->{NAME}}, $env);
1979 $self->pidl("ndr->depth--;");
1980 $self->deindent;
1981 $self->pidl("}");
1983 $self->pidl("if (flags & NDR_OUT) {");
1984 $self->indent;
1985 $self->pidl("ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");");
1986 $self->pidl("ndr->depth++;");
1988 $env = GenerateFunctionOutEnv($fn);
1989 foreach my $e (@{$fn->{ELEMENTS}}) {
1990 if (grep(/out/,@{$e->{DIRECTION}})) {
1991 $self->ParseElementPrint($e, $env->{$e->{NAME}}, $env);
1994 if ($fn->{RETURN_TYPE}) {
1995 $self->pidl("ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", r->out.result);");
1997 $self->pidl("ndr->depth--;");
1998 $self->deindent;
1999 $self->pidl("}");
2001 $self->pidl("ndr->depth--;");
2002 $self->deindent;
2003 $self->pidl("}");
2004 $self->pidl("");
2007 #####################################################################
2008 # parse a function
2009 sub ParseFunctionPush($$)
2011 my($self, $fn) = @_;
2013 $self->fn_declare("push", $fn, "enum ndr_err_code ndr_push_$fn->{NAME}(struct ndr_push *ndr, int flags, const struct $fn->{NAME} *r)") or return;
2015 return if has_property($fn, "nopush");
2017 $self->pidl("{");
2018 $self->indent;
2020 foreach my $e (@{$fn->{ELEMENTS}}) {
2021 $self->DeclareArrayVariables($e);
2024 $self->pidl("if (flags & NDR_IN) {");
2025 $self->indent;
2027 my $env = GenerateFunctionInEnv($fn);
2029 EnvSubstituteValue($env, $fn);
2031 foreach my $e (@{$fn->{ELEMENTS}}) {
2032 if (grep(/in/,@{$e->{DIRECTION}})) {
2033 $self->ParseElementPush($e, "ndr", $env, 1, 1);
2037 $self->deindent;
2038 $self->pidl("}");
2040 $self->pidl("if (flags & NDR_OUT) {");
2041 $self->indent;
2043 $env = GenerateFunctionOutEnv($fn);
2044 foreach my $e (@{$fn->{ELEMENTS}}) {
2045 if (grep(/out/,@{$e->{DIRECTION}})) {
2046 $self->ParseElementPush($e, "ndr", $env, 1, 1);
2050 if ($fn->{RETURN_TYPE}) {
2051 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));");
2054 $self->deindent;
2055 $self->pidl("}");
2056 $self->pidl("return NDR_ERR_SUCCESS;");
2057 $self->deindent;
2058 $self->pidl("}");
2059 $self->pidl("");
2062 sub AllocateArrayLevel($$$$$$)
2064 my ($self,$e,$l,$ndr,$var,$size) = @_;
2066 my $pl = GetPrevLevel($e, $l);
2067 if (defined($pl) and
2068 $pl->{TYPE} eq "POINTER" and
2069 $pl->{POINTER_TYPE} eq "ref"
2070 and not $l->{IS_ZERO_TERMINATED}) {
2071 $self->pidl("if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2072 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2073 $self->pidl("}");
2074 if (grep(/in/,@{$e->{DIRECTION}}) and
2075 grep(/out/,@{$e->{DIRECTION}})) {
2076 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2078 return;
2081 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2084 #####################################################################
2085 # parse a function
2086 sub ParseFunctionPull($$)
2088 my($self,$fn) = @_;
2090 # pull function args
2091 $self->fn_declare("pull", $fn, "enum ndr_err_code ndr_pull_$fn->{NAME}(struct ndr_pull *ndr, int flags, struct $fn->{NAME} *r)") or return;
2093 $self->pidl("{");
2094 $self->indent;
2096 # declare any internal pointers we need
2097 foreach my $e (@{$fn->{ELEMENTS}}) {
2098 $self->DeclarePtrVariables($e);
2099 $self->DeclareArrayVariables($e);
2102 my %double_cases = ();
2103 foreach my $e (@{$fn->{ELEMENTS}}) {
2104 next if ($e->{TYPE} eq "EMPTY");
2105 next if ($double_cases{"$e->{NAME}"});
2106 $self->DeclareMemCtxVariables($e);
2107 $double_cases{"$e->{NAME}"} = 1;
2110 $self->pidl("if (flags & NDR_IN) {");
2111 $self->indent;
2113 # auto-init the out section of a structure. I originally argued that
2114 # this was a bad idea as it hides bugs, but coping correctly
2115 # with initialisation and not wiping ref vars is turning
2116 # out to be too tricky (tridge)
2117 foreach my $e (@{$fn->{ELEMENTS}}) {
2118 next unless grep(/out/, @{$e->{DIRECTION}});
2119 $self->pidl("ZERO_STRUCT(r->out);");
2120 $self->pidl("");
2121 last;
2124 my $env = GenerateFunctionInEnv($fn);
2126 foreach my $e (@{$fn->{ELEMENTS}}) {
2127 next unless (grep(/in/, @{$e->{DIRECTION}}));
2128 $self->ParseElementPull($e, "ndr", $env, 1, 1);
2131 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2132 # own flag rather than be in NDR_IN ?
2134 foreach my $e (@{$fn->{ELEMENTS}}) {
2135 next unless (grep(/out/, @{$e->{DIRECTION}}));
2136 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2137 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2138 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2139 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2140 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2141 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2143 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2144 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2145 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2146 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2147 check_fully_dereferenced($e, $env));
2148 $self->pidl("NDR_PULL_ALLOC_N(ndr, r->out.$e->{NAME}, $size);");
2150 if (grep(/in/, @{$e->{DIRECTION}})) {
2151 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2152 } else {
2153 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2155 } else {
2156 $self->pidl("NDR_PULL_ALLOC(ndr, r->out.$e->{NAME});");
2158 if (grep(/in/, @{$e->{DIRECTION}})) {
2159 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2160 } else {
2161 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2166 $self->add_deferred();
2167 $self->deindent;
2168 $self->pidl("}");
2170 $self->pidl("if (flags & NDR_OUT) {");
2171 $self->indent;
2173 $env = GenerateFunctionOutEnv($fn);
2174 foreach my $e (@{$fn->{ELEMENTS}}) {
2175 next unless grep(/out/, @{$e->{DIRECTION}});
2176 $self->ParseElementPull($e, "ndr", $env, 1, 1);
2179 if ($fn->{RETURN_TYPE}) {
2180 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));");
2183 $self->add_deferred();
2184 $self->deindent;
2185 $self->pidl("}");
2187 $self->pidl("return NDR_ERR_SUCCESS;");
2188 $self->deindent;
2189 $self->pidl("}");
2190 $self->pidl("");
2193 sub AuthServiceStruct($$$)
2195 my ($self, $ifacename, $authservice) = @_;
2196 my @a = split /,/, $authservice;
2197 my $authservice_count = $#a + 1;
2199 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2200 foreach my $ap (@a) {
2201 $self->pidl("\t$ap, ");
2203 $self->pidl("};");
2204 $self->pidl("");
2206 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2207 $self->pidl("\t.count\t= $authservice_count,");
2208 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2209 $self->pidl("};");
2210 $self->pidl("");
2213 #####################################################################
2214 # produce a function call table
2215 sub FunctionTable($$)
2217 my($self,$interface) = @_;
2218 my $count = 0;
2219 my $uname = uc $interface->{NAME};
2221 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2222 return unless defined ($interface->{PROPERTIES}->{uuid});
2224 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2225 foreach my $d (@{$interface->{FUNCTIONS}}) {
2226 next if not defined($d->{OPNUM});
2227 $self->pidl("\t{");
2228 $self->pidl("\t\t\"$d->{NAME}\",");
2229 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2230 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2231 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2232 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2233 $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2234 $self->pidl("\t},");
2235 $count++;
2237 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2238 $self->pidl("};");
2239 $self->pidl("");
2241 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2242 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2243 $self->pidl("\t$ep, ");
2245 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2247 $self->pidl("};");
2248 $self->pidl("");
2250 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2251 $self->pidl("\t.count\t= $endpoint_count,");
2252 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2253 $self->pidl("};");
2254 $self->pidl("");
2256 if (! defined $interface->{PROPERTIES}->{authservice}) {
2257 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2260 $self->AuthServiceStruct($interface->{NAME},
2261 $interface->{PROPERTIES}->{authservice});
2263 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2264 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2265 $self->pidl("\t.syntax_id\t= {");
2266 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2267 $self->pidl("\t\tNDR_$uname\_VERSION");
2268 $self->pidl("\t},");
2269 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2270 $self->pidl("\t.num_calls\t= $count,");
2271 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2272 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2273 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2274 $self->pidl("};");
2275 $self->pidl("");
2279 #####################################################################
2280 # generate include statements for imported idl files
2281 sub HeaderImport
2283 my $self = shift;
2284 my @imports = @_;
2285 foreach (@imports) {
2286 s/\.idl\"$//;
2287 s/^\"//;
2288 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2292 #####################################################################
2293 # generate include statements for included header files
2294 sub HeaderInclude
2296 my $self = shift;
2297 my @includes = @_;
2298 foreach (@includes) {
2299 $self->pidl_hdr("#include $_");
2303 #####################################################################
2304 # generate prototypes and defines for the interface definitions
2305 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2306 # NDR parser and so do not belong here, technically speaking
2307 sub HeaderInterface($$$)
2309 my($self,$interface,$needed) = @_;
2311 my $count = 0;
2313 if ($needed->{"compression"}) {
2314 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2317 if (has_property($interface, "object")) {
2318 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2321 if (defined $interface->{PROPERTIES}->{helper}) {
2322 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2325 if (defined $interface->{PROPERTIES}->{uuid}) {
2326 my $name = uc $interface->{NAME};
2327 $self->pidl_hdr("#define NDR_$name\_UUID " .
2328 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2330 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2331 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2333 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2335 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2336 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2338 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2341 foreach (@{$interface->{FUNCTIONS}}) {
2342 next if has_property($_, "noopnum");
2343 next if grep(/$_->{NAME}/,@{$interface->{INHERITED_FUNCTIONS}});
2344 my $u_name = uc $_->{NAME};
2346 my $val = sprintf("0x%02x", $count);
2347 if (defined($interface->{BASE})) {
2348 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2351 $self->pidl_hdr("#define NDR_$u_name ($val)");
2353 $self->pidl_hdr("");
2354 $count++;
2357 my $val = $count;
2359 if (defined($interface->{BASE})) {
2360 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2363 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2367 sub ParseTypePush($$$$$)
2369 my ($self,$e,$varname, $primitives, $deferred) = @_;
2371 # save the old relative_base_offset
2372 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);") if defined(has_property($e, "relative_base"));
2373 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $varname);
2374 # restore the old relative_base_offset
2375 $self->pidl("ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2378 sub ParseTypePushFunction($$$)
2380 my ($self, $e, $varname) = @_;
2382 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2383 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *ndr, int ndr_flags, $args)") or return;
2385 $self->pidl("{");
2386 $self->indent;
2387 $self->ParseTypePush($e, $varname, 1, 1);
2388 $self->pidl("return NDR_ERR_SUCCESS;");
2389 $self->deindent;
2390 $self->pidl("}");
2391 $self->pidl("");;
2394 sub ParseTypePull($$$$$)
2396 my ($self, $e, $varname, $primitives, $deferred) = @_;
2398 # save the old relative_base_offset
2399 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);") if defined(has_property($e, "relative_base"));
2400 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $varname);
2401 # restore the old relative_base_offset
2402 $self->pidl("ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2405 sub ParseTypePullFunction($$)
2407 my ($self, $e, $varname) = @_;
2409 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2411 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *ndr, int ndr_flags, $args)") or return;
2413 $self->pidl("{");
2414 $self->indent;
2415 $self->ParseTypePull($e, $varname, 1, 1);
2416 $self->pidl("return NDR_ERR_SUCCESS;");
2417 $self->deindent;
2418 $self->pidl("}");
2419 $self->pidl("");
2422 sub ParseTypePrint($$$)
2424 my ($self, $e, $varname) = @_;
2426 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $e->{NAME}, $varname);
2429 sub ParseTypePrintFunction($$$)
2431 my ($self, $e, $varname) = @_;
2432 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2434 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2436 return if (has_property($e, "noprint"));
2438 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args)");
2439 $self->pidl("{");
2440 $self->indent;
2441 $self->ParseTypePrint($e, $varname);
2442 $self->deindent;
2443 $self->pidl("}");
2444 $self->pidl("");
2447 sub ParseTypeNdrSize($$)
2449 my ($self,$t) = @_;
2451 my $varname = "r";
2452 my $tf = $typefamily{$t->{TYPE}};
2453 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2455 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2457 $self->pidl("{");
2458 $self->indent;
2459 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2460 $self->deindent;
2461 $self->pidl("}");
2462 $self->pidl("");
2465 #####################################################################
2466 # parse the interface definitions
2467 sub ParseInterface($$$)
2469 my($self,$interface,$needed) = @_;
2471 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2472 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2474 $self->pidl_hdr("");
2476 $self->HeaderInterface($interface, $needed);
2478 # Typedefs
2479 foreach my $d (@{$interface->{TYPES}}) {
2480 next unless(typeHasBody($d));
2482 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2483 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2484 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2486 # Make sure we don't generate a function twice...
2487 $needed->{TypeFunctionName("ndr_push", $d)} =
2488 $needed->{TypeFunctionName("ndr_pull", $d)} =
2489 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2491 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2494 # Functions
2495 foreach my $d (@{$interface->{FUNCTIONS}}) {
2496 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2497 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2498 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2500 # Make sure we don't generate a function twice...
2501 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2502 $needed->{"ndr_print_$d->{NAME}"} = 0;
2505 $self->FunctionTable($interface);
2507 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2510 sub GenerateIncludes($)
2512 my ($self) = @_;
2513 if (is_intree()) {
2514 $self->pidl("#include \"includes.h\"");
2515 } else {
2516 $self->pidl("#define _GNU_SOURCE");
2517 $self->pidl("#include <stdint.h>");
2518 $self->pidl("#include <stdlib.h>");
2519 $self->pidl("#include <stdio.h>");
2520 $self->pidl("#include <stdbool.h>");
2521 $self->pidl("#include <stdarg.h>");
2522 $self->pidl("#include <string.h>");
2526 #####################################################################
2527 # parse a parsed IDL structure back into an IDL file
2528 sub Parse($$$$)
2530 my($self, $ndr,$gen_header,$ndr_header) = @_;
2532 $self->pidl_hdr("/* header auto-generated by pidl */");
2533 $self->pidl_hdr("");
2534 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2535 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2536 $self->pidl_hdr("");
2538 $self->pidl("/* parser auto-generated by pidl */");
2539 $self->pidl("");
2540 $self->GenerateIncludes();
2541 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2542 $self->pidl("");
2544 my %needed = ();
2546 foreach (@{$ndr}) {
2547 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2550 foreach (@{$ndr}) {
2551 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2552 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2553 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2556 return ($self->{res_hdr}, $self->{res});
2559 sub NeededElement($$$)
2561 my ($e, $dir, $needed) = @_;
2563 return if ($e->{TYPE} eq "EMPTY");
2565 return if (ref($e->{TYPE}) eq "HASH" and
2566 not defined($e->{TYPE}->{NAME}));
2568 my ($t, $rt);
2569 if (ref($e->{TYPE}) eq "HASH") {
2570 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2571 } else {
2572 $t = $e->{TYPE};
2575 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2576 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2577 } else {
2578 $rt = $e->{REPRESENTATION_TYPE};
2581 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2583 my @fn = ();
2584 if ($dir eq "print") {
2585 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2586 } elsif ($dir eq "pull") {
2587 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2588 push (@fn, "ndr_$t\_to_$rt")
2589 if ($rt ne $t);
2590 } elsif ($dir eq "push") {
2591 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2592 push (@fn, "ndr_$rt\_to_$t")
2593 if ($rt ne $t);
2594 } else {
2595 die("invalid direction `$dir'");
2598 foreach (@fn) {
2599 unless (defined($needed->{$_})) {
2600 $needed->{$_} = 1;
2605 sub NeededFunction($$)
2607 my ($fn,$needed) = @_;
2608 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2609 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2610 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2611 foreach my $e (@{$fn->{ELEMENTS}}) {
2612 $e->{PARENT} = $fn;
2613 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2617 sub NeededType($$$)
2619 sub NeededType($$$);
2620 my ($t,$needed,$req) = @_;
2622 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2624 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2625 return unless defined($t->{ELEMENTS});
2626 for my $e (@{$t->{ELEMENTS}}) {
2627 $e->{PARENT} = $t;
2628 if (has_property($e, "compression")) {
2629 $needed->{"compression"} = 1;
2631 NeededElement($e, $req, $needed);
2632 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2637 #####################################################################
2638 # work out what parse functions are needed
2639 sub NeededInterface($$)
2641 my ($interface,$needed) = @_;
2642 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2643 foreach (reverse @{$interface->{TYPES}}) {
2644 if (has_property($_, "public")) {
2645 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2646 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2649 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2650 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2651 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2652 if (has_property($_, "gensize")) {
2653 $needed->{"ndr_size_$_->{NAME}"} = 1;
2658 sub TypeFunctionName($$)
2660 my ($prefix, $t) = @_;
2662 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2663 $t->{TYPE} eq "TYPEDEF");
2664 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2665 return "$prefix\_$t";