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))";
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
203 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
206 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
207 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
210 if ($l->{IS_VARYING}) {
211 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));"); # array offset
212 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
218 sub check_fully_dereferenced($$)
220 my ($element, $env) = @_;
226 # Figure out the number of pointers in $ptr
227 my $expandedvar = $origvar;
228 $expandedvar =~ s/^(\**)//;
232 foreach (keys %$env) {
233 if ($env->{$_} eq $expandedvar) {
239 return($origvar) unless (defined($var));
241 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
242 if ($_->{NAME} eq $var) {
248 $e or die("Environment doesn't match siblings");
250 # See if pointer at pointer level $level
251 # needs to be checked.
253 foreach (@{$e->{LEVELS}}) {
254 if ($_->{TYPE} eq "POINTER") {
255 $nump = $_->{POINTER_INDEX}+1;
258 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
263 sub check_null_pointer($$$$)
265 my ($element, $env, $print_fn, $return) = @_;
268 my $expandedvar = shift;
271 # Figure out the number of pointers in $ptr
272 $expandedvar =~ s/^(\**)//;
276 foreach (keys %$env) {
277 if ($env->{$_} eq $expandedvar) {
286 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
287 if ($_->{NAME} eq $var) {
293 $e or die("Environment doesn't match siblings");
295 # See if pointer at pointer level $level
296 # needs to be checked.
297 foreach my $l (@{$e->{LEVELS}}) {
298 if ($l->{TYPE} eq "POINTER" and
299 $l->{POINTER_INDEX} == length($ptr)) {
300 # No need to check ref pointers
301 $check = ($l->{POINTER_TYPE} ne "ref");
305 if ($l->{TYPE} eq "DATA") {
306 warning($element, "too much dereferences for `$var'");
310 warning($element, "unknown dereferenced expression `$expandedvar'");
314 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
318 #####################################################################
319 # parse an array - pull side
320 sub ParseArrayPullHeader($$$$$$)
322 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
327 if ($l->{IS_CONFORMANT}) {
328 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
329 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
330 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
332 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
333 check_null_pointer($e, $env, sub { $self->pidl(shift); },
334 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
335 check_fully_dereferenced($e, $env));
338 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
339 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
342 if ($l->{IS_VARYING}) {
343 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
344 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
347 if ($length ne $size) {
348 $self->pidl("if ($length > $size) {");
350 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
355 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
356 $self->defer("if ($var_name) {");
358 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
359 check_null_pointer($e, $env, sub { $self->defer(shift); },
360 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
361 check_fully_dereferenced($e, $env));
362 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
363 $self->defer_deindent;
367 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
368 $self->defer("if ($var_name) {");
370 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
371 check_null_pointer($e, $env, sub { $self->defer(shift); },
372 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
373 check_fully_dereferenced($e, $env));
374 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
375 $self->defer_deindent;
379 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
380 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$size);
386 sub compression_alg($$)
389 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
394 sub compression_clen($$$)
396 my ($e, $l, $env) = @_;
397 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
399 return ParseExpr($clen, $env, $e->{ORIGINAL});
402 sub compression_dlen($$$)
404 my ($e,$l,$env) = @_;
405 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
407 return ParseExpr($dlen, $env, $e->{ORIGINAL});
410 sub ParseCompressionPushStart($$$$$)
412 my ($self,$e,$l,$ndr,$env) = @_;
413 my $comndr = "$ndr\_compressed";
414 my $alg = compression_alg($e, $l);
415 my $dlen = compression_dlen($e, $l, $env);
419 $self->pidl("struct ndr_push *$comndr;");
420 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
425 sub ParseCompressionPushEnd($$$$$)
427 my ($self,$e,$l,$ndr,$env) = @_;
428 my $comndr = "$ndr\_compressed";
429 my $alg = compression_alg($e, $l);
430 my $dlen = compression_dlen($e, $l, $env);
432 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
437 sub ParseCompressionPullStart($$$$$)
439 my ($self,$e,$l,$ndr,$env) = @_;
440 my $comndr = "$ndr\_compressed";
441 my $alg = compression_alg($e, $l);
442 my $dlen = compression_dlen($e, $l, $env);
446 $self->pidl("struct ndr_pull *$comndr;");
447 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
452 sub ParseCompressionPullEnd($$$$$)
454 my ($self,$e,$l,$ndr,$env) = @_;
455 my $comndr = "$ndr\_compressed";
456 my $alg = compression_alg($e, $l);
457 my $dlen = compression_dlen($e, $l, $env);
459 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
464 sub ParseSubcontextPushStart($$$$$)
466 my ($self,$e,$l,$ndr,$env) = @_;
467 my $subndr = "_ndr_$e->{NAME}";
468 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
472 $self->pidl("struct ndr_push *$subndr;");
473 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
475 if (defined $l->{COMPRESSION}) {
476 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
482 sub ParseSubcontextPushEnd($$$$$)
484 my ($self,$e,$l,$ndr,$env) = @_;
485 my $subndr = "_ndr_$e->{NAME}";
486 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
488 if (defined $l->{COMPRESSION}) {
489 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
492 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
497 sub ParseSubcontextPullStart($$$$$)
499 my ($self,$e,$l,$ndr,$env) = @_;
500 my $subndr = "_ndr_$e->{NAME}";
501 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
505 $self->pidl("struct ndr_pull *$subndr;");
506 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
508 if (defined $l->{COMPRESSION}) {
509 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
515 sub ParseSubcontextPullEnd($$$$$)
517 my ($self,$e,$l,$ndr,$env) = @_;
518 my $subndr = "_ndr_$e->{NAME}";
519 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
521 if (defined $l->{COMPRESSION}) {
522 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
525 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
530 sub ParseElementPushLevel
532 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
534 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
536 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
537 $var_name = get_pointer_to($var_name);
540 if (defined($ndr_flags)) {
541 if ($l->{TYPE} eq "SUBCONTEXT") {
542 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
543 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
544 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
545 } elsif ($l->{TYPE} eq "POINTER") {
546 $self->ParsePtrPush($e, $l, $ndr, $var_name);
547 } elsif ($l->{TYPE} eq "ARRAY") {
548 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
550 my $nl = GetNextLevel($e, $l);
552 # Allow speedups for arrays of scalar types
553 if (is_charset_array($e,$l)) {
554 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
556 } elsif (has_fast_array($e,$l)) {
557 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
560 } elsif ($l->{TYPE} eq "SWITCH") {
561 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
562 } elsif ($l->{TYPE} eq "DATA") {
563 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
564 } elsif ($l->{TYPE} eq "TYPEDEF") {
565 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
569 if ($l->{TYPE} eq "POINTER" and $deferred) {
570 my $rel_var_name = $var_name;
571 if ($l->{POINTER_TYPE} ne "ref") {
572 $self->pidl("if ($var_name) {");
574 if ($l->{POINTER_TYPE} eq "relative") {
575 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
577 if ($l->{POINTER_TYPE} eq "relative_short") {
578 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
581 $var_name = get_value_of($var_name);
582 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
584 if ($l->{POINTER_TYPE} ne "ref") {
585 if ($l->{POINTER_TYPE} eq "relative") {
586 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
591 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
592 not is_charset_array($e, $l)) {
593 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
594 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
596 my $array_pointless = ($length eq "0");
598 if ($array_pointless) {
599 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
602 $var_name = get_array_element($var_name, $counter);
604 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
605 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
607 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
612 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
613 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
615 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
619 } elsif ($l->{TYPE} eq "SWITCH") {
620 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
624 #####################################################################
625 # parse scalars in a structure element
626 sub ParseElementPush($$$$$$)
628 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
631 my $var_name = $env->{$e->{NAME}};
633 return if ContainsPipe($e, $e->{LEVELS}[0]);
635 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
637 # Representation type is different from transmit_as
638 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
641 my $transmit_name = "_transmit_$e->{NAME}";
642 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
643 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
644 $var_name = $transmit_name;
647 $var_name = append_prefix($e, $var_name);
649 $self->start_flags($e, $ndr);
651 if (defined(my $value = has_property($e, "value"))) {
652 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
655 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
657 $self->end_flags($e, $ndr);
659 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
665 #####################################################################
666 # parse a pointer in a struct element or function
667 sub ParsePtrPush($$$$$)
669 my ($self,$e,$l,$ndr,$var_name) = @_;
671 if ($l->{POINTER_TYPE} eq "ref") {
672 $self->pidl("if ($var_name == NULL) {");
674 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
677 if ($l->{LEVEL} eq "EMBEDDED") {
678 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
680 } elsif ($l->{POINTER_TYPE} eq "relative") {
681 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
682 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
683 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
684 } elsif ($l->{POINTER_TYPE} eq "unique") {
685 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
686 } elsif ($l->{POINTER_TYPE} eq "full") {
687 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
689 die("Unhandled pointer type $l->{POINTER_TYPE}");
693 sub need_pointer_to($$$)
695 my ($e, $l, $scalar_only) = @_;
698 if (ref($l->{DATA_TYPE})) {
699 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
701 $t = $l->{DATA_TYPE};
704 if (not Parse::Pidl::Typelist::is_scalar($t)) {
705 return 1 if $scalar_only;
710 foreach my $tl (@{$e->{LEVELS}}) {
712 if ($tl->{TYPE} eq "ARRAY") {
717 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
718 return 1 unless $arrays;
724 sub ParseDataPrint($$$$$)
726 my ($self, $e, $l, $ndr, $var_name) = @_;
728 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
730 if (need_pointer_to($e, $l, 1)) {
731 $var_name = get_pointer_to($var_name);
734 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
736 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
740 #####################################################################
741 # print scalars in a structure element
742 sub ParseElementPrint($$$$$)
744 my($self, $e, $ndr, $var_name, $env) = @_;
746 return if (has_property($e, "noprint"));
748 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
749 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
753 $var_name = append_prefix($e, $var_name);
755 if (defined(my $value = has_property($e, "value"))) {
756 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
759 foreach my $l (@{$e->{LEVELS}}) {
760 if ($l->{TYPE} eq "POINTER") {
761 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
762 $self->pidl("$ndr->depth++;");
763 if ($l->{POINTER_TYPE} ne "ref") {
764 $self->pidl("if ($var_name) {");
767 $var_name = get_value_of($var_name);
768 } elsif ($l->{TYPE} eq "ARRAY") {
771 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
772 $var_name = get_pointer_to($var_name);
775 if ($l->{IS_ZERO_TERMINATED}) {
776 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
778 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
779 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
782 if (is_charset_array($e,$l)) {
783 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
785 } elsif (has_fast_array($e, $l)) {
786 my $nl = GetNextLevel($e, $l);
787 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
790 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
792 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
793 $self->pidl("$ndr->depth++;");
794 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
797 $var_name = get_array_element($var_name, $counter);
799 } elsif ($l->{TYPE} eq "DATA") {
800 $self->ParseDataPrint($e, $l, $ndr, $var_name);
801 } elsif ($l->{TYPE} eq "SWITCH") {
802 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
803 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
804 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
808 foreach my $l (reverse @{$e->{LEVELS}}) {
809 if ($l->{TYPE} eq "POINTER") {
810 if ($l->{POINTER_TYPE} ne "ref") {
814 $self->pidl("$ndr->depth--;");
815 } elsif (($l->{TYPE} eq "ARRAY")
816 and not is_charset_array($e,$l)
817 and not has_fast_array($e,$l)) {
820 $self->pidl("$ndr->depth--;");
825 #####################################################################
826 # parse scalars in a structure element - pull size
827 sub ParseSwitchPull($$$$$$)
829 my($self,$e,$l,$ndr,$var_name,$env) = @_;
830 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
831 check_null_pointer($e, $env, sub { $self->pidl(shift); },
832 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
833 check_fully_dereferenced($e, $env));
835 $var_name = get_pointer_to($var_name);
836 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
839 #####################################################################
840 # push switch element
841 sub ParseSwitchPush($$$$$$)
843 my($self,$e,$l,$ndr,$var_name,$env) = @_;
844 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
845 check_null_pointer($e, $env, sub { $self->pidl(shift); },
846 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
847 check_fully_dereferenced($e, $env));
849 $var_name = get_pointer_to($var_name);
850 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
853 sub ParseDataPull($$$$$$$)
855 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
857 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
859 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
861 if (need_pointer_to($e, $l, 0)) {
862 $var_name = get_pointer_to($var_name);
865 $var_name = get_pointer_to($var_name);
867 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
869 my $pl = GetPrevLevel($e, $l);
871 my $range = has_property($e, "range");
872 if ($range and $pl->{TYPE} ne "ARRAY") {
873 $var_name = get_value_of($var_name);
874 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
875 my ($low, $high) = split(/,/, $range, 2);
876 if ($low < 0 and not $signed) {
877 warning(0, "$low is invalid for the range of an unsigned type");
879 if ($low == 0 and not $signed) {
880 $self->pidl("if ($var_name > $high) {");
882 $self->pidl("if ($var_name < $low || $var_name > $high) {");
884 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
888 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
892 sub ParseDataPush($$$$$$$)
894 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
896 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
898 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
900 # strings are passed by value rather than reference
901 if (need_pointer_to($e, $l, 1)) {
902 $var_name = get_pointer_to($var_name);
905 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
907 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
911 sub CalcNdrFlags($$$)
913 my ($l,$primitives,$deferred) = @_;
918 # Add NDR_SCALARS if this one is deferred
919 # and deferreds may be pushed
920 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
922 # Add NDR_SCALARS if this one is not deferred and
923 # primitives may be pushed
924 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
926 # Add NDR_BUFFERS if this one contains deferred stuff
927 # and deferreds may be pushed
928 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
930 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
931 return "NDR_SCALARS" if ($scalars);
932 return "NDR_BUFFERS" if ($buffers);
936 sub ParseMemCtxPullFlags($$$$)
938 my ($self, $e, $l) = @_;
940 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
942 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
943 return undef if has_fast_array($e, $l);
944 return undef if is_charset_array($e, $l);
948 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
949 my $nl = GetNextLevel($e, $l);
950 return undef if ($nl->{TYPE} eq "PIPE");
951 return undef if ($nl->{TYPE} eq "ARRAY");
952 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
954 if ($l->{LEVEL} eq "TOP") {
955 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
962 sub ParseMemCtxPullStart($$$$$)
964 my ($self, $e, $l, $ndr, $ptr_name) = @_;
966 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
967 my $mem_c_ctx = $ptr_name;
968 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
970 return unless defined($mem_c_flags);
972 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
973 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
976 sub ParseMemCtxPullEnd($$$$)
978 my ($self, $e, $l, $ndr) = @_;
980 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
981 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
983 return unless defined($mem_r_flags);
985 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
988 sub CheckStringTerminator($$$$$)
990 my ($self,$ndr,$e,$l,$length) = @_;
991 my $nl = GetNextLevel($e, $l);
993 # Make sure last element is zero!
994 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
997 sub ParseElementPullLevel
999 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1001 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1003 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1004 $var_name = get_pointer_to($var_name);
1007 # Only pull something if there's actually something to be pulled
1008 if (defined($ndr_flags)) {
1009 if ($l->{TYPE} eq "SUBCONTEXT") {
1010 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1011 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1012 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1013 } elsif ($l->{TYPE} eq "ARRAY") {
1014 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1016 if (my $range = has_property($e, "range")) {
1017 my ($low, $high) = split(/,/, $range, 2);
1019 warning(0, "$low is invalid for the range of an array size");
1022 $self->pidl("if ($length > $high) {");
1024 $self->pidl("if ($length < $low || $length > $high) {");
1026 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1030 my $nl = GetNextLevel($e, $l);
1032 if (is_charset_array($e,$l)) {
1033 if ($l->{IS_ZERO_TERMINATED}) {
1034 $self->CheckStringTerminator($ndr, $e, $l, $length);
1036 if ($l->{IS_TO_NULL}) {
1037 $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}));");
1039 $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}));");
1042 } elsif (has_fast_array($e, $l)) {
1043 if ($l->{IS_ZERO_TERMINATED}) {
1044 $self->CheckStringTerminator($ndr,$e,$l,$length);
1046 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1049 } elsif ($l->{TYPE} eq "POINTER") {
1050 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1051 } elsif ($l->{TYPE} eq "SWITCH") {
1052 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1053 } elsif ($l->{TYPE} eq "DATA") {
1054 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1055 } elsif ($l->{TYPE} eq "TYPEDEF") {
1056 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1060 # add additional constructions
1061 if ($l->{TYPE} eq "POINTER" and $deferred) {
1062 if ($l->{POINTER_TYPE} ne "ref") {
1063 $self->pidl("if ($var_name) {");
1066 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1067 $self->pidl("uint32_t _relative_save_offset;");
1068 $self->pidl("_relative_save_offset = $ndr->offset;");
1069 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1073 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1075 $var_name = get_value_of($var_name);
1076 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1078 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1080 if ($l->{POINTER_TYPE} ne "ref") {
1081 if ($l->{POINTER_TYPE} eq "relative") {
1082 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1084 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1087 $self->pidl("$ndr->offset = _relative_save_offset;");
1092 } elsif ($l->{TYPE} eq "ARRAY" and
1093 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1094 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1095 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1096 my $array_name = $var_name;
1098 if ($l->{IS_VARYING}) {
1099 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
1102 if (my $range = has_property($e, "range")) {
1103 my ($low, $high) = split(/,/, $range, 2);
1105 warning(0, "$low is invalid for the range of an array size");
1108 $self->pidl("if ($length > $high) {");
1110 $self->pidl("if ($length < $low || $length > $high) {");
1112 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1116 $var_name = get_array_element($var_name, $counter);
1118 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1120 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1121 my $nl = GetNextLevel($e,$l);
1123 if ($l->{IS_ZERO_TERMINATED}) {
1124 $self->CheckStringTerminator($ndr,$e,$l,$length);
1127 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1129 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1134 if ($deferred and ContainsDeferred($e, $l)) {
1135 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1137 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1142 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1144 } elsif ($l->{TYPE} eq "SWITCH") {
1145 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1149 #####################################################################
1150 # parse scalars in a structure element - pull size
1151 sub ParseElementPull($$$$$$)
1153 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1155 my $var_name = $env->{$e->{NAME}};
1159 return if ContainsPipe($e, $e->{LEVELS}[0]);
1161 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1163 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1166 $represent_name = $var_name;
1167 $transmit_name = "_transmit_$e->{NAME}";
1168 $var_name = $transmit_name;
1169 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1172 $var_name = append_prefix($e, $var_name);
1174 $self->start_flags($e, $ndr);
1176 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1178 $self->end_flags($e, $ndr);
1180 # Representation type is different from transmit_as
1181 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1182 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1188 #####################################################################
1189 # parse a pointer in a struct element or function
1190 sub ParsePtrPull($$$$$)
1192 my($self, $e,$l,$ndr,$var_name) = @_;
1194 my $nl = GetNextLevel($e, $l);
1195 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1196 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1197 ($nl->{DATA_TYPE} eq "string"));
1199 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1201 if (!$next_is_array and !$next_is_string) {
1202 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1203 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1208 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1209 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1210 } elsif (($l->{POINTER_TYPE} eq "unique") or
1211 ($l->{POINTER_TYPE} eq "relative") or
1212 ($l->{POINTER_TYPE} eq "full")) {
1213 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1214 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1215 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1217 die("Unhandled pointer type $l->{POINTER_TYPE}");
1220 $self->pidl("if (_ptr_$e->{NAME}) {");
1223 # Don't do this for arrays, they're allocated at the actual level
1225 unless ($next_is_array or $next_is_string) {
1226 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1228 # FIXME: Yes, this is nasty.
1229 # We allocate an array twice
1230 # - once just to indicate that it's there,
1231 # - then the real allocation...
1232 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1235 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1236 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1237 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1240 $self->pidl("} else {");
1241 $self->pidl("\t$var_name = NULL;");
1245 sub ParseStructPushPrimitives($$$$$)
1247 my ($self, $struct, $ndr, $varname, $env) = @_;
1249 # see if the structure contains a conformant array. If it
1250 # does, then it must be the last element of the structure, and
1251 # we need to push the conformant length early, as it fits on
1252 # the wire before the structure (and even before the structure
1254 if (defined($struct->{SURROUNDING_ELEMENT})) {
1255 my $e = $struct->{SURROUNDING_ELEMENT};
1257 if (defined($e->{LEVELS}[0]) and
1258 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1261 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1262 if (has_property($e, "charset")) {
1263 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1265 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1268 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1271 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1273 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1277 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1279 if (defined($struct->{PROPERTIES}{relative_base})) {
1280 # set the current offset as base for relative pointers
1281 # and store it based on the toplevel struct/union
1282 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1285 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1287 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1290 sub ParseStructPushDeferred($$$$)
1292 my ($self, $struct, $ndr, $varname, $env) = @_;
1293 if (defined($struct->{PROPERTIES}{relative_base})) {
1294 # retrieve the current offset as base for relative pointers
1295 # based on the toplevel struct/union
1296 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1298 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1301 #####################################################################
1303 sub ParseStructPush($$$$)
1305 my ($self, $struct, $ndr, $varname) = @_;
1307 return unless defined($struct->{ELEMENTS});
1309 my $env = GenerateStructEnv($struct, $varname);
1311 EnvSubstituteValue($env, $struct);
1313 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1315 $self->start_flags($struct, $ndr);
1317 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1319 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1323 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1325 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1329 $self->end_flags($struct, $ndr);
1332 #####################################################################
1333 # generate a push function for an enum
1334 sub ParseEnumPush($$$$)
1336 my($self,$enum,$ndr,$varname) = @_;
1337 my($type_fn) = $enum->{BASE_TYPE};
1339 $self->start_flags($enum, $ndr);
1340 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1341 $self->end_flags($enum, $ndr);
1344 #####################################################################
1345 # generate a pull function for an enum
1346 sub ParseEnumPull($$$$)
1348 my($self,$enum,$ndr,$varname) = @_;
1349 my($type_fn) = $enum->{BASE_TYPE};
1350 my($type_v_decl) = mapTypeName($type_fn);
1352 $self->pidl("$type_v_decl v;");
1353 $self->start_flags($enum, $ndr);
1354 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1355 $self->pidl("*$varname = v;");
1357 $self->end_flags($enum, $ndr);
1360 #####################################################################
1361 # generate a print function for an enum
1362 sub ParseEnumPrint($$$$$)
1364 my($self,$enum,$ndr,$name,$varname) = @_;
1366 $self->pidl("const char *val = NULL;");
1369 $self->start_flags($enum, $ndr);
1371 $self->pidl("switch ($varname) {");
1373 my $els = \@{$enum->{ELEMENTS}};
1374 foreach my $i (0 .. $#{$els}) {
1375 my $e = ${$els}[$i];
1377 if ($e =~ /^(.*)=/) {
1380 $self->pidl("case $e: val = \"$e\"; break;");
1386 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1388 $self->end_flags($enum, $ndr);
1393 my ($e,$t,$name,$varname) = @_;
1394 return "enum $name " .
1395 ($t eq "pull"?"*":"") . $varname;
1398 $typefamily{ENUM} = {
1400 PUSH_FN_BODY => \&ParseEnumPush,
1401 PULL_FN_BODY => \&ParseEnumPull,
1402 PRINT_FN_BODY => \&ParseEnumPrint,
1405 #####################################################################
1406 # generate a push function for a bitmap
1407 sub ParseBitmapPush($$$$)
1409 my($self,$bitmap,$ndr,$varname) = @_;
1410 my($type_fn) = $bitmap->{BASE_TYPE};
1412 $self->start_flags($bitmap, $ndr);
1414 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1416 $self->end_flags($bitmap, $ndr);
1419 #####################################################################
1420 # generate a pull function for an bitmap
1421 sub ParseBitmapPull($$$$)
1423 my($self,$bitmap,$ndr,$varname) = @_;
1424 my $type_fn = $bitmap->{BASE_TYPE};
1425 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1427 $self->pidl("$type_decl v;");
1428 $self->start_flags($bitmap, $ndr);
1429 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1430 $self->pidl("*$varname = v;");
1432 $self->end_flags($bitmap, $ndr);
1435 #####################################################################
1436 # generate a print function for an bitmap
1437 sub ParseBitmapPrintElement($$$$$$)
1439 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1440 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1441 my($type_fn) = $bitmap->{BASE_TYPE};
1444 if ($e =~ /^(\w+) .*$/) {
1447 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1450 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1453 #####################################################################
1454 # generate a print function for an bitmap
1455 sub ParseBitmapPrint($$$$$)
1457 my($self,$bitmap,$ndr,$name,$varname) = @_;
1458 my($type_decl) = mapTypeName($bitmap->{TYPE});
1459 my($type_fn) = $bitmap->{BASE_TYPE};
1461 $self->start_flags($bitmap, $ndr);
1463 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1465 $self->pidl("$ndr->depth++;");
1466 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1467 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1469 $self->pidl("$ndr->depth--;");
1471 $self->end_flags($bitmap, $ndr);
1474 sub DeclBitmap($$$$)
1476 my ($e,$t,$name,$varname) = @_;
1477 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1478 ($t eq "pull"?" *":" ") . $varname;
1481 $typefamily{BITMAP} = {
1482 DECL => \&DeclBitmap,
1483 PUSH_FN_BODY => \&ParseBitmapPush,
1484 PULL_FN_BODY => \&ParseBitmapPull,
1485 PRINT_FN_BODY => \&ParseBitmapPrint,
1488 #####################################################################
1489 # generate a struct print function
1490 sub ParseStructPrint($$$$$)
1492 my($self,$struct,$ndr,$name,$varname) = @_;
1494 return unless defined $struct->{ELEMENTS};
1496 my $env = GenerateStructEnv($struct, $varname);
1498 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1500 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1501 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1503 $self->start_flags($struct, $ndr);
1505 $self->pidl("$ndr->depth++;");
1507 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1508 foreach (@{$struct->{ELEMENTS}});
1509 $self->pidl("$ndr->depth--;");
1511 $self->end_flags($struct, $ndr);
1514 sub DeclarePtrVariables($$)
1517 foreach my $l (@{$e->{LEVELS}}) {
1519 if ($l->{TYPE} eq "POINTER" and
1520 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1521 if ($l->{POINTER_TYPE} eq "relative_short") {
1524 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1530 sub DeclareArrayVariables($$)
1534 foreach my $l (@{$e->{LEVELS}}) {
1535 next if has_fast_array($e,$l);
1536 next if is_charset_array($e,$l);
1537 if ($l->{TYPE} eq "ARRAY") {
1538 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1543 sub DeclareArrayVariablesNoZero($$$)
1545 my ($self,$e,$env) = @_;
1547 foreach my $l (@{$e->{LEVELS}}) {
1548 next if has_fast_array($e,$l);
1549 next if is_charset_array($e,$l);
1550 if ($l->{TYPE} eq "ARRAY") {
1551 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1552 if ($length eq "0") {
1553 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1555 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1561 sub DeclareMemCtxVariables($$)
1564 foreach my $l (@{$e->{LEVELS}}) {
1565 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1566 if (defined($mem_flags)) {
1567 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1572 sub ParseStructPullPrimitives($$$$$)
1574 my($self,$struct,$ndr,$varname,$env) = @_;
1576 if (defined $struct->{SURROUNDING_ELEMENT}) {
1577 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1580 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1582 if (defined($struct->{PROPERTIES}{relative_base})) {
1583 # set the current offset as base for relative pointers
1584 # and store it based on the toplevel struct/union
1585 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1588 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1590 $self->add_deferred();
1592 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1595 sub ParseStructPullDeferred($$$$$)
1597 my ($self,$struct,$ndr,$varname,$env) = @_;
1599 if (defined($struct->{PROPERTIES}{relative_base})) {
1600 # retrieve the current offset as base for relative pointers
1601 # based on the toplevel struct/union
1602 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1604 foreach my $e (@{$struct->{ELEMENTS}}) {
1605 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1608 $self->add_deferred();
1611 #####################################################################
1612 # parse a struct - pull side
1613 sub ParseStructPull($$$$)
1615 my($self,$struct,$ndr,$varname) = @_;
1617 return unless defined $struct->{ELEMENTS};
1619 # declare any internal pointers we need
1620 foreach my $e (@{$struct->{ELEMENTS}}) {
1621 $self->DeclarePtrVariables($e);
1622 $self->DeclareArrayVariables($e);
1623 $self->DeclareMemCtxVariables($e);
1626 $self->start_flags($struct, $ndr);
1628 my $env = GenerateStructEnv($struct, $varname);
1630 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1632 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1635 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1637 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1641 $self->end_flags($struct, $ndr);
1644 #####################################################################
1645 # calculate size of ndr struct
1646 sub ParseStructNdrSize($$$$)
1648 my ($self,$t, $name, $varname) = @_;
1651 if (my $flags = has_property($t, "flag")) {
1652 $self->pidl("flags |= $flags;");
1654 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1657 sub DeclStruct($$$$)
1659 my ($e,$t,$name,$varname) = @_;
1660 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1663 sub ArgsStructNdrSize($$$)
1665 my ($d, $name, $varname) = @_;
1666 return "const struct $name *$varname, int flags";
1669 $typefamily{STRUCT} = {
1670 PUSH_FN_BODY => \&ParseStructPush,
1671 DECL => \&DeclStruct,
1672 PULL_FN_BODY => \&ParseStructPull,
1673 PRINT_FN_BODY => \&ParseStructPrint,
1674 SIZE_FN_BODY => \&ParseStructNdrSize,
1675 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1678 #####################################################################
1679 # calculate size of ndr struct
1680 sub ParseUnionNdrSize($$$)
1682 my ($self, $t, $name, $varname) = @_;
1685 if (my $flags = has_property($t, "flag")) {
1686 $self->pidl("flags |= $flags;");
1689 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1692 sub ParseUnionPushPrimitives($$$$)
1694 my ($self, $e, $ndr ,$varname) = @_;
1696 my $have_default = 0;
1698 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1700 if (defined($e->{SWITCH_TYPE})) {
1701 if (defined($e->{ALIGN})) {
1702 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1705 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1708 if (defined($e->{ALIGN})) {
1709 if ($e->{IS_MS_UNION}) {
1710 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1711 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1713 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1717 $self->pidl("switch (level) {");
1719 foreach my $el (@{$e->{ELEMENTS}}) {
1720 if ($el->{CASE} eq "default") {
1723 $self->pidl("$el->{CASE}: {");
1725 if ($el->{TYPE} ne "EMPTY") {
1727 if (defined($e->{PROPERTIES}{relative_base})) {
1728 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1729 # set the current offset as base for relative pointers
1730 # and store it based on the toplevel struct/union
1731 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1733 $self->DeclareArrayVariables($el);
1734 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1737 $self->pidl("break; }");
1740 if (! $have_default) {
1741 $self->pidl("default:");
1742 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1748 sub ParseUnionPushDeferred($$$$)
1750 my ($self,$e,$ndr,$varname) = @_;
1752 my $have_default = 0;
1754 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1755 if (defined($e->{PROPERTIES}{relative_base})) {
1756 # retrieve the current offset as base for relative pointers
1757 # based on the toplevel struct/union
1758 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1760 $self->pidl("switch (level) {");
1762 foreach my $el (@{$e->{ELEMENTS}}) {
1763 if ($el->{CASE} eq "default") {
1767 $self->pidl("$el->{CASE}:");
1768 if ($el->{TYPE} ne "EMPTY") {
1770 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1773 $self->pidl("break;");
1776 if (! $have_default) {
1777 $self->pidl("default:");
1778 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1784 #####################################################################
1785 # parse a union - push side
1786 sub ParseUnionPush($$$$)
1788 my ($self,$e,$ndr,$varname) = @_;
1789 my $have_default = 0;
1791 $self->start_flags($e, $ndr);
1793 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1795 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1798 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1800 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1803 $self->end_flags($e, $ndr);
1806 #####################################################################
1808 sub ParseUnionPrint($$$$$)
1810 my ($self,$e,$ndr,$name,$varname) = @_;
1811 my $have_default = 0;
1813 $self->pidl("uint32_t level;");
1814 foreach my $el (@{$e->{ELEMENTS}}) {
1815 $self->DeclareArrayVariables($el);
1818 $self->start_flags($e, $ndr);
1820 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1822 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1824 $self->pidl("switch (level) {");
1826 foreach my $el (@{$e->{ELEMENTS}}) {
1827 if ($el->{CASE} eq "default") {
1830 $self->pidl("$el->{CASE}:");
1831 if ($el->{TYPE} ne "EMPTY") {
1833 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1836 $self->pidl("break;");
1839 if (! $have_default) {
1840 $self->pidl("default:");
1841 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1846 $self->end_flags($e, $ndr);
1849 sub ParseUnionPullPrimitives($$$$$)
1851 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1852 my $have_default = 0;
1855 if (defined($switch_type)) {
1856 if (defined($e->{ALIGN})) {
1857 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1860 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1861 $self->pidl("if (_level != level) {");
1862 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1866 if (defined($e->{ALIGN})) {
1867 if ($e->{IS_MS_UNION}) {
1868 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1869 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1871 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1875 $self->pidl("switch (level) {");
1877 foreach my $el (@{$e->{ELEMENTS}}) {
1878 if ($el->{CASE} eq "default") {
1881 $self->pidl("$el->{CASE}: {");
1883 if ($el->{TYPE} ne "EMPTY") {
1885 if (defined($e->{PROPERTIES}{relative_base})) {
1886 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1887 # set the current offset as base for relative pointers
1888 # and store it based on the toplevel struct/union
1889 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1891 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1894 $self->pidl("break; }");
1897 if (! $have_default) {
1898 $self->pidl("default:");
1899 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1905 sub ParseUnionPullDeferred($$$$)
1907 my ($self,$e,$ndr,$varname) = @_;
1908 my $have_default = 0;
1910 if (defined($e->{PROPERTIES}{relative_base})) {
1911 # retrieve the current offset as base for relative pointers
1912 # based on the toplevel struct/union
1913 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1915 $self->pidl("switch (level) {");
1917 foreach my $el (@{$e->{ELEMENTS}}) {
1918 if ($el->{CASE} eq "default") {
1922 $self->pidl("$el->{CASE}:");
1923 if ($el->{TYPE} ne "EMPTY") {
1925 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1928 $self->pidl("break;");
1931 if (! $have_default) {
1932 $self->pidl("default:");
1933 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1941 #####################################################################
1942 # parse a union - pull side
1943 sub ParseUnionPull($$$$)
1945 my ($self,$e,$ndr,$varname) = @_;
1946 my $switch_type = $e->{SWITCH_TYPE};
1948 $self->pidl("uint32_t level;");
1949 if (defined($switch_type)) {
1950 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1951 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1953 $self->pidl(mapTypeName($switch_type) . " _level;");
1956 my %double_cases = ();
1957 foreach my $el (@{$e->{ELEMENTS}}) {
1958 next if ($el->{TYPE} eq "EMPTY");
1959 next if ($double_cases{"$el->{NAME}"});
1960 $self->DeclareMemCtxVariables($el);
1961 $self->DeclarePtrVariables($el);
1962 $self->DeclareArrayVariables($el);
1963 $double_cases{"$el->{NAME}"} = 1;
1966 $self->start_flags($e, $ndr);
1968 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1970 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1972 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1976 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1978 $self->ParseUnionPullDeferred($e,$ndr,$varname);
1982 $self->add_deferred();
1984 $self->end_flags($e, $ndr);
1989 my ($e,$t,$name,$varname) = @_;
1990 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1993 sub ArgsUnionNdrSize($$)
1996 return "const union $name *r, uint32_t level, int flags";
1999 $typefamily{UNION} = {
2000 PUSH_FN_BODY => \&ParseUnionPush,
2001 DECL => \&DeclUnion,
2002 PULL_FN_BODY => \&ParseUnionPull,
2003 PRINT_FN_BODY => \&ParseUnionPrint,
2004 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2005 SIZE_FN_BODY => \&ParseUnionNdrSize,
2008 #####################################################################
2009 # parse a typedef - push side
2010 sub ParseTypedefPush($$$$)
2012 my($self,$e,$ndr,$varname) = @_;
2016 $env->{$e->{NAME}} = $varname;
2018 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2021 #####################################################################
2022 # parse a typedef - pull side
2023 sub ParseTypedefPull($$$$)
2025 my($self,$e,$ndr,$varname) = @_;
2029 $env->{$e->{NAME}} = $varname;
2031 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2034 #####################################################################
2035 # parse a typedef - print side
2036 sub ParseTypedefPrint($$$$$)
2038 my($self,$e,$ndr,$name,$varname) = @_;
2040 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2043 #####################################################################
2044 ## calculate the size of a structure
2045 sub ParseTypedefNdrSize($$$$)
2047 my($self,$t,$name,$varname) = @_;
2049 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2052 sub DeclTypedef($$$$)
2054 my ($e, $t, $name, $varname) = @_;
2056 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2059 sub ArgsTypedefNdrSize($$$)
2061 my ($d, $name, $varname) = @_;
2062 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2065 $typefamily{TYPEDEF} = {
2066 PUSH_FN_BODY => \&ParseTypedefPush,
2067 DECL => \&DeclTypedef,
2068 PULL_FN_BODY => \&ParseTypedefPull,
2069 PRINT_FN_BODY => \&ParseTypedefPrint,
2070 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2071 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2074 sub ParsePipePushChunk($$)
2076 my ($self, $t) = @_;
2079 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2080 my $struct = $pipe->{DATA};
2082 my $name = "$struct->{NAME}";
2086 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2088 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2090 return if has_property($t, "nopush");
2095 $self->ParseStructPush($struct, $ndr, $varname);
2098 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2101 $self->pidl("return NDR_ERR_SUCCESS;");
2107 sub ParsePipePullChunk($$)
2109 my ($self, $t) = @_;
2112 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2113 my $struct = $pipe->{DATA};
2115 my $name = "$struct->{NAME}";
2119 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2121 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2123 return if has_property($struct, "nopull");
2128 $self->ParseStructPull($struct, $ndr, $varname);
2131 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2134 $self->pidl("return NDR_ERR_SUCCESS;");
2140 sub ParsePipePrintChunk($$)
2142 my ($self, $t) = @_;
2145 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2146 my $struct = $pipe->{DATA};
2148 my $name = "$struct->{NAME}";
2152 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2154 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2156 return if (has_property($t, "noprint"));
2158 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2161 $self->ParseTypePrint($struct, $ndr, $varname);
2167 #####################################################################
2168 # parse a function - print side
2169 sub ParseFunctionPrint($$)
2171 my($self, $fn) = @_;
2174 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2176 return if has_property($fn, "noprint");
2178 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2182 foreach my $e (@{$fn->{ELEMENTS}}) {
2183 $self->DeclareArrayVariables($e);
2186 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2187 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2188 $self->pidl("$ndr->depth++;");
2190 $self->pidl("if (flags & NDR_SET_VALUES) {");
2191 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2194 $self->pidl("if (flags & NDR_IN) {");
2196 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2197 $self->pidl("$ndr->depth++;");
2199 my $env = GenerateFunctionInEnv($fn);
2201 foreach my $e (@{$fn->{ELEMENTS}}) {
2202 if (grep(/in/,@{$e->{DIRECTION}})) {
2203 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2206 $self->pidl("$ndr->depth--;");
2210 $self->pidl("if (flags & NDR_OUT) {");
2212 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2213 $self->pidl("$ndr->depth++;");
2215 $env = GenerateFunctionOutEnv($fn);
2216 foreach my $e (@{$fn->{ELEMENTS}}) {
2217 if (grep(/out/,@{$e->{DIRECTION}})) {
2218 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2221 if ($fn->{RETURN_TYPE}) {
2222 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2224 $self->pidl("$ndr->depth--;");
2228 $self->pidl("$ndr->depth--;");
2234 #####################################################################
2236 sub ParseFunctionPush($$)
2238 my($self, $fn) = @_;
2241 $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;
2243 return if has_property($fn, "nopush");
2248 foreach my $e (@{$fn->{ELEMENTS}}) {
2249 $self->DeclareArrayVariables($e);
2252 $self->pidl("if (flags & NDR_IN) {");
2255 my $env = GenerateFunctionInEnv($fn);
2257 EnvSubstituteValue($env, $fn);
2259 foreach my $e (@{$fn->{ELEMENTS}}) {
2260 if (grep(/in/,@{$e->{DIRECTION}})) {
2261 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2268 $self->pidl("if (flags & NDR_OUT) {");
2271 $env = GenerateFunctionOutEnv($fn);
2272 foreach my $e (@{$fn->{ELEMENTS}}) {
2273 if (grep(/out/,@{$e->{DIRECTION}})) {
2274 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2278 if ($fn->{RETURN_TYPE}) {
2279 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2284 $self->pidl("return NDR_ERR_SUCCESS;");
2290 sub AllocateArrayLevel($$$$$$)
2292 my ($self,$e,$l,$ndr,$var,$size) = @_;
2294 my $pl = GetPrevLevel($e, $l);
2295 if (defined($pl) and
2296 $pl->{TYPE} eq "POINTER" and
2297 $pl->{POINTER_TYPE} eq "ref"
2298 and not $l->{IS_ZERO_TERMINATED}) {
2299 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2300 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2302 if (grep(/in/,@{$e->{DIRECTION}}) and
2303 grep(/out/,@{$e->{DIRECTION}})) {
2304 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2309 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2312 #####################################################################
2314 sub ParseFunctionPull($$)
2319 # pull function args
2320 $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;
2325 # declare any internal pointers we need
2326 foreach my $e (@{$fn->{ELEMENTS}}) {
2327 $self->DeclarePtrVariables($e);
2328 $self->DeclareArrayVariables($e);
2331 my %double_cases = ();
2332 foreach my $e (@{$fn->{ELEMENTS}}) {
2333 next if ($e->{TYPE} eq "EMPTY");
2334 next if ($double_cases{"$e->{NAME}"});
2335 $self->DeclareMemCtxVariables($e);
2336 $double_cases{"$e->{NAME}"} = 1;
2339 $self->pidl("if (flags & NDR_IN) {");
2342 # auto-init the out section of a structure. I originally argued that
2343 # this was a bad idea as it hides bugs, but coping correctly
2344 # with initialisation and not wiping ref vars is turning
2345 # out to be too tricky (tridge)
2346 foreach my $e (@{$fn->{ELEMENTS}}) {
2347 next unless grep(/out/, @{$e->{DIRECTION}});
2348 $self->pidl("ZERO_STRUCT(r->out);");
2353 my $env = GenerateFunctionInEnv($fn);
2355 foreach my $e (@{$fn->{ELEMENTS}}) {
2356 next unless (grep(/in/, @{$e->{DIRECTION}}));
2357 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2360 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2361 # own flag rather than be in NDR_IN ?
2363 foreach my $e (@{$fn->{ELEMENTS}}) {
2364 next unless (grep(/out/, @{$e->{DIRECTION}}));
2365 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2366 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2367 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2368 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2369 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2370 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2371 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2373 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2374 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2375 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2376 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2377 check_fully_dereferenced($e, $env));
2378 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2380 if (grep(/in/, @{$e->{DIRECTION}})) {
2381 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2383 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2385 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2386 if (grep(/in/, @{$e->{DIRECTION}})) {
2387 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2389 $self->pidl("r->out.$e->{NAME} = NULL;");
2392 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2394 if (grep(/in/, @{$e->{DIRECTION}})) {
2395 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2397 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2402 $self->add_deferred();
2406 $self->pidl("if (flags & NDR_OUT) {");
2409 $env = GenerateFunctionOutEnv($fn);
2410 foreach my $e (@{$fn->{ELEMENTS}}) {
2411 next unless grep(/out/, @{$e->{DIRECTION}});
2412 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2415 if ($fn->{RETURN_TYPE}) {
2416 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2419 $self->add_deferred();
2423 $self->pidl("return NDR_ERR_SUCCESS;");
2429 sub AuthServiceStruct($$$)
2431 my ($self, $ifacename, $authservice) = @_;
2432 my @a = split /,/, $authservice;
2433 my $authservice_count = $#a + 1;
2435 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2436 foreach my $ap (@a) {
2437 $self->pidl("\t$ap, ");
2442 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2443 $self->pidl("\t.count\t= $authservice_count,");
2444 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2449 sub ParseGeneratePipeArray($$$)
2451 my ($self, $fn, $direction) = @_;
2453 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2456 foreach my $e (@{$fn->{ELEMENTS}}) {
2457 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2458 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2460 my $cname = "$e->{TYPE}_chunk";
2464 $self->pidl("\"$direction.$e->{NAME}\",");
2465 $self->pidl("\"$cname\",");
2466 $self->pidl("sizeof(struct $cname),");
2467 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2468 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2469 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2473 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2479 sub FunctionCallPipes($$)
2481 my ($self, $d) = @_;
2482 return if not defined($d->{OPNUM});
2487 foreach my $e (@{$d->{ELEMENTS}}) {
2488 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2490 if (grep(/in/, @{$e->{DIRECTION}})) {
2493 if (grep(/out/, @{$e->{DIRECTION}})) {
2499 $self->ParseGeneratePipeArray($d, "in");
2503 $self->ParseGeneratePipeArray($d, "out");
2507 sub FunctionCallEntry($$)
2509 my ($self, $d) = @_;
2510 return 0 if not defined($d->{OPNUM});
2515 foreach my $e (@{$d->{ELEMENTS}}) {
2516 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2518 if (grep(/in/, @{$e->{DIRECTION}})) {
2521 if (grep(/out/, @{$e->{DIRECTION}})) {
2526 my $in_pipes_ptr = "NULL";
2527 my $out_pipes_ptr = "NULL";
2530 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2534 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2538 $self->pidl("\t\t\"$d->{NAME}\",");
2539 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2540 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2541 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2542 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2543 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2544 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2545 $self->pidl("\t},");
2549 #####################################################################
2550 # produce a function call table
2551 sub FunctionTable($$)
2553 my($self,$interface) = @_;
2555 my $uname = uc $interface->{NAME};
2557 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2558 return unless defined ($interface->{PROPERTIES}->{uuid});
2560 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2561 $self->FunctionCallPipes($d);
2564 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2566 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2567 $count += $self->FunctionCallEntry($d);
2569 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2573 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2574 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2575 $self->pidl("\t$ep, ");
2577 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2582 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2583 $self->pidl("\t.count\t= $endpoint_count,");
2584 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2588 if (! defined $interface->{PROPERTIES}->{authservice}) {
2589 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2592 $self->AuthServiceStruct($interface->{NAME},
2593 $interface->{PROPERTIES}->{authservice});
2595 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2596 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2597 $self->pidl("\t.syntax_id\t= {");
2598 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2599 $self->pidl("\t\tNDR_$uname\_VERSION");
2600 $self->pidl("\t},");
2601 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2602 $self->pidl("\t.num_calls\t= $count,");
2603 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2604 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2605 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2611 #####################################################################
2612 # generate include statements for imported idl files
2617 foreach (@imports) {
2618 $_ = unmake_str($_);
2620 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2624 #####################################################################
2625 # generate include statements for included header files
2630 foreach (@includes) {
2631 $self->pidl_hdr("#include $_");
2635 #####################################################################
2636 # generate prototypes and defines for the interface definitions
2637 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2638 # NDR parser and so do not belong here, technically speaking
2639 sub HeaderInterface($$$)
2641 my($self,$interface,$needed) = @_;
2645 if ($needed->{"compression"}) {
2646 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2649 if (has_property($interface, "object")) {
2650 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2653 if (defined $interface->{PROPERTIES}->{helper}) {
2654 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2657 if (defined $interface->{PROPERTIES}->{uuid}) {
2658 my $name = uc $interface->{NAME};
2659 $self->pidl_hdr("#define NDR_$name\_UUID " .
2660 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2662 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2663 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2665 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2667 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2668 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2670 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2673 foreach (@{$interface->{FUNCTIONS}}) {
2674 next if has_property($_, "noopnum");
2675 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2676 my $u_name = uc $_->{NAME};
2678 my $val = sprintf("0x%02x", $count);
2679 if (defined($interface->{BASE})) {
2680 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2683 $self->pidl_hdr("#define NDR_$u_name ($val)");
2685 $self->pidl_hdr("");
2691 if (defined($interface->{BASE})) {
2692 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2695 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2699 sub ParseTypePush($$$$$$)
2701 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2703 # save the old relative_base_offset
2704 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2705 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2706 # restore the old relative_base_offset
2707 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2710 sub ParseTypePushFunction($$$)
2712 my ($self, $e, $varname) = @_;
2715 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2717 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2721 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2722 $self->pidl("return NDR_ERR_SUCCESS;");
2728 sub ParseTypePull($$$$$$)
2730 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2732 # save the old relative_base_offset
2733 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2734 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2735 # restore the old relative_base_offset
2736 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2739 sub ParseTypePullFunction($$)
2741 my ($self, $e, $varname) = @_;
2744 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2746 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2750 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2751 $self->pidl("return NDR_ERR_SUCCESS;");
2757 sub ParseTypePrint($$$$)
2759 my ($self, $e, $ndr, $varname) = @_;
2761 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2764 sub ParseTypePrintFunction($$$)
2766 my ($self, $e, $varname) = @_;
2769 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2771 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2773 return if (has_property($e, "noprint"));
2775 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2778 $self->ParseTypePrint($e, $ndr, $varname);
2784 sub ParseTypeNdrSize($$)
2789 my $tf = $typefamily{$t->{TYPE}};
2790 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2792 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2796 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2802 #####################################################################
2803 # parse the interface definitions
2804 sub ParseInterface($$$)
2806 my($self,$interface,$needed) = @_;
2808 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2809 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2811 $self->pidl_hdr("");
2813 $self->HeaderInterface($interface, $needed);
2816 foreach my $d (@{$interface->{TYPES}}) {
2817 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2818 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2819 $self->ParsePipePushChunk($d);
2820 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2821 $self->ParsePipePullChunk($d);
2822 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2823 $self->ParsePipePrintChunk($d);
2825 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2826 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2827 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2831 next unless(typeHasBody($d));
2833 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2834 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2835 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2837 # Make sure we don't generate a function twice...
2838 $needed->{TypeFunctionName("ndr_push", $d)} =
2839 $needed->{TypeFunctionName("ndr_pull", $d)} =
2840 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2842 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2846 foreach my $d (@{$interface->{FUNCTIONS}}) {
2847 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2848 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2849 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2852 $self->FunctionTable($interface);
2854 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2857 sub GenerateIncludes($)
2861 $self->pidl("#include \"includes.h\"");
2863 $self->pidl("#ifndef _GNU_SOURCE");
2864 $self->pidl("#define _GNU_SOURCE");
2865 $self->pidl("#endif");
2866 $self->pidl("#include <stdint.h>");
2867 $self->pidl("#include <stdlib.h>");
2868 $self->pidl("#include <stdio.h>");
2869 $self->pidl("#include <stdbool.h>");
2870 $self->pidl("#include <stdarg.h>");
2871 $self->pidl("#include <string.h>");
2875 #####################################################################
2876 # parse a parsed IDL structure back into an IDL file
2879 my($self, $ndr,$gen_header,$ndr_header) = @_;
2881 $self->pidl_hdr("/* header auto-generated by pidl */");
2882 $self->pidl_hdr("");
2883 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2884 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2885 $self->pidl_hdr("");
2887 $self->pidl("/* parser auto-generated by pidl */");
2889 $self->GenerateIncludes();
2890 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2896 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2900 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2901 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2902 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2905 return ($self->{res_hdr}, $self->{res});
2908 sub NeededElement($$$)
2910 my ($e, $dir, $needed) = @_;
2912 return if ($e->{TYPE} eq "EMPTY");
2914 return if (ref($e->{TYPE}) eq "HASH" and
2915 not defined($e->{TYPE}->{NAME}));
2918 if (ref($e->{TYPE}) eq "HASH") {
2919 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2924 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2925 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2927 $rt = $e->{REPRESENTATION_TYPE};
2930 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2933 if ($dir eq "print") {
2934 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2935 } elsif ($dir eq "pull") {
2936 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2937 push (@fn, "ndr_$t\_to_$rt")
2939 } elsif ($dir eq "push") {
2940 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2941 push (@fn, "ndr_$rt\_to_$t")
2944 die("invalid direction `$dir'");
2948 unless (defined($needed->{$_})) {
2954 sub NeededFunction($$)
2956 my ($fn,$needed) = @_;
2957 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2958 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2959 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2960 foreach my $e (@{$fn->{ELEMENTS}}) {
2962 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2968 sub NeededType($$$);
2969 my ($t,$needed,$req) = @_;
2971 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2972 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
2974 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2975 return unless defined($t->{ELEMENTS});
2976 for my $e (@{$t->{ELEMENTS}}) {
2978 if (has_property($e, "compression")) {
2979 $needed->{"compression"} = 1;
2981 NeededElement($e, $req, $needed);
2982 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2987 #####################################################################
2988 # work out what parse functions are needed
2989 sub NeededInterface($$)
2991 my ($interface,$needed) = @_;
2992 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2993 foreach (reverse @{$interface->{TYPES}}) {
2995 if (has_property($_, "public")) {
2996 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2997 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3000 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3001 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3002 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3003 if (has_property($_, "gensize")) {
3004 $needed->{"ndr_size_$_->{NAME}"} = 1;
3009 sub TypeFunctionName($$)
3011 my ($prefix, $t) = @_;
3013 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3014 $t->{TYPE} eq "TYPEDEF");
3015 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3016 return "$prefix\_$t";