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));");
688 } elsif ($l->{POINTER_TYPE} eq "ignore") {
689 # We don't want this pointer to appear on the wire at all
690 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
692 die("Unhandled pointer type $l->{POINTER_TYPE}");
696 sub need_pointer_to($$$)
698 my ($e, $l, $scalar_only) = @_;
701 if (ref($l->{DATA_TYPE})) {
702 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
704 $t = $l->{DATA_TYPE};
707 if (not Parse::Pidl::Typelist::is_scalar($t)) {
708 return 1 if $scalar_only;
713 foreach my $tl (@{$e->{LEVELS}}) {
715 if ($tl->{TYPE} eq "ARRAY") {
720 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
721 return 1 unless $arrays;
727 sub ParseDataPrint($$$$$)
729 my ($self, $e, $l, $ndr, $var_name) = @_;
731 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
733 if (need_pointer_to($e, $l, 1)) {
734 $var_name = get_pointer_to($var_name);
737 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
739 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
743 #####################################################################
744 # print scalars in a structure element
745 sub ParseElementPrint($$$$$)
747 my($self, $e, $ndr, $var_name, $env) = @_;
749 return if (has_property($e, "noprint"));
751 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
752 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
756 $var_name = append_prefix($e, $var_name);
758 if (defined(my $value = has_property($e, "value"))) {
759 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
762 foreach my $l (@{$e->{LEVELS}}) {
763 if ($l->{TYPE} eq "POINTER") {
764 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
765 $self->pidl("$ndr->depth++;");
766 if ($l->{POINTER_TYPE} ne "ref") {
767 $self->pidl("if ($var_name) {");
770 $var_name = get_value_of($var_name);
771 } elsif ($l->{TYPE} eq "ARRAY") {
774 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
775 $var_name = get_pointer_to($var_name);
778 if ($l->{IS_ZERO_TERMINATED}) {
779 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
781 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
782 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
785 if (is_charset_array($e,$l)) {
786 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
788 } elsif (has_fast_array($e, $l)) {
789 my $nl = GetNextLevel($e, $l);
790 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
793 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
795 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
796 $self->pidl("$ndr->depth++;");
797 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
800 $var_name = get_array_element($var_name, $counter);
802 } elsif ($l->{TYPE} eq "DATA") {
803 $self->ParseDataPrint($e, $l, $ndr, $var_name);
804 } elsif ($l->{TYPE} eq "SWITCH") {
805 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
806 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
807 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
811 foreach my $l (reverse @{$e->{LEVELS}}) {
812 if ($l->{TYPE} eq "POINTER") {
813 if ($l->{POINTER_TYPE} ne "ref") {
817 $self->pidl("$ndr->depth--;");
818 } elsif (($l->{TYPE} eq "ARRAY")
819 and not is_charset_array($e,$l)
820 and not has_fast_array($e,$l)) {
823 $self->pidl("$ndr->depth--;");
828 #####################################################################
829 # parse scalars in a structure element - pull size
830 sub ParseSwitchPull($$$$$$)
832 my($self,$e,$l,$ndr,$var_name,$env) = @_;
833 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
834 check_null_pointer($e, $env, sub { $self->pidl(shift); },
835 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
836 check_fully_dereferenced($e, $env));
838 $var_name = get_pointer_to($var_name);
839 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
842 #####################################################################
843 # push switch element
844 sub ParseSwitchPush($$$$$$)
846 my($self,$e,$l,$ndr,$var_name,$env) = @_;
847 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
848 check_null_pointer($e, $env, sub { $self->pidl(shift); },
849 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
850 check_fully_dereferenced($e, $env));
852 $var_name = get_pointer_to($var_name);
853 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
856 sub ParseDataPull($$$$$$$)
858 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
860 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
862 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
864 if (need_pointer_to($e, $l, 0)) {
865 $var_name = get_pointer_to($var_name);
868 $var_name = get_pointer_to($var_name);
870 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
872 my $pl = GetPrevLevel($e, $l);
874 my $range = has_property($e, "range");
875 if ($range and $pl->{TYPE} ne "ARRAY") {
876 $var_name = get_value_of($var_name);
877 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
878 my ($low, $high) = split(/,/, $range, 2);
879 if ($low < 0 and not $signed) {
880 warning(0, "$low is invalid for the range of an unsigned type");
882 if ($low == 0 and not $signed) {
883 $self->pidl("if ($var_name > $high) {");
885 $self->pidl("if ($var_name < $low || $var_name > $high) {");
887 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
891 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
895 sub ParseDataPush($$$$$$$)
897 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
899 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
901 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
903 # strings are passed by value rather than reference
904 if (need_pointer_to($e, $l, 1)) {
905 $var_name = get_pointer_to($var_name);
908 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
910 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
914 sub CalcNdrFlags($$$)
916 my ($l,$primitives,$deferred) = @_;
921 # Add NDR_SCALARS if this one is deferred
922 # and deferreds may be pushed
923 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
925 # Add NDR_SCALARS if this one is not deferred and
926 # primitives may be pushed
927 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
929 # Add NDR_BUFFERS if this one contains deferred stuff
930 # and deferreds may be pushed
931 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
933 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
934 return "NDR_SCALARS" if ($scalars);
935 return "NDR_BUFFERS" if ($buffers);
939 sub ParseMemCtxPullFlags($$$$)
941 my ($self, $e, $l) = @_;
943 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
945 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
946 return undef if has_fast_array($e, $l);
947 return undef if is_charset_array($e, $l);
951 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
952 my $nl = GetNextLevel($e, $l);
953 return undef if ($nl->{TYPE} eq "PIPE");
954 return undef if ($nl->{TYPE} eq "ARRAY");
955 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
957 if ($l->{LEVEL} eq "TOP") {
958 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
965 sub ParseMemCtxPullStart($$$$$)
967 my ($self, $e, $l, $ndr, $ptr_name) = @_;
969 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
970 my $mem_c_ctx = $ptr_name;
971 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
973 return unless defined($mem_c_flags);
975 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
976 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
979 sub ParseMemCtxPullEnd($$$$)
981 my ($self, $e, $l, $ndr) = @_;
983 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
984 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
986 return unless defined($mem_r_flags);
988 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
991 sub CheckStringTerminator($$$$$)
993 my ($self,$ndr,$e,$l,$length) = @_;
994 my $nl = GetNextLevel($e, $l);
996 # Make sure last element is zero!
997 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1000 sub ParseElementPullLevel
1002 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1004 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1006 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1007 $var_name = get_pointer_to($var_name);
1010 # Only pull something if there's actually something to be pulled
1011 if (defined($ndr_flags)) {
1012 if ($l->{TYPE} eq "SUBCONTEXT") {
1013 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1014 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1015 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1016 } elsif ($l->{TYPE} eq "ARRAY") {
1017 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1019 if (my $range = has_property($e, "range")) {
1020 my ($low, $high) = split(/,/, $range, 2);
1022 warning(0, "$low is invalid for the range of an array size");
1025 $self->pidl("if ($length > $high) {");
1027 $self->pidl("if ($length < $low || $length > $high) {");
1029 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1033 my $nl = GetNextLevel($e, $l);
1035 if (is_charset_array($e,$l)) {
1036 if ($l->{IS_ZERO_TERMINATED}) {
1037 $self->CheckStringTerminator($ndr, $e, $l, $length);
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}));");
1041 } elsif (has_fast_array($e, $l)) {
1042 if ($l->{IS_ZERO_TERMINATED}) {
1043 $self->CheckStringTerminator($ndr,$e,$l,$length);
1045 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1048 } elsif ($l->{TYPE} eq "POINTER") {
1049 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1050 } elsif ($l->{TYPE} eq "SWITCH") {
1051 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1052 } elsif ($l->{TYPE} eq "DATA") {
1053 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1054 } elsif ($l->{TYPE} eq "TYPEDEF") {
1055 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1059 # add additional constructions
1060 if ($l->{TYPE} eq "POINTER" and $deferred) {
1061 if ($l->{POINTER_TYPE} ne "ref") {
1062 $self->pidl("if ($var_name) {");
1065 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1066 $self->pidl("uint32_t _relative_save_offset;");
1067 $self->pidl("_relative_save_offset = $ndr->offset;");
1068 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1072 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1074 $var_name = get_value_of($var_name);
1075 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1077 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1079 if ($l->{POINTER_TYPE} ne "ref") {
1080 if ($l->{POINTER_TYPE} eq "relative") {
1081 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1083 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1086 $self->pidl("$ndr->offset = _relative_save_offset;");
1091 } elsif ($l->{TYPE} eq "ARRAY" and
1092 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1093 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1094 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1095 my $array_name = $var_name;
1097 if ($l->{IS_VARYING}) {
1098 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
1101 if (my $range = has_property($e, "range")) {
1102 my ($low, $high) = split(/,/, $range, 2);
1104 warning(0, "$low is invalid for the range of an array size");
1107 $self->pidl("if ($length > $high) {");
1109 $self->pidl("if ($length < $low || $length > $high) {");
1111 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1115 $var_name = get_array_element($var_name, $counter);
1117 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1119 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1120 my $nl = GetNextLevel($e,$l);
1122 if ($l->{IS_ZERO_TERMINATED}) {
1123 $self->CheckStringTerminator($ndr,$e,$l,$length);
1126 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1128 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1133 if ($deferred and ContainsDeferred($e, $l)) {
1134 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1136 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1141 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1143 } elsif ($l->{TYPE} eq "SWITCH") {
1144 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1148 #####################################################################
1149 # parse scalars in a structure element - pull size
1150 sub ParseElementPull($$$$$$)
1152 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1154 my $var_name = $env->{$e->{NAME}};
1158 return if ContainsPipe($e, $e->{LEVELS}[0]);
1160 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1162 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1165 $represent_name = $var_name;
1166 $transmit_name = "_transmit_$e->{NAME}";
1167 $var_name = $transmit_name;
1168 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1171 $var_name = append_prefix($e, $var_name);
1173 $self->start_flags($e, $ndr);
1175 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1177 $self->end_flags($e, $ndr);
1179 # Representation type is different from transmit_as
1180 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1181 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1187 #####################################################################
1188 # parse a pointer in a struct element or function
1189 sub ParsePtrPull($$$$$)
1191 my($self, $e,$l,$ndr,$var_name) = @_;
1193 my $nl = GetNextLevel($e, $l);
1194 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1195 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1196 ($nl->{DATA_TYPE} eq "string"));
1198 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1200 if (!$next_is_array and !$next_is_string) {
1201 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1202 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1207 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1208 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1209 } elsif (($l->{POINTER_TYPE} eq "unique") or
1210 ($l->{POINTER_TYPE} eq "relative") or
1211 ($l->{POINTER_TYPE} eq "full")) {
1212 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1213 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1214 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1215 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1216 #We want to consume the pointer bytes, but ignore the pointer value
1217 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1218 $self->pidl("_ptr_$e->{NAME} = 0;");
1220 die("Unhandled pointer type $l->{POINTER_TYPE}");
1223 $self->pidl("if (_ptr_$e->{NAME}) {");
1226 if ($l->{POINTER_TYPE} eq "ignore") {
1227 # Don't do anything, we don't want to do the
1228 # allocation, as we forced it to NULL just above, and
1229 # we may not know the declared type anyway.
1231 # Don't do this for arrays, they're allocated at the actual level
1233 unless ($next_is_array or $next_is_string) {
1234 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1236 # FIXME: Yes, this is nasty.
1237 # We allocate an array twice
1238 # - once just to indicate that it's there,
1239 # - then the real allocation...
1240 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1244 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1245 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1246 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1249 $self->pidl("} else {");
1250 $self->pidl("\t$var_name = NULL;");
1254 sub ParseStructPushPrimitives($$$$$)
1256 my ($self, $struct, $ndr, $varname, $env) = @_;
1258 # see if the structure contains a conformant array. If it
1259 # does, then it must be the last element of the structure, and
1260 # we need to push the conformant length early, as it fits on
1261 # the wire before the structure (and even before the structure
1263 if (defined($struct->{SURROUNDING_ELEMENT})) {
1264 my $e = $struct->{SURROUNDING_ELEMENT};
1266 if (defined($e->{LEVELS}[0]) and
1267 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1270 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1271 if (has_property($e, "charset")) {
1272 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1274 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1277 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1280 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1282 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1286 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1288 if (defined($struct->{PROPERTIES}{relative_base})) {
1289 # set the current offset as base for relative pointers
1290 # and store it based on the toplevel struct/union
1291 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1294 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1296 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1299 sub ParseStructPushDeferred($$$$)
1301 my ($self, $struct, $ndr, $varname, $env) = @_;
1302 if (defined($struct->{PROPERTIES}{relative_base})) {
1303 # retrieve the current offset as base for relative pointers
1304 # based on the toplevel struct/union
1305 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1307 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1310 #####################################################################
1312 sub ParseStructPush($$$$)
1314 my ($self, $struct, $ndr, $varname) = @_;
1316 return unless defined($struct->{ELEMENTS});
1318 my $env = GenerateStructEnv($struct, $varname);
1320 EnvSubstituteValue($env, $struct);
1322 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1324 $self->start_flags($struct, $ndr);
1326 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1328 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1332 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1334 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1338 $self->end_flags($struct, $ndr);
1341 #####################################################################
1342 # generate a push function for an enum
1343 sub ParseEnumPush($$$$)
1345 my($self,$enum,$ndr,$varname) = @_;
1346 my($type_fn) = $enum->{BASE_TYPE};
1348 $self->start_flags($enum, $ndr);
1349 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1350 $self->end_flags($enum, $ndr);
1353 #####################################################################
1354 # generate a pull function for an enum
1355 sub ParseEnumPull($$$$)
1357 my($self,$enum,$ndr,$varname) = @_;
1358 my($type_fn) = $enum->{BASE_TYPE};
1359 my($type_v_decl) = mapTypeName($type_fn);
1361 $self->pidl("$type_v_decl v;");
1362 $self->start_flags($enum, $ndr);
1363 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1364 $self->pidl("*$varname = v;");
1366 $self->end_flags($enum, $ndr);
1369 #####################################################################
1370 # generate a print function for an enum
1371 sub ParseEnumPrint($$$$$)
1373 my($self,$enum,$ndr,$name,$varname) = @_;
1375 $self->pidl("const char *val = NULL;");
1378 $self->start_flags($enum, $ndr);
1380 $self->pidl("switch ($varname) {");
1382 my $els = \@{$enum->{ELEMENTS}};
1383 foreach my $i (0 .. $#{$els}) {
1384 my $e = ${$els}[$i];
1386 if ($e =~ /^(.*)=/) {
1389 $self->pidl("case $e: val = \"$e\"; break;");
1395 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1397 $self->end_flags($enum, $ndr);
1402 my ($e,$t,$name,$varname) = @_;
1403 return "enum $name " .
1404 ($t eq "pull"?"*":"") . $varname;
1407 $typefamily{ENUM} = {
1409 PUSH_FN_BODY => \&ParseEnumPush,
1410 PULL_FN_BODY => \&ParseEnumPull,
1411 PRINT_FN_BODY => \&ParseEnumPrint,
1414 #####################################################################
1415 # generate a push function for a bitmap
1416 sub ParseBitmapPush($$$$)
1418 my($self,$bitmap,$ndr,$varname) = @_;
1419 my($type_fn) = $bitmap->{BASE_TYPE};
1421 $self->start_flags($bitmap, $ndr);
1423 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1425 $self->end_flags($bitmap, $ndr);
1428 #####################################################################
1429 # generate a pull function for an bitmap
1430 sub ParseBitmapPull($$$$)
1432 my($self,$bitmap,$ndr,$varname) = @_;
1433 my $type_fn = $bitmap->{BASE_TYPE};
1434 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1436 $self->pidl("$type_decl v;");
1437 $self->start_flags($bitmap, $ndr);
1438 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1439 $self->pidl("*$varname = v;");
1441 $self->end_flags($bitmap, $ndr);
1444 #####################################################################
1445 # generate a print function for an bitmap
1446 sub ParseBitmapPrintElement($$$$$$)
1448 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1449 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1450 my($type_fn) = $bitmap->{BASE_TYPE};
1453 if ($e =~ /^(\w+) .*$/) {
1456 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1459 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1462 #####################################################################
1463 # generate a print function for an bitmap
1464 sub ParseBitmapPrint($$$$$)
1466 my($self,$bitmap,$ndr,$name,$varname) = @_;
1467 my($type_decl) = mapTypeName($bitmap->{TYPE});
1468 my($type_fn) = $bitmap->{BASE_TYPE};
1470 $self->start_flags($bitmap, $ndr);
1472 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1474 $self->pidl("$ndr->depth++;");
1475 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1476 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1478 $self->pidl("$ndr->depth--;");
1480 $self->end_flags($bitmap, $ndr);
1483 sub DeclBitmap($$$$)
1485 my ($e,$t,$name,$varname) = @_;
1486 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1487 ($t eq "pull"?" *":" ") . $varname;
1490 $typefamily{BITMAP} = {
1491 DECL => \&DeclBitmap,
1492 PUSH_FN_BODY => \&ParseBitmapPush,
1493 PULL_FN_BODY => \&ParseBitmapPull,
1494 PRINT_FN_BODY => \&ParseBitmapPrint,
1497 #####################################################################
1498 # generate a struct print function
1499 sub ParseStructPrint($$$$$)
1501 my($self,$struct,$ndr,$name,$varname) = @_;
1503 return unless defined $struct->{ELEMENTS};
1505 my $env = GenerateStructEnv($struct, $varname);
1507 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1509 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1510 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1512 $self->start_flags($struct, $ndr);
1514 $self->pidl("$ndr->depth++;");
1516 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1517 foreach (@{$struct->{ELEMENTS}});
1518 $self->pidl("$ndr->depth--;");
1520 $self->end_flags($struct, $ndr);
1523 sub DeclarePtrVariables($$)
1526 foreach my $l (@{$e->{LEVELS}}) {
1528 if ($l->{TYPE} eq "POINTER" and
1529 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1530 if ($l->{POINTER_TYPE} eq "relative_short") {
1533 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1539 sub DeclareArrayVariables($$)
1543 foreach my $l (@{$e->{LEVELS}}) {
1544 next if has_fast_array($e,$l);
1545 next if is_charset_array($e,$l);
1546 if ($l->{TYPE} eq "ARRAY") {
1547 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1552 sub DeclareArrayVariablesNoZero($$$)
1554 my ($self,$e,$env) = @_;
1556 foreach my $l (@{$e->{LEVELS}}) {
1557 next if has_fast_array($e,$l);
1558 next if is_charset_array($e,$l);
1559 if ($l->{TYPE} eq "ARRAY") {
1560 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1561 if ($length eq "0") {
1562 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1564 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1570 sub DeclareMemCtxVariables($$)
1573 foreach my $l (@{$e->{LEVELS}}) {
1574 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1575 if (defined($mem_flags)) {
1576 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1581 sub ParseStructPullPrimitives($$$$$)
1583 my($self,$struct,$ndr,$varname,$env) = @_;
1585 if (defined $struct->{SURROUNDING_ELEMENT}) {
1586 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1589 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1591 if (defined($struct->{PROPERTIES}{relative_base})) {
1592 # set the current offset as base for relative pointers
1593 # and store it based on the toplevel struct/union
1594 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1597 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1599 $self->add_deferred();
1601 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1604 sub ParseStructPullDeferred($$$$$)
1606 my ($self,$struct,$ndr,$varname,$env) = @_;
1608 if (defined($struct->{PROPERTIES}{relative_base})) {
1609 # retrieve the current offset as base for relative pointers
1610 # based on the toplevel struct/union
1611 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1613 foreach my $e (@{$struct->{ELEMENTS}}) {
1614 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1617 $self->add_deferred();
1620 #####################################################################
1621 # parse a struct - pull side
1622 sub ParseStructPull($$$$)
1624 my($self,$struct,$ndr,$varname) = @_;
1626 return unless defined $struct->{ELEMENTS};
1628 # declare any internal pointers we need
1629 foreach my $e (@{$struct->{ELEMENTS}}) {
1630 $self->DeclarePtrVariables($e);
1631 $self->DeclareArrayVariables($e);
1632 $self->DeclareMemCtxVariables($e);
1635 $self->start_flags($struct, $ndr);
1637 my $env = GenerateStructEnv($struct, $varname);
1639 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1641 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1644 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1646 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1650 $self->end_flags($struct, $ndr);
1653 #####################################################################
1654 # calculate size of ndr struct
1655 sub ParseStructNdrSize($$$$)
1657 my ($self,$t, $name, $varname) = @_;
1660 if (my $flags = has_property($t, "flag")) {
1661 $self->pidl("flags |= $flags;");
1663 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1666 sub DeclStruct($$$$)
1668 my ($e,$t,$name,$varname) = @_;
1669 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1672 sub ArgsStructNdrSize($$$)
1674 my ($d, $name, $varname) = @_;
1675 return "const struct $name *$varname, int flags";
1678 $typefamily{STRUCT} = {
1679 PUSH_FN_BODY => \&ParseStructPush,
1680 DECL => \&DeclStruct,
1681 PULL_FN_BODY => \&ParseStructPull,
1682 PRINT_FN_BODY => \&ParseStructPrint,
1683 SIZE_FN_BODY => \&ParseStructNdrSize,
1684 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1687 #####################################################################
1688 # calculate size of ndr struct
1689 sub ParseUnionNdrSize($$$)
1691 my ($self, $t, $name, $varname) = @_;
1694 if (my $flags = has_property($t, "flag")) {
1695 $self->pidl("flags |= $flags;");
1698 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1701 sub ParseUnionPushPrimitives($$$$)
1703 my ($self, $e, $ndr ,$varname) = @_;
1705 my $have_default = 0;
1707 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1709 if (defined($e->{SWITCH_TYPE})) {
1710 if (defined($e->{ALIGN})) {
1711 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1714 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1717 if (defined($e->{ALIGN})) {
1718 if ($e->{IS_MS_UNION}) {
1719 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1720 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1722 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1726 $self->pidl("switch (level) {");
1728 foreach my $el (@{$e->{ELEMENTS}}) {
1729 if ($el->{CASE} eq "default") {
1732 $self->pidl("$el->{CASE}: {");
1734 if ($el->{TYPE} ne "EMPTY") {
1736 if (defined($e->{PROPERTIES}{relative_base})) {
1737 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1738 # set the current offset as base for relative pointers
1739 # and store it based on the toplevel struct/union
1740 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1742 $self->DeclareArrayVariables($el);
1743 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1746 $self->pidl("break; }");
1749 if (! $have_default) {
1750 $self->pidl("default:");
1751 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1757 sub ParseUnionPushDeferred($$$$)
1759 my ($self,$e,$ndr,$varname) = @_;
1761 my $have_default = 0;
1763 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1764 if (defined($e->{PROPERTIES}{relative_base})) {
1765 # retrieve the current offset as base for relative pointers
1766 # based on the toplevel struct/union
1767 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1769 $self->pidl("switch (level) {");
1771 foreach my $el (@{$e->{ELEMENTS}}) {
1772 if ($el->{CASE} eq "default") {
1776 $self->pidl("$el->{CASE}:");
1777 if ($el->{TYPE} ne "EMPTY") {
1779 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1782 $self->pidl("break;");
1785 if (! $have_default) {
1786 $self->pidl("default:");
1787 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1793 #####################################################################
1794 # parse a union - push side
1795 sub ParseUnionPush($$$$)
1797 my ($self,$e,$ndr,$varname) = @_;
1798 my $have_default = 0;
1800 $self->start_flags($e, $ndr);
1802 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1804 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1807 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1809 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1812 $self->end_flags($e, $ndr);
1815 #####################################################################
1817 sub ParseUnionPrint($$$$$)
1819 my ($self,$e,$ndr,$name,$varname) = @_;
1820 my $have_default = 0;
1822 $self->pidl("uint32_t level;");
1823 foreach my $el (@{$e->{ELEMENTS}}) {
1824 $self->DeclareArrayVariables($el);
1827 $self->start_flags($e, $ndr);
1829 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1831 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1833 $self->pidl("switch (level) {");
1835 foreach my $el (@{$e->{ELEMENTS}}) {
1836 if ($el->{CASE} eq "default") {
1839 $self->pidl("$el->{CASE}:");
1840 if ($el->{TYPE} ne "EMPTY") {
1842 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1845 $self->pidl("break;");
1848 if (! $have_default) {
1849 $self->pidl("default:");
1850 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1855 $self->end_flags($e, $ndr);
1858 sub ParseUnionPullPrimitives($$$$$)
1860 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1861 my $have_default = 0;
1864 if (defined($switch_type)) {
1865 if (defined($e->{ALIGN})) {
1866 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1869 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1870 $self->pidl("if (_level != level) {");
1871 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1875 if (defined($e->{ALIGN})) {
1876 if ($e->{IS_MS_UNION}) {
1877 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1878 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1880 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1884 $self->pidl("switch (level) {");
1886 foreach my $el (@{$e->{ELEMENTS}}) {
1887 if ($el->{CASE} eq "default") {
1890 $self->pidl("$el->{CASE}: {");
1892 if ($el->{TYPE} ne "EMPTY") {
1894 $self->DeclarePtrVariables($el);
1895 $self->DeclareArrayVariables($el);
1896 if (defined($e->{PROPERTIES}{relative_base})) {
1897 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1898 # set the current offset as base for relative pointers
1899 # and store it based on the toplevel struct/union
1900 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1902 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1905 $self->pidl("break; }");
1908 if (! $have_default) {
1909 $self->pidl("default:");
1910 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1916 sub ParseUnionPullDeferred($$$$)
1918 my ($self,$e,$ndr,$varname) = @_;
1919 my $have_default = 0;
1921 if (defined($e->{PROPERTIES}{relative_base})) {
1922 # retrieve the current offset as base for relative pointers
1923 # based on the toplevel struct/union
1924 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1926 $self->pidl("switch (level) {");
1928 foreach my $el (@{$e->{ELEMENTS}}) {
1929 if ($el->{CASE} eq "default") {
1933 $self->pidl("$el->{CASE}:");
1934 if ($el->{TYPE} ne "EMPTY") {
1936 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1939 $self->pidl("break;");
1942 if (! $have_default) {
1943 $self->pidl("default:");
1944 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1952 #####################################################################
1953 # parse a union - pull side
1954 sub ParseUnionPull($$$$)
1956 my ($self,$e,$ndr,$varname) = @_;
1957 my $switch_type = $e->{SWITCH_TYPE};
1959 $self->pidl("uint32_t level;");
1960 if (defined($switch_type)) {
1961 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1962 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1964 $self->pidl(mapTypeName($switch_type) . " _level;");
1967 my %double_cases = ();
1968 foreach my $el (@{$e->{ELEMENTS}}) {
1969 next if ($el->{TYPE} eq "EMPTY");
1970 next if ($double_cases{"$el->{NAME}"});
1971 $self->DeclareMemCtxVariables($el);
1972 $double_cases{"$el->{NAME}"} = 1;
1975 $self->start_flags($e, $ndr);
1977 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1979 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1981 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1985 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1987 $self->ParseUnionPullDeferred($e,$ndr,$varname);
1991 $self->add_deferred();
1993 $self->end_flags($e, $ndr);
1998 my ($e,$t,$name,$varname) = @_;
1999 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2002 sub ArgsUnionNdrSize($$)
2005 return "const union $name *r, uint32_t level, int flags";
2008 $typefamily{UNION} = {
2009 PUSH_FN_BODY => \&ParseUnionPush,
2010 DECL => \&DeclUnion,
2011 PULL_FN_BODY => \&ParseUnionPull,
2012 PRINT_FN_BODY => \&ParseUnionPrint,
2013 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2014 SIZE_FN_BODY => \&ParseUnionNdrSize,
2017 #####################################################################
2018 # parse a typedef - push side
2019 sub ParseTypedefPush($$$$)
2021 my($self,$e,$ndr,$varname) = @_;
2025 $env->{$e->{NAME}} = $varname;
2027 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2030 #####################################################################
2031 # parse a typedef - pull side
2032 sub ParseTypedefPull($$$$)
2034 my($self,$e,$ndr,$varname) = @_;
2038 $env->{$e->{NAME}} = $varname;
2040 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2043 #####################################################################
2044 # parse a typedef - print side
2045 sub ParseTypedefPrint($$$$$)
2047 my($self,$e,$ndr,$name,$varname) = @_;
2049 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2052 #####################################################################
2053 ## calculate the size of a structure
2054 sub ParseTypedefNdrSize($$$$)
2056 my($self,$t,$name,$varname) = @_;
2058 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2061 sub DeclTypedef($$$$)
2063 my ($e, $t, $name, $varname) = @_;
2065 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2068 sub ArgsTypedefNdrSize($$$)
2070 my ($d, $name, $varname) = @_;
2071 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2074 $typefamily{TYPEDEF} = {
2075 PUSH_FN_BODY => \&ParseTypedefPush,
2076 DECL => \&DeclTypedef,
2077 PULL_FN_BODY => \&ParseTypedefPull,
2078 PRINT_FN_BODY => \&ParseTypedefPrint,
2079 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2080 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2083 sub ParsePipePushChunk($$)
2085 my ($self, $t) = @_;
2088 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2089 my $struct = $pipe->{DATA};
2091 my $name = "$struct->{NAME}";
2095 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2097 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2099 return if has_property($t, "nopush");
2104 $self->ParseStructPush($struct, $ndr, $varname);
2107 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2110 $self->pidl("return NDR_ERR_SUCCESS;");
2116 sub ParsePipePullChunk($$)
2118 my ($self, $t) = @_;
2121 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2122 my $struct = $pipe->{DATA};
2124 my $name = "$struct->{NAME}";
2128 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2130 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2132 return if has_property($struct, "nopull");
2137 $self->ParseStructPull($struct, $ndr, $varname);
2140 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2143 $self->pidl("return NDR_ERR_SUCCESS;");
2149 sub ParsePipePrintChunk($$)
2151 my ($self, $t) = @_;
2154 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2155 my $struct = $pipe->{DATA};
2157 my $name = "$struct->{NAME}";
2161 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2163 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2165 return if (has_property($t, "noprint"));
2167 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2170 $self->ParseTypePrint($struct, $ndr, $varname);
2176 #####################################################################
2177 # parse a function - print side
2178 sub ParseFunctionPrint($$)
2180 my($self, $fn) = @_;
2183 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2185 return if has_property($fn, "noprint");
2187 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2191 foreach my $e (@{$fn->{ELEMENTS}}) {
2192 $self->DeclareArrayVariables($e);
2195 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2196 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2197 $self->pidl("$ndr->depth++;");
2199 $self->pidl("if (flags & NDR_SET_VALUES) {");
2200 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2203 $self->pidl("if (flags & NDR_IN) {");
2205 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2206 $self->pidl("$ndr->depth++;");
2208 my $env = GenerateFunctionInEnv($fn);
2210 foreach my $e (@{$fn->{ELEMENTS}}) {
2211 if (grep(/in/,@{$e->{DIRECTION}})) {
2212 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2215 $self->pidl("$ndr->depth--;");
2219 $self->pidl("if (flags & NDR_OUT) {");
2221 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2222 $self->pidl("$ndr->depth++;");
2224 $env = GenerateFunctionOutEnv($fn);
2225 foreach my $e (@{$fn->{ELEMENTS}}) {
2226 if (grep(/out/,@{$e->{DIRECTION}})) {
2227 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2230 if ($fn->{RETURN_TYPE}) {
2231 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2233 $self->pidl("$ndr->depth--;");
2237 $self->pidl("$ndr->depth--;");
2243 #####################################################################
2245 sub ParseFunctionPush($$)
2247 my($self, $fn) = @_;
2250 $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;
2252 return if has_property($fn, "nopush");
2257 foreach my $e (@{$fn->{ELEMENTS}}) {
2258 $self->DeclareArrayVariables($e);
2261 $self->pidl("if (flags & NDR_IN) {");
2264 my $env = GenerateFunctionInEnv($fn);
2266 EnvSubstituteValue($env, $fn);
2268 foreach my $e (@{$fn->{ELEMENTS}}) {
2269 if (grep(/in/,@{$e->{DIRECTION}})) {
2270 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2277 $self->pidl("if (flags & NDR_OUT) {");
2280 $env = GenerateFunctionOutEnv($fn);
2281 foreach my $e (@{$fn->{ELEMENTS}}) {
2282 if (grep(/out/,@{$e->{DIRECTION}})) {
2283 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2287 if ($fn->{RETURN_TYPE}) {
2288 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2293 $self->pidl("return NDR_ERR_SUCCESS;");
2299 sub AllocateArrayLevel($$$$$$)
2301 my ($self,$e,$l,$ndr,$var,$size) = @_;
2303 my $pl = GetPrevLevel($e, $l);
2304 if (defined($pl) and
2305 $pl->{TYPE} eq "POINTER" and
2306 $pl->{POINTER_TYPE} eq "ref"
2307 and not $l->{IS_ZERO_TERMINATED}) {
2308 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2309 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2311 if (grep(/in/,@{$e->{DIRECTION}}) and
2312 grep(/out/,@{$e->{DIRECTION}})) {
2313 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2318 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2321 #####################################################################
2323 sub ParseFunctionPull($$)
2328 # pull function args
2329 $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;
2334 # declare any internal pointers we need
2335 foreach my $e (@{$fn->{ELEMENTS}}) {
2336 $self->DeclarePtrVariables($e);
2337 $self->DeclareArrayVariables($e);
2340 my %double_cases = ();
2341 foreach my $e (@{$fn->{ELEMENTS}}) {
2342 next if ($e->{TYPE} eq "EMPTY");
2343 next if ($double_cases{"$e->{NAME}"});
2344 $self->DeclareMemCtxVariables($e);
2345 $double_cases{"$e->{NAME}"} = 1;
2348 $self->pidl("if (flags & NDR_IN) {");
2351 # auto-init the out section of a structure. I originally argued that
2352 # this was a bad idea as it hides bugs, but coping correctly
2353 # with initialisation and not wiping ref vars is turning
2354 # out to be too tricky (tridge)
2355 foreach my $e (@{$fn->{ELEMENTS}}) {
2356 next unless grep(/out/, @{$e->{DIRECTION}});
2357 $self->pidl("ZERO_STRUCT(r->out);");
2362 my $env = GenerateFunctionInEnv($fn);
2364 foreach my $e (@{$fn->{ELEMENTS}}) {
2365 next unless (grep(/in/, @{$e->{DIRECTION}}));
2366 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2369 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2370 # own flag rather than be in NDR_IN ?
2372 foreach my $e (@{$fn->{ELEMENTS}}) {
2373 next unless (grep(/out/, @{$e->{DIRECTION}}));
2374 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2375 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2376 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2377 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2378 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2379 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2380 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2382 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2383 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2384 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2385 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2386 check_fully_dereferenced($e, $env));
2387 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2389 if (grep(/in/, @{$e->{DIRECTION}})) {
2390 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2392 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2394 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2395 if (grep(/in/, @{$e->{DIRECTION}})) {
2396 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2398 $self->pidl("r->out.$e->{NAME} = NULL;");
2401 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2403 if (grep(/in/, @{$e->{DIRECTION}})) {
2404 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2406 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2411 $self->add_deferred();
2415 $self->pidl("if (flags & NDR_OUT) {");
2418 $env = GenerateFunctionOutEnv($fn);
2419 foreach my $e (@{$fn->{ELEMENTS}}) {
2420 next unless grep(/out/, @{$e->{DIRECTION}});
2421 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2424 if ($fn->{RETURN_TYPE}) {
2425 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2428 $self->add_deferred();
2432 $self->pidl("return NDR_ERR_SUCCESS;");
2438 sub AuthServiceStruct($$$)
2440 my ($self, $ifacename, $authservice) = @_;
2441 my @a = split /,/, $authservice;
2442 my $authservice_count = $#a + 1;
2444 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2445 foreach my $ap (@a) {
2446 $self->pidl("\t$ap, ");
2451 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2452 $self->pidl("\t.count\t= $authservice_count,");
2453 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2458 sub ParseGeneratePipeArray($$$)
2460 my ($self, $fn, $direction) = @_;
2462 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2465 foreach my $e (@{$fn->{ELEMENTS}}) {
2466 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2467 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2469 my $cname = "$e->{TYPE}_chunk";
2473 $self->pidl("\"$direction.$e->{NAME}\",");
2474 $self->pidl("\"$cname\",");
2475 $self->pidl("sizeof(struct $cname),");
2476 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2477 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2478 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2482 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2488 sub FunctionCallPipes($$)
2490 my ($self, $d) = @_;
2491 return if not defined($d->{OPNUM});
2496 foreach my $e (@{$d->{ELEMENTS}}) {
2497 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2499 if (grep(/in/, @{$e->{DIRECTION}})) {
2502 if (grep(/out/, @{$e->{DIRECTION}})) {
2508 $self->ParseGeneratePipeArray($d, "in");
2512 $self->ParseGeneratePipeArray($d, "out");
2516 sub FunctionCallEntry($$)
2518 my ($self, $d) = @_;
2519 return 0 if not defined($d->{OPNUM});
2524 foreach my $e (@{$d->{ELEMENTS}}) {
2525 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2527 if (grep(/in/, @{$e->{DIRECTION}})) {
2530 if (grep(/out/, @{$e->{DIRECTION}})) {
2535 my $in_pipes_ptr = "NULL";
2536 my $out_pipes_ptr = "NULL";
2539 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2543 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2547 $self->pidl("\t\t\"$d->{NAME}\",");
2548 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2549 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2550 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2551 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2552 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2553 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2554 $self->pidl("\t},");
2558 #####################################################################
2559 # produce a function call table
2560 sub FunctionTable($$)
2562 my($self,$interface) = @_;
2564 my $uname = uc $interface->{NAME};
2566 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2567 return unless defined ($interface->{PROPERTIES}->{uuid});
2569 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2570 $self->FunctionCallPipes($d);
2573 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2575 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2576 $count += $self->FunctionCallEntry($d);
2578 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2582 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2583 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2584 $self->pidl("\t$ep, ");
2586 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2591 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2592 $self->pidl("\t.count\t= $endpoint_count,");
2593 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2597 if (! defined $interface->{PROPERTIES}->{authservice}) {
2598 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2601 $self->AuthServiceStruct($interface->{NAME},
2602 $interface->{PROPERTIES}->{authservice});
2604 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2605 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2606 $self->pidl("\t.syntax_id\t= {");
2607 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2608 $self->pidl("\t\tNDR_$uname\_VERSION");
2609 $self->pidl("\t},");
2610 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2611 $self->pidl("\t.num_calls\t= $count,");
2612 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2613 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2614 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2620 #####################################################################
2621 # generate include statements for imported idl files
2626 foreach (@imports) {
2627 $_ = unmake_str($_);
2629 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2633 #####################################################################
2634 # generate include statements for included header files
2639 foreach (@includes) {
2640 $self->pidl_hdr("#include $_");
2644 #####################################################################
2645 # generate prototypes and defines for the interface definitions
2646 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2647 # NDR parser and so do not belong here, technically speaking
2648 sub HeaderInterface($$$)
2650 my($self,$interface,$needed) = @_;
2654 if ($needed->{"compression"}) {
2655 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2658 if (has_property($interface, "object")) {
2659 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2662 if (defined $interface->{PROPERTIES}->{helper}) {
2663 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2666 if (defined $interface->{PROPERTIES}->{uuid}) {
2667 my $name = uc $interface->{NAME};
2668 $self->pidl_hdr("#define NDR_$name\_UUID " .
2669 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
2671 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
2673 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2675 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2676 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2678 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2681 foreach (@{$interface->{FUNCTIONS}}) {
2682 next if has_property($_, "noopnum");
2683 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2684 my $u_name = uc $_->{NAME};
2686 my $val = sprintf("0x%02x", $count);
2687 if (defined($interface->{BASE})) {
2688 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2691 $self->pidl_hdr("#define NDR_$u_name ($val)");
2693 $self->pidl_hdr("");
2699 if (defined($interface->{BASE})) {
2700 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2703 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2707 sub ParseTypePush($$$$$$)
2709 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2711 # save the old relative_base_offset
2712 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2713 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2714 # restore the old relative_base_offset
2715 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2718 sub ParseTypePushFunction($$$)
2720 my ($self, $e, $varname) = @_;
2723 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2725 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2729 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2730 $self->pidl("return NDR_ERR_SUCCESS;");
2736 sub ParseTypePull($$$$$$)
2738 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2740 # save the old relative_base_offset
2741 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2742 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2743 # restore the old relative_base_offset
2744 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2747 sub ParseTypePullFunction($$)
2749 my ($self, $e, $varname) = @_;
2752 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2754 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2758 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2759 $self->pidl("return NDR_ERR_SUCCESS;");
2765 sub ParseTypePrint($$$$)
2767 my ($self, $e, $ndr, $varname) = @_;
2769 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2772 sub ParseTypePrintFunction($$$)
2774 my ($self, $e, $varname) = @_;
2777 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2779 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2781 return if (has_property($e, "noprint"));
2783 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2786 $self->ParseTypePrint($e, $ndr, $varname);
2792 sub ParseTypeNdrSize($$)
2797 my $tf = $typefamily{$t->{TYPE}};
2798 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2800 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2804 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2810 #####################################################################
2811 # parse the interface definitions
2812 sub ParseInterface($$$)
2814 my($self,$interface,$needed) = @_;
2816 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2817 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2819 $self->pidl_hdr("");
2821 $self->HeaderInterface($interface, $needed);
2824 foreach my $d (@{$interface->{TYPES}}) {
2825 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2826 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2827 $self->ParsePipePushChunk($d);
2828 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2829 $self->ParsePipePullChunk($d);
2830 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2831 $self->ParsePipePrintChunk($d);
2833 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2834 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2835 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2839 next unless(typeHasBody($d));
2841 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2842 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2843 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2845 # Make sure we don't generate a function twice...
2846 $needed->{TypeFunctionName("ndr_push", $d)} =
2847 $needed->{TypeFunctionName("ndr_pull", $d)} =
2848 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2850 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2854 foreach my $d (@{$interface->{FUNCTIONS}}) {
2855 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2856 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2857 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2860 $self->FunctionTable($interface);
2862 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2865 sub GenerateIncludes($)
2869 $self->pidl("#include \"includes.h\"");
2871 $self->pidl("#ifndef _GNU_SOURCE");
2872 $self->pidl("#define _GNU_SOURCE");
2873 $self->pidl("#endif");
2874 $self->pidl("#include <stdint.h>");
2875 $self->pidl("#include <stdlib.h>");
2876 $self->pidl("#include <stdio.h>");
2877 $self->pidl("#include <stdbool.h>");
2878 $self->pidl("#include <stdarg.h>");
2879 $self->pidl("#include <string.h>");
2883 #####################################################################
2884 # parse a parsed IDL structure back into an IDL file
2887 my($self, $ndr,$gen_header,$ndr_header) = @_;
2889 $self->pidl_hdr("/* header auto-generated by pidl */");
2890 $self->pidl_hdr("");
2891 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2892 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2893 $self->pidl_hdr("");
2895 $self->pidl("/* parser auto-generated by pidl */");
2897 $self->GenerateIncludes();
2898 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2904 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2908 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2909 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2910 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2913 return ($self->{res_hdr}, $self->{res});
2916 sub NeededElement($$$)
2918 my ($e, $dir, $needed) = @_;
2920 return if ($e->{TYPE} eq "EMPTY");
2922 return if (ref($e->{TYPE}) eq "HASH" and
2923 not defined($e->{TYPE}->{NAME}));
2926 if (ref($e->{TYPE}) eq "HASH") {
2927 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2932 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2933 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2935 $rt = $e->{REPRESENTATION_TYPE};
2938 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2941 if ($dir eq "print") {
2942 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2943 } elsif ($dir eq "pull") {
2944 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2945 push (@fn, "ndr_$t\_to_$rt")
2947 } elsif ($dir eq "push") {
2948 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2949 push (@fn, "ndr_$rt\_to_$t")
2952 die("invalid direction `$dir'");
2956 unless (defined($needed->{$_})) {
2962 sub NeededFunction($$)
2964 my ($fn,$needed) = @_;
2965 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2966 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2967 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2968 foreach my $e (@{$fn->{ELEMENTS}}) {
2970 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2976 sub NeededType($$$);
2977 my ($t,$needed,$req) = @_;
2979 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2980 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
2982 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2983 return unless defined($t->{ELEMENTS});
2984 for my $e (@{$t->{ELEMENTS}}) {
2986 if (has_property($e, "compression")) {
2987 $needed->{"compression"} = 1;
2989 NeededElement($e, $req, $needed);
2990 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2995 #####################################################################
2996 # work out what parse functions are needed
2997 sub NeededInterface($$)
2999 my ($interface,$needed) = @_;
3000 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3001 foreach (reverse @{$interface->{TYPES}}) {
3003 if (has_property($_, "public")) {
3004 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3005 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3008 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3009 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3010 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3011 if (has_property($_, "gensize")) {
3012 $needed->{"ndr_size_$_->{NAME}"} = 1;
3017 sub TypeFunctionName($$)
3019 my ($prefix, $t) = @_;
3021 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3022 $t->{TYPE} eq "TYPEDEF");
3023 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3024 return "$prefix\_$t";