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 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 unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
635 # Representation type is different from transmit_as
636 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
639 my $transmit_name = "_transmit_$e->{NAME}";
640 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
641 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
642 $var_name = $transmit_name;
645 $var_name = append_prefix($e, $var_name);
647 $self->start_flags($e, $ndr);
649 if (defined(my $value = has_property($e, "value"))) {
650 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
653 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
655 $self->end_flags($e, $ndr);
657 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
663 #####################################################################
664 # parse a pointer in a struct element or function
665 sub ParsePtrPush($$$$$)
667 my ($self,$e,$l,$ndr,$var_name) = @_;
669 if ($l->{POINTER_TYPE} eq "ref") {
670 $self->pidl("if ($var_name == NULL) {");
672 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
675 if ($l->{LEVEL} eq "EMBEDDED") {
676 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
678 } elsif ($l->{POINTER_TYPE} eq "relative") {
679 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
680 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
681 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
682 } elsif ($l->{POINTER_TYPE} eq "unique") {
683 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
684 } elsif ($l->{POINTER_TYPE} eq "full") {
685 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
687 die("Unhandled pointer type $l->{POINTER_TYPE}");
691 sub need_pointer_to($$$)
693 my ($e, $l, $scalar_only) = @_;
696 if (ref($l->{DATA_TYPE})) {
697 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
699 $t = $l->{DATA_TYPE};
702 if (not Parse::Pidl::Typelist::is_scalar($t)) {
703 return 1 if $scalar_only;
708 foreach my $tl (@{$e->{LEVELS}}) {
710 if ($tl->{TYPE} eq "ARRAY") {
715 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
716 return 1 unless $arrays;
722 sub ParseDataPrint($$$$$)
724 my ($self, $e, $l, $ndr, $var_name) = @_;
726 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
728 if (need_pointer_to($e, $l, 1)) {
729 $var_name = get_pointer_to($var_name);
732 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
734 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
738 #####################################################################
739 # print scalars in a structure element
740 sub ParseElementPrint($$$$$)
742 my($self, $e, $ndr, $var_name, $env) = @_;
744 return if (has_property($e, "noprint"));
746 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
747 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
751 $var_name = append_prefix($e, $var_name);
753 if (defined(my $value = has_property($e, "value"))) {
754 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
757 foreach my $l (@{$e->{LEVELS}}) {
758 if ($l->{TYPE} eq "POINTER") {
759 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
760 $self->pidl("$ndr->depth++;");
761 if ($l->{POINTER_TYPE} ne "ref") {
762 $self->pidl("if ($var_name) {");
765 $var_name = get_value_of($var_name);
766 } elsif ($l->{TYPE} eq "ARRAY") {
769 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
770 $var_name = get_pointer_to($var_name);
773 if ($l->{IS_ZERO_TERMINATED}) {
774 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
776 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
777 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
780 if (is_charset_array($e,$l)) {
781 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
783 } elsif (has_fast_array($e, $l)) {
784 my $nl = GetNextLevel($e, $l);
785 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
788 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
790 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
791 $self->pidl("$ndr->depth++;");
792 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
794 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
795 $self->pidl("if (asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter) != -1) {");
798 $var_name = get_array_element($var_name, $counter);
800 } elsif ($l->{TYPE} eq "DATA") {
801 $self->ParseDataPrint($e, $l, $ndr, $var_name);
802 } elsif ($l->{TYPE} eq "SWITCH") {
803 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
804 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
805 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
809 foreach my $l (reverse @{$e->{LEVELS}}) {
810 if ($l->{TYPE} eq "POINTER") {
811 if ($l->{POINTER_TYPE} ne "ref") {
815 $self->pidl("$ndr->depth--;");
816 } elsif (($l->{TYPE} eq "ARRAY")
817 and not is_charset_array($e,$l)
818 and not has_fast_array($e,$l)) {
819 $self->pidl("free(idx_$l->{LEVEL_INDEX});");
824 $self->pidl("$ndr->depth--;");
829 #####################################################################
830 # parse scalars in a structure element - pull size
831 sub ParseSwitchPull($$$$$$)
833 my($self,$e,$l,$ndr,$var_name,$env) = @_;
834 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
835 check_null_pointer($e, $env, sub { $self->pidl(shift); },
836 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
837 check_fully_dereferenced($e, $env));
839 $var_name = get_pointer_to($var_name);
840 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
843 #####################################################################
844 # push switch element
845 sub ParseSwitchPush($$$$$$)
847 my($self,$e,$l,$ndr,$var_name,$env) = @_;
848 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
849 check_null_pointer($e, $env, sub { $self->pidl(shift); },
850 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
851 check_fully_dereferenced($e, $env));
853 $var_name = get_pointer_to($var_name);
854 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
857 sub ParseDataPull($$$$$$$)
859 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
861 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
863 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
865 if (need_pointer_to($e, $l, 0)) {
866 $var_name = get_pointer_to($var_name);
869 $var_name = get_pointer_to($var_name);
871 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
873 if (my $range = has_property($e, "range")) {
874 $var_name = get_value_of($var_name);
875 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
876 my ($low, $high) = split(/,/, $range, 2);
877 if ($low < 0 and not $signed) {
878 warning(0, "$low is invalid for the range of an unsigned type");
880 if ($low == 0 and not $signed) {
881 $self->pidl("if ($var_name > $high) {");
883 $self->pidl("if ($var_name < $low || $var_name > $high) {");
885 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
889 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
893 sub ParseDataPush($$$$$$$)
895 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
897 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
899 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
901 # strings are passed by value rather than reference
902 if (need_pointer_to($e, $l, 1)) {
903 $var_name = get_pointer_to($var_name);
906 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
908 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
912 sub CalcNdrFlags($$$)
914 my ($l,$primitives,$deferred) = @_;
919 # Add NDR_SCALARS if this one is deferred
920 # and deferreds may be pushed
921 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
923 # Add NDR_SCALARS if this one is not deferred and
924 # primitives may be pushed
925 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
927 # Add NDR_BUFFERS if this one contains deferred stuff
928 # and deferreds may be pushed
929 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
931 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
932 return "NDR_SCALARS" if ($scalars);
933 return "NDR_BUFFERS" if ($buffers);
937 sub ParseMemCtxPullFlags($$$$)
939 my ($self, $e, $l) = @_;
941 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
943 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
944 return undef if has_fast_array($e, $l);
945 return undef if is_charset_array($e, $l);
949 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
950 my $nl = GetNextLevel($e, $l);
951 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
952 my $next_is_string = (($nl->{TYPE} eq "DATA") and
953 ($nl->{DATA_TYPE} eq "string"));
954 if ($next_is_array or $next_is_string) {
956 } elsif ($l->{LEVEL} eq "TOP") {
957 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
964 sub ParseMemCtxPullStart($$$$$)
966 my ($self, $e, $l, $ndr, $ptr_name) = @_;
968 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
969 my $mem_c_ctx = $ptr_name;
970 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
972 return unless defined($mem_c_flags);
974 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
975 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
978 sub ParseMemCtxPullEnd($$$$)
980 my ($self, $e, $l, $ndr) = @_;
982 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
983 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
985 return unless defined($mem_r_flags);
987 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
990 sub CheckStringTerminator($$$$$)
992 my ($self,$ndr,$e,$l,$length) = @_;
993 my $nl = GetNextLevel($e, $l);
995 # Make sure last element is zero!
996 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
999 sub ParseElementPullLevel
1001 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1003 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1005 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1006 $var_name = get_pointer_to($var_name);
1009 # Only pull something if there's actually something to be pulled
1010 if (defined($ndr_flags)) {
1011 if ($l->{TYPE} eq "SUBCONTEXT") {
1012 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1013 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1014 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1015 } elsif ($l->{TYPE} eq "ARRAY") {
1016 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1018 my $nl = GetNextLevel($e, $l);
1020 if (is_charset_array($e,$l)) {
1021 if ($l->{IS_ZERO_TERMINATED}) {
1022 $self->CheckStringTerminator($ndr, $e, $l, $length);
1024 $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}));");
1026 } elsif (has_fast_array($e, $l)) {
1027 if ($l->{IS_ZERO_TERMINATED}) {
1028 $self->CheckStringTerminator($ndr,$e,$l,$length);
1030 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1033 } elsif ($l->{TYPE} eq "POINTER") {
1034 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1035 } elsif ($l->{TYPE} eq "SWITCH") {
1036 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1037 } elsif ($l->{TYPE} eq "DATA") {
1038 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1039 } elsif ($l->{TYPE} eq "TYPEDEF") {
1040 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1044 # add additional constructions
1045 if ($l->{TYPE} eq "POINTER" and $deferred) {
1046 if ($l->{POINTER_TYPE} ne "ref") {
1047 $self->pidl("if ($var_name) {");
1050 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1051 $self->pidl("uint32_t _relative_save_offset;");
1052 $self->pidl("_relative_save_offset = $ndr->offset;");
1053 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1057 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1059 $var_name = get_value_of($var_name);
1060 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1062 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1064 if ($l->{POINTER_TYPE} ne "ref") {
1065 if ($l->{POINTER_TYPE} eq "relative") {
1066 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1068 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1071 $self->pidl("$ndr->offset = _relative_save_offset;");
1076 } elsif ($l->{TYPE} eq "ARRAY" and
1077 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1078 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1079 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1080 my $array_name = $var_name;
1082 if ($l->{IS_VARYING}) {
1083 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
1086 $var_name = get_array_element($var_name, $counter);
1088 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1090 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1091 my $nl = GetNextLevel($e,$l);
1093 if ($l->{IS_ZERO_TERMINATED}) {
1094 $self->CheckStringTerminator($ndr,$e,$l,$length);
1097 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1099 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1104 if ($deferred and ContainsDeferred($e, $l)) {
1105 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1107 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1112 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1114 } elsif ($l->{TYPE} eq "SWITCH") {
1115 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1119 #####################################################################
1120 # parse scalars in a structure element - pull size
1121 sub ParseElementPull($$$$$$)
1123 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1125 my $var_name = $env->{$e->{NAME}};
1129 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1131 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1134 $represent_name = $var_name;
1135 $transmit_name = "_transmit_$e->{NAME}";
1136 $var_name = $transmit_name;
1137 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1140 $var_name = append_prefix($e, $var_name);
1142 $self->start_flags($e, $ndr);
1144 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1146 $self->end_flags($e, $ndr);
1148 # Representation type is different from transmit_as
1149 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1150 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1156 #####################################################################
1157 # parse a pointer in a struct element or function
1158 sub ParsePtrPull($$$$$)
1160 my($self, $e,$l,$ndr,$var_name) = @_;
1162 my $nl = GetNextLevel($e, $l);
1163 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1164 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1165 ($nl->{DATA_TYPE} eq "string"));
1167 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1169 if (!$next_is_array and !$next_is_string) {
1170 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1171 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1176 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1177 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1178 } elsif (($l->{POINTER_TYPE} eq "unique") or
1179 ($l->{POINTER_TYPE} eq "relative") or
1180 ($l->{POINTER_TYPE} eq "full")) {
1181 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1182 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1183 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1185 die("Unhandled pointer type $l->{POINTER_TYPE}");
1188 $self->pidl("if (_ptr_$e->{NAME}) {");
1191 # Don't do this for arrays, they're allocated at the actual level
1193 unless ($next_is_array or $next_is_string) {
1194 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1196 # FIXME: Yes, this is nasty.
1197 # We allocate an array twice
1198 # - once just to indicate that it's there,
1199 # - then the real allocation...
1200 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1203 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1204 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1205 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1208 $self->pidl("} else {");
1209 $self->pidl("\t$var_name = NULL;");
1213 sub ParseStructPushPrimitives($$$$$)
1215 my ($self, $struct, $ndr, $varname, $env) = @_;
1217 # see if the structure contains a conformant array. If it
1218 # does, then it must be the last element of the structure, and
1219 # we need to push the conformant length early, as it fits on
1220 # the wire before the structure (and even before the structure
1222 if (defined($struct->{SURROUNDING_ELEMENT})) {
1223 my $e = $struct->{SURROUNDING_ELEMENT};
1225 if (defined($e->{LEVELS}[0]) and
1226 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1229 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1230 if (has_property($e, "charset")) {
1231 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1233 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1236 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1239 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1241 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1245 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1247 if (defined($struct->{PROPERTIES}{relative_base})) {
1248 # set the current offset as base for relative pointers
1249 # and store it based on the toplevel struct/union
1250 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1253 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1255 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1258 sub ParseStructPushDeferred($$$$)
1260 my ($self, $struct, $ndr, $varname, $env) = @_;
1261 if (defined($struct->{PROPERTIES}{relative_base})) {
1262 # retrieve the current offset as base for relative pointers
1263 # based on the toplevel struct/union
1264 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1266 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1269 #####################################################################
1271 sub ParseStructPush($$$$)
1273 my ($self, $struct, $ndr, $varname) = @_;
1275 return unless defined($struct->{ELEMENTS});
1277 my $env = GenerateStructEnv($struct, $varname);
1279 EnvSubstituteValue($env, $struct);
1281 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1283 $self->start_flags($struct, $ndr);
1285 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1287 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1291 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1293 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1297 $self->end_flags($struct, $ndr);
1300 #####################################################################
1301 # generate a push function for an enum
1302 sub ParseEnumPush($$$$)
1304 my($self,$enum,$ndr,$varname) = @_;
1305 my($type_fn) = $enum->{BASE_TYPE};
1307 $self->start_flags($enum, $ndr);
1308 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1309 $self->end_flags($enum, $ndr);
1312 #####################################################################
1313 # generate a pull function for an enum
1314 sub ParseEnumPull($$$$)
1316 my($self,$enum,$ndr,$varname) = @_;
1317 my($type_fn) = $enum->{BASE_TYPE};
1318 my($type_v_decl) = mapTypeName($type_fn);
1320 $self->pidl("$type_v_decl v;");
1321 $self->start_flags($enum, $ndr);
1322 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1323 $self->pidl("*$varname = v;");
1325 $self->end_flags($enum, $ndr);
1328 #####################################################################
1329 # generate a print function for an enum
1330 sub ParseEnumPrint($$$$$)
1332 my($self,$enum,$ndr,$name,$varname) = @_;
1334 $self->pidl("const char *val = NULL;");
1337 $self->start_flags($enum, $ndr);
1339 $self->pidl("switch ($varname) {");
1341 my $els = \@{$enum->{ELEMENTS}};
1342 foreach my $i (0 .. $#{$els}) {
1343 my $e = ${$els}[$i];
1345 if ($e =~ /^(.*)=/) {
1348 $self->pidl("case $e: val = \"$e\"; break;");
1354 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1356 $self->end_flags($enum, $ndr);
1361 my ($e,$t,$name,$varname) = @_;
1362 return "enum $name " .
1363 ($t eq "pull"?"*":"") . $varname;
1366 $typefamily{ENUM} = {
1368 PUSH_FN_BODY => \&ParseEnumPush,
1369 PULL_FN_BODY => \&ParseEnumPull,
1370 PRINT_FN_BODY => \&ParseEnumPrint,
1373 #####################################################################
1374 # generate a push function for a bitmap
1375 sub ParseBitmapPush($$$$)
1377 my($self,$bitmap,$ndr,$varname) = @_;
1378 my($type_fn) = $bitmap->{BASE_TYPE};
1380 $self->start_flags($bitmap, $ndr);
1382 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1384 $self->end_flags($bitmap, $ndr);
1387 #####################################################################
1388 # generate a pull function for an bitmap
1389 sub ParseBitmapPull($$$$)
1391 my($self,$bitmap,$ndr,$varname) = @_;
1392 my $type_fn = $bitmap->{BASE_TYPE};
1393 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1395 $self->pidl("$type_decl v;");
1396 $self->start_flags($bitmap, $ndr);
1397 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1398 $self->pidl("*$varname = v;");
1400 $self->end_flags($bitmap, $ndr);
1403 #####################################################################
1404 # generate a print function for an bitmap
1405 sub ParseBitmapPrintElement($$$$$$)
1407 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1408 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1409 my($type_fn) = $bitmap->{BASE_TYPE};
1412 if ($e =~ /^(\w+) .*$/) {
1415 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1418 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1421 #####################################################################
1422 # generate a print function for an bitmap
1423 sub ParseBitmapPrint($$$$$)
1425 my($self,$bitmap,$ndr,$name,$varname) = @_;
1426 my($type_decl) = mapTypeName($bitmap->{TYPE});
1427 my($type_fn) = $bitmap->{BASE_TYPE};
1429 $self->start_flags($bitmap, $ndr);
1431 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1433 $self->pidl("$ndr->depth++;");
1434 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1435 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1437 $self->pidl("$ndr->depth--;");
1439 $self->end_flags($bitmap, $ndr);
1442 sub DeclBitmap($$$$)
1444 my ($e,$t,$name,$varname) = @_;
1445 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1446 ($t eq "pull"?" *":" ") . $varname;
1449 $typefamily{BITMAP} = {
1450 DECL => \&DeclBitmap,
1451 PUSH_FN_BODY => \&ParseBitmapPush,
1452 PULL_FN_BODY => \&ParseBitmapPull,
1453 PRINT_FN_BODY => \&ParseBitmapPrint,
1456 #####################################################################
1457 # generate a struct print function
1458 sub ParseStructPrint($$$$$)
1460 my($self,$struct,$ndr,$name,$varname) = @_;
1462 return unless defined $struct->{ELEMENTS};
1464 my $env = GenerateStructEnv($struct, $varname);
1466 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1468 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1469 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1471 $self->start_flags($struct, $ndr);
1473 $self->pidl("$ndr->depth++;");
1475 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1476 foreach (@{$struct->{ELEMENTS}});
1477 $self->pidl("$ndr->depth--;");
1479 $self->end_flags($struct, $ndr);
1482 sub DeclarePtrVariables($$)
1485 foreach my $l (@{$e->{LEVELS}}) {
1487 if ($l->{TYPE} eq "POINTER" and
1488 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1489 if ($l->{POINTER_TYPE} eq "relative_short") {
1492 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1498 sub DeclareArrayVariables($$)
1502 foreach my $l (@{$e->{LEVELS}}) {
1503 next if has_fast_array($e,$l);
1504 next if is_charset_array($e,$l);
1505 if ($l->{TYPE} eq "ARRAY") {
1506 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1511 sub DeclareArrayVariablesNoZero($$$)
1513 my ($self,$e,$env) = @_;
1515 foreach my $l (@{$e->{LEVELS}}) {
1516 next if has_fast_array($e,$l);
1517 next if is_charset_array($e,$l);
1518 if ($l->{TYPE} eq "ARRAY") {
1519 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1520 if ($length eq "0") {
1521 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1523 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1529 sub DeclareMemCtxVariables($$)
1532 foreach my $l (@{$e->{LEVELS}}) {
1533 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1534 if (defined($mem_flags)) {
1535 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1540 sub ParseStructPullPrimitives($$$$$)
1542 my($self,$struct,$ndr,$varname,$env) = @_;
1544 if (defined $struct->{SURROUNDING_ELEMENT}) {
1545 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1548 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1550 if (defined($struct->{PROPERTIES}{relative_base})) {
1551 # set the current offset as base for relative pointers
1552 # and store it based on the toplevel struct/union
1553 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1556 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1558 $self->add_deferred();
1560 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1563 sub ParseStructPullDeferred($$$$$)
1565 my ($self,$struct,$ndr,$varname,$env) = @_;
1567 if (defined($struct->{PROPERTIES}{relative_base})) {
1568 # retrieve the current offset as base for relative pointers
1569 # based on the toplevel struct/union
1570 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1572 foreach my $e (@{$struct->{ELEMENTS}}) {
1573 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1576 $self->add_deferred();
1579 #####################################################################
1580 # parse a struct - pull side
1581 sub ParseStructPull($$$$)
1583 my($self,$struct,$ndr,$varname) = @_;
1585 return unless defined $struct->{ELEMENTS};
1587 # declare any internal pointers we need
1588 foreach my $e (@{$struct->{ELEMENTS}}) {
1589 $self->DeclarePtrVariables($e);
1590 $self->DeclareArrayVariables($e);
1591 $self->DeclareMemCtxVariables($e);
1594 $self->start_flags($struct, $ndr);
1596 my $env = GenerateStructEnv($struct, $varname);
1598 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1600 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1603 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1605 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1609 $self->end_flags($struct, $ndr);
1612 #####################################################################
1613 # calculate size of ndr struct
1614 sub ParseStructNdrSize($$$$)
1616 my ($self,$t, $name, $varname) = @_;
1619 if (my $flags = has_property($t, "flag")) {
1620 $self->pidl("flags |= $flags;");
1622 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1625 sub DeclStruct($$$$)
1627 my ($e,$t,$name,$varname) = @_;
1628 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1631 sub ArgsStructNdrSize($$$)
1633 my ($d, $name, $varname) = @_;
1634 return "const struct $name *$varname, int flags";
1637 $typefamily{STRUCT} = {
1638 PUSH_FN_BODY => \&ParseStructPush,
1639 DECL => \&DeclStruct,
1640 PULL_FN_BODY => \&ParseStructPull,
1641 PRINT_FN_BODY => \&ParseStructPrint,
1642 SIZE_FN_BODY => \&ParseStructNdrSize,
1643 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1646 #####################################################################
1647 # calculate size of ndr struct
1648 sub ParseUnionNdrSize($$$)
1650 my ($self, $t, $name, $varname) = @_;
1653 if (my $flags = has_property($t, "flag")) {
1654 $self->pidl("flags |= $flags;");
1657 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1660 sub ParseUnionPushPrimitives($$$$)
1662 my ($self, $e, $ndr ,$varname) = @_;
1664 my $have_default = 0;
1666 $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1668 if (defined($e->{SWITCH_TYPE})) {
1669 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1672 if (defined($e->{ALIGN})) {
1673 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1676 $self->pidl("switch (level) {");
1678 foreach my $el (@{$e->{ELEMENTS}}) {
1679 if ($el->{CASE} eq "default") {
1682 $self->pidl("$el->{CASE}: {");
1684 if ($el->{TYPE} ne "EMPTY") {
1686 if (defined($e->{PROPERTIES}{relative_base})) {
1687 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1688 # set the current offset as base for relative pointers
1689 # and store it based on the toplevel struct/union
1690 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1692 $self->DeclareArrayVariables($el);
1693 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1696 $self->pidl("break; }");
1699 if (! $have_default) {
1700 $self->pidl("default:");
1701 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1707 sub ParseUnionPushDeferred($$$$)
1709 my ($self,$e,$ndr,$varname) = @_;
1711 my $have_default = 0;
1713 $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1714 if (defined($e->{PROPERTIES}{relative_base})) {
1715 # retrieve the current offset as base for relative pointers
1716 # based on the toplevel struct/union
1717 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1719 $self->pidl("switch (level) {");
1721 foreach my $el (@{$e->{ELEMENTS}}) {
1722 if ($el->{CASE} eq "default") {
1726 $self->pidl("$el->{CASE}:");
1727 if ($el->{TYPE} ne "EMPTY") {
1729 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1732 $self->pidl("break;");
1735 if (! $have_default) {
1736 $self->pidl("default:");
1737 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1743 #####################################################################
1744 # parse a union - push side
1745 sub ParseUnionPush($$$$)
1747 my ($self,$e,$ndr,$varname) = @_;
1748 my $have_default = 0;
1750 $self->start_flags($e, $ndr);
1752 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1754 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1757 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1759 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1762 $self->end_flags($e, $ndr);
1765 #####################################################################
1767 sub ParseUnionPrint($$$$$)
1769 my ($self,$e,$ndr,$name,$varname) = @_;
1770 my $have_default = 0;
1772 $self->pidl("int level;");
1773 foreach my $el (@{$e->{ELEMENTS}}) {
1774 $self->DeclareArrayVariables($el);
1777 $self->start_flags($e, $ndr);
1779 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1781 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1783 $self->pidl("switch (level) {");
1785 foreach my $el (@{$e->{ELEMENTS}}) {
1786 if ($el->{CASE} eq "default") {
1789 $self->pidl("$el->{CASE}:");
1790 if ($el->{TYPE} ne "EMPTY") {
1792 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1795 $self->pidl("break;");
1798 if (! $have_default) {
1799 $self->pidl("default:");
1800 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1805 $self->end_flags($e, $ndr);
1808 sub ParseUnionPullPrimitives($$$$$)
1810 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1811 my $have_default = 0;
1813 if (defined($switch_type)) {
1814 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1815 $self->pidl("if (_level != level) {");
1816 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1820 if (defined($e->{ALIGN})) {
1821 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1824 $self->pidl("switch (level) {");
1826 foreach my $el (@{$e->{ELEMENTS}}) {
1827 if ($el->{CASE} eq "default") {
1830 $self->pidl("$el->{CASE}: {");
1832 if ($el->{TYPE} ne "EMPTY") {
1834 $self->DeclarePtrVariables($el);
1835 $self->DeclareArrayVariables($el);
1836 if (defined($e->{PROPERTIES}{relative_base})) {
1837 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1838 # set the current offset as base for relative pointers
1839 # and store it based on the toplevel struct/union
1840 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1842 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1845 $self->pidl("break; }");
1848 if (! $have_default) {
1849 $self->pidl("default:");
1850 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1856 sub ParseUnionPullDeferred($$$$)
1858 my ($self,$e,$ndr,$varname) = @_;
1859 my $have_default = 0;
1861 if (defined($e->{PROPERTIES}{relative_base})) {
1862 # retrieve the current offset as base for relative pointers
1863 # based on the toplevel struct/union
1864 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1866 $self->pidl("switch (level) {");
1868 foreach my $el (@{$e->{ELEMENTS}}) {
1869 if ($el->{CASE} eq "default") {
1873 $self->pidl("$el->{CASE}:");
1874 if ($el->{TYPE} ne "EMPTY") {
1876 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1879 $self->pidl("break;");
1882 if (! $have_default) {
1883 $self->pidl("default:");
1884 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1892 #####################################################################
1893 # parse a union - pull side
1894 sub ParseUnionPull($$$$)
1896 my ($self,$e,$ndr,$varname) = @_;
1897 my $switch_type = $e->{SWITCH_TYPE};
1899 $self->pidl("int level;");
1900 if (defined($switch_type)) {
1901 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1902 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1904 $self->pidl(mapTypeName($switch_type) . " _level;");
1907 my %double_cases = ();
1908 foreach my $el (@{$e->{ELEMENTS}}) {
1909 next if ($el->{TYPE} eq "EMPTY");
1910 next if ($double_cases{"$el->{NAME}"});
1911 $self->DeclareMemCtxVariables($el);
1912 $double_cases{"$el->{NAME}"} = 1;
1915 $self->start_flags($e, $ndr);
1917 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1919 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1921 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1925 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1927 $self->ParseUnionPullDeferred($e,$ndr,$varname);
1931 $self->add_deferred();
1933 $self->end_flags($e, $ndr);
1938 my ($e,$t,$name,$varname) = @_;
1939 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1942 sub ArgsUnionNdrSize($$)
1945 return "const union $name *r, uint32_t level, int flags";
1948 $typefamily{UNION} = {
1949 PUSH_FN_BODY => \&ParseUnionPush,
1950 DECL => \&DeclUnion,
1951 PULL_FN_BODY => \&ParseUnionPull,
1952 PRINT_FN_BODY => \&ParseUnionPrint,
1953 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1954 SIZE_FN_BODY => \&ParseUnionNdrSize,
1957 #####################################################################
1958 # parse a typedef - push side
1959 sub ParseTypedefPush($$$$)
1961 my($self,$e,$ndr,$varname) = @_;
1965 $env->{$e->{NAME}} = $varname;
1967 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1970 #####################################################################
1971 # parse a typedef - pull side
1972 sub ParseTypedefPull($$$$)
1974 my($self,$e,$ndr,$varname) = @_;
1978 $env->{$e->{NAME}} = $varname;
1980 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
1983 #####################################################################
1984 # parse a typedef - print side
1985 sub ParseTypedefPrint($$$$$)
1987 my($self,$e,$ndr,$name,$varname) = @_;
1989 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
1992 #####################################################################
1993 ## calculate the size of a structure
1994 sub ParseTypedefNdrSize($$$$)
1996 my($self,$t,$name,$varname) = @_;
1998 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2001 sub DeclTypedef($$$$)
2003 my ($e, $t, $name, $varname) = @_;
2005 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2008 sub ArgsTypedefNdrSize($$$)
2010 my ($d, $name, $varname) = @_;
2011 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2014 $typefamily{TYPEDEF} = {
2015 PUSH_FN_BODY => \&ParseTypedefPush,
2016 DECL => \&DeclTypedef,
2017 PULL_FN_BODY => \&ParseTypedefPull,
2018 PRINT_FN_BODY => \&ParseTypedefPrint,
2019 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2020 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2023 #####################################################################
2024 # parse a function - print side
2025 sub ParseFunctionPrint($$)
2027 my($self, $fn) = @_;
2030 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2032 return if has_property($fn, "noprint");
2034 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2038 foreach my $e (@{$fn->{ELEMENTS}}) {
2039 $self->DeclareArrayVariables($e);
2042 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2043 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2044 $self->pidl("$ndr->depth++;");
2046 $self->pidl("if (flags & NDR_SET_VALUES) {");
2047 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2050 $self->pidl("if (flags & NDR_IN) {");
2052 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2053 $self->pidl("$ndr->depth++;");
2055 my $env = GenerateFunctionInEnv($fn);
2057 foreach my $e (@{$fn->{ELEMENTS}}) {
2058 if (grep(/in/,@{$e->{DIRECTION}})) {
2059 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2062 $self->pidl("$ndr->depth--;");
2066 $self->pidl("if (flags & NDR_OUT) {");
2068 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2069 $self->pidl("$ndr->depth++;");
2071 $env = GenerateFunctionOutEnv($fn);
2072 foreach my $e (@{$fn->{ELEMENTS}}) {
2073 if (grep(/out/,@{$e->{DIRECTION}})) {
2074 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2077 if ($fn->{RETURN_TYPE}) {
2078 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2080 $self->pidl("$ndr->depth--;");
2084 $self->pidl("$ndr->depth--;");
2090 #####################################################################
2092 sub ParseFunctionPush($$)
2094 my($self, $fn) = @_;
2097 $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;
2099 return if has_property($fn, "nopush");
2104 foreach my $e (@{$fn->{ELEMENTS}}) {
2105 $self->DeclareArrayVariables($e);
2108 $self->pidl("if (flags & NDR_IN) {");
2111 my $env = GenerateFunctionInEnv($fn);
2113 EnvSubstituteValue($env, $fn);
2115 foreach my $e (@{$fn->{ELEMENTS}}) {
2116 if (grep(/in/,@{$e->{DIRECTION}})) {
2117 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2124 $self->pidl("if (flags & NDR_OUT) {");
2127 $env = GenerateFunctionOutEnv($fn);
2128 foreach my $e (@{$fn->{ELEMENTS}}) {
2129 if (grep(/out/,@{$e->{DIRECTION}})) {
2130 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2134 if ($fn->{RETURN_TYPE}) {
2135 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2140 $self->pidl("return NDR_ERR_SUCCESS;");
2146 sub AllocateArrayLevel($$$$$$)
2148 my ($self,$e,$l,$ndr,$var,$size) = @_;
2150 my $pl = GetPrevLevel($e, $l);
2151 if (defined($pl) and
2152 $pl->{TYPE} eq "POINTER" and
2153 $pl->{POINTER_TYPE} eq "ref"
2154 and not $l->{IS_ZERO_TERMINATED}) {
2155 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2156 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2158 if (grep(/in/,@{$e->{DIRECTION}}) and
2159 grep(/out/,@{$e->{DIRECTION}})) {
2160 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2165 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2168 #####################################################################
2170 sub ParseFunctionPull($$)
2175 # pull function args
2176 $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;
2181 # declare any internal pointers we need
2182 foreach my $e (@{$fn->{ELEMENTS}}) {
2183 $self->DeclarePtrVariables($e);
2184 $self->DeclareArrayVariables($e);
2187 my %double_cases = ();
2188 foreach my $e (@{$fn->{ELEMENTS}}) {
2189 next if ($e->{TYPE} eq "EMPTY");
2190 next if ($double_cases{"$e->{NAME}"});
2191 $self->DeclareMemCtxVariables($e);
2192 $double_cases{"$e->{NAME}"} = 1;
2195 $self->pidl("if (flags & NDR_IN) {");
2198 # auto-init the out section of a structure. I originally argued that
2199 # this was a bad idea as it hides bugs, but coping correctly
2200 # with initialisation and not wiping ref vars is turning
2201 # out to be too tricky (tridge)
2202 foreach my $e (@{$fn->{ELEMENTS}}) {
2203 next unless grep(/out/, @{$e->{DIRECTION}});
2204 $self->pidl("ZERO_STRUCT(r->out);");
2209 my $env = GenerateFunctionInEnv($fn);
2211 foreach my $e (@{$fn->{ELEMENTS}}) {
2212 next unless (grep(/in/, @{$e->{DIRECTION}}));
2213 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2216 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2217 # own flag rather than be in NDR_IN ?
2219 foreach my $e (@{$fn->{ELEMENTS}}) {
2220 next unless (grep(/out/, @{$e->{DIRECTION}}));
2221 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2222 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2223 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2224 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2225 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2226 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2228 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2229 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2230 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2231 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2232 check_fully_dereferenced($e, $env));
2233 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2235 if (grep(/in/, @{$e->{DIRECTION}})) {
2236 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2238 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2241 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2243 if (grep(/in/, @{$e->{DIRECTION}})) {
2244 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2246 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2251 $self->add_deferred();
2255 $self->pidl("if (flags & NDR_OUT) {");
2258 $env = GenerateFunctionOutEnv($fn);
2259 foreach my $e (@{$fn->{ELEMENTS}}) {
2260 next unless grep(/out/, @{$e->{DIRECTION}});
2261 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2264 if ($fn->{RETURN_TYPE}) {
2265 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2268 $self->add_deferred();
2272 $self->pidl("return NDR_ERR_SUCCESS;");
2278 sub AuthServiceStruct($$$)
2280 my ($self, $ifacename, $authservice) = @_;
2281 my @a = split /,/, $authservice;
2282 my $authservice_count = $#a + 1;
2284 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2285 foreach my $ap (@a) {
2286 $self->pidl("\t$ap, ");
2291 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2292 $self->pidl("\t.count\t= $authservice_count,");
2293 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2298 sub FunctionCallEntry($$)
2300 my ($self, $d) = @_;
2301 return 0 if not defined($d->{OPNUM});
2303 $self->pidl("\t\t\"$d->{NAME}\",");
2304 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2305 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2306 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2307 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2308 $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2309 $self->pidl("\t},");
2313 #####################################################################
2314 # produce a function call table
2315 sub FunctionTable($$)
2317 my($self,$interface) = @_;
2319 my $uname = uc $interface->{NAME};
2321 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2322 return unless defined ($interface->{PROPERTIES}->{uuid});
2324 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2326 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2327 $count += $self->FunctionCallEntry($d);
2329 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2333 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2334 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2335 $self->pidl("\t$ep, ");
2337 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2342 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2343 $self->pidl("\t.count\t= $endpoint_count,");
2344 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2348 if (! defined $interface->{PROPERTIES}->{authservice}) {
2349 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2352 $self->AuthServiceStruct($interface->{NAME},
2353 $interface->{PROPERTIES}->{authservice});
2355 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2356 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2357 $self->pidl("\t.syntax_id\t= {");
2358 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2359 $self->pidl("\t\tNDR_$uname\_VERSION");
2360 $self->pidl("\t},");
2361 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2362 $self->pidl("\t.num_calls\t= $count,");
2363 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2364 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2365 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2371 #####################################################################
2372 # generate include statements for imported idl files
2377 foreach (@imports) {
2378 $_ = unmake_str($_);
2380 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2384 #####################################################################
2385 # generate include statements for included header files
2390 foreach (@includes) {
2391 $self->pidl_hdr("#include $_");
2395 #####################################################################
2396 # generate prototypes and defines for the interface definitions
2397 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2398 # NDR parser and so do not belong here, technically speaking
2399 sub HeaderInterface($$$)
2401 my($self,$interface,$needed) = @_;
2405 if ($needed->{"compression"}) {
2406 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2409 if (has_property($interface, "object")) {
2410 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2413 if (defined $interface->{PROPERTIES}->{helper}) {
2414 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2417 if (defined $interface->{PROPERTIES}->{uuid}) {
2418 my $name = uc $interface->{NAME};
2419 $self->pidl_hdr("#define NDR_$name\_UUID " .
2420 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2422 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2423 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2425 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2427 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2428 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2430 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2433 foreach (@{$interface->{FUNCTIONS}}) {
2434 next if has_property($_, "noopnum");
2435 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2436 my $u_name = uc $_->{NAME};
2438 my $val = sprintf("0x%02x", $count);
2439 if (defined($interface->{BASE})) {
2440 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2443 $self->pidl_hdr("#define NDR_$u_name ($val)");
2445 $self->pidl_hdr("");
2451 if (defined($interface->{BASE})) {
2452 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2455 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2459 sub ParseTypePush($$$$$$)
2461 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2463 # save the old relative_base_offset
2464 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2465 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2466 # restore the old relative_base_offset
2467 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2470 sub ParseTypePushFunction($$$)
2472 my ($self, $e, $varname) = @_;
2475 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2477 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2481 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2482 $self->pidl("return NDR_ERR_SUCCESS;");
2488 sub ParseTypePull($$$$$$)
2490 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2492 # save the old relative_base_offset
2493 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2494 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2495 # restore the old relative_base_offset
2496 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2499 sub ParseTypePullFunction($$)
2501 my ($self, $e, $varname) = @_;
2504 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2506 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2510 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2511 $self->pidl("return NDR_ERR_SUCCESS;");
2517 sub ParseTypePrint($$$$)
2519 my ($self, $e, $ndr, $varname) = @_;
2521 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2524 sub ParseTypePrintFunction($$$)
2526 my ($self, $e, $varname) = @_;
2529 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2531 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2533 return if (has_property($e, "noprint"));
2535 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2538 $self->ParseTypePrint($e, $ndr, $varname);
2544 sub ParseTypeNdrSize($$)
2549 my $tf = $typefamily{$t->{TYPE}};
2550 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2552 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2556 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2562 #####################################################################
2563 # parse the interface definitions
2564 sub ParseInterface($$$)
2566 my($self,$interface,$needed) = @_;
2568 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2569 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2571 $self->pidl_hdr("");
2573 $self->HeaderInterface($interface, $needed);
2576 foreach my $d (@{$interface->{TYPES}}) {
2577 next unless(typeHasBody($d));
2579 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2580 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2581 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2583 # Make sure we don't generate a function twice...
2584 $needed->{TypeFunctionName("ndr_push", $d)} =
2585 $needed->{TypeFunctionName("ndr_pull", $d)} =
2586 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2588 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2592 foreach my $d (@{$interface->{FUNCTIONS}}) {
2593 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2594 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2595 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2597 # Make sure we don't generate a function twice...
2598 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2599 $needed->{"ndr_print_$d->{NAME}"} = 0;
2602 $self->FunctionTable($interface);
2604 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2607 sub GenerateIncludes($)
2611 $self->pidl("#include \"includes.h\"");
2613 $self->pidl("#ifndef _GNU_SOURCE");
2614 $self->pidl("#define _GNU_SOURCE");
2615 $self->pidl("#endif");
2616 $self->pidl("#include <stdint.h>");
2617 $self->pidl("#include <stdlib.h>");
2618 $self->pidl("#include <stdio.h>");
2619 $self->pidl("#include <stdbool.h>");
2620 $self->pidl("#include <stdarg.h>");
2621 $self->pidl("#include <string.h>");
2625 #####################################################################
2626 # parse a parsed IDL structure back into an IDL file
2629 my($self, $ndr,$gen_header,$ndr_header) = @_;
2631 $self->pidl_hdr("/* header auto-generated by pidl */");
2632 $self->pidl_hdr("");
2633 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2634 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2635 $self->pidl_hdr("");
2637 $self->pidl("/* parser auto-generated by pidl */");
2639 $self->GenerateIncludes();
2640 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2646 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2650 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2651 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2652 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2655 return ($self->{res_hdr}, $self->{res});
2658 sub NeededElement($$$)
2660 my ($e, $dir, $needed) = @_;
2662 return if ($e->{TYPE} eq "EMPTY");
2664 return if (ref($e->{TYPE}) eq "HASH" and
2665 not defined($e->{TYPE}->{NAME}));
2668 if (ref($e->{TYPE}) eq "HASH") {
2669 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2674 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2675 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2677 $rt = $e->{REPRESENTATION_TYPE};
2680 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2683 if ($dir eq "print") {
2684 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2685 } elsif ($dir eq "pull") {
2686 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2687 push (@fn, "ndr_$t\_to_$rt")
2689 } elsif ($dir eq "push") {
2690 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2691 push (@fn, "ndr_$rt\_to_$t")
2694 die("invalid direction `$dir'");
2698 unless (defined($needed->{$_})) {
2704 sub NeededFunction($$)
2706 my ($fn,$needed) = @_;
2707 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2708 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2709 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2710 foreach my $e (@{$fn->{ELEMENTS}}) {
2712 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2718 sub NeededType($$$);
2719 my ($t,$needed,$req) = @_;
2721 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2723 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2724 return unless defined($t->{ELEMENTS});
2725 for my $e (@{$t->{ELEMENTS}}) {
2727 if (has_property($e, "compression")) {
2728 $needed->{"compression"} = 1;
2730 NeededElement($e, $req, $needed);
2731 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2736 #####################################################################
2737 # work out what parse functions are needed
2738 sub NeededInterface($$)
2740 my ($interface,$needed) = @_;
2741 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2742 foreach (reverse @{$interface->{TYPES}}) {
2743 if (has_property($_, "public")) {
2744 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2745 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2748 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2749 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2750 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2751 if (has_property($_, "gensize")) {
2752 $needed->{"ndr_size_$_->{NAME}"} = 1;
2757 sub TypeFunctionName($$)
2759 my ($prefix, $t) = @_;
2761 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2762 $t->{TYPE} eq "TYPEDEF");
2763 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2764 return "$prefix\_$t";