1 ###################################################
2 # Samba4 NDR parser generator for IDL structures
3 # Copyright tridge@samba.org 2000-2003
4 # Copyright tpot@samba.org 2001
5 # Copyright jelmer@samba.org 2004-2006
6 # released under the GNU GPL
8 package Parse::Pidl::Samba4::NDR::Parser;
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid unmake_str);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
21 use Parse::Pidl qw(warning);
23 use vars qw($VERSION);
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
38 return $typefamily{$n};
43 my ($e, $var_name) = @_;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
50 } elsif ($l->{TYPE} eq "ARRAY") {
52 if (($pointers == 0) and
53 (not $l->{IS_FIXED}) and
54 (not $l->{IS_INLINE})) {
55 return get_value_of($var_name);
57 } elsif ($l->{TYPE} eq "DATA") {
58 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
59 return get_value_of($var_name) unless ($pointers or $arrays);
67 sub has_fast_array($$)
71 return 0 if ($l->{TYPE} ne "ARRAY");
73 my $nl = GetNextLevel($e,$l);
74 return 0 unless ($nl->{TYPE} eq "DATA");
75 return 0 unless (hasType($nl->{DATA_TYPE}));
77 my $t = getType($nl->{DATA_TYPE});
79 # Only uint8 and string have fast array functions at the moment
80 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
84 ####################################
85 # pidl() is our basic output routine
90 $self->{res} .= $self->{tabs};
96 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
98 ####################################
99 # defer() is like pidl(), but adds to
100 # a deferred buffer which is then added to the
101 # output buffer at the end of the structure/union/function
102 # This is needed to cope with code that must be pushed back
103 # to the end of a block of elements
104 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
105 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
129 $self->{tabs} .= "\t";
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
153 $self->pidl("static $decl");
159 ###################################################################
160 # setup any special flags for an element or structure
163 my ($self, $e, $ndr) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
168 $self->pidl("uint32_t _flags_save_$e->{TYPE} = $ndr->flags;");
169 $self->pidl("ndr_set_flags(&$ndr->flags, $flags);");
173 ###################################################################
174 # end any special flags for an element or structure
177 my ($self, $e, $ndr) = @_;
178 my $flags = has_property($e, "flag");
179 if (defined $flags) {
180 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
201 if (defined($l->{SIZE_IS})) {
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
204 if (defined($l->{LENGTH_IS})) {
205 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
208 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
209 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
212 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
213 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
216 if ($l->{IS_VARYING}) {
217 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));"); # array offset
218 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
224 sub check_fully_dereferenced($$)
226 my ($element, $env) = @_;
232 # Figure out the number of pointers in $ptr
233 my $expandedvar = $origvar;
234 $expandedvar =~ s/^(\**)//;
238 foreach (keys %$env) {
239 if ($env->{$_} eq $expandedvar) {
245 return($origvar) unless (defined($var));
247 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
248 if ($_->{NAME} eq $var) {
254 $e or die("Environment doesn't match siblings");
256 # See if pointer at pointer level $level
257 # needs to be checked.
259 foreach (@{$e->{LEVELS}}) {
260 if ($_->{TYPE} eq "POINTER") {
261 $nump = $_->{POINTER_INDEX}+1;
264 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully dereferenced variable") if ($nump > length($ptr));
269 sub check_null_pointer($$$$)
271 my ($element, $env, $print_fn, $return) = @_;
274 my $expandedvar = shift;
277 # Figure out the number of pointers in $ptr
278 $expandedvar =~ s/^(\**)//;
282 foreach (keys %$env) {
283 if ($env->{$_} eq $expandedvar) {
292 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
293 if ($_->{NAME} eq $var) {
299 $e or die("Environment doesn't match siblings");
301 # See if pointer at pointer level $level
302 # needs to be checked.
303 foreach my $l (@{$e->{LEVELS}}) {
304 if ($l->{TYPE} eq "POINTER" and
305 $l->{POINTER_INDEX} == length($ptr)) {
306 # No need to check ref pointers
307 $check = ($l->{POINTER_TYPE} ne "ref");
311 if ($l->{TYPE} eq "DATA") {
312 warning($element, "too much dereferences for `$var'");
316 warning($element, "unknown dereferenced expression `$expandedvar'");
320 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
324 sub is_deferred_switch_non_empty($)
326 # 1 if there needs to be a deferred branch in an ndr_pull/push,
329 my $have_default = 0;
330 foreach my $el (@{$e->{ELEMENTS}}) {
331 if ($el->{CASE} eq "default") {
334 if ($el->{TYPE} ne "EMPTY") {
335 if (ContainsDeferred($el, $el->{LEVELS}[0])) {
340 return ! $have_default;
343 sub ParseArrayPullGetSize($$$$$$)
345 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
349 if ($l->{IS_CONFORMANT}) {
350 $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
351 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
352 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
354 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
355 check_null_pointer($e, $env, sub { $self->pidl(shift); },
356 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
357 check_fully_dereferenced($e, $env));
360 $self->pidl("size_$e->{NAME}_$l->{LEVEL_INDEX} = $size;");
361 my $array_size = "size_$e->{NAME}_$l->{LEVEL_INDEX}";
363 if (my $range = has_property($e, "range")) {
364 my ($low, $high) = split(/,/, $range, 2);
366 warning(0, "$low is invalid for the range of an array size");
369 $self->pidl("if ($array_size > $high) {");
371 $self->pidl("if ($array_size < $low || $array_size > $high) {");
373 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
380 #####################################################################
381 # parse an array - pull side
382 sub ParseArrayPullGetLength($$$$$$;$)
384 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
386 if (not defined($array_size)) {
387 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
390 if (not $l->{IS_VARYING}) {
394 my $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
395 $self->pidl("length_$e->{NAME}_$l->{LEVEL_INDEX} = $length;");
396 my $array_length = "length_$e->{NAME}_$l->{LEVEL_INDEX}";
398 if (my $range = has_property($e, "range")) {
399 my ($low, $high) = split(/,/, $range, 2);
401 warning(0, "$low is invalid for the range of an array size");
404 $self->pidl("if ($array_length > $high) {");
406 $self->pidl("if ($array_length < $low || $array_length > $high) {");
408 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
412 return $array_length;
415 #####################################################################
416 # parse an array - pull side
417 sub ParseArrayPullHeader($$$$$$)
419 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
421 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
422 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
425 if ($l->{IS_VARYING}) {
426 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
429 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
430 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
432 if ($array_length ne $array_size) {
433 $self->pidl("if ($array_length > $array_size) {");
435 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
440 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
441 $self->defer("if ($var_name) {");
443 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
444 check_null_pointer($e, $env, sub { $self->defer(shift); },
445 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
446 check_fully_dereferenced($e, $env));
447 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
448 $self->defer_deindent;
452 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
453 $self->defer("if ($var_name) {");
455 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
456 check_null_pointer($e, $env, sub { $self->defer(shift); },
457 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
458 check_fully_dereferenced($e, $env));
459 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
460 $self->defer_deindent;
464 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
465 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
468 return $array_length;
471 sub compression_alg($$)
474 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
479 sub compression_clen($$$)
481 my ($e, $l, $env) = @_;
482 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
484 return ParseExpr($clen, $env, $e->{ORIGINAL});
487 sub compression_dlen($$$)
489 my ($e,$l,$env) = @_;
490 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
492 return ParseExpr($dlen, $env, $e->{ORIGINAL});
495 sub ParseCompressionPushStart($$$$$)
497 my ($self,$e,$l,$ndr,$env) = @_;
498 my $comndr = "$ndr\_compressed";
499 my $alg = compression_alg($e, $l);
500 my $dlen = compression_dlen($e, $l, $env);
504 $self->pidl("struct ndr_push *$comndr;");
505 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
510 sub ParseCompressionPushEnd($$$$$)
512 my ($self,$e,$l,$ndr,$env) = @_;
513 my $comndr = "$ndr\_compressed";
514 my $alg = compression_alg($e, $l);
515 my $dlen = compression_dlen($e, $l, $env);
517 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
522 sub ParseCompressionPullStart($$$$$)
524 my ($self,$e,$l,$ndr,$env) = @_;
525 my $comndr = "$ndr\_compressed";
526 my $alg = compression_alg($e, $l);
527 my $dlen = compression_dlen($e, $l, $env);
531 $self->pidl("struct ndr_pull *$comndr;");
532 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
537 sub ParseCompressionPullEnd($$$$$)
539 my ($self,$e,$l,$ndr,$env) = @_;
540 my $comndr = "$ndr\_compressed";
541 my $alg = compression_alg($e, $l);
542 my $dlen = compression_dlen($e, $l, $env);
544 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
549 sub ParseSubcontextPushStart($$$$$)
551 my ($self,$e,$l,$ndr,$env) = @_;
552 my $subndr = "_ndr_$e->{NAME}";
553 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
557 $self->pidl("struct ndr_push *$subndr;");
558 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
560 if (defined $l->{COMPRESSION}) {
561 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
567 sub ParseSubcontextPushEnd($$$$$)
569 my ($self,$e,$l,$ndr,$env) = @_;
570 my $subndr = "_ndr_$e->{NAME}";
571 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
573 if (defined $l->{COMPRESSION}) {
574 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
577 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
582 sub ParseSubcontextPullStart($$$$$)
584 my ($self,$e,$l,$ndr,$env) = @_;
585 my $subndr = "_ndr_$e->{NAME}";
586 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
590 $self->pidl("struct ndr_pull *$subndr;");
591 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
593 if (defined $l->{COMPRESSION}) {
594 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
600 sub ParseSubcontextPullEnd($$$$$)
602 my ($self,$e,$l,$ndr,$env) = @_;
603 my $subndr = "_ndr_$e->{NAME}";
604 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
606 if (defined $l->{COMPRESSION}) {
607 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
610 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
615 sub ParseElementPushLevel
617 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
619 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
621 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
622 $var_name = get_pointer_to($var_name);
625 if (defined($ndr_flags)) {
626 if ($l->{TYPE} eq "SUBCONTEXT") {
627 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
628 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
629 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
630 } elsif ($l->{TYPE} eq "POINTER") {
631 $self->ParsePtrPush($e, $l, $ndr, $var_name);
632 } elsif ($l->{TYPE} eq "ARRAY") {
633 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
635 my $nl = GetNextLevel($e, $l);
637 # Allow speedups for arrays of scalar types
638 if (is_charset_array($e,$l)) {
639 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
641 } elsif (has_fast_array($e,$l)) {
642 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
645 } elsif ($l->{TYPE} eq "SWITCH") {
646 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
647 } elsif ($l->{TYPE} eq "DATA") {
648 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
649 } elsif ($l->{TYPE} eq "TYPEDEF") {
650 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
654 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
655 $self->pidl("/* [ignore] '$e->{NAME}' */");
656 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
657 my $rel_var_name = $var_name;
658 if ($l->{POINTER_TYPE} ne "ref") {
659 $self->pidl("if ($var_name) {");
661 if ($l->{POINTER_TYPE} eq "relative") {
662 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
664 if ($l->{POINTER_TYPE} eq "relative_short") {
665 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
668 $var_name = get_value_of($var_name);
669 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
671 if ($l->{POINTER_TYPE} ne "ref") {
672 if ($l->{POINTER_TYPE} eq "relative") {
673 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
678 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
679 not is_charset_array($e, $l)) {
680 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
681 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
683 my $array_pointless = ($length eq "0");
685 if ($array_pointless) {
686 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
689 $var_name = get_array_element($var_name, $counter);
691 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
692 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
694 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
699 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
700 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
702 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
706 } elsif ($l->{TYPE} eq "SWITCH") {
707 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
711 #####################################################################
712 # parse scalars in a structure element
713 sub ParseElementPush($$$$$$)
715 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
718 my $var_name = $env->{$e->{NAME}};
720 return if ContainsPipe($e, $e->{LEVELS}[0]);
722 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
724 # Representation type is different from transmit_as
725 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
728 my $transmit_name = "_transmit_$e->{NAME}";
729 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
730 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
731 $var_name = $transmit_name;
734 $var_name = append_prefix($e, $var_name);
736 $self->start_flags($e, $ndr);
738 if (defined(my $value = has_property($e, "value"))) {
739 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
742 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
744 $self->end_flags($e, $ndr);
746 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
752 #####################################################################
753 # parse a pointer in a struct element or function
754 sub ParsePtrPush($$$$$)
756 my ($self,$e,$l,$ndr,$var_name) = @_;
758 if ($l->{POINTER_TYPE} eq "ref") {
759 if ($l->{LEVEL_INDEX} > 0) {
760 $self->pidl("if ($var_name == NULL) {");
762 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
766 if ($l->{LEVEL} eq "EMBEDDED") {
767 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr)); /* $var_name */");
769 } elsif ($l->{POINTER_TYPE} eq "relative") {
770 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
771 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
772 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
773 } elsif ($l->{POINTER_TYPE} eq "unique") {
774 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
775 } elsif ($l->{POINTER_TYPE} eq "full") {
776 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
777 } elsif ($l->{POINTER_TYPE} eq "ignore") {
778 # We don't want this pointer to appear on the wire at all
779 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
781 die("Unhandled pointer type $l->{POINTER_TYPE}");
785 sub need_pointer_to($$$)
787 my ($e, $l, $scalar_only) = @_;
790 if (ref($l->{DATA_TYPE})) {
791 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
793 $t = $l->{DATA_TYPE};
796 if (not Parse::Pidl::Typelist::is_scalar($t)) {
797 return 1 if $scalar_only;
802 foreach my $tl (@{$e->{LEVELS}}) {
804 if ($tl->{TYPE} eq "ARRAY") {
809 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
810 return 1 unless $arrays;
816 sub ParseDataPrint($$$$$)
818 my ($self, $e, $l, $ndr, $var_name) = @_;
820 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
822 if (need_pointer_to($e, $l, 1)) {
823 $var_name = get_pointer_to($var_name);
826 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
828 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
832 #####################################################################
833 # print scalars in a structure element
834 sub ParseElementPrint($$$$$)
836 my($self, $e, $ndr, $var_name, $env) = @_;
838 return if (has_property($e, "noprint"));
840 my $ignore_depth = 0xFFFF;
842 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
843 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
847 $var_name = append_prefix($e, $var_name);
849 if (defined(my $value = has_property($e, "value"))) {
850 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
853 foreach my $l (@{$e->{LEVELS}}) {
856 if ($cur_depth > $ignore_depth) {
860 if ($l->{TYPE} eq "POINTER") {
861 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
862 if ($l->{POINTER_TYPE} eq "ignore") {
863 $self->pidl("/* [ignore] '$e->{NAME}' */");
864 $ignore_depth = $cur_depth;
867 $self->pidl("$ndr->depth++;");
868 if ($l->{POINTER_TYPE} ne "ref") {
869 $self->pidl("if ($var_name) {");
872 $var_name = get_value_of($var_name);
873 } elsif ($l->{TYPE} eq "ARRAY") {
876 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
877 $var_name = get_pointer_to($var_name);
880 if ($l->{IS_ZERO_TERMINATED} and not defined($l->{LENGTH_IS})) {
881 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
883 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
884 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
887 if (is_charset_array($e,$l)) {
888 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
890 } elsif (has_fast_array($e, $l)) {
891 my $nl = GetNextLevel($e, $l);
892 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
895 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
897 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
898 $self->pidl("$ndr->depth++;");
899 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
902 $var_name = get_array_element($var_name, $counter);
904 } elsif ($l->{TYPE} eq "DATA") {
905 $self->ParseDataPrint($e, $l, $ndr, $var_name);
906 } elsif ($l->{TYPE} eq "SWITCH") {
907 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
908 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
909 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
913 foreach my $l (reverse @{$e->{LEVELS}}) {
916 if ($cur_depth > $ignore_depth) {
920 if ($l->{TYPE} eq "POINTER") {
921 if ($l->{POINTER_TYPE} eq "ignore") {
925 if ($l->{POINTER_TYPE} ne "ref") {
929 $self->pidl("$ndr->depth--;");
930 } elsif (($l->{TYPE} eq "ARRAY")
931 and not is_charset_array($e,$l)
932 and not has_fast_array($e,$l)) {
935 $self->pidl("$ndr->depth--;");
940 #####################################################################
941 # parse scalars in a structure element - pull size
942 sub ParseSwitchPull($$$$$$)
944 my($self,$e,$l,$ndr,$var_name,$env) = @_;
945 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
946 check_null_pointer($e, $env, sub { $self->pidl(shift); },
947 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
948 check_fully_dereferenced($e, $env));
950 $var_name = get_pointer_to($var_name);
951 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
954 #####################################################################
955 # push switch element
956 sub ParseSwitchPush($$$$$$)
958 my($self,$e,$l,$ndr,$var_name,$env) = @_;
959 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
960 check_null_pointer($e, $env, sub { $self->pidl(shift); },
961 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
962 check_fully_dereferenced($e, $env));
964 $var_name = get_pointer_to($var_name);
965 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
968 sub ParseDataPull($$$$$$$)
970 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
972 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
974 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
976 if (need_pointer_to($e, $l, 0)) {
977 $var_name = get_pointer_to($var_name);
980 $var_name = get_pointer_to($var_name);
982 if (has_property($e, "skip")) {
983 $self->pidl("/* [skip] '$var_name' */");
985 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
988 my $pl = GetPrevLevel($e, $l);
990 my $range = has_property($e, "range");
991 if ($range and $pl->{TYPE} ne "ARRAY") {
992 $var_name = get_value_of($var_name);
993 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
994 my ($low, $high) = split(/,/, $range, 2);
995 if ($low < 0 and not $signed) {
996 warning(0, "$low is invalid for the range of an unsigned type");
998 if ($low == 0 and not $signed) {
999 $self->pidl("if ($var_name > $high) {");
1001 $self->pidl("if ($var_name < $low || $var_name > $high) {");
1003 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1007 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1011 sub ParseDataPush($$$$$$$)
1013 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
1015 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
1017 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1019 # strings are passed by value rather than reference
1020 if (need_pointer_to($e, $l, 1)) {
1021 $var_name = get_pointer_to($var_name);
1024 if (has_property($e, "skip")) {
1025 $self->pidl("/* [skip] '$var_name' */");
1027 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
1030 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1034 sub CalcNdrFlags($$$)
1036 my ($l,$primitives,$deferred) = @_;
1041 # Add NDR_SCALARS if this one is deferred
1042 # and deferreds may be pushed
1043 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
1045 # Add NDR_SCALARS if this one is not deferred and
1046 # primitives may be pushed
1047 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
1049 # Add NDR_BUFFERS if this one contains deferred stuff
1050 # and deferreds may be pushed
1051 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
1053 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
1054 return "NDR_SCALARS" if ($scalars);
1055 return "NDR_BUFFERS" if ($buffers);
1059 sub ParseMemCtxPullFlags($$$$)
1061 my ($self, $e, $l) = @_;
1063 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1064 return undef if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore"));
1066 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1067 return undef if has_fast_array($e, $l);
1068 return undef if is_charset_array($e, $l);
1070 my $mem_flags = "0";
1072 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1073 my $nl = GetNextLevel($e, $l);
1074 return undef if ($nl->{TYPE} eq "PIPE");
1075 return undef if ($nl->{TYPE} eq "ARRAY");
1076 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1078 if ($l->{LEVEL} eq "TOP") {
1079 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1086 sub ParseMemCtxPullStart($$$$$)
1088 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1090 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1091 my $mem_c_ctx = $ptr_name;
1092 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1094 return unless defined($mem_c_flags);
1096 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1097 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1100 sub ParseMemCtxPullEnd($$$$)
1102 my ($self, $e, $l, $ndr) = @_;
1104 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1105 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1107 return unless defined($mem_r_flags);
1109 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1112 sub CheckStringTerminator($$$$$)
1114 my ($self,$ndr,$e,$l,$length) = @_;
1115 my $nl = GetNextLevel($e, $l);
1117 # Make sure last element is zero!
1118 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1121 sub ParseElementPullLevel
1123 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1125 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1126 my $array_length = undef;
1128 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1129 $var_name = get_pointer_to($var_name);
1132 # Only pull something if there's actually something to be pulled
1133 if (defined($ndr_flags)) {
1134 if ($l->{TYPE} eq "SUBCONTEXT") {
1135 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1136 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1137 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1138 } elsif ($l->{TYPE} eq "ARRAY") {
1139 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1140 $array_length = $length;
1142 my $nl = GetNextLevel($e, $l);
1144 if (is_charset_array($e,$l)) {
1145 if ($l->{IS_ZERO_TERMINATED}) {
1146 $self->CheckStringTerminator($ndr, $e, $l, $length);
1148 if ($l->{IS_TO_NULL}) {
1149 $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}));");
1151 $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}));");
1154 } elsif (has_fast_array($e, $l)) {
1155 if ($l->{IS_ZERO_TERMINATED}) {
1156 $self->CheckStringTerminator($ndr,$e,$l,$length);
1158 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1161 } elsif ($l->{TYPE} eq "POINTER") {
1162 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1163 } elsif ($l->{TYPE} eq "SWITCH") {
1164 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1165 } elsif ($l->{TYPE} eq "DATA") {
1166 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1167 } elsif ($l->{TYPE} eq "TYPEDEF") {
1168 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1172 # add additional constructions
1173 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
1174 $self->pidl("/* [ignore] '$e->{NAME}' */");
1175 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
1176 if ($l->{POINTER_TYPE} ne "ref") {
1177 $self->pidl("if ($var_name) {");
1180 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1181 $self->pidl("uint32_t _relative_save_offset;");
1182 $self->pidl("_relative_save_offset = $ndr->offset;");
1183 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1187 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1189 $var_name = get_value_of($var_name);
1190 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1192 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1194 if ($l->{POINTER_TYPE} ne "ref") {
1195 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1196 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1198 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1201 $self->pidl("$ndr->offset = _relative_save_offset;");
1206 } elsif ($l->{TYPE} eq "ARRAY" and
1207 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1208 my $length = $array_length;
1209 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1210 my $array_name = $var_name;
1212 if (not defined($length)) {
1213 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1216 $var_name = get_array_element($var_name, $counter);
1218 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1220 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1221 my $nl = GetNextLevel($e,$l);
1223 if ($l->{IS_ZERO_TERMINATED}) {
1224 $self->CheckStringTerminator($ndr,$e,$l,$length);
1227 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1229 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1234 if ($deferred and ContainsDeferred($e, $l)) {
1235 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1237 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1242 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1244 } elsif ($l->{TYPE} eq "SWITCH") {
1245 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1249 #####################################################################
1250 # parse scalars in a structure element - pull size
1251 sub ParseElementPull($$$$$$)
1253 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1255 my $var_name = $env->{$e->{NAME}};
1259 return if ContainsPipe($e, $e->{LEVELS}[0]);
1261 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1263 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1266 $represent_name = $var_name;
1267 $transmit_name = "_transmit_$e->{NAME}";
1268 $var_name = $transmit_name;
1269 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1272 $var_name = append_prefix($e, $var_name);
1274 $self->start_flags($e, $ndr);
1276 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1278 $self->end_flags($e, $ndr);
1280 # Representation type is different from transmit_as
1281 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1282 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1288 #####################################################################
1289 # parse a pointer in a struct element or function
1290 sub ParsePtrPull($$$$$)
1292 my($self, $e,$l,$ndr,$var_name) = @_;
1294 my $nl = GetNextLevel($e, $l);
1295 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1296 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1297 ($nl->{DATA_TYPE} eq "string"));
1299 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1301 if (!$next_is_array and !$next_is_string) {
1302 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1303 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1308 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1309 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1310 } elsif (($l->{POINTER_TYPE} eq "unique") or
1311 ($l->{POINTER_TYPE} eq "relative") or
1312 ($l->{POINTER_TYPE} eq "full")) {
1313 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1314 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1315 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1316 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1317 #We want to consume the pointer bytes, but ignore the pointer value
1318 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1319 $self->pidl("_ptr_$e->{NAME} = 0;");
1321 die("Unhandled pointer type $l->{POINTER_TYPE}");
1324 $self->pidl("if (_ptr_$e->{NAME}) {");
1327 if ($l->{POINTER_TYPE} eq "ignore") {
1328 # Don't do anything, we don't want to do the
1329 # allocation, as we forced it to NULL just above, and
1330 # we may not know the declared type anyway.
1332 # Don't do this for arrays, they're allocated at the actual level
1334 unless ($next_is_array or $next_is_string) {
1335 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1337 # FIXME: Yes, this is nasty.
1338 # We allocate an array twice
1339 # - once just to indicate that it's there,
1340 # - then the real allocation...
1341 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1345 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1346 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1347 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1350 $self->pidl("} else {");
1351 $self->pidl("\t$var_name = NULL;");
1355 sub CheckRefPtrs($$$$)
1357 my ($self,$e,$ndr,$env) = @_;
1359 return if ContainsPipe($e, $e->{LEVELS}[0]);
1360 return if ($e->{LEVELS}[0]->{TYPE} ne "POINTER");
1361 return if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref");
1363 my $var_name = $env->{$e->{NAME}};
1364 $var_name = append_prefix($e, $var_name);
1366 $self->pidl("if ($var_name == NULL) {");
1368 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
1373 sub ParseStructPushPrimitives($$$$$)
1375 my ($self, $struct, $ndr, $varname, $env) = @_;
1377 $self->CheckRefPtrs($_, $ndr, $env) foreach (@{$struct->{ELEMENTS}});
1379 # see if the structure contains a conformant array. If it
1380 # does, then it must be the last element of the structure, and
1381 # we need to push the conformant length early, as it fits on
1382 # the wire before the structure (and even before the structure
1384 if (defined($struct->{SURROUNDING_ELEMENT})) {
1385 my $e = $struct->{SURROUNDING_ELEMENT};
1387 if (defined($e->{LEVELS}[0]) and
1388 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1391 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1392 if (has_property($e, "charset")) {
1393 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1395 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1397 if (defined($e->{LEVELS}[0]->{SIZE_IS})) {
1398 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1401 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1404 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1406 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1410 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1412 if (defined($struct->{PROPERTIES}{relative_base})) {
1413 # set the current offset as base for relative pointers
1414 # and store it based on the toplevel struct/union
1415 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1418 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1420 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1423 sub ParseStructPushDeferred($$$$)
1425 my ($self, $struct, $ndr, $varname, $env) = @_;
1426 if (defined($struct->{PROPERTIES}{relative_base})) {
1427 # retrieve the current offset as base for relative pointers
1428 # based on the toplevel struct/union
1429 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1431 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1434 #####################################################################
1436 sub ParseStructPush($$$$)
1438 my ($self, $struct, $ndr, $varname) = @_;
1440 return unless defined($struct->{ELEMENTS});
1442 my $env = GenerateStructEnv($struct, $varname);
1444 EnvSubstituteValue($env, $struct);
1446 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1448 $self->start_flags($struct, $ndr);
1450 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1451 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1453 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1457 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1459 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1463 $self->end_flags($struct, $ndr);
1466 #####################################################################
1467 # generate a push function for an enum
1468 sub ParseEnumPush($$$$)
1470 my($self,$enum,$ndr,$varname) = @_;
1471 my($type_fn) = $enum->{BASE_TYPE};
1473 $self->start_flags($enum, $ndr);
1474 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1475 $self->end_flags($enum, $ndr);
1478 #####################################################################
1479 # generate a pull function for an enum
1480 sub ParseEnumPull($$$$)
1482 my($self,$enum,$ndr,$varname) = @_;
1483 my($type_fn) = $enum->{BASE_TYPE};
1484 my($type_v_decl) = mapTypeName($type_fn);
1486 $self->pidl("$type_v_decl v;");
1487 $self->start_flags($enum, $ndr);
1488 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1489 $self->pidl("*$varname = v;");
1491 $self->end_flags($enum, $ndr);
1494 #####################################################################
1495 # generate a print function for an enum
1496 sub ParseEnumPrint($$$$$)
1498 my($self,$enum,$ndr,$name,$varname) = @_;
1500 $self->pidl("const char *val = NULL;");
1503 $self->start_flags($enum, $ndr);
1505 $self->pidl("switch ($varname) {");
1507 my $els = \@{$enum->{ELEMENTS}};
1508 foreach my $i (0 .. $#{$els}) {
1509 my $e = ${$els}[$i];
1511 if ($e =~ /^(.*)=/) {
1514 $self->pidl("case $e: val = \"$e\"; break;");
1520 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1522 $self->end_flags($enum, $ndr);
1527 my ($e,$t,$name,$varname) = @_;
1528 return "enum $name " .
1529 ($t eq "pull"?"*":"") . $varname;
1532 $typefamily{ENUM} = {
1534 PUSH_FN_BODY => \&ParseEnumPush,
1535 PULL_FN_BODY => \&ParseEnumPull,
1536 PRINT_FN_BODY => \&ParseEnumPrint,
1539 #####################################################################
1540 # generate a push function for a bitmap
1541 sub ParseBitmapPush($$$$)
1543 my($self,$bitmap,$ndr,$varname) = @_;
1544 my($type_fn) = $bitmap->{BASE_TYPE};
1546 $self->start_flags($bitmap, $ndr);
1548 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1550 $self->end_flags($bitmap, $ndr);
1553 #####################################################################
1554 # generate a pull function for an bitmap
1555 sub ParseBitmapPull($$$$)
1557 my($self,$bitmap,$ndr,$varname) = @_;
1558 my $type_fn = $bitmap->{BASE_TYPE};
1559 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1561 $self->pidl("$type_decl v;");
1562 $self->start_flags($bitmap, $ndr);
1563 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1564 $self->pidl("*$varname = v;");
1566 $self->end_flags($bitmap, $ndr);
1569 #####################################################################
1570 # generate a print function for an bitmap
1571 sub ParseBitmapPrintElement($$$$$$)
1573 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1574 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1575 my($type_fn) = $bitmap->{BASE_TYPE};
1578 if ($e =~ /^(\w+) .*$/) {
1581 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1584 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1587 #####################################################################
1588 # generate a print function for an bitmap
1589 sub ParseBitmapPrint($$$$$)
1591 my($self,$bitmap,$ndr,$name,$varname) = @_;
1592 my($type_decl) = mapTypeName($bitmap->{TYPE});
1593 my($type_fn) = $bitmap->{BASE_TYPE};
1595 $self->start_flags($bitmap, $ndr);
1597 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1599 $self->pidl("$ndr->depth++;");
1600 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1601 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1603 $self->pidl("$ndr->depth--;");
1605 $self->end_flags($bitmap, $ndr);
1608 sub DeclBitmap($$$$)
1610 my ($e,$t,$name,$varname) = @_;
1611 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1612 ($t eq "pull"?" *":" ") . $varname;
1615 $typefamily{BITMAP} = {
1616 DECL => \&DeclBitmap,
1617 PUSH_FN_BODY => \&ParseBitmapPush,
1618 PULL_FN_BODY => \&ParseBitmapPull,
1619 PRINT_FN_BODY => \&ParseBitmapPrint,
1622 #####################################################################
1623 # generate a struct print function
1624 sub ParseStructPrint($$$$$)
1626 my($self,$struct,$ndr,$name,$varname) = @_;
1628 return unless defined $struct->{ELEMENTS};
1630 my $env = GenerateStructEnv($struct, $varname);
1632 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1634 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1635 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1637 $self->start_flags($struct, $ndr);
1639 $self->pidl("$ndr->depth++;");
1641 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1642 foreach (@{$struct->{ELEMENTS}});
1643 $self->pidl("$ndr->depth--;");
1645 $self->end_flags($struct, $ndr);
1648 sub DeclarePtrVariables($$)
1651 foreach my $l (@{$e->{LEVELS}}) {
1653 if ($l->{TYPE} eq "POINTER" and
1654 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1655 if ($l->{POINTER_TYPE} eq "relative_short") {
1658 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1664 sub DeclareArrayVariables($$;$)
1666 my ($self,$e,$pull) = @_;
1668 foreach my $l (@{$e->{LEVELS}}) {
1669 next if ($l->{TYPE} ne "ARRAY");
1670 if (defined($pull)) {
1671 $self->pidl("uint32_t size_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1672 if ($l->{IS_VARYING}) {
1673 $self->pidl("uint32_t length_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1676 next if has_fast_array($e,$l);
1677 next if is_charset_array($e,$l);
1678 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1682 sub DeclareArrayVariablesNoZero($$$)
1684 my ($self,$e,$env) = @_;
1686 foreach my $l (@{$e->{LEVELS}}) {
1687 next if ($l->{TYPE} ne "ARRAY");
1688 next if has_fast_array($e,$l);
1689 next if is_charset_array($e,$l);
1690 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1691 if ($length eq "0") {
1692 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1694 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1699 sub DeclareMemCtxVariables($$)
1702 foreach my $l (@{$e->{LEVELS}}) {
1703 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1705 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore")) {
1709 if (defined($mem_flags)) {
1710 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX} = NULL;");
1715 sub ParseStructPullPrimitives($$$$$)
1717 my($self,$struct,$ndr,$varname,$env) = @_;
1719 if (defined $struct->{SURROUNDING_ELEMENT}) {
1720 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1723 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1725 if (defined($struct->{PROPERTIES}{relative_base})) {
1726 # set the current offset as base for relative pointers
1727 # and store it based on the toplevel struct/union
1728 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1731 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1733 $self->add_deferred();
1735 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1738 sub ParseStructPullDeferred($$$$$)
1740 my ($self,$struct,$ndr,$varname,$env) = @_;
1742 if (defined($struct->{PROPERTIES}{relative_base})) {
1743 # retrieve the current offset as base for relative pointers
1744 # based on the toplevel struct/union
1745 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1747 foreach my $e (@{$struct->{ELEMENTS}}) {
1748 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1751 $self->add_deferred();
1754 #####################################################################
1755 # parse a struct - pull side
1756 sub ParseStructPull($$$$)
1758 my($self,$struct,$ndr,$varname) = @_;
1760 return unless defined $struct->{ELEMENTS};
1762 # declare any internal pointers we need
1763 foreach my $e (@{$struct->{ELEMENTS}}) {
1764 $self->DeclarePtrVariables($e);
1765 $self->DeclareArrayVariables($e, "pull");
1766 $self->DeclareMemCtxVariables($e);
1769 $self->start_flags($struct, $ndr);
1771 my $env = GenerateStructEnv($struct, $varname);
1773 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
1774 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1776 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1779 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1781 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1785 $self->end_flags($struct, $ndr);
1788 #####################################################################
1789 # calculate size of ndr struct
1790 sub ParseStructNdrSize($$$$)
1792 my ($self,$t, $name, $varname) = @_;
1795 if (my $flags = has_property($t, "flag")) {
1796 $self->pidl("flags |= $flags;");
1798 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1801 sub DeclStruct($$$$)
1803 my ($e,$t,$name,$varname) = @_;
1804 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1807 sub ArgsStructNdrSize($$$)
1809 my ($d, $name, $varname) = @_;
1810 return "const struct $name *$varname, int flags";
1813 $typefamily{STRUCT} = {
1814 PUSH_FN_BODY => \&ParseStructPush,
1815 DECL => \&DeclStruct,
1816 PULL_FN_BODY => \&ParseStructPull,
1817 PRINT_FN_BODY => \&ParseStructPrint,
1818 SIZE_FN_BODY => \&ParseStructNdrSize,
1819 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1822 #####################################################################
1823 # calculate size of ndr struct
1824 sub ParseUnionNdrSize($$$)
1826 my ($self, $t, $name, $varname) = @_;
1829 if (my $flags = has_property($t, "flag")) {
1830 $self->pidl("flags |= $flags;");
1833 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1836 sub ParseUnionPushPrimitives($$$$)
1838 my ($self, $e, $ndr ,$varname) = @_;
1840 my $have_default = 0;
1842 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1844 if (defined($e->{SWITCH_TYPE})) {
1845 if (defined($e->{ALIGN})) {
1846 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1849 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1852 if (defined($e->{ALIGN})) {
1853 if ($e->{IS_MS_UNION}) {
1854 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1855 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1857 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1861 $self->pidl("switch (level) {");
1863 foreach my $el (@{$e->{ELEMENTS}}) {
1864 if ($el->{CASE} eq "default") {
1867 $self->pidl("$el->{CASE}: {");
1869 if ($el->{TYPE} ne "EMPTY") {
1871 if (defined($e->{PROPERTIES}{relative_base})) {
1872 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1873 # set the current offset as base for relative pointers
1874 # and store it based on the toplevel struct/union
1875 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1877 $self->DeclareArrayVariables($el);
1878 my $el_env = {$el->{NAME} => "$varname->$el->{NAME}"};
1879 $self->CheckRefPtrs($el, $ndr, $el_env);
1880 $self->ParseElementPush($el, $ndr, $el_env, 1, 0);
1883 $self->pidl("break; }");
1886 if (! $have_default) {
1887 $self->pidl("default:");
1888 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1894 sub ParseUnionPushDeferred($$$$)
1896 my ($self,$e,$ndr,$varname) = @_;
1898 my $have_default = 0;
1900 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1901 if (defined($e->{PROPERTIES}{relative_base})) {
1902 # retrieve the current offset as base for relative pointers
1903 # based on the toplevel struct/union
1904 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1906 $self->pidl("switch (level) {");
1908 foreach my $el (@{$e->{ELEMENTS}}) {
1909 if ($el->{CASE} eq "default") {
1913 $self->pidl("$el->{CASE}:");
1914 if ($el->{TYPE} ne "EMPTY") {
1916 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1919 $self->pidl("break;");
1922 if (! $have_default) {
1923 $self->pidl("default:");
1924 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1930 #####################################################################
1931 # parse a union - push side
1932 sub ParseUnionPush($$$$)
1934 my ($self,$e,$ndr,$varname) = @_;
1935 my $have_default = 0;
1937 $self->start_flags($e, $ndr);
1939 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1940 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1942 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1945 if (is_deferred_switch_non_empty($e)) {
1946 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1948 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1952 $self->end_flags($e, $ndr);
1955 #####################################################################
1957 sub ParseUnionPrint($$$$$)
1959 my ($self,$e,$ndr,$name,$varname) = @_;
1960 my $have_default = 0;
1962 $self->pidl("uint32_t level;");
1963 foreach my $el (@{$e->{ELEMENTS}}) {
1964 $self->DeclareArrayVariables($el);
1967 $self->start_flags($e, $ndr);
1969 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1971 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1973 $self->pidl("switch (level) {");
1975 foreach my $el (@{$e->{ELEMENTS}}) {
1976 if ($el->{CASE} eq "default") {
1979 $self->pidl("$el->{CASE}:");
1980 if ($el->{TYPE} ne "EMPTY") {
1982 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1985 $self->pidl("break;");
1988 if (! $have_default) {
1989 $self->pidl("default:");
1990 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1995 $self->end_flags($e, $ndr);
1998 sub ParseUnionPullPrimitives($$$$$)
2000 my ($self,$e,$ndr,$varname,$switch_type) = @_;
2001 my $have_default = 0;
2004 if (defined($switch_type)) {
2005 if (defined($e->{ALIGN})) {
2006 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
2009 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
2010 $self->pidl("if (_level != level) {");
2011 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
2015 if (defined($e->{ALIGN})) {
2016 if ($e->{IS_MS_UNION}) {
2017 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
2018 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
2020 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
2024 $self->pidl("switch (level) {");
2026 foreach my $el (@{$e->{ELEMENTS}}) {
2027 if ($el->{CASE} eq "default") {
2030 $self->pidl("$el->{CASE}: {");
2032 if ($el->{TYPE} ne "EMPTY") {
2034 if (defined($e->{PROPERTIES}{relative_base})) {
2035 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
2036 # set the current offset as base for relative pointers
2037 # and store it based on the toplevel struct/union
2038 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
2040 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
2043 $self->pidl("break; }");
2046 if (! $have_default) {
2047 $self->pidl("default:");
2048 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2054 sub ParseUnionPullDeferred($$$$)
2056 my ($self,$e,$ndr,$varname) = @_;
2057 my $have_default = 0;
2059 if (defined($e->{PROPERTIES}{relative_base})) {
2060 # retrieve the current offset as base for relative pointers
2061 # based on the toplevel struct/union
2062 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
2064 $self->pidl("switch (level) {");
2066 foreach my $el (@{$e->{ELEMENTS}}) {
2067 if ($el->{CASE} eq "default") {
2071 $self->pidl("$el->{CASE}:");
2072 if ($el->{TYPE} ne "EMPTY") {
2074 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
2077 $self->pidl("break;");
2080 if (! $have_default) {
2081 $self->pidl("default:");
2082 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2090 #####################################################################
2091 # parse a union - pull side
2092 sub ParseUnionPull($$$$)
2094 my ($self,$e,$ndr,$varname) = @_;
2095 my $switch_type = $e->{SWITCH_TYPE};
2097 $self->pidl("uint32_t level;");
2098 if (defined($switch_type)) {
2099 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
2100 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
2102 $self->pidl(mapTypeName($switch_type) . " _level;");
2105 my %double_cases = ();
2106 foreach my $el (@{$e->{ELEMENTS}}) {
2107 next if ($el->{TYPE} eq "EMPTY");
2108 next if ($double_cases{"$el->{NAME}"});
2109 $self->DeclareMemCtxVariables($el);
2110 $self->DeclarePtrVariables($el);
2111 $self->DeclareArrayVariables($el, "pull");
2112 $double_cases{"$el->{NAME}"} = 1;
2115 $self->start_flags($e, $ndr);
2117 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
2118 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2120 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
2121 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2124 if (is_deferred_switch_non_empty($e)) {
2125 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2127 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
2128 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2132 $self->add_deferred();
2134 $self->end_flags($e, $ndr);
2139 my ($e,$t,$name,$varname) = @_;
2140 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2143 sub ArgsUnionNdrSize($$)
2146 return "const union $name *r, uint32_t level, int flags";
2149 $typefamily{UNION} = {
2150 PUSH_FN_BODY => \&ParseUnionPush,
2151 DECL => \&DeclUnion,
2152 PULL_FN_BODY => \&ParseUnionPull,
2153 PRINT_FN_BODY => \&ParseUnionPrint,
2154 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2155 SIZE_FN_BODY => \&ParseUnionNdrSize,
2158 #####################################################################
2159 # parse a typedef - push side
2160 sub ParseTypedefPush($$$$)
2162 my($self,$e,$ndr,$varname) = @_;
2166 $env->{$e->{NAME}} = $varname;
2168 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2171 #####################################################################
2172 # parse a typedef - pull side
2173 sub ParseTypedefPull($$$$)
2175 my($self,$e,$ndr,$varname) = @_;
2179 $env->{$e->{NAME}} = $varname;
2181 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2184 #####################################################################
2185 # parse a typedef - print side
2186 sub ParseTypedefPrint($$$$$)
2188 my($self,$e,$ndr,$name,$varname) = @_;
2190 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2193 #####################################################################
2194 ## calculate the size of a structure
2195 sub ParseTypedefNdrSize($$$$)
2197 my($self,$t,$name,$varname) = @_;
2199 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2202 sub DeclTypedef($$$$)
2204 my ($e, $t, $name, $varname) = @_;
2206 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2209 sub ArgsTypedefNdrSize($$$)
2211 my ($d, $name, $varname) = @_;
2212 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2215 $typefamily{TYPEDEF} = {
2216 PUSH_FN_BODY => \&ParseTypedefPush,
2217 DECL => \&DeclTypedef,
2218 PULL_FN_BODY => \&ParseTypedefPull,
2219 PRINT_FN_BODY => \&ParseTypedefPrint,
2220 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2221 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2224 sub ParsePipePushChunk($$)
2226 my ($self, $t) = @_;
2229 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2230 my $struct = $pipe->{DATA};
2232 my $name = "$struct->{NAME}";
2236 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2238 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2240 return if has_property($t, "nopush");
2245 $self->ParseStructPush($struct, $ndr, $varname);
2248 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2251 $self->pidl("return NDR_ERR_SUCCESS;");
2257 sub ParsePipePullChunk($$)
2259 my ($self, $t) = @_;
2262 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2263 my $struct = $pipe->{DATA};
2265 my $name = "$struct->{NAME}";
2269 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2271 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2273 return if has_property($struct, "nopull");
2278 $self->ParseStructPull($struct, $ndr, $varname);
2281 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2284 $self->pidl("return NDR_ERR_SUCCESS;");
2290 sub ParsePipePrintChunk($$)
2292 my ($self, $t) = @_;
2295 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2296 my $struct = $pipe->{DATA};
2298 my $name = "$struct->{NAME}";
2302 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2304 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2306 return if (has_property($t, "noprint"));
2308 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2311 $self->ParseTypePrint($struct, $ndr, $varname);
2317 #####################################################################
2318 # parse a function - print side
2319 sub ParseFunctionPrint($$)
2321 my($self, $fn) = @_;
2324 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2326 return if has_property($fn, "noprint");
2328 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2332 foreach my $e (@{$fn->{ELEMENTS}}) {
2333 $self->DeclareArrayVariables($e);
2336 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2337 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2338 $self->pidl("$ndr->depth++;");
2340 $self->pidl("if (flags & NDR_SET_VALUES) {");
2341 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2344 $self->pidl("if (flags & NDR_IN) {");
2346 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2347 $self->pidl("$ndr->depth++;");
2349 my $env = GenerateFunctionInEnv($fn);
2351 foreach my $e (@{$fn->{ELEMENTS}}) {
2352 if (grep(/in/,@{$e->{DIRECTION}})) {
2353 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2356 $self->pidl("$ndr->depth--;");
2360 $self->pidl("if (flags & NDR_OUT) {");
2362 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2363 $self->pidl("$ndr->depth++;");
2365 $env = GenerateFunctionOutEnv($fn);
2366 foreach my $e (@{$fn->{ELEMENTS}}) {
2367 if (grep(/out/,@{$e->{DIRECTION}})) {
2368 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2371 if ($fn->{RETURN_TYPE}) {
2372 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2374 $self->pidl("$ndr->depth--;");
2378 $self->pidl("$ndr->depth--;");
2384 #####################################################################
2386 sub ParseFunctionPush($$)
2388 my($self, $fn) = @_;
2391 $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;
2393 return if has_property($fn, "nopush");
2398 foreach my $e (@{$fn->{ELEMENTS}}) {
2399 $self->DeclareArrayVariables($e);
2402 $self->pidl("NDR_PUSH_CHECK_FN_FLAGS(ndr, flags);");
2404 $self->pidl("if (flags & NDR_IN) {");
2407 my $env = GenerateFunctionInEnv($fn);
2409 EnvSubstituteValue($env, $fn);
2411 foreach my $e (@{$fn->{ELEMENTS}}) {
2412 if (grep(/in/,@{$e->{DIRECTION}})) {
2413 $self->CheckRefPtrs($e, $ndr, $env);
2417 foreach my $e (@{$fn->{ELEMENTS}}) {
2418 if (grep(/in/,@{$e->{DIRECTION}})) {
2419 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2426 $self->pidl("if (flags & NDR_OUT) {");
2429 $env = GenerateFunctionOutEnv($fn);
2430 EnvSubstituteValue($env, $fn);
2432 foreach my $e (@{$fn->{ELEMENTS}}) {
2433 if (grep(/out/,@{$e->{DIRECTION}})) {
2434 $self->CheckRefPtrs($e, $ndr, $env);
2438 foreach my $e (@{$fn->{ELEMENTS}}) {
2439 if (grep(/out/,@{$e->{DIRECTION}})) {
2440 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2444 if ($fn->{RETURN_TYPE}) {
2445 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2450 $self->pidl("return NDR_ERR_SUCCESS;");
2456 sub AllocateArrayLevel($$$$$$)
2458 my ($self,$e,$l,$ndr,$var,$size) = @_;
2460 my $pl = GetPrevLevel($e, $l);
2461 if (defined($pl) and
2462 $pl->{TYPE} eq "POINTER" and
2463 $pl->{POINTER_TYPE} eq "ref"
2464 and not $l->{IS_ZERO_TERMINATED}) {
2465 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2466 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2468 if (grep(/in/,@{$e->{DIRECTION}}) and
2469 grep(/out/,@{$e->{DIRECTION}})) {
2470 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2475 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2478 #####################################################################
2480 sub ParseFunctionPull($$)
2485 # pull function args
2486 $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;
2491 # declare any internal pointers we need
2492 foreach my $e (@{$fn->{ELEMENTS}}) {
2493 $self->DeclarePtrVariables($e);
2494 $self->DeclareArrayVariables($e, "pull");
2497 my %double_cases = ();
2498 foreach my $e (@{$fn->{ELEMENTS}}) {
2499 next if ($e->{TYPE} eq "EMPTY");
2500 next if ($double_cases{"$e->{NAME}"});
2501 $self->DeclareMemCtxVariables($e);
2502 $double_cases{"$e->{NAME}"} = 1;
2505 $self->pidl("NDR_PULL_CHECK_FN_FLAGS(ndr, flags);");
2507 $self->pidl("if (flags & NDR_IN) {");
2510 # auto-init the out section of a structure. I originally argued that
2511 # this was a bad idea as it hides bugs, but coping correctly
2512 # with initialisation and not wiping ref vars is turning
2513 # out to be too tricky (tridge)
2514 foreach my $e (@{$fn->{ELEMENTS}}) {
2515 next unless grep(/out/, @{$e->{DIRECTION}});
2516 $self->pidl("ZERO_STRUCT(r->out);");
2521 my $env = GenerateFunctionInEnv($fn);
2523 foreach my $e (@{$fn->{ELEMENTS}}) {
2524 next unless (grep(/in/, @{$e->{DIRECTION}}));
2525 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2528 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2529 # own flag rather than be in NDR_IN ?
2531 foreach my $e (@{$fn->{ELEMENTS}}) {
2532 next unless (grep(/out/, @{$e->{DIRECTION}}));
2533 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2534 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2535 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2536 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2537 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2538 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2539 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2541 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2542 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2543 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2544 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2545 check_fully_dereferenced($e, $env));
2546 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2548 if (grep(/in/, @{$e->{DIRECTION}})) {
2549 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2551 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2553 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2554 if (grep(/in/, @{$e->{DIRECTION}})) {
2555 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2557 $self->pidl("r->out.$e->{NAME} = NULL;");
2560 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2562 if (grep(/in/, @{$e->{DIRECTION}})) {
2563 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2565 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2570 $self->add_deferred();
2574 $self->pidl("if (flags & NDR_OUT) {");
2577 $env = GenerateFunctionOutEnv($fn);
2578 foreach my $e (@{$fn->{ELEMENTS}}) {
2579 next unless grep(/out/, @{$e->{DIRECTION}});
2580 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2583 if ($fn->{RETURN_TYPE}) {
2584 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2587 $self->add_deferred();
2591 $self->pidl("return NDR_ERR_SUCCESS;");
2597 sub AuthServiceStruct($$$)
2599 my ($self, $ifacename, $authservice) = @_;
2600 my @a = split /,/, $authservice;
2601 my $authservice_count = $#a + 1;
2603 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2604 foreach my $ap (@a) {
2605 $self->pidl("\t$ap, ");
2610 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2611 $self->pidl("\t.count\t= $authservice_count,");
2612 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2617 sub ParseGeneratePipeArray($$$)
2619 my ($self, $fn, $direction) = @_;
2621 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2624 foreach my $e (@{$fn->{ELEMENTS}}) {
2625 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2626 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2628 my $cname = "$e->{TYPE}_chunk";
2632 $self->pidl("\"$direction.$e->{NAME}\",");
2633 $self->pidl("\"$cname\",");
2634 $self->pidl("sizeof(struct $cname),");
2635 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2636 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2637 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2641 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2647 sub FunctionCallPipes($$)
2649 my ($self, $d) = @_;
2650 return if not defined($d->{OPNUM});
2655 foreach my $e (@{$d->{ELEMENTS}}) {
2656 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2658 if (grep(/in/, @{$e->{DIRECTION}})) {
2661 if (grep(/out/, @{$e->{DIRECTION}})) {
2667 $self->ParseGeneratePipeArray($d, "in");
2671 $self->ParseGeneratePipeArray($d, "out");
2675 sub FunctionCallEntry($$)
2677 my ($self, $d) = @_;
2678 return 0 if not defined($d->{OPNUM});
2683 foreach my $e (@{$d->{ELEMENTS}}) {
2684 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2686 if (grep(/in/, @{$e->{DIRECTION}})) {
2689 if (grep(/out/, @{$e->{DIRECTION}})) {
2694 my $in_pipes_ptr = "NULL";
2695 my $out_pipes_ptr = "NULL";
2698 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2702 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2706 $self->pidl("\t\t\"$d->{NAME}\",");
2707 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2708 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2709 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2710 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2711 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2712 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2713 $self->pidl("\t},");
2717 #####################################################################
2718 # produce a function call table
2719 sub FunctionTable($$)
2721 my($self,$interface) = @_;
2723 my $uname = uc $interface->{NAME};
2725 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2726 return unless defined ($interface->{PROPERTIES}->{uuid});
2728 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2729 $self->FunctionCallPipes($d);
2732 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2734 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2735 $count += $self->FunctionCallEntry($d);
2737 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2741 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2742 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2743 $self->pidl("\t$ep, ");
2745 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2750 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2751 $self->pidl("\t.count\t= $endpoint_count,");
2752 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2756 if (! defined $interface->{PROPERTIES}->{authservice}) {
2757 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2760 $self->AuthServiceStruct($interface->{NAME},
2761 $interface->{PROPERTIES}->{authservice});
2763 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2764 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2765 $self->pidl("\t.syntax_id\t= {");
2766 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2767 $self->pidl("\t\tNDR_$uname\_VERSION");
2768 $self->pidl("\t},");
2769 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2770 $self->pidl("\t.num_calls\t= $count,");
2771 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2772 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2773 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2779 #####################################################################
2780 # generate include statements for imported idl files
2785 foreach (@imports) {
2786 $_ = unmake_str($_);
2788 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2792 #####################################################################
2793 # generate include statements for included header files
2798 foreach (@includes) {
2799 $self->pidl_hdr("#include $_");
2803 #####################################################################
2804 # generate prototypes and defines for the interface definitions
2805 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2806 # NDR parser and so do not belong here, technically speaking
2807 sub HeaderInterface($$$)
2809 my($self,$interface,$needed) = @_;
2813 if ($needed->{"compression"}) {
2814 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2817 if (has_property($interface, "object")) {
2818 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2821 if (defined $interface->{PROPERTIES}->{helper}) {
2822 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2825 if (defined $interface->{PROPERTIES}->{uuid}) {
2826 my $name = uc $interface->{NAME};
2827 $self->pidl_hdr("#define NDR_$name\_UUID " .
2828 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
2830 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
2832 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2834 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2835 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2837 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2840 foreach (@{$interface->{FUNCTIONS}}) {
2841 next if has_property($_, "noopnum");
2842 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2843 my $u_name = uc $_->{NAME};
2845 my $val = sprintf("0x%02x", $count);
2846 if (defined($interface->{BASE})) {
2847 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2850 $self->pidl_hdr("#define NDR_$u_name ($val)");
2852 $self->pidl_hdr("");
2858 if (defined($interface->{BASE})) {
2859 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2862 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2866 sub ParseTypePush($$$$$$)
2868 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2870 # save the old relative_base_offset
2871 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2872 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2873 # restore the old relative_base_offset
2874 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2877 sub ParseTypePushFunction($$$)
2879 my ($self, $e, $varname) = @_;
2882 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2884 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2888 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2889 $self->pidl("return NDR_ERR_SUCCESS;");
2895 sub ParseTypePull($$$$$$)
2897 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2899 # save the old relative_base_offset
2900 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2901 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2902 # restore the old relative_base_offset
2903 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2906 sub ParseTypePullFunction($$)
2908 my ($self, $e, $varname) = @_;
2911 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2913 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2917 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2918 $self->pidl("return NDR_ERR_SUCCESS;");
2924 sub ParseTypePrint($$$$)
2926 my ($self, $e, $ndr, $varname) = @_;
2928 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2931 sub ParseTypePrintFunction($$$)
2933 my ($self, $e, $varname) = @_;
2936 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2938 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2940 return if (has_property($e, "noprint"));
2942 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2945 $self->ParseTypePrint($e, $ndr, $varname);
2951 sub ParseTypeNdrSize($$)
2956 my $tf = $typefamily{$t->{TYPE}};
2957 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2959 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2963 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2969 #####################################################################
2970 # parse the interface definitions
2971 sub ParseInterface($$$)
2973 my($self,$interface,$needed) = @_;
2975 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2976 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2978 $self->pidl_hdr("");
2980 $self->HeaderInterface($interface, $needed);
2983 foreach my $d (@{$interface->{TYPES}}) {
2984 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2985 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2986 $self->ParsePipePushChunk($d);
2987 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2988 $self->ParsePipePullChunk($d);
2989 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2990 $self->ParsePipePrintChunk($d);
2992 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2993 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2994 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2998 next unless(typeHasBody($d));
3000 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
3001 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
3002 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
3004 # Make sure we don't generate a function twice...
3005 $needed->{TypeFunctionName("ndr_push", $d)} =
3006 $needed->{TypeFunctionName("ndr_pull", $d)} =
3007 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
3009 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
3013 foreach my $d (@{$interface->{FUNCTIONS}}) {
3014 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
3015 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
3016 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
3019 $self->FunctionTable($interface);
3021 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
3024 sub GenerateIncludes($)
3028 $self->pidl("#include \"includes.h\"");
3030 $self->pidl("#ifndef _GNU_SOURCE");
3031 $self->pidl("#define _GNU_SOURCE");
3032 $self->pidl("#endif");
3033 $self->pidl("#include <stdint.h>");
3034 $self->pidl("#include <stdlib.h>");
3035 $self->pidl("#include <stdio.h>");
3036 $self->pidl("#include <stdbool.h>");
3037 $self->pidl("#include <stdarg.h>");
3038 $self->pidl("#include <string.h>");
3042 #####################################################################
3043 # parse a parsed IDL structure back into an IDL file
3046 my($self, $ndr,$gen_header,$ndr_header) = @_;
3048 $self->pidl_hdr("/* header auto-generated by pidl */");
3049 $self->pidl_hdr("");
3050 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
3051 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
3052 $self->pidl_hdr("");
3054 $self->pidl("/* parser auto-generated by pidl */");
3056 $self->GenerateIncludes();
3057 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
3063 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
3067 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
3068 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
3069 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
3072 return ($self->{res_hdr}, $self->{res});
3075 sub NeededElement($$$)
3077 my ($e, $dir, $needed) = @_;
3079 return if ($e->{TYPE} eq "EMPTY");
3081 return if (ref($e->{TYPE}) eq "HASH" and
3082 not defined($e->{TYPE}->{NAME}));
3085 if (ref($e->{TYPE}) eq "HASH") {
3086 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
3091 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
3092 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
3094 $rt = $e->{REPRESENTATION_TYPE};
3097 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
3100 if ($dir eq "print") {
3101 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
3102 } elsif ($dir eq "pull") {
3103 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
3104 push (@fn, "ndr_$t\_to_$rt")
3106 } elsif ($dir eq "push") {
3107 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
3108 push (@fn, "ndr_$rt\_to_$t")
3111 die("invalid direction `$dir'");
3115 unless (defined($needed->{$_})) {
3121 sub NeededFunction($$)
3123 my ($fn,$needed) = @_;
3124 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
3125 $needed->{"ndr_push_$fn->{NAME}"} = 1;
3126 $needed->{"ndr_print_$fn->{NAME}"} = 1;
3127 foreach my $e (@{$fn->{ELEMENTS}}) {
3129 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3135 sub NeededType($$$);
3136 my ($t,$needed,$req) = @_;
3138 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3139 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3141 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3142 return unless defined($t->{ELEMENTS});
3143 for my $e (@{$t->{ELEMENTS}}) {
3145 if (has_property($e, "compression")) {
3146 $needed->{"compression"} = 1;
3148 NeededElement($e, $req, $needed);
3149 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3154 #####################################################################
3155 # work out what parse functions are needed
3156 sub NeededInterface($$)
3158 my ($interface,$needed) = @_;
3159 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3160 foreach (reverse @{$interface->{TYPES}}) {
3162 if (has_property($_, "public")) {
3163 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3164 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3167 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3168 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3169 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3170 if (has_property($_, "gensize")) {
3171 $needed->{"ndr_size_$_->{NAME}"} = 1;
3176 sub TypeFunctionName($$)
3178 my ($prefix, $t) = @_;
3180 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3181 $t->{TYPE} eq "TYPEDEF");
3182 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3183 return "$prefix\_$t";