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 sub ParseArrayPullGetSize($$$$$$)
326 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
330 if ($l->{IS_CONFORMANT}) {
331 $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
332 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
333 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
335 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
336 check_null_pointer($e, $env, sub { $self->pidl(shift); },
337 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
338 check_fully_dereferenced($e, $env));
341 my $array_size = $size;
346 #####################################################################
347 # parse an array - pull side
348 sub ParseArrayPullGetLength($$$$$$;$)
350 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
352 if (not defined($array_size)) {
353 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
356 my $array_length = $array_size;
357 if ($l->{IS_VARYING}) {
358 my $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
359 $array_length = $length;
362 return $array_length;
365 #####################################################################
366 # parse an array - pull side
367 sub ParseArrayPullHeader($$$$$$)
369 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
371 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
372 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
375 if ($l->{IS_VARYING}) {
376 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
379 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
380 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
382 if ($array_length ne $array_size) {
383 $self->pidl("if ($array_length > $array_size) {");
385 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
390 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
391 $self->defer("if ($var_name) {");
393 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
394 check_null_pointer($e, $env, sub { $self->defer(shift); },
395 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
396 check_fully_dereferenced($e, $env));
397 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
398 $self->defer_deindent;
402 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
403 $self->defer("if ($var_name) {");
405 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
406 check_null_pointer($e, $env, sub { $self->defer(shift); },
407 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
408 check_fully_dereferenced($e, $env));
409 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
410 $self->defer_deindent;
414 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
415 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
418 return $array_length;
421 sub compression_alg($$)
424 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
429 sub compression_clen($$$)
431 my ($e, $l, $env) = @_;
432 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
434 return ParseExpr($clen, $env, $e->{ORIGINAL});
437 sub compression_dlen($$$)
439 my ($e,$l,$env) = @_;
440 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
442 return ParseExpr($dlen, $env, $e->{ORIGINAL});
445 sub ParseCompressionPushStart($$$$$)
447 my ($self,$e,$l,$ndr,$env) = @_;
448 my $comndr = "$ndr\_compressed";
449 my $alg = compression_alg($e, $l);
450 my $dlen = compression_dlen($e, $l, $env);
454 $self->pidl("struct ndr_push *$comndr;");
455 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
460 sub ParseCompressionPushEnd($$$$$)
462 my ($self,$e,$l,$ndr,$env) = @_;
463 my $comndr = "$ndr\_compressed";
464 my $alg = compression_alg($e, $l);
465 my $dlen = compression_dlen($e, $l, $env);
467 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
472 sub ParseCompressionPullStart($$$$$)
474 my ($self,$e,$l,$ndr,$env) = @_;
475 my $comndr = "$ndr\_compressed";
476 my $alg = compression_alg($e, $l);
477 my $dlen = compression_dlen($e, $l, $env);
481 $self->pidl("struct ndr_pull *$comndr;");
482 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
487 sub ParseCompressionPullEnd($$$$$)
489 my ($self,$e,$l,$ndr,$env) = @_;
490 my $comndr = "$ndr\_compressed";
491 my $alg = compression_alg($e, $l);
492 my $dlen = compression_dlen($e, $l, $env);
494 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
499 sub ParseSubcontextPushStart($$$$$)
501 my ($self,$e,$l,$ndr,$env) = @_;
502 my $subndr = "_ndr_$e->{NAME}";
503 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
507 $self->pidl("struct ndr_push *$subndr;");
508 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
510 if (defined $l->{COMPRESSION}) {
511 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
517 sub ParseSubcontextPushEnd($$$$$)
519 my ($self,$e,$l,$ndr,$env) = @_;
520 my $subndr = "_ndr_$e->{NAME}";
521 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
523 if (defined $l->{COMPRESSION}) {
524 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
527 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
532 sub ParseSubcontextPullStart($$$$$)
534 my ($self,$e,$l,$ndr,$env) = @_;
535 my $subndr = "_ndr_$e->{NAME}";
536 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
540 $self->pidl("struct ndr_pull *$subndr;");
541 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
543 if (defined $l->{COMPRESSION}) {
544 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
550 sub ParseSubcontextPullEnd($$$$$)
552 my ($self,$e,$l,$ndr,$env) = @_;
553 my $subndr = "_ndr_$e->{NAME}";
554 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
556 if (defined $l->{COMPRESSION}) {
557 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
560 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
565 sub ParseElementPushLevel
567 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
569 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
571 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
572 $var_name = get_pointer_to($var_name);
575 if (defined($ndr_flags)) {
576 if ($l->{TYPE} eq "SUBCONTEXT") {
577 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
578 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
579 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
580 } elsif ($l->{TYPE} eq "POINTER") {
581 $self->ParsePtrPush($e, $l, $ndr, $var_name);
582 } elsif ($l->{TYPE} eq "ARRAY") {
583 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
585 my $nl = GetNextLevel($e, $l);
587 # Allow speedups for arrays of scalar types
588 if (is_charset_array($e,$l)) {
589 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
591 } elsif (has_fast_array($e,$l)) {
592 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
595 } elsif ($l->{TYPE} eq "SWITCH") {
596 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
597 } elsif ($l->{TYPE} eq "DATA") {
598 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
599 } elsif ($l->{TYPE} eq "TYPEDEF") {
600 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
604 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
605 $self->pidl("/* [ignore] '$e->{NAME}' */");
606 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
607 my $rel_var_name = $var_name;
608 if ($l->{POINTER_TYPE} ne "ref") {
609 $self->pidl("if ($var_name) {");
611 if ($l->{POINTER_TYPE} eq "relative") {
612 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
614 if ($l->{POINTER_TYPE} eq "relative_short") {
615 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
618 $var_name = get_value_of($var_name);
619 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
621 if ($l->{POINTER_TYPE} ne "ref") {
622 if ($l->{POINTER_TYPE} eq "relative") {
623 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
628 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
629 not is_charset_array($e, $l)) {
630 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
631 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
633 my $array_pointless = ($length eq "0");
635 if ($array_pointless) {
636 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
639 $var_name = get_array_element($var_name, $counter);
641 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
642 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
644 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
649 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
650 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
652 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
656 } elsif ($l->{TYPE} eq "SWITCH") {
657 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
661 #####################################################################
662 # parse scalars in a structure element
663 sub ParseElementPush($$$$$$)
665 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
668 my $var_name = $env->{$e->{NAME}};
670 return if ContainsPipe($e, $e->{LEVELS}[0]);
672 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
674 # Representation type is different from transmit_as
675 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
678 my $transmit_name = "_transmit_$e->{NAME}";
679 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
680 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
681 $var_name = $transmit_name;
684 $var_name = append_prefix($e, $var_name);
686 $self->start_flags($e, $ndr);
688 if (defined(my $value = has_property($e, "value"))) {
689 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
692 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
694 $self->end_flags($e, $ndr);
696 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
702 #####################################################################
703 # parse a pointer in a struct element or function
704 sub ParsePtrPush($$$$$)
706 my ($self,$e,$l,$ndr,$var_name) = @_;
708 if ($l->{POINTER_TYPE} eq "ref") {
709 $self->pidl("if ($var_name == NULL) {");
711 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
714 if ($l->{LEVEL} eq "EMBEDDED") {
715 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
717 } elsif ($l->{POINTER_TYPE} eq "relative") {
718 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
719 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
720 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
721 } elsif ($l->{POINTER_TYPE} eq "unique") {
722 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
723 } elsif ($l->{POINTER_TYPE} eq "full") {
724 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
725 } elsif ($l->{POINTER_TYPE} eq "ignore") {
726 # We don't want this pointer to appear on the wire at all
727 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
729 die("Unhandled pointer type $l->{POINTER_TYPE}");
733 sub need_pointer_to($$$)
735 my ($e, $l, $scalar_only) = @_;
738 if (ref($l->{DATA_TYPE})) {
739 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
741 $t = $l->{DATA_TYPE};
744 if (not Parse::Pidl::Typelist::is_scalar($t)) {
745 return 1 if $scalar_only;
750 foreach my $tl (@{$e->{LEVELS}}) {
752 if ($tl->{TYPE} eq "ARRAY") {
757 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
758 return 1 unless $arrays;
764 sub ParseDataPrint($$$$$)
766 my ($self, $e, $l, $ndr, $var_name) = @_;
768 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
770 if (need_pointer_to($e, $l, 1)) {
771 $var_name = get_pointer_to($var_name);
774 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
776 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
780 #####################################################################
781 # print scalars in a structure element
782 sub ParseElementPrint($$$$$)
784 my($self, $e, $ndr, $var_name, $env) = @_;
786 return if (has_property($e, "noprint"));
788 my $ignore_depth = 0xFFFF;
790 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
791 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
795 $var_name = append_prefix($e, $var_name);
797 if (defined(my $value = has_property($e, "value"))) {
798 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
801 foreach my $l (@{$e->{LEVELS}}) {
804 if ($cur_depth > $ignore_depth) {
808 if ($l->{TYPE} eq "POINTER") {
809 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
810 if ($l->{POINTER_TYPE} eq "ignore") {
811 $self->pidl("/* [ignore] '$e->{NAME}' */");
812 $ignore_depth = $cur_depth;
815 $self->pidl("$ndr->depth++;");
816 if ($l->{POINTER_TYPE} ne "ref") {
817 $self->pidl("if ($var_name) {");
820 $var_name = get_value_of($var_name);
821 } elsif ($l->{TYPE} eq "ARRAY") {
824 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
825 $var_name = get_pointer_to($var_name);
828 if ($l->{IS_ZERO_TERMINATED} and not defined($l->{LENGTH_IS})) {
829 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
831 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
832 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
835 if (is_charset_array($e,$l)) {
836 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
838 } elsif (has_fast_array($e, $l)) {
839 my $nl = GetNextLevel($e, $l);
840 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
843 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
845 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
846 $self->pidl("$ndr->depth++;");
847 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
850 $var_name = get_array_element($var_name, $counter);
852 } elsif ($l->{TYPE} eq "DATA") {
853 $self->ParseDataPrint($e, $l, $ndr, $var_name);
854 } elsif ($l->{TYPE} eq "SWITCH") {
855 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
856 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
857 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
861 foreach my $l (reverse @{$e->{LEVELS}}) {
864 if ($cur_depth > $ignore_depth) {
868 if ($l->{TYPE} eq "POINTER") {
869 if ($l->{POINTER_TYPE} eq "ignore") {
873 if ($l->{POINTER_TYPE} ne "ref") {
877 $self->pidl("$ndr->depth--;");
878 } elsif (($l->{TYPE} eq "ARRAY")
879 and not is_charset_array($e,$l)
880 and not has_fast_array($e,$l)) {
883 $self->pidl("$ndr->depth--;");
888 #####################################################################
889 # parse scalars in a structure element - pull size
890 sub ParseSwitchPull($$$$$$)
892 my($self,$e,$l,$ndr,$var_name,$env) = @_;
893 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
894 check_null_pointer($e, $env, sub { $self->pidl(shift); },
895 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
896 check_fully_dereferenced($e, $env));
898 $var_name = get_pointer_to($var_name);
899 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
902 #####################################################################
903 # push switch element
904 sub ParseSwitchPush($$$$$$)
906 my($self,$e,$l,$ndr,$var_name,$env) = @_;
907 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
908 check_null_pointer($e, $env, sub { $self->pidl(shift); },
909 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
910 check_fully_dereferenced($e, $env));
912 $var_name = get_pointer_to($var_name);
913 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
916 sub ParseDataPull($$$$$$$)
918 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
920 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
922 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
924 if (need_pointer_to($e, $l, 0)) {
925 $var_name = get_pointer_to($var_name);
928 $var_name = get_pointer_to($var_name);
930 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
932 my $pl = GetPrevLevel($e, $l);
934 my $range = has_property($e, "range");
935 if ($range and $pl->{TYPE} ne "ARRAY") {
936 $var_name = get_value_of($var_name);
937 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
938 my ($low, $high) = split(/,/, $range, 2);
939 if ($low < 0 and not $signed) {
940 warning(0, "$low is invalid for the range of an unsigned type");
942 if ($low == 0 and not $signed) {
943 $self->pidl("if ($var_name > $high) {");
945 $self->pidl("if ($var_name < $low || $var_name > $high) {");
947 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
951 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
955 sub ParseDataPush($$$$$$$)
957 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
959 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
961 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
963 # strings are passed by value rather than reference
964 if (need_pointer_to($e, $l, 1)) {
965 $var_name = get_pointer_to($var_name);
968 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
970 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
974 sub CalcNdrFlags($$$)
976 my ($l,$primitives,$deferred) = @_;
981 # Add NDR_SCALARS if this one is deferred
982 # and deferreds may be pushed
983 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
985 # Add NDR_SCALARS if this one is not deferred and
986 # primitives may be pushed
987 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
989 # Add NDR_BUFFERS if this one contains deferred stuff
990 # and deferreds may be pushed
991 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
993 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
994 return "NDR_SCALARS" if ($scalars);
995 return "NDR_BUFFERS" if ($buffers);
999 sub ParseMemCtxPullFlags($$$$)
1001 my ($self, $e, $l) = @_;
1003 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1004 return undef if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore"));
1006 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1007 return undef if has_fast_array($e, $l);
1008 return undef if is_charset_array($e, $l);
1010 my $mem_flags = "0";
1012 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1013 my $nl = GetNextLevel($e, $l);
1014 return undef if ($nl->{TYPE} eq "PIPE");
1015 return undef if ($nl->{TYPE} eq "ARRAY");
1016 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1018 if ($l->{LEVEL} eq "TOP") {
1019 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1026 sub ParseMemCtxPullStart($$$$$)
1028 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1030 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1031 my $mem_c_ctx = $ptr_name;
1032 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1034 return unless defined($mem_c_flags);
1036 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1037 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1040 sub ParseMemCtxPullEnd($$$$)
1042 my ($self, $e, $l, $ndr) = @_;
1044 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1045 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1047 return unless defined($mem_r_flags);
1049 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1052 sub CheckStringTerminator($$$$$)
1054 my ($self,$ndr,$e,$l,$length) = @_;
1055 my $nl = GetNextLevel($e, $l);
1057 # Make sure last element is zero!
1058 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1061 sub ParseElementPullLevel
1063 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1065 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1066 my $array_length = undef;
1068 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1069 $var_name = get_pointer_to($var_name);
1072 # Only pull something if there's actually something to be pulled
1073 if (defined($ndr_flags)) {
1074 if ($l->{TYPE} eq "SUBCONTEXT") {
1075 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1076 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1077 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1078 } elsif ($l->{TYPE} eq "ARRAY") {
1079 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1080 $array_length = $length;
1082 if (my $range = has_property($e, "range")) {
1083 my ($low, $high) = split(/,/, $range, 2);
1085 warning(0, "$low is invalid for the range of an array size");
1088 $self->pidl("if ($length > $high) {");
1090 $self->pidl("if ($length < $low || $length > $high) {");
1092 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1096 my $nl = GetNextLevel($e, $l);
1098 if (is_charset_array($e,$l)) {
1099 if ($l->{IS_ZERO_TERMINATED}) {
1100 $self->CheckStringTerminator($ndr, $e, $l, $length);
1102 if ($l->{IS_TO_NULL}) {
1103 $self->pidl("NDR_CHECK(ndr_pull_charset_to_null($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
1105 $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}));");
1108 } elsif (has_fast_array($e, $l)) {
1109 if ($l->{IS_ZERO_TERMINATED}) {
1110 $self->CheckStringTerminator($ndr,$e,$l,$length);
1112 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1115 } elsif ($l->{TYPE} eq "POINTER") {
1116 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1117 } elsif ($l->{TYPE} eq "SWITCH") {
1118 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1119 } elsif ($l->{TYPE} eq "DATA") {
1120 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1121 } elsif ($l->{TYPE} eq "TYPEDEF") {
1122 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1126 # add additional constructions
1127 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
1128 $self->pidl("/* [ignore] '$e->{NAME}' */");
1129 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
1130 if ($l->{POINTER_TYPE} ne "ref") {
1131 $self->pidl("if ($var_name) {");
1134 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1135 $self->pidl("uint32_t _relative_save_offset;");
1136 $self->pidl("_relative_save_offset = $ndr->offset;");
1137 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1141 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1143 $var_name = get_value_of($var_name);
1144 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1146 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1148 if ($l->{POINTER_TYPE} ne "ref") {
1149 if ($l->{POINTER_TYPE} eq "relative") {
1150 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1152 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1155 $self->pidl("$ndr->offset = _relative_save_offset;");
1160 } elsif ($l->{TYPE} eq "ARRAY" and
1161 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1162 my $length = $array_length;
1163 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1164 my $array_name = $var_name;
1166 if (not defined($length)) {
1167 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1170 if (my $range = has_property($e, "range")) {
1171 my ($low, $high) = split(/,/, $range, 2);
1173 warning(0, "$low is invalid for the range of an array size");
1176 $self->pidl("if ($length > $high) {");
1178 $self->pidl("if ($length < $low || $length > $high) {");
1180 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1184 $var_name = get_array_element($var_name, $counter);
1186 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1188 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1189 my $nl = GetNextLevel($e,$l);
1191 if ($l->{IS_ZERO_TERMINATED}) {
1192 $self->CheckStringTerminator($ndr,$e,$l,$length);
1195 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1197 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1202 if ($deferred and ContainsDeferred($e, $l)) {
1203 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1205 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1210 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1212 } elsif ($l->{TYPE} eq "SWITCH") {
1213 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1217 #####################################################################
1218 # parse scalars in a structure element - pull size
1219 sub ParseElementPull($$$$$$)
1221 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1223 my $var_name = $env->{$e->{NAME}};
1227 return if ContainsPipe($e, $e->{LEVELS}[0]);
1229 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1231 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1234 $represent_name = $var_name;
1235 $transmit_name = "_transmit_$e->{NAME}";
1236 $var_name = $transmit_name;
1237 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1240 $var_name = append_prefix($e, $var_name);
1242 $self->start_flags($e, $ndr);
1244 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1246 $self->end_flags($e, $ndr);
1248 # Representation type is different from transmit_as
1249 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1250 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1256 #####################################################################
1257 # parse a pointer in a struct element or function
1258 sub ParsePtrPull($$$$$)
1260 my($self, $e,$l,$ndr,$var_name) = @_;
1262 my $nl = GetNextLevel($e, $l);
1263 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1264 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1265 ($nl->{DATA_TYPE} eq "string"));
1267 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1269 if (!$next_is_array and !$next_is_string) {
1270 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1271 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1276 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1277 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1278 } elsif (($l->{POINTER_TYPE} eq "unique") or
1279 ($l->{POINTER_TYPE} eq "relative") or
1280 ($l->{POINTER_TYPE} eq "full")) {
1281 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1282 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1283 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1284 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1285 #We want to consume the pointer bytes, but ignore the pointer value
1286 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1287 $self->pidl("_ptr_$e->{NAME} = 0;");
1289 die("Unhandled pointer type $l->{POINTER_TYPE}");
1292 $self->pidl("if (_ptr_$e->{NAME}) {");
1295 if ($l->{POINTER_TYPE} eq "ignore") {
1296 # Don't do anything, we don't want to do the
1297 # allocation, as we forced it to NULL just above, and
1298 # we may not know the declared type anyway.
1300 # Don't do this for arrays, they're allocated at the actual level
1302 unless ($next_is_array or $next_is_string) {
1303 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1305 # FIXME: Yes, this is nasty.
1306 # We allocate an array twice
1307 # - once just to indicate that it's there,
1308 # - then the real allocation...
1309 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1313 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1314 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1315 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1318 $self->pidl("} else {");
1319 $self->pidl("\t$var_name = NULL;");
1323 sub ParseStructPushPrimitives($$$$$)
1325 my ($self, $struct, $ndr, $varname, $env) = @_;
1327 # see if the structure contains a conformant array. If it
1328 # does, then it must be the last element of the structure, and
1329 # we need to push the conformant length early, as it fits on
1330 # the wire before the structure (and even before the structure
1332 if (defined($struct->{SURROUNDING_ELEMENT})) {
1333 my $e = $struct->{SURROUNDING_ELEMENT};
1335 if (defined($e->{LEVELS}[0]) and
1336 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1339 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1340 if (has_property($e, "charset")) {
1341 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1343 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1345 if (defined($e->{LEVELS}[0]->{SIZE_IS})) {
1346 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1349 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1352 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1354 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1358 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1360 if (defined($struct->{PROPERTIES}{relative_base})) {
1361 # set the current offset as base for relative pointers
1362 # and store it based on the toplevel struct/union
1363 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1366 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1368 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1371 sub ParseStructPushDeferred($$$$)
1373 my ($self, $struct, $ndr, $varname, $env) = @_;
1374 if (defined($struct->{PROPERTIES}{relative_base})) {
1375 # retrieve the current offset as base for relative pointers
1376 # based on the toplevel struct/union
1377 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1379 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1382 #####################################################################
1384 sub ParseStructPush($$$$)
1386 my ($self, $struct, $ndr, $varname) = @_;
1388 return unless defined($struct->{ELEMENTS});
1390 my $env = GenerateStructEnv($struct, $varname);
1392 EnvSubstituteValue($env, $struct);
1394 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1396 $self->start_flags($struct, $ndr);
1398 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1399 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1401 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1405 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1407 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1411 $self->end_flags($struct, $ndr);
1414 #####################################################################
1415 # generate a push function for an enum
1416 sub ParseEnumPush($$$$)
1418 my($self,$enum,$ndr,$varname) = @_;
1419 my($type_fn) = $enum->{BASE_TYPE};
1421 $self->start_flags($enum, $ndr);
1422 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1423 $self->end_flags($enum, $ndr);
1426 #####################################################################
1427 # generate a pull function for an enum
1428 sub ParseEnumPull($$$$)
1430 my($self,$enum,$ndr,$varname) = @_;
1431 my($type_fn) = $enum->{BASE_TYPE};
1432 my($type_v_decl) = mapTypeName($type_fn);
1434 $self->pidl("$type_v_decl v;");
1435 $self->start_flags($enum, $ndr);
1436 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1437 $self->pidl("*$varname = v;");
1439 $self->end_flags($enum, $ndr);
1442 #####################################################################
1443 # generate a print function for an enum
1444 sub ParseEnumPrint($$$$$)
1446 my($self,$enum,$ndr,$name,$varname) = @_;
1448 $self->pidl("const char *val = NULL;");
1451 $self->start_flags($enum, $ndr);
1453 $self->pidl("switch ($varname) {");
1455 my $els = \@{$enum->{ELEMENTS}};
1456 foreach my $i (0 .. $#{$els}) {
1457 my $e = ${$els}[$i];
1459 if ($e =~ /^(.*)=/) {
1462 $self->pidl("case $e: val = \"$e\"; break;");
1468 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1470 $self->end_flags($enum, $ndr);
1475 my ($e,$t,$name,$varname) = @_;
1476 return "enum $name " .
1477 ($t eq "pull"?"*":"") . $varname;
1480 $typefamily{ENUM} = {
1482 PUSH_FN_BODY => \&ParseEnumPush,
1483 PULL_FN_BODY => \&ParseEnumPull,
1484 PRINT_FN_BODY => \&ParseEnumPrint,
1487 #####################################################################
1488 # generate a push function for a bitmap
1489 sub ParseBitmapPush($$$$)
1491 my($self,$bitmap,$ndr,$varname) = @_;
1492 my($type_fn) = $bitmap->{BASE_TYPE};
1494 $self->start_flags($bitmap, $ndr);
1496 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1498 $self->end_flags($bitmap, $ndr);
1501 #####################################################################
1502 # generate a pull function for an bitmap
1503 sub ParseBitmapPull($$$$)
1505 my($self,$bitmap,$ndr,$varname) = @_;
1506 my $type_fn = $bitmap->{BASE_TYPE};
1507 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1509 $self->pidl("$type_decl v;");
1510 $self->start_flags($bitmap, $ndr);
1511 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1512 $self->pidl("*$varname = v;");
1514 $self->end_flags($bitmap, $ndr);
1517 #####################################################################
1518 # generate a print function for an bitmap
1519 sub ParseBitmapPrintElement($$$$$$)
1521 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1522 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1523 my($type_fn) = $bitmap->{BASE_TYPE};
1526 if ($e =~ /^(\w+) .*$/) {
1529 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1532 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1535 #####################################################################
1536 # generate a print function for an bitmap
1537 sub ParseBitmapPrint($$$$$)
1539 my($self,$bitmap,$ndr,$name,$varname) = @_;
1540 my($type_decl) = mapTypeName($bitmap->{TYPE});
1541 my($type_fn) = $bitmap->{BASE_TYPE};
1543 $self->start_flags($bitmap, $ndr);
1545 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1547 $self->pidl("$ndr->depth++;");
1548 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1549 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1551 $self->pidl("$ndr->depth--;");
1553 $self->end_flags($bitmap, $ndr);
1556 sub DeclBitmap($$$$)
1558 my ($e,$t,$name,$varname) = @_;
1559 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1560 ($t eq "pull"?" *":" ") . $varname;
1563 $typefamily{BITMAP} = {
1564 DECL => \&DeclBitmap,
1565 PUSH_FN_BODY => \&ParseBitmapPush,
1566 PULL_FN_BODY => \&ParseBitmapPull,
1567 PRINT_FN_BODY => \&ParseBitmapPrint,
1570 #####################################################################
1571 # generate a struct print function
1572 sub ParseStructPrint($$$$$)
1574 my($self,$struct,$ndr,$name,$varname) = @_;
1576 return unless defined $struct->{ELEMENTS};
1578 my $env = GenerateStructEnv($struct, $varname);
1580 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1582 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1583 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1585 $self->start_flags($struct, $ndr);
1587 $self->pidl("$ndr->depth++;");
1589 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1590 foreach (@{$struct->{ELEMENTS}});
1591 $self->pidl("$ndr->depth--;");
1593 $self->end_flags($struct, $ndr);
1596 sub DeclarePtrVariables($$)
1599 foreach my $l (@{$e->{LEVELS}}) {
1601 if ($l->{TYPE} eq "POINTER" and
1602 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1603 if ($l->{POINTER_TYPE} eq "relative_short") {
1606 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1612 sub DeclareArrayVariables($$)
1616 foreach my $l (@{$e->{LEVELS}}) {
1617 next if ($l->{TYPE} ne "ARRAY");
1618 next if has_fast_array($e,$l);
1619 next if is_charset_array($e,$l);
1620 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1624 sub DeclareArrayVariablesNoZero($$$)
1626 my ($self,$e,$env) = @_;
1628 foreach my $l (@{$e->{LEVELS}}) {
1629 next if ($l->{TYPE} ne "ARRAY");
1630 next if has_fast_array($e,$l);
1631 next if is_charset_array($e,$l);
1632 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1633 if ($length eq "0") {
1634 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1636 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1641 sub DeclareMemCtxVariables($$)
1644 foreach my $l (@{$e->{LEVELS}}) {
1645 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1647 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore")) {
1651 if (defined($mem_flags)) {
1652 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1657 sub ParseStructPullPrimitives($$$$$)
1659 my($self,$struct,$ndr,$varname,$env) = @_;
1661 if (defined $struct->{SURROUNDING_ELEMENT}) {
1662 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1665 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1667 if (defined($struct->{PROPERTIES}{relative_base})) {
1668 # set the current offset as base for relative pointers
1669 # and store it based on the toplevel struct/union
1670 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1673 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1675 $self->add_deferred();
1677 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1680 sub ParseStructPullDeferred($$$$$)
1682 my ($self,$struct,$ndr,$varname,$env) = @_;
1684 if (defined($struct->{PROPERTIES}{relative_base})) {
1685 # retrieve the current offset as base for relative pointers
1686 # based on the toplevel struct/union
1687 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1689 foreach my $e (@{$struct->{ELEMENTS}}) {
1690 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1693 $self->add_deferred();
1696 #####################################################################
1697 # parse a struct - pull side
1698 sub ParseStructPull($$$$)
1700 my($self,$struct,$ndr,$varname) = @_;
1702 return unless defined $struct->{ELEMENTS};
1704 # declare any internal pointers we need
1705 foreach my $e (@{$struct->{ELEMENTS}}) {
1706 $self->DeclarePtrVariables($e);
1707 $self->DeclareArrayVariables($e);
1708 $self->DeclareMemCtxVariables($e);
1711 $self->start_flags($struct, $ndr);
1713 my $env = GenerateStructEnv($struct, $varname);
1715 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
1716 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1718 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1721 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1723 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1727 $self->end_flags($struct, $ndr);
1730 #####################################################################
1731 # calculate size of ndr struct
1732 sub ParseStructNdrSize($$$$)
1734 my ($self,$t, $name, $varname) = @_;
1737 if (my $flags = has_property($t, "flag")) {
1738 $self->pidl("flags |= $flags;");
1740 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1743 sub DeclStruct($$$$)
1745 my ($e,$t,$name,$varname) = @_;
1746 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1749 sub ArgsStructNdrSize($$$)
1751 my ($d, $name, $varname) = @_;
1752 return "const struct $name *$varname, int flags";
1755 $typefamily{STRUCT} = {
1756 PUSH_FN_BODY => \&ParseStructPush,
1757 DECL => \&DeclStruct,
1758 PULL_FN_BODY => \&ParseStructPull,
1759 PRINT_FN_BODY => \&ParseStructPrint,
1760 SIZE_FN_BODY => \&ParseStructNdrSize,
1761 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1764 #####################################################################
1765 # calculate size of ndr struct
1766 sub ParseUnionNdrSize($$$)
1768 my ($self, $t, $name, $varname) = @_;
1771 if (my $flags = has_property($t, "flag")) {
1772 $self->pidl("flags |= $flags;");
1775 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1778 sub ParseUnionPushPrimitives($$$$)
1780 my ($self, $e, $ndr ,$varname) = @_;
1782 my $have_default = 0;
1784 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1786 if (defined($e->{SWITCH_TYPE})) {
1787 if (defined($e->{ALIGN})) {
1788 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1791 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1794 if (defined($e->{ALIGN})) {
1795 if ($e->{IS_MS_UNION}) {
1796 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1797 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1799 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1803 $self->pidl("switch (level) {");
1805 foreach my $el (@{$e->{ELEMENTS}}) {
1806 if ($el->{CASE} eq "default") {
1809 $self->pidl("$el->{CASE}: {");
1811 if ($el->{TYPE} ne "EMPTY") {
1813 if (defined($e->{PROPERTIES}{relative_base})) {
1814 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1815 # set the current offset as base for relative pointers
1816 # and store it based on the toplevel struct/union
1817 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1819 $self->DeclareArrayVariables($el);
1820 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1823 $self->pidl("break; }");
1826 if (! $have_default) {
1827 $self->pidl("default:");
1828 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1834 sub ParseUnionPushDeferred($$$$)
1836 my ($self,$e,$ndr,$varname) = @_;
1838 my $have_default = 0;
1840 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1841 if (defined($e->{PROPERTIES}{relative_base})) {
1842 # retrieve the current offset as base for relative pointers
1843 # based on the toplevel struct/union
1844 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1846 $self->pidl("switch (level) {");
1848 foreach my $el (@{$e->{ELEMENTS}}) {
1849 if ($el->{CASE} eq "default") {
1853 $self->pidl("$el->{CASE}:");
1854 if ($el->{TYPE} ne "EMPTY") {
1856 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1859 $self->pidl("break;");
1862 if (! $have_default) {
1863 $self->pidl("default:");
1864 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1870 #####################################################################
1871 # parse a union - push side
1872 sub ParseUnionPush($$$$)
1874 my ($self,$e,$ndr,$varname) = @_;
1875 my $have_default = 0;
1877 $self->start_flags($e, $ndr);
1879 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1880 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1882 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1885 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1887 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1890 $self->end_flags($e, $ndr);
1893 #####################################################################
1895 sub ParseUnionPrint($$$$$)
1897 my ($self,$e,$ndr,$name,$varname) = @_;
1898 my $have_default = 0;
1900 $self->pidl("uint32_t level;");
1901 foreach my $el (@{$e->{ELEMENTS}}) {
1902 $self->DeclareArrayVariables($el);
1905 $self->start_flags($e, $ndr);
1907 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1909 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1911 $self->pidl("switch (level) {");
1913 foreach my $el (@{$e->{ELEMENTS}}) {
1914 if ($el->{CASE} eq "default") {
1917 $self->pidl("$el->{CASE}:");
1918 if ($el->{TYPE} ne "EMPTY") {
1920 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1923 $self->pidl("break;");
1926 if (! $have_default) {
1927 $self->pidl("default:");
1928 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1933 $self->end_flags($e, $ndr);
1936 sub ParseUnionPullPrimitives($$$$$)
1938 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1939 my $have_default = 0;
1942 if (defined($switch_type)) {
1943 if (defined($e->{ALIGN})) {
1944 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1947 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1948 $self->pidl("if (_level != level) {");
1949 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1953 if (defined($e->{ALIGN})) {
1954 if ($e->{IS_MS_UNION}) {
1955 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1956 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1958 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1962 $self->pidl("switch (level) {");
1964 foreach my $el (@{$e->{ELEMENTS}}) {
1965 if ($el->{CASE} eq "default") {
1968 $self->pidl("$el->{CASE}: {");
1970 if ($el->{TYPE} ne "EMPTY") {
1972 if (defined($e->{PROPERTIES}{relative_base})) {
1973 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1974 # set the current offset as base for relative pointers
1975 # and store it based on the toplevel struct/union
1976 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1978 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1981 $self->pidl("break; }");
1984 if (! $have_default) {
1985 $self->pidl("default:");
1986 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1992 sub ParseUnionPullDeferred($$$$)
1994 my ($self,$e,$ndr,$varname) = @_;
1995 my $have_default = 0;
1997 if (defined($e->{PROPERTIES}{relative_base})) {
1998 # retrieve the current offset as base for relative pointers
1999 # based on the toplevel struct/union
2000 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
2002 $self->pidl("switch (level) {");
2004 foreach my $el (@{$e->{ELEMENTS}}) {
2005 if ($el->{CASE} eq "default") {
2009 $self->pidl("$el->{CASE}:");
2010 if ($el->{TYPE} ne "EMPTY") {
2012 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
2015 $self->pidl("break;");
2018 if (! $have_default) {
2019 $self->pidl("default:");
2020 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2028 #####################################################################
2029 # parse a union - pull side
2030 sub ParseUnionPull($$$$)
2032 my ($self,$e,$ndr,$varname) = @_;
2033 my $switch_type = $e->{SWITCH_TYPE};
2035 $self->pidl("uint32_t level;");
2036 if (defined($switch_type)) {
2037 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
2038 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
2040 $self->pidl(mapTypeName($switch_type) . " _level;");
2043 my %double_cases = ();
2044 foreach my $el (@{$e->{ELEMENTS}}) {
2045 next if ($el->{TYPE} eq "EMPTY");
2046 next if ($double_cases{"$el->{NAME}"});
2047 $self->DeclareMemCtxVariables($el);
2048 $self->DeclarePtrVariables($el);
2049 $self->DeclareArrayVariables($el);
2050 $double_cases{"$el->{NAME}"} = 1;
2053 $self->start_flags($e, $ndr);
2055 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
2057 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
2058 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2060 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2064 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2066 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2070 $self->add_deferred();
2072 $self->end_flags($e, $ndr);
2077 my ($e,$t,$name,$varname) = @_;
2078 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2081 sub ArgsUnionNdrSize($$)
2084 return "const union $name *r, uint32_t level, int flags";
2087 $typefamily{UNION} = {
2088 PUSH_FN_BODY => \&ParseUnionPush,
2089 DECL => \&DeclUnion,
2090 PULL_FN_BODY => \&ParseUnionPull,
2091 PRINT_FN_BODY => \&ParseUnionPrint,
2092 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2093 SIZE_FN_BODY => \&ParseUnionNdrSize,
2096 #####################################################################
2097 # parse a typedef - push side
2098 sub ParseTypedefPush($$$$)
2100 my($self,$e,$ndr,$varname) = @_;
2104 $env->{$e->{NAME}} = $varname;
2106 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2109 #####################################################################
2110 # parse a typedef - pull side
2111 sub ParseTypedefPull($$$$)
2113 my($self,$e,$ndr,$varname) = @_;
2117 $env->{$e->{NAME}} = $varname;
2119 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2122 #####################################################################
2123 # parse a typedef - print side
2124 sub ParseTypedefPrint($$$$$)
2126 my($self,$e,$ndr,$name,$varname) = @_;
2128 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2131 #####################################################################
2132 ## calculate the size of a structure
2133 sub ParseTypedefNdrSize($$$$)
2135 my($self,$t,$name,$varname) = @_;
2137 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2140 sub DeclTypedef($$$$)
2142 my ($e, $t, $name, $varname) = @_;
2144 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2147 sub ArgsTypedefNdrSize($$$)
2149 my ($d, $name, $varname) = @_;
2150 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2153 $typefamily{TYPEDEF} = {
2154 PUSH_FN_BODY => \&ParseTypedefPush,
2155 DECL => \&DeclTypedef,
2156 PULL_FN_BODY => \&ParseTypedefPull,
2157 PRINT_FN_BODY => \&ParseTypedefPrint,
2158 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2159 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2162 sub ParsePipePushChunk($$)
2164 my ($self, $t) = @_;
2167 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2168 my $struct = $pipe->{DATA};
2170 my $name = "$struct->{NAME}";
2174 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2176 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2178 return if has_property($t, "nopush");
2183 $self->ParseStructPush($struct, $ndr, $varname);
2186 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2189 $self->pidl("return NDR_ERR_SUCCESS;");
2195 sub ParsePipePullChunk($$)
2197 my ($self, $t) = @_;
2200 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2201 my $struct = $pipe->{DATA};
2203 my $name = "$struct->{NAME}";
2207 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2209 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2211 return if has_property($struct, "nopull");
2216 $self->ParseStructPull($struct, $ndr, $varname);
2219 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2222 $self->pidl("return NDR_ERR_SUCCESS;");
2228 sub ParsePipePrintChunk($$)
2230 my ($self, $t) = @_;
2233 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2234 my $struct = $pipe->{DATA};
2236 my $name = "$struct->{NAME}";
2240 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2242 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2244 return if (has_property($t, "noprint"));
2246 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2249 $self->ParseTypePrint($struct, $ndr, $varname);
2255 #####################################################################
2256 # parse a function - print side
2257 sub ParseFunctionPrint($$)
2259 my($self, $fn) = @_;
2262 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2264 return if has_property($fn, "noprint");
2266 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2270 foreach my $e (@{$fn->{ELEMENTS}}) {
2271 $self->DeclareArrayVariables($e);
2274 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2275 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2276 $self->pidl("$ndr->depth++;");
2278 $self->pidl("if (flags & NDR_SET_VALUES) {");
2279 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2282 $self->pidl("if (flags & NDR_IN) {");
2284 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2285 $self->pidl("$ndr->depth++;");
2287 my $env = GenerateFunctionInEnv($fn);
2289 foreach my $e (@{$fn->{ELEMENTS}}) {
2290 if (grep(/in/,@{$e->{DIRECTION}})) {
2291 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2294 $self->pidl("$ndr->depth--;");
2298 $self->pidl("if (flags & NDR_OUT) {");
2300 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2301 $self->pidl("$ndr->depth++;");
2303 $env = GenerateFunctionOutEnv($fn);
2304 foreach my $e (@{$fn->{ELEMENTS}}) {
2305 if (grep(/out/,@{$e->{DIRECTION}})) {
2306 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2309 if ($fn->{RETURN_TYPE}) {
2310 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2312 $self->pidl("$ndr->depth--;");
2316 $self->pidl("$ndr->depth--;");
2322 #####################################################################
2324 sub ParseFunctionPush($$)
2326 my($self, $fn) = @_;
2329 $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;
2331 return if has_property($fn, "nopush");
2336 foreach my $e (@{$fn->{ELEMENTS}}) {
2337 $self->DeclareArrayVariables($e);
2340 $self->pidl("NDR_PUSH_CHECK_FN_FLAGS(ndr, flags);");
2342 $self->pidl("if (flags & NDR_IN) {");
2345 my $env = GenerateFunctionInEnv($fn);
2347 EnvSubstituteValue($env, $fn);
2349 foreach my $e (@{$fn->{ELEMENTS}}) {
2350 if (grep(/in/,@{$e->{DIRECTION}})) {
2351 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2358 $self->pidl("if (flags & NDR_OUT) {");
2361 $env = GenerateFunctionOutEnv($fn);
2362 foreach my $e (@{$fn->{ELEMENTS}}) {
2363 if (grep(/out/,@{$e->{DIRECTION}})) {
2364 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2368 if ($fn->{RETURN_TYPE}) {
2369 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2374 $self->pidl("return NDR_ERR_SUCCESS;");
2380 sub AllocateArrayLevel($$$$$$)
2382 my ($self,$e,$l,$ndr,$var,$size) = @_;
2384 my $pl = GetPrevLevel($e, $l);
2385 if (defined($pl) and
2386 $pl->{TYPE} eq "POINTER" and
2387 $pl->{POINTER_TYPE} eq "ref"
2388 and not $l->{IS_ZERO_TERMINATED}) {
2389 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2390 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2392 if (grep(/in/,@{$e->{DIRECTION}}) and
2393 grep(/out/,@{$e->{DIRECTION}})) {
2394 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2399 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2402 #####################################################################
2404 sub ParseFunctionPull($$)
2409 # pull function args
2410 $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;
2415 # declare any internal pointers we need
2416 foreach my $e (@{$fn->{ELEMENTS}}) {
2417 $self->DeclarePtrVariables($e);
2418 $self->DeclareArrayVariables($e);
2421 my %double_cases = ();
2422 foreach my $e (@{$fn->{ELEMENTS}}) {
2423 next if ($e->{TYPE} eq "EMPTY");
2424 next if ($double_cases{"$e->{NAME}"});
2425 $self->DeclareMemCtxVariables($e);
2426 $double_cases{"$e->{NAME}"} = 1;
2429 $self->pidl("NDR_PULL_CHECK_FN_FLAGS(ndr, flags);");
2431 $self->pidl("if (flags & NDR_IN) {");
2434 # auto-init the out section of a structure. I originally argued that
2435 # this was a bad idea as it hides bugs, but coping correctly
2436 # with initialisation and not wiping ref vars is turning
2437 # out to be too tricky (tridge)
2438 foreach my $e (@{$fn->{ELEMENTS}}) {
2439 next unless grep(/out/, @{$e->{DIRECTION}});
2440 $self->pidl("ZERO_STRUCT(r->out);");
2445 my $env = GenerateFunctionInEnv($fn);
2447 foreach my $e (@{$fn->{ELEMENTS}}) {
2448 next unless (grep(/in/, @{$e->{DIRECTION}}));
2449 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2452 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2453 # own flag rather than be in NDR_IN ?
2455 foreach my $e (@{$fn->{ELEMENTS}}) {
2456 next unless (grep(/out/, @{$e->{DIRECTION}}));
2457 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2458 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2459 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2460 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2461 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2462 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2463 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2465 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2466 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2467 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2468 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2469 check_fully_dereferenced($e, $env));
2470 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2472 if (grep(/in/, @{$e->{DIRECTION}})) {
2473 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2475 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2477 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2478 if (grep(/in/, @{$e->{DIRECTION}})) {
2479 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2481 $self->pidl("r->out.$e->{NAME} = NULL;");
2484 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2486 if (grep(/in/, @{$e->{DIRECTION}})) {
2487 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2489 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2494 $self->add_deferred();
2498 $self->pidl("if (flags & NDR_OUT) {");
2501 $env = GenerateFunctionOutEnv($fn);
2502 foreach my $e (@{$fn->{ELEMENTS}}) {
2503 next unless grep(/out/, @{$e->{DIRECTION}});
2504 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2507 if ($fn->{RETURN_TYPE}) {
2508 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2511 $self->add_deferred();
2515 $self->pidl("return NDR_ERR_SUCCESS;");
2521 sub AuthServiceStruct($$$)
2523 my ($self, $ifacename, $authservice) = @_;
2524 my @a = split /,/, $authservice;
2525 my $authservice_count = $#a + 1;
2527 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2528 foreach my $ap (@a) {
2529 $self->pidl("\t$ap, ");
2534 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2535 $self->pidl("\t.count\t= $authservice_count,");
2536 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2541 sub ParseGeneratePipeArray($$$)
2543 my ($self, $fn, $direction) = @_;
2545 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2548 foreach my $e (@{$fn->{ELEMENTS}}) {
2549 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2550 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2552 my $cname = "$e->{TYPE}_chunk";
2556 $self->pidl("\"$direction.$e->{NAME}\",");
2557 $self->pidl("\"$cname\",");
2558 $self->pidl("sizeof(struct $cname),");
2559 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2560 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2561 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2565 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2571 sub FunctionCallPipes($$)
2573 my ($self, $d) = @_;
2574 return if not defined($d->{OPNUM});
2579 foreach my $e (@{$d->{ELEMENTS}}) {
2580 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2582 if (grep(/in/, @{$e->{DIRECTION}})) {
2585 if (grep(/out/, @{$e->{DIRECTION}})) {
2591 $self->ParseGeneratePipeArray($d, "in");
2595 $self->ParseGeneratePipeArray($d, "out");
2599 sub FunctionCallEntry($$)
2601 my ($self, $d) = @_;
2602 return 0 if not defined($d->{OPNUM});
2607 foreach my $e (@{$d->{ELEMENTS}}) {
2608 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2610 if (grep(/in/, @{$e->{DIRECTION}})) {
2613 if (grep(/out/, @{$e->{DIRECTION}})) {
2618 my $in_pipes_ptr = "NULL";
2619 my $out_pipes_ptr = "NULL";
2622 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2626 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2630 $self->pidl("\t\t\"$d->{NAME}\",");
2631 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2632 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2633 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2634 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2635 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2636 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2637 $self->pidl("\t},");
2641 #####################################################################
2642 # produce a function call table
2643 sub FunctionTable($$)
2645 my($self,$interface) = @_;
2647 my $uname = uc $interface->{NAME};
2649 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2650 return unless defined ($interface->{PROPERTIES}->{uuid});
2652 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2653 $self->FunctionCallPipes($d);
2656 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2658 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2659 $count += $self->FunctionCallEntry($d);
2661 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2665 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2666 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2667 $self->pidl("\t$ep, ");
2669 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2674 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2675 $self->pidl("\t.count\t= $endpoint_count,");
2676 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2680 if (! defined $interface->{PROPERTIES}->{authservice}) {
2681 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2684 $self->AuthServiceStruct($interface->{NAME},
2685 $interface->{PROPERTIES}->{authservice});
2687 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2688 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2689 $self->pidl("\t.syntax_id\t= {");
2690 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2691 $self->pidl("\t\tNDR_$uname\_VERSION");
2692 $self->pidl("\t},");
2693 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2694 $self->pidl("\t.num_calls\t= $count,");
2695 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2696 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2697 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2703 #####################################################################
2704 # generate include statements for imported idl files
2709 foreach (@imports) {
2710 $_ = unmake_str($_);
2712 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2716 #####################################################################
2717 # generate include statements for included header files
2722 foreach (@includes) {
2723 $self->pidl_hdr("#include $_");
2727 #####################################################################
2728 # generate prototypes and defines for the interface definitions
2729 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2730 # NDR parser and so do not belong here, technically speaking
2731 sub HeaderInterface($$$)
2733 my($self,$interface,$needed) = @_;
2737 if ($needed->{"compression"}) {
2738 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2741 if (has_property($interface, "object")) {
2742 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2745 if (defined $interface->{PROPERTIES}->{helper}) {
2746 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2749 if (defined $interface->{PROPERTIES}->{uuid}) {
2750 my $name = uc $interface->{NAME};
2751 $self->pidl_hdr("#define NDR_$name\_UUID " .
2752 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
2754 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
2756 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2758 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2759 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2761 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2764 foreach (@{$interface->{FUNCTIONS}}) {
2765 next if has_property($_, "noopnum");
2766 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2767 my $u_name = uc $_->{NAME};
2769 my $val = sprintf("0x%02x", $count);
2770 if (defined($interface->{BASE})) {
2771 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2774 $self->pidl_hdr("#define NDR_$u_name ($val)");
2776 $self->pidl_hdr("");
2782 if (defined($interface->{BASE})) {
2783 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2786 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2790 sub ParseTypePush($$$$$$)
2792 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2794 # save the old relative_base_offset
2795 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2796 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2797 # restore the old relative_base_offset
2798 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2801 sub ParseTypePushFunction($$$)
2803 my ($self, $e, $varname) = @_;
2806 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2808 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2812 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2813 $self->pidl("return NDR_ERR_SUCCESS;");
2819 sub ParseTypePull($$$$$$)
2821 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2823 # save the old relative_base_offset
2824 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2825 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2826 # restore the old relative_base_offset
2827 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2830 sub ParseTypePullFunction($$)
2832 my ($self, $e, $varname) = @_;
2835 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2837 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2841 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2842 $self->pidl("return NDR_ERR_SUCCESS;");
2848 sub ParseTypePrint($$$$)
2850 my ($self, $e, $ndr, $varname) = @_;
2852 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2855 sub ParseTypePrintFunction($$$)
2857 my ($self, $e, $varname) = @_;
2860 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2862 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2864 return if (has_property($e, "noprint"));
2866 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2869 $self->ParseTypePrint($e, $ndr, $varname);
2875 sub ParseTypeNdrSize($$)
2880 my $tf = $typefamily{$t->{TYPE}};
2881 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2883 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2887 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2893 #####################################################################
2894 # parse the interface definitions
2895 sub ParseInterface($$$)
2897 my($self,$interface,$needed) = @_;
2899 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2900 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2902 $self->pidl_hdr("");
2904 $self->HeaderInterface($interface, $needed);
2907 foreach my $d (@{$interface->{TYPES}}) {
2908 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2909 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2910 $self->ParsePipePushChunk($d);
2911 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2912 $self->ParsePipePullChunk($d);
2913 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2914 $self->ParsePipePrintChunk($d);
2916 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2917 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2918 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2922 next unless(typeHasBody($d));
2924 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2925 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2926 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2928 # Make sure we don't generate a function twice...
2929 $needed->{TypeFunctionName("ndr_push", $d)} =
2930 $needed->{TypeFunctionName("ndr_pull", $d)} =
2931 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2933 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2937 foreach my $d (@{$interface->{FUNCTIONS}}) {
2938 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2939 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2940 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2943 $self->FunctionTable($interface);
2945 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2948 sub GenerateIncludes($)
2952 $self->pidl("#include \"includes.h\"");
2954 $self->pidl("#ifndef _GNU_SOURCE");
2955 $self->pidl("#define _GNU_SOURCE");
2956 $self->pidl("#endif");
2957 $self->pidl("#include <stdint.h>");
2958 $self->pidl("#include <stdlib.h>");
2959 $self->pidl("#include <stdio.h>");
2960 $self->pidl("#include <stdbool.h>");
2961 $self->pidl("#include <stdarg.h>");
2962 $self->pidl("#include <string.h>");
2966 #####################################################################
2967 # parse a parsed IDL structure back into an IDL file
2970 my($self, $ndr,$gen_header,$ndr_header) = @_;
2972 $self->pidl_hdr("/* header auto-generated by pidl */");
2973 $self->pidl_hdr("");
2974 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2975 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2976 $self->pidl_hdr("");
2978 $self->pidl("/* parser auto-generated by pidl */");
2980 $self->GenerateIncludes();
2981 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2987 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2991 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2992 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2993 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2996 return ($self->{res_hdr}, $self->{res});
2999 sub NeededElement($$$)
3001 my ($e, $dir, $needed) = @_;
3003 return if ($e->{TYPE} eq "EMPTY");
3005 return if (ref($e->{TYPE}) eq "HASH" and
3006 not defined($e->{TYPE}->{NAME}));
3009 if (ref($e->{TYPE}) eq "HASH") {
3010 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
3015 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
3016 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
3018 $rt = $e->{REPRESENTATION_TYPE};
3021 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
3024 if ($dir eq "print") {
3025 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
3026 } elsif ($dir eq "pull") {
3027 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
3028 push (@fn, "ndr_$t\_to_$rt")
3030 } elsif ($dir eq "push") {
3031 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
3032 push (@fn, "ndr_$rt\_to_$t")
3035 die("invalid direction `$dir'");
3039 unless (defined($needed->{$_})) {
3045 sub NeededFunction($$)
3047 my ($fn,$needed) = @_;
3048 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
3049 $needed->{"ndr_push_$fn->{NAME}"} = 1;
3050 $needed->{"ndr_print_$fn->{NAME}"} = 1;
3051 foreach my $e (@{$fn->{ELEMENTS}}) {
3053 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3059 sub NeededType($$$);
3060 my ($t,$needed,$req) = @_;
3062 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3063 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3065 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3066 return unless defined($t->{ELEMENTS});
3067 for my $e (@{$t->{ELEMENTS}}) {
3069 if (has_property($e, "compression")) {
3070 $needed->{"compression"} = 1;
3072 NeededElement($e, $req, $needed);
3073 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3078 #####################################################################
3079 # work out what parse functions are needed
3080 sub NeededInterface($$)
3082 my ($interface,$needed) = @_;
3083 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3084 foreach (reverse @{$interface->{TYPES}}) {
3086 if (has_property($_, "public")) {
3087 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3088 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3091 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3092 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3093 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3094 if (has_property($_, "gensize")) {
3095 $needed->{"ndr_size_$_->{NAME}"} = 1;
3100 sub TypeFunctionName($$)
3102 my ($prefix, $t) = @_;
3104 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3105 $t->{TYPE} eq "TYPEDEF");
3106 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3107 return "$prefix\_$t";