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;
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid unmake_str);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
21 use Parse::Pidl qw(warning);
23 use vars qw($VERSION);
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
38 return $typefamily{$n};
43 my ($e, $var_name) = @_;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
50 } elsif ($l->{TYPE} eq "ARRAY") {
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);
67 sub has_fast_array($$)
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
90 $self->{res} .= $self->{tabs};
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); }
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
129 $self->{tabs} .= "\t";
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
153 $self->pidl("static $decl");
159 ###################################################################
160 # setup any special flags for an element or structure
163 my ($self, $e, $ndr) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
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
177 my ($self, $e, $ndr) = @_;
178 my $flags = has_property($e, "flag");
179 if (defined $flags) {
180 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
201 if (defined($l->{SIZE_IS})) {
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
204 if (defined($l->{LENGTH_IS})) {
205 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
208 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
209 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
212 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
213 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
216 if ($l->{IS_VARYING}) {
217 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));"); # array offset
218 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
224 sub check_fully_dereferenced($$)
226 my ($element, $env) = @_;
232 # Figure out the number of pointers in $ptr
233 my $expandedvar = $origvar;
234 $expandedvar =~ s/^(\**)//;
238 foreach (keys %$env) {
239 if ($env->{$_} eq $expandedvar) {
245 return($origvar) unless (defined($var));
247 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
248 if ($_->{NAME} eq $var) {
254 $e or die("Environment doesn't match siblings");
256 # See if pointer at pointer level $level
257 # needs to be checked.
259 foreach (@{$e->{LEVELS}}) {
260 if ($_->{TYPE} eq "POINTER") {
261 $nump = $_->{POINTER_INDEX}+1;
264 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
269 sub check_null_pointer($$$$)
271 my ($element, $env, $print_fn, $return) = @_;
274 my $expandedvar = shift;
277 # Figure out the number of pointers in $ptr
278 $expandedvar =~ s/^(\**)//;
282 foreach (keys %$env) {
283 if ($env->{$_} eq $expandedvar) {
292 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
293 if ($_->{NAME} eq $var) {
299 $e or die("Environment doesn't match siblings");
301 # See if pointer at pointer level $level
302 # needs to be checked.
303 foreach my $l (@{$e->{LEVELS}}) {
304 if ($l->{TYPE} eq "POINTER" and
305 $l->{POINTER_INDEX} == length($ptr)) {
306 # No need to check ref pointers
307 $check = ($l->{POINTER_TYPE} ne "ref");
311 if ($l->{TYPE} eq "DATA") {
312 warning($element, "too much dereferences for `$var'");
316 warning($element, "unknown dereferenced expression `$expandedvar'");
320 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
324 #####################################################################
325 # parse an array - pull side
326 sub ParseArrayPullHeader($$$$$$)
328 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
333 if ($l->{IS_CONFORMANT}) {
334 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
335 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
336 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
338 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
339 check_null_pointer($e, $env, sub { $self->pidl(shift); },
340 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
341 check_fully_dereferenced($e, $env));
344 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
345 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
348 if ($l->{IS_VARYING}) {
349 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
350 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
353 if ($length ne $size) {
354 $self->pidl("if ($length > $size) {");
356 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
361 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
362 $self->defer("if ($var_name) {");
364 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
365 check_null_pointer($e, $env, sub { $self->defer(shift); },
366 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
367 check_fully_dereferenced($e, $env));
368 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
369 $self->defer_deindent;
373 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
374 $self->defer("if ($var_name) {");
376 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
377 check_null_pointer($e, $env, sub { $self->defer(shift); },
378 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
379 check_fully_dereferenced($e, $env));
380 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
381 $self->defer_deindent;
385 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
386 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$size);
392 sub compression_alg($$)
395 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
400 sub compression_clen($$$)
402 my ($e, $l, $env) = @_;
403 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
405 return ParseExpr($clen, $env, $e->{ORIGINAL});
408 sub compression_dlen($$$)
410 my ($e,$l,$env) = @_;
411 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
413 return ParseExpr($dlen, $env, $e->{ORIGINAL});
416 sub ParseCompressionPushStart($$$$$)
418 my ($self,$e,$l,$ndr,$env) = @_;
419 my $comndr = "$ndr\_compressed";
420 my $alg = compression_alg($e, $l);
421 my $dlen = compression_dlen($e, $l, $env);
425 $self->pidl("struct ndr_push *$comndr;");
426 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
431 sub ParseCompressionPushEnd($$$$$)
433 my ($self,$e,$l,$ndr,$env) = @_;
434 my $comndr = "$ndr\_compressed";
435 my $alg = compression_alg($e, $l);
436 my $dlen = compression_dlen($e, $l, $env);
438 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
443 sub ParseCompressionPullStart($$$$$)
445 my ($self,$e,$l,$ndr,$env) = @_;
446 my $comndr = "$ndr\_compressed";
447 my $alg = compression_alg($e, $l);
448 my $dlen = compression_dlen($e, $l, $env);
452 $self->pidl("struct ndr_pull *$comndr;");
453 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
458 sub ParseCompressionPullEnd($$$$$)
460 my ($self,$e,$l,$ndr,$env) = @_;
461 my $comndr = "$ndr\_compressed";
462 my $alg = compression_alg($e, $l);
463 my $dlen = compression_dlen($e, $l, $env);
465 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
470 sub ParseSubcontextPushStart($$$$$)
472 my ($self,$e,$l,$ndr,$env) = @_;
473 my $subndr = "_ndr_$e->{NAME}";
474 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
478 $self->pidl("struct ndr_push *$subndr;");
479 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
481 if (defined $l->{COMPRESSION}) {
482 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
488 sub ParseSubcontextPushEnd($$$$$)
490 my ($self,$e,$l,$ndr,$env) = @_;
491 my $subndr = "_ndr_$e->{NAME}";
492 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
494 if (defined $l->{COMPRESSION}) {
495 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
498 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
503 sub ParseSubcontextPullStart($$$$$)
505 my ($self,$e,$l,$ndr,$env) = @_;
506 my $subndr = "_ndr_$e->{NAME}";
507 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
511 $self->pidl("struct ndr_pull *$subndr;");
512 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
514 if (defined $l->{COMPRESSION}) {
515 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
521 sub ParseSubcontextPullEnd($$$$$)
523 my ($self,$e,$l,$ndr,$env) = @_;
524 my $subndr = "_ndr_$e->{NAME}";
525 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
527 if (defined $l->{COMPRESSION}) {
528 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
531 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
536 sub ParseElementPushLevel
538 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
540 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
542 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
543 $var_name = get_pointer_to($var_name);
546 if (defined($ndr_flags)) {
547 if ($l->{TYPE} eq "SUBCONTEXT") {
548 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
549 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
550 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
551 } elsif ($l->{TYPE} eq "POINTER") {
552 $self->ParsePtrPush($e, $l, $ndr, $var_name);
553 } elsif ($l->{TYPE} eq "ARRAY") {
554 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
556 my $nl = GetNextLevel($e, $l);
558 # Allow speedups for arrays of scalar types
559 if (is_charset_array($e,$l)) {
560 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
562 } elsif (has_fast_array($e,$l)) {
563 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
566 } elsif ($l->{TYPE} eq "SWITCH") {
567 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
568 } elsif ($l->{TYPE} eq "DATA") {
569 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
570 } elsif ($l->{TYPE} eq "TYPEDEF") {
571 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
575 if ($l->{TYPE} eq "POINTER" and $deferred) {
576 my $rel_var_name = $var_name;
577 if ($l->{POINTER_TYPE} ne "ref") {
578 $self->pidl("if ($var_name) {");
580 if ($l->{POINTER_TYPE} eq "relative") {
581 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
583 if ($l->{POINTER_TYPE} eq "relative_short") {
584 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
587 $var_name = get_value_of($var_name);
588 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
590 if ($l->{POINTER_TYPE} ne "ref") {
591 if ($l->{POINTER_TYPE} eq "relative") {
592 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
597 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
598 not is_charset_array($e, $l)) {
599 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
600 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
602 my $array_pointless = ($length eq "0");
604 if ($array_pointless) {
605 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
608 $var_name = get_array_element($var_name, $counter);
610 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
611 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
613 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
618 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
619 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
621 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
625 } elsif ($l->{TYPE} eq "SWITCH") {
626 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
630 #####################################################################
631 # parse scalars in a structure element
632 sub ParseElementPush($$$$$$)
634 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
637 my $var_name = $env->{$e->{NAME}};
639 return if ContainsPipe($e, $e->{LEVELS}[0]);
641 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
643 # Representation type is different from transmit_as
644 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
647 my $transmit_name = "_transmit_$e->{NAME}";
648 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
649 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
650 $var_name = $transmit_name;
653 $var_name = append_prefix($e, $var_name);
655 $self->start_flags($e, $ndr);
657 if (defined(my $value = has_property($e, "value"))) {
658 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
661 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
663 $self->end_flags($e, $ndr);
665 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
671 #####################################################################
672 # parse a pointer in a struct element or function
673 sub ParsePtrPush($$$$$)
675 my ($self,$e,$l,$ndr,$var_name) = @_;
677 if ($l->{POINTER_TYPE} eq "ref") {
678 $self->pidl("if ($var_name == NULL) {");
680 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
683 if ($l->{LEVEL} eq "EMBEDDED") {
684 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
686 } elsif ($l->{POINTER_TYPE} eq "relative") {
687 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
688 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
689 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
690 } elsif ($l->{POINTER_TYPE} eq "unique") {
691 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
692 } elsif ($l->{POINTER_TYPE} eq "full") {
693 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
694 } elsif ($l->{POINTER_TYPE} eq "ignore") {
695 # We don't want this pointer to appear on the wire at all
696 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
698 die("Unhandled pointer type $l->{POINTER_TYPE}");
702 sub need_pointer_to($$$)
704 my ($e, $l, $scalar_only) = @_;
707 if (ref($l->{DATA_TYPE})) {
708 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
710 $t = $l->{DATA_TYPE};
713 if (not Parse::Pidl::Typelist::is_scalar($t)) {
714 return 1 if $scalar_only;
719 foreach my $tl (@{$e->{LEVELS}}) {
721 if ($tl->{TYPE} eq "ARRAY") {
726 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
727 return 1 unless $arrays;
733 sub ParseDataPrint($$$$$)
735 my ($self, $e, $l, $ndr, $var_name) = @_;
737 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
739 if (need_pointer_to($e, $l, 1)) {
740 $var_name = get_pointer_to($var_name);
743 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
745 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
749 #####################################################################
750 # print scalars in a structure element
751 sub ParseElementPrint($$$$$)
753 my($self, $e, $ndr, $var_name, $env) = @_;
755 return if (has_property($e, "noprint"));
757 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
758 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
762 $var_name = append_prefix($e, $var_name);
764 if (defined(my $value = has_property($e, "value"))) {
765 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
768 foreach my $l (@{$e->{LEVELS}}) {
769 if ($l->{TYPE} eq "POINTER") {
770 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
771 $self->pidl("$ndr->depth++;");
772 if ($l->{POINTER_TYPE} ne "ref") {
773 $self->pidl("if ($var_name) {");
776 $var_name = get_value_of($var_name);
777 } elsif ($l->{TYPE} eq "ARRAY") {
780 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
781 $var_name = get_pointer_to($var_name);
784 if ($l->{IS_ZERO_TERMINATED} and not defined($l->{LENGTH_IS})) {
785 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
787 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
788 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
791 if (is_charset_array($e,$l)) {
792 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
794 } elsif (has_fast_array($e, $l)) {
795 my $nl = GetNextLevel($e, $l);
796 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
799 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
801 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
802 $self->pidl("$ndr->depth++;");
803 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
806 $var_name = get_array_element($var_name, $counter);
808 } elsif ($l->{TYPE} eq "DATA") {
809 $self->ParseDataPrint($e, $l, $ndr, $var_name);
810 } elsif ($l->{TYPE} eq "SWITCH") {
811 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
812 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
813 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
817 foreach my $l (reverse @{$e->{LEVELS}}) {
818 if ($l->{TYPE} eq "POINTER") {
819 if ($l->{POINTER_TYPE} ne "ref") {
823 $self->pidl("$ndr->depth--;");
824 } elsif (($l->{TYPE} eq "ARRAY")
825 and not is_charset_array($e,$l)
826 and not has_fast_array($e,$l)) {
829 $self->pidl("$ndr->depth--;");
834 #####################################################################
835 # parse scalars in a structure element - pull size
836 sub ParseSwitchPull($$$$$$)
838 my($self,$e,$l,$ndr,$var_name,$env) = @_;
839 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
840 check_null_pointer($e, $env, sub { $self->pidl(shift); },
841 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
842 check_fully_dereferenced($e, $env));
844 $var_name = get_pointer_to($var_name);
845 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
848 #####################################################################
849 # push switch element
850 sub ParseSwitchPush($$$$$$)
852 my($self,$e,$l,$ndr,$var_name,$env) = @_;
853 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
854 check_null_pointer($e, $env, sub { $self->pidl(shift); },
855 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
856 check_fully_dereferenced($e, $env));
858 $var_name = get_pointer_to($var_name);
859 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
862 sub ParseDataPull($$$$$$$)
864 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
866 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
868 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
870 if (need_pointer_to($e, $l, 0)) {
871 $var_name = get_pointer_to($var_name);
874 $var_name = get_pointer_to($var_name);
876 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
878 my $pl = GetPrevLevel($e, $l);
880 my $range = has_property($e, "range");
881 if ($range and $pl->{TYPE} ne "ARRAY") {
882 $var_name = get_value_of($var_name);
883 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
884 my ($low, $high) = split(/,/, $range, 2);
885 if ($low < 0 and not $signed) {
886 warning(0, "$low is invalid for the range of an unsigned type");
888 if ($low == 0 and not $signed) {
889 $self->pidl("if ($var_name > $high) {");
891 $self->pidl("if ($var_name < $low || $var_name > $high) {");
893 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
897 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
901 sub ParseDataPush($$$$$$$)
903 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
905 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
907 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
909 # strings are passed by value rather than reference
910 if (need_pointer_to($e, $l, 1)) {
911 $var_name = get_pointer_to($var_name);
914 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
916 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
920 sub CalcNdrFlags($$$)
922 my ($l,$primitives,$deferred) = @_;
927 # Add NDR_SCALARS if this one is deferred
928 # and deferreds may be pushed
929 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
931 # Add NDR_SCALARS if this one is not deferred and
932 # primitives may be pushed
933 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
935 # Add NDR_BUFFERS if this one contains deferred stuff
936 # and deferreds may be pushed
937 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
939 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
940 return "NDR_SCALARS" if ($scalars);
941 return "NDR_BUFFERS" if ($buffers);
945 sub ParseMemCtxPullFlags($$$$)
947 my ($self, $e, $l) = @_;
949 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
951 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
952 return undef if has_fast_array($e, $l);
953 return undef if is_charset_array($e, $l);
957 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
958 my $nl = GetNextLevel($e, $l);
959 return undef if ($nl->{TYPE} eq "PIPE");
960 return undef if ($nl->{TYPE} eq "ARRAY");
961 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
963 if ($l->{LEVEL} eq "TOP") {
964 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
971 sub ParseMemCtxPullStart($$$$$)
973 my ($self, $e, $l, $ndr, $ptr_name) = @_;
975 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
976 my $mem_c_ctx = $ptr_name;
977 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
979 return unless defined($mem_c_flags);
981 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
982 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
985 sub ParseMemCtxPullEnd($$$$)
987 my ($self, $e, $l, $ndr) = @_;
989 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
990 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
992 return unless defined($mem_r_flags);
994 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
997 sub CheckStringTerminator($$$$$)
999 my ($self,$ndr,$e,$l,$length) = @_;
1000 my $nl = GetNextLevel($e, $l);
1002 # Make sure last element is zero!
1003 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1006 sub ParseElementPullLevel
1008 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1010 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1012 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1013 $var_name = get_pointer_to($var_name);
1016 # Only pull something if there's actually something to be pulled
1017 if (defined($ndr_flags)) {
1018 if ($l->{TYPE} eq "SUBCONTEXT") {
1019 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1020 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1021 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1022 } elsif ($l->{TYPE} eq "ARRAY") {
1023 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1025 if (my $range = has_property($e, "range")) {
1026 my ($low, $high) = split(/,/, $range, 2);
1028 warning(0, "$low is invalid for the range of an array size");
1031 $self->pidl("if ($length > $high) {");
1033 $self->pidl("if ($length < $low || $length > $high) {");
1035 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1039 my $nl = GetNextLevel($e, $l);
1041 if (is_charset_array($e,$l)) {
1042 if ($l->{IS_ZERO_TERMINATED}) {
1043 $self->CheckStringTerminator($ndr, $e, $l, $length);
1045 $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}));");
1047 } elsif (has_fast_array($e, $l)) {
1048 if ($l->{IS_ZERO_TERMINATED}) {
1049 $self->CheckStringTerminator($ndr,$e,$l,$length);
1051 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1054 } elsif ($l->{TYPE} eq "POINTER") {
1055 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1056 } elsif ($l->{TYPE} eq "SWITCH") {
1057 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1058 } elsif ($l->{TYPE} eq "DATA") {
1059 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1060 } elsif ($l->{TYPE} eq "TYPEDEF") {
1061 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1065 # add additional constructions
1066 if ($l->{TYPE} eq "POINTER" and $deferred) {
1067 if ($l->{POINTER_TYPE} ne "ref") {
1068 $self->pidl("if ($var_name) {");
1071 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1072 $self->pidl("uint32_t _relative_save_offset;");
1073 $self->pidl("_relative_save_offset = $ndr->offset;");
1074 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1078 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1080 $var_name = get_value_of($var_name);
1081 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1083 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1085 if ($l->{POINTER_TYPE} ne "ref") {
1086 if ($l->{POINTER_TYPE} eq "relative") {
1087 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1089 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1092 $self->pidl("$ndr->offset = _relative_save_offset;");
1097 } elsif ($l->{TYPE} eq "ARRAY" and
1098 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1099 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1100 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1101 my $array_name = $var_name;
1103 if ($l->{IS_VARYING}) {
1104 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
1107 if (my $range = has_property($e, "range")) {
1108 my ($low, $high) = split(/,/, $range, 2);
1110 warning(0, "$low is invalid for the range of an array size");
1113 $self->pidl("if ($length > $high) {");
1115 $self->pidl("if ($length < $low || $length > $high) {");
1117 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1121 $var_name = get_array_element($var_name, $counter);
1123 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1125 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1126 my $nl = GetNextLevel($e,$l);
1128 if ($l->{IS_ZERO_TERMINATED}) {
1129 $self->CheckStringTerminator($ndr,$e,$l,$length);
1132 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1134 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1139 if ($deferred and ContainsDeferred($e, $l)) {
1140 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1142 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1147 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1149 } elsif ($l->{TYPE} eq "SWITCH") {
1150 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1154 #####################################################################
1155 # parse scalars in a structure element - pull size
1156 sub ParseElementPull($$$$$$)
1158 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1160 my $var_name = $env->{$e->{NAME}};
1164 return if ContainsPipe($e, $e->{LEVELS}[0]);
1166 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1168 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1171 $represent_name = $var_name;
1172 $transmit_name = "_transmit_$e->{NAME}";
1173 $var_name = $transmit_name;
1174 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1177 $var_name = append_prefix($e, $var_name);
1179 $self->start_flags($e, $ndr);
1181 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1183 $self->end_flags($e, $ndr);
1185 # Representation type is different from transmit_as
1186 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1187 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1193 #####################################################################
1194 # parse a pointer in a struct element or function
1195 sub ParsePtrPull($$$$$)
1197 my($self, $e,$l,$ndr,$var_name) = @_;
1199 my $nl = GetNextLevel($e, $l);
1200 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1201 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1202 ($nl->{DATA_TYPE} eq "string"));
1204 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1206 if (!$next_is_array and !$next_is_string) {
1207 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1208 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1213 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1214 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1215 } elsif (($l->{POINTER_TYPE} eq "unique") or
1216 ($l->{POINTER_TYPE} eq "relative") or
1217 ($l->{POINTER_TYPE} eq "full")) {
1218 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1219 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1220 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1221 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1222 #We want to consume the pointer bytes, but ignore the pointer value
1223 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1224 $self->pidl("_ptr_$e->{NAME} = 0;");
1226 die("Unhandled pointer type $l->{POINTER_TYPE}");
1229 $self->pidl("if (_ptr_$e->{NAME}) {");
1232 if ($l->{POINTER_TYPE} eq "ignore") {
1233 # Don't do anything, we don't want to do the
1234 # allocation, as we forced it to NULL just above, and
1235 # we may not know the declared type anyway.
1237 # Don't do this for arrays, they're allocated at the actual level
1239 unless ($next_is_array or $next_is_string) {
1240 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1242 # FIXME: Yes, this is nasty.
1243 # We allocate an array twice
1244 # - once just to indicate that it's there,
1245 # - then the real allocation...
1246 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1250 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1251 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1252 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1255 $self->pidl("} else {");
1256 $self->pidl("\t$var_name = NULL;");
1260 sub ParseStructPushPrimitives($$$$$)
1262 my ($self, $struct, $ndr, $varname, $env) = @_;
1264 # see if the structure contains a conformant array. If it
1265 # does, then it must be the last element of the structure, and
1266 # we need to push the conformant length early, as it fits on
1267 # the wire before the structure (and even before the structure
1269 if (defined($struct->{SURROUNDING_ELEMENT})) {
1270 my $e = $struct->{SURROUNDING_ELEMENT};
1272 if (defined($e->{LEVELS}[0]) and
1273 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1276 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1277 if (has_property($e, "charset")) {
1278 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1280 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1282 if (defined($e->{LEVELS}[0]->{SIZE_IS})) {
1283 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1286 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1289 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1291 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1295 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1297 if (defined($struct->{PROPERTIES}{relative_base})) {
1298 # set the current offset as base for relative pointers
1299 # and store it based on the toplevel struct/union
1300 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1303 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1305 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1308 sub ParseStructPushDeferred($$$$)
1310 my ($self, $struct, $ndr, $varname, $env) = @_;
1311 if (defined($struct->{PROPERTIES}{relative_base})) {
1312 # retrieve the current offset as base for relative pointers
1313 # based on the toplevel struct/union
1314 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1316 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1319 #####################################################################
1321 sub ParseStructPush($$$$)
1323 my ($self, $struct, $ndr, $varname) = @_;
1325 return unless defined($struct->{ELEMENTS});
1327 my $env = GenerateStructEnv($struct, $varname);
1329 EnvSubstituteValue($env, $struct);
1331 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1333 $self->start_flags($struct, $ndr);
1335 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1337 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1341 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1343 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1347 $self->end_flags($struct, $ndr);
1350 #####################################################################
1351 # generate a push function for an enum
1352 sub ParseEnumPush($$$$)
1354 my($self,$enum,$ndr,$varname) = @_;
1355 my($type_fn) = $enum->{BASE_TYPE};
1357 $self->start_flags($enum, $ndr);
1358 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1359 $self->end_flags($enum, $ndr);
1362 #####################################################################
1363 # generate a pull function for an enum
1364 sub ParseEnumPull($$$$)
1366 my($self,$enum,$ndr,$varname) = @_;
1367 my($type_fn) = $enum->{BASE_TYPE};
1368 my($type_v_decl) = mapTypeName($type_fn);
1370 $self->pidl("$type_v_decl v;");
1371 $self->start_flags($enum, $ndr);
1372 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1373 $self->pidl("*$varname = v;");
1375 $self->end_flags($enum, $ndr);
1378 #####################################################################
1379 # generate a print function for an enum
1380 sub ParseEnumPrint($$$$$)
1382 my($self,$enum,$ndr,$name,$varname) = @_;
1384 $self->pidl("const char *val = NULL;");
1387 $self->start_flags($enum, $ndr);
1389 $self->pidl("switch ($varname) {");
1391 my $els = \@{$enum->{ELEMENTS}};
1392 foreach my $i (0 .. $#{$els}) {
1393 my $e = ${$els}[$i];
1395 if ($e =~ /^(.*)=/) {
1398 $self->pidl("case $e: val = \"$e\"; break;");
1404 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1406 $self->end_flags($enum, $ndr);
1411 my ($e,$t,$name,$varname) = @_;
1412 return "enum $name " .
1413 ($t eq "pull"?"*":"") . $varname;
1416 $typefamily{ENUM} = {
1418 PUSH_FN_BODY => \&ParseEnumPush,
1419 PULL_FN_BODY => \&ParseEnumPull,
1420 PRINT_FN_BODY => \&ParseEnumPrint,
1423 #####################################################################
1424 # generate a push function for a bitmap
1425 sub ParseBitmapPush($$$$)
1427 my($self,$bitmap,$ndr,$varname) = @_;
1428 my($type_fn) = $bitmap->{BASE_TYPE};
1430 $self->start_flags($bitmap, $ndr);
1432 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1434 $self->end_flags($bitmap, $ndr);
1437 #####################################################################
1438 # generate a pull function for an bitmap
1439 sub ParseBitmapPull($$$$)
1441 my($self,$bitmap,$ndr,$varname) = @_;
1442 my $type_fn = $bitmap->{BASE_TYPE};
1443 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1445 $self->pidl("$type_decl v;");
1446 $self->start_flags($bitmap, $ndr);
1447 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1448 $self->pidl("*$varname = v;");
1450 $self->end_flags($bitmap, $ndr);
1453 #####################################################################
1454 # generate a print function for an bitmap
1455 sub ParseBitmapPrintElement($$$$$$)
1457 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1458 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1459 my($type_fn) = $bitmap->{BASE_TYPE};
1462 if ($e =~ /^(\w+) .*$/) {
1465 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1468 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1471 #####################################################################
1472 # generate a print function for an bitmap
1473 sub ParseBitmapPrint($$$$$)
1475 my($self,$bitmap,$ndr,$name,$varname) = @_;
1476 my($type_decl) = mapTypeName($bitmap->{TYPE});
1477 my($type_fn) = $bitmap->{BASE_TYPE};
1479 $self->start_flags($bitmap, $ndr);
1481 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1483 $self->pidl("$ndr->depth++;");
1484 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1485 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1487 $self->pidl("$ndr->depth--;");
1489 $self->end_flags($bitmap, $ndr);
1492 sub DeclBitmap($$$$)
1494 my ($e,$t,$name,$varname) = @_;
1495 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1496 ($t eq "pull"?" *":" ") . $varname;
1499 $typefamily{BITMAP} = {
1500 DECL => \&DeclBitmap,
1501 PUSH_FN_BODY => \&ParseBitmapPush,
1502 PULL_FN_BODY => \&ParseBitmapPull,
1503 PRINT_FN_BODY => \&ParseBitmapPrint,
1506 #####################################################################
1507 # generate a struct print function
1508 sub ParseStructPrint($$$$$)
1510 my($self,$struct,$ndr,$name,$varname) = @_;
1512 return unless defined $struct->{ELEMENTS};
1514 my $env = GenerateStructEnv($struct, $varname);
1516 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1518 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1519 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1521 $self->start_flags($struct, $ndr);
1523 $self->pidl("$ndr->depth++;");
1525 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1526 foreach (@{$struct->{ELEMENTS}});
1527 $self->pidl("$ndr->depth--;");
1529 $self->end_flags($struct, $ndr);
1532 sub DeclarePtrVariables($$)
1535 foreach my $l (@{$e->{LEVELS}}) {
1537 if ($l->{TYPE} eq "POINTER" and
1538 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1539 if ($l->{POINTER_TYPE} eq "relative_short") {
1542 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1548 sub DeclareArrayVariables($$)
1552 foreach my $l (@{$e->{LEVELS}}) {
1553 next if has_fast_array($e,$l);
1554 next if is_charset_array($e,$l);
1555 if ($l->{TYPE} eq "ARRAY") {
1556 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1561 sub DeclareArrayVariablesNoZero($$$)
1563 my ($self,$e,$env) = @_;
1565 foreach my $l (@{$e->{LEVELS}}) {
1566 next if has_fast_array($e,$l);
1567 next if is_charset_array($e,$l);
1568 if ($l->{TYPE} eq "ARRAY") {
1569 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1570 if ($length eq "0") {
1571 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1573 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1579 sub DeclareMemCtxVariables($$)
1582 foreach my $l (@{$e->{LEVELS}}) {
1583 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1584 if (defined($mem_flags)) {
1585 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1590 sub ParseStructPullPrimitives($$$$$)
1592 my($self,$struct,$ndr,$varname,$env) = @_;
1594 if (defined $struct->{SURROUNDING_ELEMENT}) {
1595 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1598 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1600 if (defined($struct->{PROPERTIES}{relative_base})) {
1601 # set the current offset as base for relative pointers
1602 # and store it based on the toplevel struct/union
1603 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1606 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1608 $self->add_deferred();
1610 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1613 sub ParseStructPullDeferred($$$$$)
1615 my ($self,$struct,$ndr,$varname,$env) = @_;
1617 if (defined($struct->{PROPERTIES}{relative_base})) {
1618 # retrieve the current offset as base for relative pointers
1619 # based on the toplevel struct/union
1620 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1622 foreach my $e (@{$struct->{ELEMENTS}}) {
1623 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1626 $self->add_deferred();
1629 #####################################################################
1630 # parse a struct - pull side
1631 sub ParseStructPull($$$$)
1633 my($self,$struct,$ndr,$varname) = @_;
1635 return unless defined $struct->{ELEMENTS};
1637 # declare any internal pointers we need
1638 foreach my $e (@{$struct->{ELEMENTS}}) {
1639 $self->DeclarePtrVariables($e);
1640 $self->DeclareArrayVariables($e);
1641 $self->DeclareMemCtxVariables($e);
1644 $self->start_flags($struct, $ndr);
1646 my $env = GenerateStructEnv($struct, $varname);
1648 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1650 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1653 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1655 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1659 $self->end_flags($struct, $ndr);
1662 #####################################################################
1663 # calculate size of ndr struct
1664 sub ParseStructNdrSize($$$$)
1666 my ($self,$t, $name, $varname) = @_;
1669 if (my $flags = has_property($t, "flag")) {
1670 $self->pidl("flags |= $flags;");
1672 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1675 sub DeclStruct($$$$)
1677 my ($e,$t,$name,$varname) = @_;
1678 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1681 sub ArgsStructNdrSize($$$)
1683 my ($d, $name, $varname) = @_;
1684 return "const struct $name *$varname, int flags";
1687 $typefamily{STRUCT} = {
1688 PUSH_FN_BODY => \&ParseStructPush,
1689 DECL => \&DeclStruct,
1690 PULL_FN_BODY => \&ParseStructPull,
1691 PRINT_FN_BODY => \&ParseStructPrint,
1692 SIZE_FN_BODY => \&ParseStructNdrSize,
1693 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1696 #####################################################################
1697 # calculate size of ndr struct
1698 sub ParseUnionNdrSize($$$)
1700 my ($self, $t, $name, $varname) = @_;
1703 if (my $flags = has_property($t, "flag")) {
1704 $self->pidl("flags |= $flags;");
1707 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1710 sub ParseUnionPushPrimitives($$$$)
1712 my ($self, $e, $ndr ,$varname) = @_;
1714 my $have_default = 0;
1716 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1718 if (defined($e->{SWITCH_TYPE})) {
1719 if (defined($e->{ALIGN})) {
1720 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1723 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1726 if (defined($e->{ALIGN})) {
1727 if ($e->{IS_MS_UNION}) {
1728 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1729 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1731 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1735 $self->pidl("switch (level) {");
1737 foreach my $el (@{$e->{ELEMENTS}}) {
1738 if ($el->{CASE} eq "default") {
1741 $self->pidl("$el->{CASE}: {");
1743 if ($el->{TYPE} ne "EMPTY") {
1745 if (defined($e->{PROPERTIES}{relative_base})) {
1746 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1747 # set the current offset as base for relative pointers
1748 # and store it based on the toplevel struct/union
1749 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1751 $self->DeclareArrayVariables($el);
1752 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1755 $self->pidl("break; }");
1758 if (! $have_default) {
1759 $self->pidl("default:");
1760 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1766 sub ParseUnionPushDeferred($$$$)
1768 my ($self,$e,$ndr,$varname) = @_;
1770 my $have_default = 0;
1772 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1773 if (defined($e->{PROPERTIES}{relative_base})) {
1774 # retrieve the current offset as base for relative pointers
1775 # based on the toplevel struct/union
1776 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1778 $self->pidl("switch (level) {");
1780 foreach my $el (@{$e->{ELEMENTS}}) {
1781 if ($el->{CASE} eq "default") {
1785 $self->pidl("$el->{CASE}:");
1786 if ($el->{TYPE} ne "EMPTY") {
1788 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1791 $self->pidl("break;");
1794 if (! $have_default) {
1795 $self->pidl("default:");
1796 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1802 #####################################################################
1803 # parse a union - push side
1804 sub ParseUnionPush($$$$)
1806 my ($self,$e,$ndr,$varname) = @_;
1807 my $have_default = 0;
1809 $self->start_flags($e, $ndr);
1811 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1813 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1816 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1818 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1821 $self->end_flags($e, $ndr);
1824 #####################################################################
1826 sub ParseUnionPrint($$$$$)
1828 my ($self,$e,$ndr,$name,$varname) = @_;
1829 my $have_default = 0;
1831 $self->pidl("uint32_t level;");
1832 foreach my $el (@{$e->{ELEMENTS}}) {
1833 $self->DeclareArrayVariables($el);
1836 $self->start_flags($e, $ndr);
1838 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1840 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1842 $self->pidl("switch (level) {");
1844 foreach my $el (@{$e->{ELEMENTS}}) {
1845 if ($el->{CASE} eq "default") {
1848 $self->pidl("$el->{CASE}:");
1849 if ($el->{TYPE} ne "EMPTY") {
1851 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1854 $self->pidl("break;");
1857 if (! $have_default) {
1858 $self->pidl("default:");
1859 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1864 $self->end_flags($e, $ndr);
1867 sub ParseUnionPullPrimitives($$$$$)
1869 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1870 my $have_default = 0;
1873 if (defined($switch_type)) {
1874 if (defined($e->{ALIGN})) {
1875 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1878 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1879 $self->pidl("if (_level != level) {");
1880 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1884 if (defined($e->{ALIGN})) {
1885 if ($e->{IS_MS_UNION}) {
1886 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1887 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1889 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1893 $self->pidl("switch (level) {");
1895 foreach my $el (@{$e->{ELEMENTS}}) {
1896 if ($el->{CASE} eq "default") {
1899 $self->pidl("$el->{CASE}: {");
1901 if ($el->{TYPE} ne "EMPTY") {
1903 $self->DeclarePtrVariables($el);
1904 $self->DeclareArrayVariables($el);
1905 if (defined($e->{PROPERTIES}{relative_base})) {
1906 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1907 # set the current offset as base for relative pointers
1908 # and store it based on the toplevel struct/union
1909 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1911 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1914 $self->pidl("break; }");
1917 if (! $have_default) {
1918 $self->pidl("default:");
1919 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1925 sub ParseUnionPullDeferred($$$$)
1927 my ($self,$e,$ndr,$varname) = @_;
1928 my $have_default = 0;
1930 if (defined($e->{PROPERTIES}{relative_base})) {
1931 # retrieve the current offset as base for relative pointers
1932 # based on the toplevel struct/union
1933 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1935 $self->pidl("switch (level) {");
1937 foreach my $el (@{$e->{ELEMENTS}}) {
1938 if ($el->{CASE} eq "default") {
1942 $self->pidl("$el->{CASE}:");
1943 if ($el->{TYPE} ne "EMPTY") {
1945 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1948 $self->pidl("break;");
1951 if (! $have_default) {
1952 $self->pidl("default:");
1953 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1961 #####################################################################
1962 # parse a union - pull side
1963 sub ParseUnionPull($$$$)
1965 my ($self,$e,$ndr,$varname) = @_;
1966 my $switch_type = $e->{SWITCH_TYPE};
1968 $self->pidl("uint32_t level;");
1969 if (defined($switch_type)) {
1970 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1971 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1973 $self->pidl(mapTypeName($switch_type) . " _level;");
1976 my %double_cases = ();
1977 foreach my $el (@{$e->{ELEMENTS}}) {
1978 next if ($el->{TYPE} eq "EMPTY");
1979 next if ($double_cases{"$el->{NAME}"});
1980 $self->DeclareMemCtxVariables($el);
1981 $double_cases{"$el->{NAME}"} = 1;
1984 $self->start_flags($e, $ndr);
1986 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1988 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1990 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1994 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1996 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2000 $self->add_deferred();
2002 $self->end_flags($e, $ndr);
2007 my ($e,$t,$name,$varname) = @_;
2008 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2011 sub ArgsUnionNdrSize($$)
2014 return "const union $name *r, uint32_t level, int flags";
2017 $typefamily{UNION} = {
2018 PUSH_FN_BODY => \&ParseUnionPush,
2019 DECL => \&DeclUnion,
2020 PULL_FN_BODY => \&ParseUnionPull,
2021 PRINT_FN_BODY => \&ParseUnionPrint,
2022 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2023 SIZE_FN_BODY => \&ParseUnionNdrSize,
2026 #####################################################################
2027 # parse a typedef - push side
2028 sub ParseTypedefPush($$$$)
2030 my($self,$e,$ndr,$varname) = @_;
2034 $env->{$e->{NAME}} = $varname;
2036 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2039 #####################################################################
2040 # parse a typedef - pull side
2041 sub ParseTypedefPull($$$$)
2043 my($self,$e,$ndr,$varname) = @_;
2047 $env->{$e->{NAME}} = $varname;
2049 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2052 #####################################################################
2053 # parse a typedef - print side
2054 sub ParseTypedefPrint($$$$$)
2056 my($self,$e,$ndr,$name,$varname) = @_;
2058 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2061 #####################################################################
2062 ## calculate the size of a structure
2063 sub ParseTypedefNdrSize($$$$)
2065 my($self,$t,$name,$varname) = @_;
2067 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2070 sub DeclTypedef($$$$)
2072 my ($e, $t, $name, $varname) = @_;
2074 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2077 sub ArgsTypedefNdrSize($$$)
2079 my ($d, $name, $varname) = @_;
2080 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2083 $typefamily{TYPEDEF} = {
2084 PUSH_FN_BODY => \&ParseTypedefPush,
2085 DECL => \&DeclTypedef,
2086 PULL_FN_BODY => \&ParseTypedefPull,
2087 PRINT_FN_BODY => \&ParseTypedefPrint,
2088 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2089 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2092 sub ParsePipePushChunk($$)
2094 my ($self, $t) = @_;
2097 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2098 my $struct = $pipe->{DATA};
2100 my $name = "$struct->{NAME}";
2104 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2106 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2108 return if has_property($t, "nopush");
2113 $self->ParseStructPush($struct, $ndr, $varname);
2116 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2119 $self->pidl("return NDR_ERR_SUCCESS;");
2125 sub ParsePipePullChunk($$)
2127 my ($self, $t) = @_;
2130 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2131 my $struct = $pipe->{DATA};
2133 my $name = "$struct->{NAME}";
2137 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2139 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2141 return if has_property($struct, "nopull");
2146 $self->ParseStructPull($struct, $ndr, $varname);
2149 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2152 $self->pidl("return NDR_ERR_SUCCESS;");
2158 sub ParsePipePrintChunk($$)
2160 my ($self, $t) = @_;
2163 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2164 my $struct = $pipe->{DATA};
2166 my $name = "$struct->{NAME}";
2170 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2172 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2174 return if (has_property($t, "noprint"));
2176 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2179 $self->ParseTypePrint($struct, $ndr, $varname);
2185 #####################################################################
2186 # parse a function - print side
2187 sub ParseFunctionPrint($$)
2189 my($self, $fn) = @_;
2192 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2194 return if has_property($fn, "noprint");
2196 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2200 foreach my $e (@{$fn->{ELEMENTS}}) {
2201 $self->DeclareArrayVariables($e);
2204 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2205 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2206 $self->pidl("$ndr->depth++;");
2208 $self->pidl("if (flags & NDR_SET_VALUES) {");
2209 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2212 $self->pidl("if (flags & NDR_IN) {");
2214 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2215 $self->pidl("$ndr->depth++;");
2217 my $env = GenerateFunctionInEnv($fn);
2219 foreach my $e (@{$fn->{ELEMENTS}}) {
2220 if (grep(/in/,@{$e->{DIRECTION}})) {
2221 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2224 $self->pidl("$ndr->depth--;");
2228 $self->pidl("if (flags & NDR_OUT) {");
2230 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2231 $self->pidl("$ndr->depth++;");
2233 $env = GenerateFunctionOutEnv($fn);
2234 foreach my $e (@{$fn->{ELEMENTS}}) {
2235 if (grep(/out/,@{$e->{DIRECTION}})) {
2236 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2239 if ($fn->{RETURN_TYPE}) {
2240 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2242 $self->pidl("$ndr->depth--;");
2246 $self->pidl("$ndr->depth--;");
2252 #####################################################################
2254 sub ParseFunctionPush($$)
2256 my($self, $fn) = @_;
2259 $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;
2261 return if has_property($fn, "nopush");
2266 foreach my $e (@{$fn->{ELEMENTS}}) {
2267 $self->DeclareArrayVariables($e);
2270 $self->pidl("if (flags & NDR_IN) {");
2273 my $env = GenerateFunctionInEnv($fn);
2275 EnvSubstituteValue($env, $fn);
2277 foreach my $e (@{$fn->{ELEMENTS}}) {
2278 if (grep(/in/,@{$e->{DIRECTION}})) {
2279 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2286 $self->pidl("if (flags & NDR_OUT) {");
2289 $env = GenerateFunctionOutEnv($fn);
2290 foreach my $e (@{$fn->{ELEMENTS}}) {
2291 if (grep(/out/,@{$e->{DIRECTION}})) {
2292 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2296 if ($fn->{RETURN_TYPE}) {
2297 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2302 $self->pidl("return NDR_ERR_SUCCESS;");
2308 sub AllocateArrayLevel($$$$$$)
2310 my ($self,$e,$l,$ndr,$var,$size) = @_;
2312 my $pl = GetPrevLevel($e, $l);
2313 if (defined($pl) and
2314 $pl->{TYPE} eq "POINTER" and
2315 $pl->{POINTER_TYPE} eq "ref"
2316 and not $l->{IS_ZERO_TERMINATED}) {
2317 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2318 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2320 if (grep(/in/,@{$e->{DIRECTION}}) and
2321 grep(/out/,@{$e->{DIRECTION}})) {
2322 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2327 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2330 #####################################################################
2332 sub ParseFunctionPull($$)
2337 # pull function args
2338 $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;
2343 # declare any internal pointers we need
2344 foreach my $e (@{$fn->{ELEMENTS}}) {
2345 $self->DeclarePtrVariables($e);
2346 $self->DeclareArrayVariables($e);
2349 my %double_cases = ();
2350 foreach my $e (@{$fn->{ELEMENTS}}) {
2351 next if ($e->{TYPE} eq "EMPTY");
2352 next if ($double_cases{"$e->{NAME}"});
2353 $self->DeclareMemCtxVariables($e);
2354 $double_cases{"$e->{NAME}"} = 1;
2357 $self->pidl("if (flags & NDR_IN) {");
2360 # auto-init the out section of a structure. I originally argued that
2361 # this was a bad idea as it hides bugs, but coping correctly
2362 # with initialisation and not wiping ref vars is turning
2363 # out to be too tricky (tridge)
2364 foreach my $e (@{$fn->{ELEMENTS}}) {
2365 next unless grep(/out/, @{$e->{DIRECTION}});
2366 $self->pidl("ZERO_STRUCT(r->out);");
2371 my $env = GenerateFunctionInEnv($fn);
2373 foreach my $e (@{$fn->{ELEMENTS}}) {
2374 next unless (grep(/in/, @{$e->{DIRECTION}}));
2375 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2378 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2379 # own flag rather than be in NDR_IN ?
2381 foreach my $e (@{$fn->{ELEMENTS}}) {
2382 next unless (grep(/out/, @{$e->{DIRECTION}}));
2383 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2384 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2385 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2386 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2387 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2388 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2389 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2391 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2392 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2393 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2394 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2395 check_fully_dereferenced($e, $env));
2396 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2398 if (grep(/in/, @{$e->{DIRECTION}})) {
2399 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2401 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2403 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2404 if (grep(/in/, @{$e->{DIRECTION}})) {
2405 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2407 $self->pidl("r->out.$e->{NAME} = NULL;");
2410 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2412 if (grep(/in/, @{$e->{DIRECTION}})) {
2413 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2415 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2420 $self->add_deferred();
2424 $self->pidl("if (flags & NDR_OUT) {");
2427 $env = GenerateFunctionOutEnv($fn);
2428 foreach my $e (@{$fn->{ELEMENTS}}) {
2429 next unless grep(/out/, @{$e->{DIRECTION}});
2430 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2433 if ($fn->{RETURN_TYPE}) {
2434 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2437 $self->add_deferred();
2441 $self->pidl("return NDR_ERR_SUCCESS;");
2447 sub AuthServiceStruct($$$)
2449 my ($self, $ifacename, $authservice) = @_;
2450 my @a = split /,/, $authservice;
2451 my $authservice_count = $#a + 1;
2453 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2454 foreach my $ap (@a) {
2455 $self->pidl("\t$ap, ");
2460 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2461 $self->pidl("\t.count\t= $authservice_count,");
2462 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2467 sub ParseGeneratePipeArray($$$)
2469 my ($self, $fn, $direction) = @_;
2471 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2474 foreach my $e (@{$fn->{ELEMENTS}}) {
2475 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2476 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2478 my $cname = "$e->{TYPE}_chunk";
2482 $self->pidl("\"$direction.$e->{NAME}\",");
2483 $self->pidl("\"$cname\",");
2484 $self->pidl("sizeof(struct $cname),");
2485 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2486 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2487 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2491 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2497 sub FunctionCallPipes($$)
2499 my ($self, $d) = @_;
2500 return if not defined($d->{OPNUM});
2505 foreach my $e (@{$d->{ELEMENTS}}) {
2506 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2508 if (grep(/in/, @{$e->{DIRECTION}})) {
2511 if (grep(/out/, @{$e->{DIRECTION}})) {
2517 $self->ParseGeneratePipeArray($d, "in");
2521 $self->ParseGeneratePipeArray($d, "out");
2525 sub FunctionCallEntry($$)
2527 my ($self, $d) = @_;
2528 return 0 if not defined($d->{OPNUM});
2533 foreach my $e (@{$d->{ELEMENTS}}) {
2534 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2536 if (grep(/in/, @{$e->{DIRECTION}})) {
2539 if (grep(/out/, @{$e->{DIRECTION}})) {
2544 my $in_pipes_ptr = "NULL";
2545 my $out_pipes_ptr = "NULL";
2548 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2552 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2556 $self->pidl("\t\t\"$d->{NAME}\",");
2557 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2558 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2559 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2560 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2561 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2562 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2563 $self->pidl("\t},");
2567 #####################################################################
2568 # produce a function call table
2569 sub FunctionTable($$)
2571 my($self,$interface) = @_;
2573 my $uname = uc $interface->{NAME};
2575 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2576 return unless defined ($interface->{PROPERTIES}->{uuid});
2578 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2579 $self->FunctionCallPipes($d);
2582 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2584 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2585 $count += $self->FunctionCallEntry($d);
2587 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2591 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2592 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2593 $self->pidl("\t$ep, ");
2595 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2600 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2601 $self->pidl("\t.count\t= $endpoint_count,");
2602 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2606 if (! defined $interface->{PROPERTIES}->{authservice}) {
2607 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2610 $self->AuthServiceStruct($interface->{NAME},
2611 $interface->{PROPERTIES}->{authservice});
2613 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2614 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2615 $self->pidl("\t.syntax_id\t= {");
2616 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2617 $self->pidl("\t\tNDR_$uname\_VERSION");
2618 $self->pidl("\t},");
2619 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2620 $self->pidl("\t.num_calls\t= $count,");
2621 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2622 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2623 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2629 #####################################################################
2630 # generate include statements for imported idl files
2635 foreach (@imports) {
2636 $_ = unmake_str($_);
2638 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2642 #####################################################################
2643 # generate include statements for included header files
2648 foreach (@includes) {
2649 $self->pidl_hdr("#include $_");
2653 #####################################################################
2654 # generate prototypes and defines for the interface definitions
2655 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2656 # NDR parser and so do not belong here, technically speaking
2657 sub HeaderInterface($$$)
2659 my($self,$interface,$needed) = @_;
2663 if ($needed->{"compression"}) {
2664 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2667 if (has_property($interface, "object")) {
2668 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2671 if (defined $interface->{PROPERTIES}->{helper}) {
2672 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2675 if (defined $interface->{PROPERTIES}->{uuid}) {
2676 my $name = uc $interface->{NAME};
2677 $self->pidl_hdr("#define NDR_$name\_UUID " .
2678 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
2680 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
2682 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2684 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2685 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2687 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2690 foreach (@{$interface->{FUNCTIONS}}) {
2691 next if has_property($_, "noopnum");
2692 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2693 my $u_name = uc $_->{NAME};
2695 my $val = sprintf("0x%02x", $count);
2696 if (defined($interface->{BASE})) {
2697 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2700 $self->pidl_hdr("#define NDR_$u_name ($val)");
2702 $self->pidl_hdr("");
2708 if (defined($interface->{BASE})) {
2709 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2712 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2716 sub ParseTypePush($$$$$$)
2718 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2720 # save the old relative_base_offset
2721 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2722 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2723 # restore the old relative_base_offset
2724 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2727 sub ParseTypePushFunction($$$)
2729 my ($self, $e, $varname) = @_;
2732 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2734 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2738 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2739 $self->pidl("return NDR_ERR_SUCCESS;");
2745 sub ParseTypePull($$$$$$)
2747 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2749 # save the old relative_base_offset
2750 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2751 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2752 # restore the old relative_base_offset
2753 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2756 sub ParseTypePullFunction($$)
2758 my ($self, $e, $varname) = @_;
2761 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2763 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2767 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2768 $self->pidl("return NDR_ERR_SUCCESS;");
2774 sub ParseTypePrint($$$$)
2776 my ($self, $e, $ndr, $varname) = @_;
2778 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2781 sub ParseTypePrintFunction($$$)
2783 my ($self, $e, $varname) = @_;
2786 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2788 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2790 return if (has_property($e, "noprint"));
2792 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2795 $self->ParseTypePrint($e, $ndr, $varname);
2801 sub ParseTypeNdrSize($$)
2806 my $tf = $typefamily{$t->{TYPE}};
2807 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2809 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2813 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2819 #####################################################################
2820 # parse the interface definitions
2821 sub ParseInterface($$$)
2823 my($self,$interface,$needed) = @_;
2825 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2826 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2828 $self->pidl_hdr("");
2830 $self->HeaderInterface($interface, $needed);
2833 foreach my $d (@{$interface->{TYPES}}) {
2834 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2835 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2836 $self->ParsePipePushChunk($d);
2837 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2838 $self->ParsePipePullChunk($d);
2839 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2840 $self->ParsePipePrintChunk($d);
2842 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2843 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2844 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2848 next unless(typeHasBody($d));
2850 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2851 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2852 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2854 # Make sure we don't generate a function twice...
2855 $needed->{TypeFunctionName("ndr_push", $d)} =
2856 $needed->{TypeFunctionName("ndr_pull", $d)} =
2857 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2859 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2863 foreach my $d (@{$interface->{FUNCTIONS}}) {
2864 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2865 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2866 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2869 $self->FunctionTable($interface);
2871 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2874 sub GenerateIncludes($)
2878 $self->pidl("#include \"includes.h\"");
2880 $self->pidl("#ifndef _GNU_SOURCE");
2881 $self->pidl("#define _GNU_SOURCE");
2882 $self->pidl("#endif");
2883 $self->pidl("#include <stdint.h>");
2884 $self->pidl("#include <stdlib.h>");
2885 $self->pidl("#include <stdio.h>");
2886 $self->pidl("#include <stdbool.h>");
2887 $self->pidl("#include <stdarg.h>");
2888 $self->pidl("#include <string.h>");
2892 #####################################################################
2893 # parse a parsed IDL structure back into an IDL file
2896 my($self, $ndr,$gen_header,$ndr_header) = @_;
2898 $self->pidl_hdr("/* header auto-generated by pidl */");
2899 $self->pidl_hdr("");
2900 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2901 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2902 $self->pidl_hdr("");
2904 $self->pidl("/* parser auto-generated by pidl */");
2906 $self->GenerateIncludes();
2907 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2913 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2917 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2918 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2919 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2922 return ($self->{res_hdr}, $self->{res});
2925 sub NeededElement($$$)
2927 my ($e, $dir, $needed) = @_;
2929 return if ($e->{TYPE} eq "EMPTY");
2931 return if (ref($e->{TYPE}) eq "HASH" and
2932 not defined($e->{TYPE}->{NAME}));
2935 if (ref($e->{TYPE}) eq "HASH") {
2936 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2941 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2942 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2944 $rt = $e->{REPRESENTATION_TYPE};
2947 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2950 if ($dir eq "print") {
2951 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2952 } elsif ($dir eq "pull") {
2953 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2954 push (@fn, "ndr_$t\_to_$rt")
2956 } elsif ($dir eq "push") {
2957 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2958 push (@fn, "ndr_$rt\_to_$t")
2961 die("invalid direction `$dir'");
2965 unless (defined($needed->{$_})) {
2971 sub NeededFunction($$)
2973 my ($fn,$needed) = @_;
2974 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2975 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2976 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2977 foreach my $e (@{$fn->{ELEMENTS}}) {
2979 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2985 sub NeededType($$$);
2986 my ($t,$needed,$req) = @_;
2988 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2989 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
2991 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2992 return unless defined($t->{ELEMENTS});
2993 for my $e (@{$t->{ELEMENTS}}) {
2995 if (has_property($e, "compression")) {
2996 $needed->{"compression"} = 1;
2998 NeededElement($e, $req, $needed);
2999 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3004 #####################################################################
3005 # work out what parse functions are needed
3006 sub NeededInterface($$)
3008 my ($interface,$needed) = @_;
3009 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3010 foreach (reverse @{$interface->{TYPES}}) {
3012 if (has_property($_, "public")) {
3013 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3014 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3017 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3018 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3019 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3020 if (has_property($_, "gensize")) {
3021 $needed->{"ndr_size_$_->{NAME}"} = 1;
3026 sub TypeFunctionName($$)
3028 my ($prefix, $t) = @_;
3030 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3031 $t->{TYPE} eq "TYPEDEF");
3032 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3033 return "$prefix\_$t";