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);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header);
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) = @_;
46 foreach my $l (@{$e->{LEVELS}}) {
47 if ($l->{TYPE} eq "POINTER") {
49 } elsif ($l->{TYPE} eq "ARRAY") {
50 if (($pointers == 0) and
51 (not $l->{IS_FIXED}) and
52 (not $l->{IS_INLINE})) {
53 return get_value_of($var_name);
55 } elsif ($l->{TYPE} eq "DATA") {
56 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
57 return get_value_of($var_name) unless ($pointers);
65 sub has_fast_array($$)
69 return 0 if ($l->{TYPE} ne "ARRAY");
71 my $nl = GetNextLevel($e,$l);
72 return 0 unless ($nl->{TYPE} eq "DATA");
73 return 0 unless (hasType($nl->{DATA_TYPE}));
75 my $t = getType($nl->{DATA_TYPE});
77 # Only uint8 and string have fast array functions at the moment
78 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
82 ####################################
83 # pidl() is our basic output routine
88 $self->{res} .= $self->{tabs};
94 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
96 ####################################
97 # defer() is like pidl(), but adds to
98 # a deferred buffer which is then added to the
99 # output buffer at the end of the structure/union/function
100 # This is needed to cope with code that must be pushed back
101 # to the end of a block of elements
102 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
103 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
109 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
113 ########################################
114 # add the deferred content to the current
119 $self->pidl($_) foreach (@{$self->{deferred}});
120 $self->{deferred} = [];
121 $self->{defer_tabs} = "";
127 $self->{tabs} .= "\t";
133 $self->{tabs} = substr($self->{tabs}, 0, -1);
136 #####################################################################
137 # declare a function public or static, depending on its attributes
140 my ($self,$type,$fn,$decl) = @_;
142 if (has_property($fn, "no$type")) {
143 $self->pidl_hdr("$decl;");
147 if (has_property($fn, "public")) {
148 $self->pidl_hdr("$decl;");
149 $self->pidl("_PUBLIC_ $decl");
151 $self->pidl("static $decl");
157 ###################################################################
158 # setup any special flags for an element or structure
162 my $flags = has_property($e, "flag");
163 if (defined $flags) {
166 $self->pidl("uint32_t _flags_save_$e->{TYPE} = ndr->flags;");
167 $self->pidl("ndr_set_flags(&ndr->flags, $flags);");
171 ###################################################################
172 # end any special flags for an element or structure
176 my $flags = has_property($e, "flag");
177 if (defined $flags) {
178 $self->pidl("ndr->flags = _flags_save_$e->{TYPE};");
184 #####################################################################
185 # parse the data of an array - push side
186 sub ParseArrayPushHeader($$$$$$)
188 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
193 if ($l->{IS_ZERO_TERMINATED}) {
194 if (has_property($e, "charset")) {
195 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
197 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
200 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
201 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
204 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
205 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
208 if ($l->{IS_VARYING}) {
209 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"); # array offset
210 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));");
216 sub check_fully_dereferenced($$)
218 my ($element, $env) = @_;
224 # Figure out the number of pointers in $ptr
225 my $expandedvar = $origvar;
226 $expandedvar =~ s/^(\**)//;
230 foreach (keys %$env) {
231 if ($env->{$_} eq $expandedvar) {
237 return($origvar) unless (defined($var));
239 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
240 if ($_->{NAME} eq $var) {
246 $e or die("Environment doesn't match siblings");
248 # See if pointer at pointer level $level
249 # needs to be checked.
251 foreach (@{$e->{LEVELS}}) {
252 if ($_->{TYPE} eq "POINTER") {
253 $nump = $_->{POINTER_INDEX}+1;
256 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
261 sub check_null_pointer($$$$)
263 my ($element, $env, $print_fn, $return) = @_;
266 my $expandedvar = shift;
269 # Figure out the number of pointers in $ptr
270 $expandedvar =~ s/^(\**)//;
274 foreach (keys %$env) {
275 if ($env->{$_} eq $expandedvar) {
284 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
285 if ($_->{NAME} eq $var) {
291 $e or die("Environment doesn't match siblings");
293 # See if pointer at pointer level $level
294 # needs to be checked.
295 foreach my $l (@{$e->{LEVELS}}) {
296 if ($l->{TYPE} eq "POINTER" and
297 $l->{POINTER_INDEX} == length($ptr)) {
298 # No need to check ref pointers
299 $check = ($l->{POINTER_TYPE} ne "ref");
303 if ($l->{TYPE} eq "DATA") {
304 warning($element, "too much dereferences for `$var'");
308 warning($element, "unknown dereferenced expression `$expandedvar'");
312 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
316 #####################################################################
317 # parse an array - pull side
318 sub ParseArrayPullHeader($$$$$$)
320 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
325 if ($l->{IS_CONFORMANT}) {
326 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
327 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
328 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
330 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
331 check_null_pointer($e, $env, sub { $self->pidl(shift); },
332 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
333 check_fully_dereferenced($e, $env));
336 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
337 $self->pidl("NDR_CHECK(ndr_pull_array_size(ndr, " . get_pointer_to($var_name) . "));");
340 if ($l->{IS_VARYING}) {
341 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
342 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
345 if ($length ne $size) {
346 $self->pidl("if ($length > $size) {");
348 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);");
353 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
354 $self->defer("if ($var_name) {");
356 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
357 check_null_pointer($e, $env, sub { $self->defer(shift); },
358 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
359 check_fully_dereferenced($e, $env));
360 $self->defer("NDR_CHECK(ndr_check_array_size(ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
361 $self->defer_deindent;
365 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
366 $self->defer("if ($var_name) {");
368 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
369 check_null_pointer($e, $env, sub { $self->defer(shift); },
370 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
371 check_fully_dereferenced($e, $env));
372 $self->defer("NDR_CHECK(ndr_check_array_length(ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
373 $self->defer_deindent;
377 if (not $l->{IS_FIXED} and not is_charset_array($e, $l)) {
378 $self->AllocateArrayLevel($e,$l,$ndr,$env,$size);
384 sub compression_alg($$)
387 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
392 sub compression_clen($$$)
394 my ($e, $l, $env) = @_;
395 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
397 return ParseExpr($clen, $env, $e->{ORIGINAL});
400 sub compression_dlen($$$)
402 my ($e,$l,$env) = @_;
403 my ($alg, $clen, $dlen) = split(/ /, $l->{COMPRESSION});
405 return ParseExpr($dlen, $env, $e->{ORIGINAL});
408 sub ParseCompressionPushStart($$$$$)
410 my ($self,$e,$l,$ndr,$env) = @_;
411 my $comndr = "$ndr\_compressed";
412 my $alg = compression_alg($e, $l);
413 my $dlen = compression_dlen($e, $l, $env);
417 $self->pidl("struct ndr_push *$comndr;");
418 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
423 sub ParseCompressionPushEnd($$$$$)
425 my ($self,$e,$l,$ndr,$env) = @_;
426 my $comndr = "$ndr\_compressed";
427 my $alg = compression_alg($e, $l);
428 my $dlen = compression_dlen($e, $l, $env);
430 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
435 sub ParseCompressionPullStart($$$$$)
437 my ($self,$e,$l,$ndr,$env) = @_;
438 my $comndr = "$ndr\_compressed";
439 my $alg = compression_alg($e, $l);
440 my $dlen = compression_dlen($e, $l, $env);
444 $self->pidl("struct ndr_pull *$comndr;");
445 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
450 sub ParseCompressionPullEnd($$$$$)
452 my ($self,$e,$l,$ndr,$env) = @_;
453 my $comndr = "$ndr\_compressed";
454 my $alg = compression_alg($e, $l);
455 my $dlen = compression_dlen($e, $l, $env);
457 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
462 sub ParseSubcontextPushStart($$$$$)
464 my ($self,$e,$l,$ndr,$env) = @_;
465 my $subndr = "_ndr_$e->{NAME}";
466 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
470 $self->pidl("struct ndr_push *$subndr;");
471 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
473 if (defined $l->{COMPRESSION}) {
474 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
480 sub ParseSubcontextPushEnd($$$$$)
482 my ($self,$e,$l,$ndr,$env) = @_;
483 my $subndr = "_ndr_$e->{NAME}";
484 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
486 if (defined $l->{COMPRESSION}) {
487 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
490 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
495 sub ParseSubcontextPullStart($$$$$)
497 my ($self,$e,$l,$ndr,$env) = @_;
498 my $subndr = "_ndr_$e->{NAME}";
499 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
503 $self->pidl("struct ndr_pull *$subndr;");
504 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
506 if (defined $l->{COMPRESSION}) {
507 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
513 sub ParseSubcontextPullEnd($$$$$)
515 my ($self,$e,$l,$ndr,$env) = @_;
516 my $subndr = "_ndr_$e->{NAME}";
517 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
519 if (defined $l->{COMPRESSION}) {
520 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
523 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
528 sub ParseElementPushLevel
530 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
532 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
534 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
535 $var_name = get_pointer_to($var_name);
538 if (defined($ndr_flags)) {
539 if ($l->{TYPE} eq "SUBCONTEXT") {
540 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
541 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
542 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
543 } elsif ($l->{TYPE} eq "POINTER") {
544 $self->ParsePtrPush($e, $l, $var_name);
545 } elsif ($l->{TYPE} eq "ARRAY") {
546 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
548 my $nl = GetNextLevel($e, $l);
550 # Allow speedups for arrays of scalar types
551 if (is_charset_array($e,$l)) {
552 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
554 } elsif (has_fast_array($e,$l)) {
555 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
558 } elsif ($l->{TYPE} eq "SWITCH") {
559 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
560 } elsif ($l->{TYPE} eq "DATA") {
561 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
565 if ($l->{TYPE} eq "POINTER" and $deferred) {
566 if ($l->{POINTER_TYPE} ne "ref") {
567 $self->pidl("if ($var_name) {");
569 if ($l->{POINTER_TYPE} eq "relative") {
570 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_name));");
573 $var_name = get_value_of($var_name);
574 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
576 if ($l->{POINTER_TYPE} ne "ref") {
580 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
581 not is_charset_array($e, $l)) {
582 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
583 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
585 $var_name = $var_name . "[$counter]";
587 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
588 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
590 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
595 if ($deferred and ContainsDeferred($e, $l)) {
596 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
598 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
602 } elsif ($l->{TYPE} eq "SWITCH") {
603 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
607 #####################################################################
608 # parse scalars in a structure element
609 sub ParseElementPush($$$$$$)
611 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
614 my $var_name = $env->{$e->{NAME}};
616 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
618 # Representation type is different from transmit_as
619 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
622 my $transmit_name = "_transmit_$e->{NAME}";
623 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
624 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
625 $var_name = $transmit_name;
628 $var_name = append_prefix($e, $var_name);
630 $self->start_flags($e);
632 if (defined(my $value = has_property($e, "value"))) {
633 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
636 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
638 $self->end_flags($e);
640 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
646 #####################################################################
647 # parse a pointer in a struct element or function
648 sub ParsePtrPush($$$$)
650 my ($self,$e,$l,$var_name) = @_;
652 if ($l->{POINTER_TYPE} eq "ref") {
653 $self->pidl("if ($var_name == NULL) {");
655 $self->pidl("return ndr_push_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
658 if ($l->{LEVEL} eq "EMBEDDED") {
659 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
661 } elsif ($l->{POINTER_TYPE} eq "relative") {
662 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_name));");
663 } elsif ($l->{POINTER_TYPE} eq "unique") {
664 $self->pidl("NDR_CHECK(ndr_push_unique_ptr(ndr, $var_name));");
665 } elsif ($l->{POINTER_TYPE} eq "full") {
666 $self->pidl("NDR_CHECK(ndr_push_full_ptr(ndr, $var_name));");
668 die("Unhandled pointer type $l->{POINTER_TYPE}");
672 sub ParseDataPrint($$$$)
674 my ($self, $e, $l, $var_name) = @_;
676 if (not ref($l->{DATA_TYPE}) or
677 defined($l->{DATA_TYPE}->{NAME})) {
679 if (ref($l->{DATA_TYPE})) {
680 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
682 $t = $l->{DATA_TYPE};
684 if (not Parse::Pidl::Typelist::is_scalar($t) or
685 Parse::Pidl::Typelist::scalar_is_reference($t)) {
686 $var_name = get_pointer_to($var_name);
688 $self->pidl("ndr_print_$t(ndr, \"$e->{NAME}\", $var_name);");
690 $self->ParseTypePrint($l->{DATA_TYPE}, $var_name);
694 #####################################################################
695 # print scalars in a structure element
696 sub ParseElementPrint($$$$)
698 my($self, $e, $var_name, $env) = @_;
700 return if (has_property($e, "noprint"));
702 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
703 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}(ndr, \"$e->{NAME}\", $var_name);");
707 $var_name = append_prefix($e, $var_name);
709 if (defined(my $value = has_property($e, "value"))) {
710 $var_name = "(ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
713 foreach my $l (@{$e->{LEVELS}}) {
714 if ($l->{TYPE} eq "POINTER") {
715 $self->pidl("ndr_print_ptr(ndr, \"$e->{NAME}\", $var_name);");
716 $self->pidl("ndr->depth++;");
717 if ($l->{POINTER_TYPE} ne "ref") {
718 $self->pidl("if ($var_name) {");
721 $var_name = get_value_of($var_name);
722 } elsif ($l->{TYPE} eq "ARRAY") {
725 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
726 $var_name = get_pointer_to($var_name);
729 if ($l->{IS_ZERO_TERMINATED}) {
730 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
732 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
733 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
736 if (is_charset_array($e,$l)) {
737 $self->pidl("ndr_print_string(ndr, \"$e->{NAME}\", $var_name);");
739 } elsif (has_fast_array($e, $l)) {
740 my $nl = GetNextLevel($e, $l);
741 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name, $length);");
744 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
746 $self->pidl("ndr->print(ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", $length);");
747 $self->pidl("ndr->depth++;");
748 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
750 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
751 $self->pidl("asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter);");
752 $self->pidl("if (idx_$l->{LEVEL_INDEX}) {");
755 $var_name = $var_name . "[$counter]";
757 } elsif ($l->{TYPE} eq "DATA") {
758 $self->ParseDataPrint($e, $l, $var_name);
759 } elsif ($l->{TYPE} eq "SWITCH") {
760 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
761 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
762 $self->pidl("ndr_print_set_switch_value(ndr, " . get_pointer_to($var_name) . ", $switch_var);");
766 foreach my $l (reverse @{$e->{LEVELS}}) {
767 if ($l->{TYPE} eq "POINTER") {
768 if ($l->{POINTER_TYPE} ne "ref") {
772 $self->pidl("ndr->depth--;");
773 } elsif (($l->{TYPE} eq "ARRAY")
774 and not is_charset_array($e,$l)
775 and not has_fast_array($e,$l)) {
776 $self->pidl("free(idx_$l->{LEVEL_INDEX});");
781 $self->pidl("ndr->depth--;");
786 #####################################################################
787 # parse scalars in a structure element - pull size
788 sub ParseSwitchPull($$$$$$)
790 my($self,$e,$l,$ndr,$var_name,$env) = @_;
791 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
792 check_null_pointer($e, $env, sub { $self->pidl(shift); },
793 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
794 check_fully_dereferenced($e, $env));
796 $var_name = get_pointer_to($var_name);
797 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
800 #####################################################################
801 # push switch element
802 sub ParseSwitchPush($$$$$$)
804 my($self,$e,$l,$ndr,$var_name,$env) = @_;
805 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
806 check_null_pointer($e, $env, sub { $self->pidl(shift); },
807 "return ndr_push_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
808 check_fully_dereferenced($e, $env));
810 $var_name = get_pointer_to($var_name);
811 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
814 sub ParseDataPull($$$$$$$)
816 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
818 if (not ref($l->{DATA_TYPE}) or
819 defined($l->{DATA_TYPE}->{NAME})) {
821 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
823 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
824 $var_name = get_pointer_to($var_name);
827 $var_name = get_pointer_to($var_name);
829 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
831 if (my $range = has_property($e, "range")) {
832 $var_name = get_value_of($var_name);
833 my ($low, $high) = split(/ /, $range, 2);
834 $self->pidl("if ($var_name < $low || $var_name > $high) {");
835 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
839 $self->ParseTypePull($l->{DATA_TYPE}, $var_name, $primitives, $deferred);
843 sub ParseDataPush($$$$$$$)
845 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
847 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
849 if (ref($l->{DATA_TYPE}) eq "HASH") {
850 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
852 $t = $l->{DATA_TYPE};
855 # strings are passed by value rather than reference
856 if (not Parse::Pidl::Typelist::is_scalar($t) or
857 Parse::Pidl::Typelist::scalar_is_reference($t)) {
858 $var_name = get_pointer_to($var_name);
861 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
862 $self->pidl("NDR_CHECK(ndr_push_$t($ndr, $ndr_flags, $var_name));");
864 $self->ParseTypePush($l->{DATA_TYPE}, $var_name, $primitives, $deferred);
868 sub CalcNdrFlags($$$)
870 my ($l,$primitives,$deferred) = @_;
875 # Add NDR_SCALARS if this one is deferred
876 # and deferreds may be pushed
877 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
879 # Add NDR_SCALARS if this one is not deferred and
880 # primitives may be pushed
881 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
883 # Add NDR_BUFFERS if this one contains deferred stuff
884 # and deferreds may be pushed
885 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
887 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
888 return "NDR_SCALARS" if ($scalars);
889 return "NDR_BUFFERS" if ($buffers);
893 sub ParseMemCtxPullStart($$$$)
895 my ($self, $e, $l, $ptr_name) = @_;
897 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
898 my $mem_c_ctx = $ptr_name;
899 my $mem_c_flags = "0";
901 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
903 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
904 my $nl = GetNextLevel($e, $l);
905 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
906 my $next_is_string = (($nl->{TYPE} eq "DATA") and
907 ($nl->{DATA_TYPE} eq "string"));
908 if ($next_is_array or $next_is_string) {
911 $mem_c_flags = "LIBNDR_FLAG_REF_ALLOC";
915 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX(ndr);");
916 $self->pidl("NDR_PULL_SET_MEM_CTX(ndr, $mem_c_ctx, $mem_c_flags);");
919 sub ParseMemCtxPullEnd($$$)
921 my ($self, $e, $l) = @_;
923 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
924 my $mem_r_flags = "0";
926 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
928 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
929 my $nl = GetNextLevel($e, $l);
930 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
931 my $next_is_string = (($nl->{TYPE} eq "DATA") and
932 ($nl->{DATA_TYPE} eq "string"));
933 if ($next_is_array or $next_is_string) {
936 $mem_r_flags = "LIBNDR_FLAG_REF_ALLOC";
940 $self->pidl("NDR_PULL_SET_MEM_CTX(ndr, $mem_r_ctx, $mem_r_flags);");
943 sub CheckStringTerminator($$$$$)
945 my ($self,$ndr,$e,$l,$length) = @_;
946 my $nl = GetNextLevel($e, $l);
948 # Make sure last element is zero!
949 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
952 sub ParseElementPullLevel
954 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
956 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
958 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
959 $var_name = get_pointer_to($var_name);
962 # Only pull something if there's actually something to be pulled
963 if (defined($ndr_flags)) {
964 if ($l->{TYPE} eq "SUBCONTEXT") {
965 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
966 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
967 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
968 } elsif ($l->{TYPE} eq "ARRAY") {
969 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
971 my $nl = GetNextLevel($e, $l);
973 if (is_charset_array($e,$l)) {
974 if ($l->{IS_ZERO_TERMINATED}) {
975 $self->CheckStringTerminator($ndr, $e, $l, $length);
977 $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}));");
979 } elsif (has_fast_array($e, $l)) {
980 if ($l->{IS_ZERO_TERMINATED}) {
981 $self->CheckStringTerminator($ndr,$e,$l,$length);
983 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
986 } elsif ($l->{TYPE} eq "POINTER") {
987 $self->ParsePtrPull($e, $l, $ndr, $var_name);
988 } elsif ($l->{TYPE} eq "SWITCH") {
989 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
990 } elsif ($l->{TYPE} eq "DATA") {
991 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
995 # add additional constructions
996 if ($l->{TYPE} eq "POINTER" and $deferred) {
997 if ($l->{POINTER_TYPE} ne "ref") {
998 $self->pidl("if ($var_name) {");
1001 if ($l->{POINTER_TYPE} eq "relative") {
1002 $self->pidl("uint32_t _relative_save_offset;");
1003 $self->pidl("_relative_save_offset = ndr->offset;");
1004 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_name));");
1008 $self->ParseMemCtxPullStart($e, $l, $var_name);
1010 $var_name = get_value_of($var_name);
1011 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1013 $self->ParseMemCtxPullEnd($e,$l);
1015 if ($l->{POINTER_TYPE} ne "ref") {
1016 if ($l->{POINTER_TYPE} eq "relative") {
1017 $self->pidl("ndr->offset = _relative_save_offset;");
1022 } elsif ($l->{TYPE} eq "ARRAY" and
1023 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1024 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1025 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1026 my $array_name = $var_name;
1028 $var_name = $var_name . "[$counter]";
1030 $self->ParseMemCtxPullStart($e, $l, $array_name);
1032 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1033 my $nl = GetNextLevel($e,$l);
1035 if ($l->{IS_ZERO_TERMINATED}) {
1036 $self->CheckStringTerminator($ndr,$e,$l,$length);
1039 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1041 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1046 if ($deferred and ContainsDeferred($e, $l)) {
1047 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1049 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1054 $self->ParseMemCtxPullEnd($e, $l);
1056 } elsif ($l->{TYPE} eq "SWITCH") {
1057 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1061 #####################################################################
1062 # parse scalars in a structure element - pull size
1063 sub ParseElementPull($$$$$$)
1065 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1067 my $var_name = $env->{$e->{NAME}};
1071 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1073 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1076 $represent_name = $var_name;
1077 $transmit_name = "_transmit_$e->{NAME}";
1078 $var_name = $transmit_name;
1079 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1082 $var_name = append_prefix($e, $var_name);
1084 $self->start_flags($e);
1086 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1088 $self->end_flags($e);
1090 # Representation type is different from transmit_as
1091 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1092 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1098 #####################################################################
1099 # parse a pointer in a struct element or function
1100 sub ParsePtrPull($$$$$)
1102 my($self, $e,$l,$ndr,$var_name) = @_;
1104 my $nl = GetNextLevel($e, $l);
1105 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1106 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1107 ($nl->{DATA_TYPE} eq "string"));
1109 if ($l->{POINTER_TYPE} eq "ref") {
1110 if ($l->{LEVEL} eq "EMBEDDED") {
1111 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1114 if (!$next_is_array and !$next_is_string) {
1115 $self->pidl("if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1116 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1121 } elsif (($l->{POINTER_TYPE} eq "unique") or
1122 ($l->{POINTER_TYPE} eq "relative") or
1123 ($l->{POINTER_TYPE} eq "full")) {
1124 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1125 $self->pidl("if (_ptr_$e->{NAME}) {");
1128 die("Unhandled pointer type $l->{POINTER_TYPE}");
1131 # Don't do this for arrays, they're allocated at the actual level
1133 unless ($next_is_array or $next_is_string) {
1134 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1136 # FIXME: Yes, this is nasty.
1137 # We allocate an array twice
1138 # - once just to indicate that it's there,
1139 # - then the real allocation...
1140 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1143 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1144 if ($l->{POINTER_TYPE} eq "relative") {
1145 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1148 $self->pidl("} else {");
1149 $self->pidl("\t$var_name = NULL;");
1153 sub ParseStructPushPrimitives($$$$)
1155 my ($self, $struct, $varname, $env) = @_;
1157 # see if the structure contains a conformant array. If it
1158 # does, then it must be the last element of the structure, and
1159 # we need to push the conformant length early, as it fits on
1160 # the wire before the structure (and even before the structure
1162 if (defined($struct->{SURROUNDING_ELEMENT})) {
1163 my $e = $struct->{SURROUNDING_ELEMENT};
1165 if (defined($e->{LEVELS}[0]) and
1166 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1169 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1170 if (has_property($e, "charset")) {
1171 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1173 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1176 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1179 $self->pidl("NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));");
1181 $self->pidl("NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, $varname->$e->{NAME})));");
1185 $self->pidl("NDR_CHECK(ndr_push_align(ndr, $struct->{ALIGN}));");
1187 if (defined($struct->{PROPERTIES}{relative_base})) {
1188 # set the current offset as base for relative pointers
1189 # and store it based on the toplevel struct/union
1190 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1193 $self->ParseElementPush($_, "ndr", $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1196 sub ParseStructPushDeferred($$$)
1198 my ($self, $struct, $varname, $env) = @_;
1199 if (defined($struct->{PROPERTIES}{relative_base})) {
1200 # retrieve the current offset as base for relative pointers
1201 # based on the toplevel struct/union
1202 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, $varname));");
1204 $self->ParseElementPush($_, "ndr", $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1207 #####################################################################
1209 sub ParseStructPush($$$)
1211 my ($self, $struct, $varname) = @_;
1213 return unless defined($struct->{ELEMENTS});
1215 my $env = GenerateStructEnv($struct, $varname);
1217 EnvSubstituteValue($env, $struct);
1219 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1221 $self->start_flags($struct);
1223 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1225 $self->ParseStructPushPrimitives($struct, $varname, $env);
1229 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1231 $self->ParseStructPushDeferred($struct, $varname, $env);
1235 $self->end_flags($struct);
1238 #####################################################################
1239 # generate a push function for an enum
1240 sub ParseEnumPush($$$)
1242 my($self,$enum,$varname) = @_;
1243 my($type_fn) = $enum->{BASE_TYPE};
1245 $self->start_flags($enum);
1246 $self->pidl("NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, $varname));");
1247 $self->end_flags($enum);
1250 #####################################################################
1251 # generate a pull function for an enum
1252 sub ParseEnumPull($$$)
1254 my($self,$enum,$varname) = @_;
1255 my($type_fn) = $enum->{BASE_TYPE};
1256 my($type_v_decl) = mapTypeName($type_fn);
1258 $self->pidl("$type_v_decl v;");
1259 $self->start_flags($enum);
1260 $self->pidl("NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));");
1261 $self->pidl("*$varname = v;");
1263 $self->end_flags($enum);
1266 #####################################################################
1267 # generate a print function for an enum
1268 sub ParseEnumPrint($$$$)
1270 my($self,$enum,$name,$varname) = @_;
1272 $self->pidl("const char *val = NULL;");
1275 $self->start_flags($enum);
1277 $self->pidl("switch ($varname) {");
1279 my $els = \@{$enum->{ELEMENTS}};
1280 foreach my $i (0 .. $#{$els}) {
1281 my $e = ${$els}[$i];
1283 if ($e =~ /^(.*)=/) {
1286 $self->pidl("case $e: val = \"$e\"; break;");
1292 $self->pidl("ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, $varname);");
1294 $self->end_flags($enum);
1299 my ($e,$t,$name,$varname) = @_;
1300 return "enum $name " .
1301 ($t eq "pull"?"*":"") . $varname;
1304 $typefamily{ENUM} = {
1306 PUSH_FN_BODY => \&ParseEnumPush,
1307 PULL_FN_BODY => \&ParseEnumPull,
1308 PRINT_FN_BODY => \&ParseEnumPrint,
1311 #####################################################################
1312 # generate a push function for a bitmap
1313 sub ParseBitmapPush($$$)
1315 my($self,$bitmap,$varname) = @_;
1316 my($type_fn) = $bitmap->{BASE_TYPE};
1318 $self->start_flags($bitmap);
1320 $self->pidl("NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, $varname));");
1322 $self->end_flags($bitmap);
1325 #####################################################################
1326 # generate a pull function for an bitmap
1327 sub ParseBitmapPull($$$)
1329 my($self,$bitmap,$varname) = @_;
1330 my $type_fn = $bitmap->{BASE_TYPE};
1331 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1333 $self->pidl("$type_decl v;");
1334 $self->start_flags($bitmap);
1335 $self->pidl("NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));");
1336 $self->pidl("*$varname = v;");
1338 $self->end_flags($bitmap);
1341 #####################################################################
1342 # generate a print function for an bitmap
1343 sub ParseBitmapPrintElement($$$$$)
1345 my($self,$e,$bitmap,$name,$varname) = @_;
1346 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1347 my($type_fn) = $bitmap->{BASE_TYPE};
1350 if ($e =~ /^(\w+) .*$/) {
1353 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1356 $self->pidl("ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1359 #####################################################################
1360 # generate a print function for an bitmap
1361 sub ParseBitmapPrint($$$$)
1363 my($self,$bitmap,$name,$varname) = @_;
1364 my($type_decl) = mapTypeName($bitmap->{TYPE});
1365 my($type_fn) = $bitmap->{BASE_TYPE};
1367 $self->start_flags($bitmap);
1369 $self->pidl("ndr_print_$type_fn(ndr, name, $varname);");
1371 $self->pidl("ndr->depth++;");
1372 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1373 $self->ParseBitmapPrintElement($e, $bitmap, $name, $varname);
1375 $self->pidl("ndr->depth--;");
1377 $self->end_flags($bitmap);
1380 sub DeclBitmap($$$$)
1382 my ($e,$t,$name,$varname) = @_;
1383 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1384 ($t eq "pull"?" *":" ") . $varname;
1387 $typefamily{BITMAP} = {
1388 DECL => \&DeclBitmap,
1389 PUSH_FN_BODY => \&ParseBitmapPush,
1390 PULL_FN_BODY => \&ParseBitmapPull,
1391 PRINT_FN_BODY => \&ParseBitmapPrint,
1394 #####################################################################
1395 # generate a struct print function
1396 sub ParseStructPrint($$$$)
1398 my($self,$struct,$name,$varname) = @_;
1400 return unless defined $struct->{ELEMENTS};
1402 my $env = GenerateStructEnv($struct, $varname);
1404 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1406 $self->pidl("ndr_print_struct(ndr, name, \"$name\");");
1408 $self->start_flags($struct);
1410 $self->pidl("ndr->depth++;");
1412 $self->ParseElementPrint($_, $env->{$_->{NAME}}, $env)
1413 foreach (@{$struct->{ELEMENTS}});
1414 $self->pidl("ndr->depth--;");
1416 $self->end_flags($struct);
1419 sub DeclarePtrVariables($$)
1422 foreach my $l (@{$e->{LEVELS}}) {
1423 if ($l->{TYPE} eq "POINTER" and
1424 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1425 $self->pidl("uint32_t _ptr_$e->{NAME};");
1431 sub DeclareArrayVariables($$)
1435 foreach my $l (@{$e->{LEVELS}}) {
1436 next if has_fast_array($e,$l);
1437 next if is_charset_array($e,$l);
1438 if ($l->{TYPE} eq "ARRAY") {
1439 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1444 sub need_decl_mem_ctx($$)
1448 return 0 if has_fast_array($e,$l);
1449 return 0 if is_charset_array($e,$l);
1450 return 1 if (($l->{TYPE} eq "ARRAY") and not $l->{IS_FIXED});
1452 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1453 my $nl = GetNextLevel($e, $l);
1454 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1455 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1456 ($nl->{DATA_TYPE} eq "string"));
1457 return 0 if ($next_is_array or $next_is_string);
1459 return 1 if ($l->{TYPE} eq "POINTER");
1464 sub DeclareMemCtxVariables($$)
1467 foreach my $l (@{$e->{LEVELS}}) {
1468 if (need_decl_mem_ctx($e, $l)) {
1469 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1474 sub ParseStructPullPrimitives($$$$)
1476 my($self,$struct,$varname,$env) = @_;
1478 if (defined $struct->{SURROUNDING_ELEMENT}) {
1479 $self->pidl("NDR_CHECK(ndr_pull_array_size(ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1482 $self->pidl("NDR_CHECK(ndr_pull_align(ndr, $struct->{ALIGN}));");
1484 if (defined($struct->{PROPERTIES}{relative_base})) {
1485 # set the current offset as base for relative pointers
1486 # and store it based on the toplevel struct/union
1487 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1490 $self->ParseElementPull($_, "ndr", $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1492 $self->add_deferred();
1495 sub ParseStructPullDeferred($$$$)
1497 my ($self,$struct,$varname,$env) = @_;
1499 if (defined($struct->{PROPERTIES}{relative_base})) {
1500 # retrieve the current offset as base for relative pointers
1501 # based on the toplevel struct/union
1502 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, $varname));");
1504 foreach my $e (@{$struct->{ELEMENTS}}) {
1505 $self->ParseElementPull($e, "ndr", $env, 0, 1);
1508 $self->add_deferred();
1511 #####################################################################
1512 # parse a struct - pull side
1513 sub ParseStructPull($$$)
1515 my($self,$struct,$varname) = @_;
1517 return unless defined $struct->{ELEMENTS};
1519 # declare any internal pointers we need
1520 foreach my $e (@{$struct->{ELEMENTS}}) {
1521 $self->DeclarePtrVariables($e);
1522 $self->DeclareArrayVariables($e);
1523 $self->DeclareMemCtxVariables($e);
1526 $self->start_flags($struct);
1528 my $env = GenerateStructEnv($struct, $varname);
1530 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1532 $self->ParseStructPullPrimitives($struct,$varname,$env);
1535 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1537 $self->ParseStructPullDeferred($struct,$varname,$env);
1541 $self->end_flags($struct);
1544 #####################################################################
1545 # calculate size of ndr struct
1546 sub ParseStructNdrSize($$$$)
1548 my ($self,$t, $name, $varname) = @_;
1551 if (my $flags = has_property($t, "flag")) {
1552 $self->pidl("flags |= $flags;");
1554 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1557 sub DeclStruct($$$$)
1559 my ($e,$t,$name,$varname) = @_;
1560 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1563 sub ArgsStructNdrSize($$$)
1565 my ($d, $name, $varname) = @_;
1566 return "const struct $name *$varname, int flags";
1569 $typefamily{STRUCT} = {
1570 PUSH_FN_BODY => \&ParseStructPush,
1571 DECL => \&DeclStruct,
1572 PULL_FN_BODY => \&ParseStructPull,
1573 PRINT_FN_BODY => \&ParseStructPrint,
1574 SIZE_FN_BODY => \&ParseStructNdrSize,
1575 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1578 #####################################################################
1579 # calculate size of ndr struct
1580 sub ParseUnionNdrSize($$$)
1582 my ($self, $t, $name, $varname) = @_;
1585 if (my $flags = has_property($t, "flag")) {
1586 $self->pidl("flags |= $flags;");
1589 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1592 sub ParseUnionPushPrimitives($$$)
1594 my ($self, $e, $varname) = @_;
1596 my $have_default = 0;
1598 $self->pidl("int level = ndr_push_get_switch_value(ndr, $varname);");
1600 if (defined($e->{SWITCH_TYPE})) {
1601 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}(ndr, NDR_SCALARS, level));");
1604 $self->pidl("switch (level) {");
1606 foreach my $el (@{$e->{ELEMENTS}}) {
1607 if ($el->{CASE} eq "default") {
1610 $self->pidl("$el->{CASE}:");
1612 if ($el->{TYPE} ne "EMPTY") {
1614 if (defined($e->{PROPERTIES}{relative_base})) {
1615 $self->pidl("NDR_CHECK(ndr_push_align(ndr, $el->{ALIGN}));");
1616 # set the current offset as base for relative pointers
1617 # and store it based on the toplevel struct/union
1618 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1620 $self->DeclareArrayVariables($el);
1621 $self->ParseElementPush($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1624 $self->pidl("break;");
1627 if (! $have_default) {
1628 $self->pidl("default:");
1629 $self->pidl("\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1635 sub ParseUnionPushDeferred($$$)
1637 my ($self,$e,$varname) = @_;
1639 my $have_default = 0;
1641 $self->pidl("int level = ndr_push_get_switch_value(ndr, $varname);");
1642 if (defined($e->{PROPERTIES}{relative_base})) {
1643 # retrieve the current offset as base for relative pointers
1644 # based on the toplevel struct/union
1645 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, $varname));");
1647 $self->pidl("switch (level) {");
1649 foreach my $el (@{$e->{ELEMENTS}}) {
1650 if ($el->{CASE} eq "default") {
1654 $self->pidl("$el->{CASE}:");
1655 if ($el->{TYPE} ne "EMPTY") {
1657 $self->ParseElementPush($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1660 $self->pidl("break;");
1663 if (! $have_default) {
1664 $self->pidl("default:");
1665 $self->pidl("\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1671 #####################################################################
1672 # parse a union - push side
1673 sub ParseUnionPush($$$)
1675 my ($self,$e,$varname) = @_;
1676 my $have_default = 0;
1678 $self->start_flags($e);
1680 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1682 $self->ParseUnionPushPrimitives($e, $varname);
1685 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1687 $self->ParseUnionPushDeferred($e, $varname);
1690 $self->end_flags($e);
1693 #####################################################################
1695 sub ParseUnionPrint($$$$)
1697 my ($self,$e,$name,$varname) = @_;
1698 my $have_default = 0;
1700 $self->pidl("int level;");
1701 foreach my $el (@{$e->{ELEMENTS}}) {
1702 $self->DeclareArrayVariables($el);
1705 $self->start_flags($e);
1707 $self->pidl("level = ndr_print_get_switch_value(ndr, $varname);");
1709 $self->pidl("ndr_print_union(ndr, name, level, \"$name\");");
1711 $self->pidl("switch (level) {");
1713 foreach my $el (@{$e->{ELEMENTS}}) {
1714 if ($el->{CASE} eq "default") {
1717 $self->pidl("$el->{CASE}:");
1718 if ($el->{TYPE} ne "EMPTY") {
1720 $self->ParseElementPrint($el, "$varname->$el->{NAME}", {});
1723 $self->pidl("break;");
1726 if (! $have_default) {
1727 $self->pidl("default:");
1728 $self->pidl("\tndr_print_bad_level(ndr, name, level);");
1733 $self->end_flags($e);
1736 sub ParseUnionPullPrimitives($$$$)
1738 my ($self,$e,$varname,$switch_type) = @_;
1739 my $have_default = 0;
1741 if (defined($switch_type)) {
1742 $self->pidl("NDR_CHECK(ndr_pull_$switch_type(ndr, NDR_SCALARS, &_level));");
1743 $self->pidl("if (_level != level) {");
1744 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname\", _level);");
1748 $self->pidl("switch (level) {");
1750 foreach my $el (@{$e->{ELEMENTS}}) {
1751 if ($el->{CASE} eq "default") {
1754 $self->pidl("$el->{CASE}: {");
1756 if ($el->{TYPE} ne "EMPTY") {
1758 $self->DeclarePtrVariables($el);
1759 $self->DeclareArrayVariables($el);
1760 if (defined($e->{PROPERTIES}{relative_base})) {
1761 $self->pidl("NDR_CHECK(ndr_pull_align(ndr, $el->{ALIGN}));");
1762 # set the current offset as base for relative pointers
1763 # and store it based on the toplevel struct/union
1764 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, $varname, ndr->offset));");
1766 $self->ParseElementPull($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1769 $self->pidl("break; }");
1772 if (! $have_default) {
1773 $self->pidl("default:");
1774 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1780 sub ParseUnionPullDeferred($$$)
1782 my ($self,$e,$varname) = @_;
1783 my $have_default = 0;
1785 if (defined($e->{PROPERTIES}{relative_base})) {
1786 # retrieve the current offset as base for relative pointers
1787 # based on the toplevel struct/union
1788 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, $varname));");
1790 $self->pidl("switch (level) {");
1792 foreach my $el (@{$e->{ELEMENTS}}) {
1793 if ($el->{CASE} eq "default") {
1797 $self->pidl("$el->{CASE}:");
1798 if ($el->{TYPE} ne "EMPTY") {
1800 $self->ParseElementPull($el, "ndr", {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1803 $self->pidl("break;");
1806 if (! $have_default) {
1807 $self->pidl("default:");
1808 $self->pidl("\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1816 #####################################################################
1817 # parse a union - pull side
1818 sub ParseUnionPull($$$)
1820 my ($self,$e,$varname) = @_;
1821 my $switch_type = $e->{SWITCH_TYPE};
1823 $self->pidl("int level;");
1824 if (defined($switch_type)) {
1825 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1826 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1828 $self->pidl(mapTypeName($switch_type) . " _level;");
1831 my %double_cases = ();
1832 foreach my $el (@{$e->{ELEMENTS}}) {
1833 next if ($el->{TYPE} eq "EMPTY");
1834 next if ($double_cases{"$el->{NAME}"});
1835 $self->DeclareMemCtxVariables($el);
1836 $double_cases{"$el->{NAME}"} = 1;
1839 $self->start_flags($e);
1841 $self->pidl("level = ndr_pull_get_switch_value(ndr, $varname);");
1843 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1845 $self->ParseUnionPullPrimitives($e,$varname,$switch_type);
1849 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1851 $self->ParseUnionPullDeferred($e,$varname);
1855 $self->add_deferred();
1857 $self->end_flags($e);
1862 my ($e,$t,$name,$varname) = @_;
1863 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1866 sub ArgsUnionNdrSize($$)
1869 return "const union $name *r, uint32_t level, int flags";
1872 $typefamily{UNION} = {
1873 PUSH_FN_BODY => \&ParseUnionPush,
1874 DECL => \&DeclUnion,
1875 PULL_FN_BODY => \&ParseUnionPull,
1876 PRINT_FN_BODY => \&ParseUnionPrint,
1877 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1878 SIZE_FN_BODY => \&ParseUnionNdrSize,
1881 #####################################################################
1882 # parse a typedef - push side
1883 sub ParseTypedefPush($$$)
1885 my($self,$e,$varname) = @_;
1887 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $varname);
1890 #####################################################################
1891 # parse a typedef - pull side
1892 sub ParseTypedefPull($$$)
1894 my($self,$e,$varname) = @_;
1896 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $varname);
1899 #####################################################################
1900 # parse a typedef - print side
1901 sub ParseTypedefPrint($$$$)
1903 my($self,$e,$name,$varname) = @_;
1905 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $name, $varname);
1908 #####################################################################
1909 ## calculate the size of a structure
1910 sub ParseTypedefNdrSize($$$$)
1912 my($self,$t,$name,$varname) = @_;
1914 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
1917 sub DeclTypedef($$$$)
1919 my ($e, $t, $name, $varname) = @_;
1921 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
1924 sub ArgsTypedefNdrSize($$$)
1926 my ($d, $name, $varname) = @_;
1927 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
1930 $typefamily{TYPEDEF} = {
1931 PUSH_FN_BODY => \&ParseTypedefPush,
1932 DECL => \&DeclTypedef,
1933 PULL_FN_BODY => \&ParseTypedefPull,
1934 PRINT_FN_BODY => \&ParseTypedefPrint,
1935 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
1936 SIZE_FN_BODY => \&ParseTypedefNdrSize,
1939 #####################################################################
1940 # parse a function - print side
1941 sub ParseFunctionPrint($$)
1943 my($self, $fn) = @_;
1945 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
1947 return if has_property($fn, "noprint");
1949 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
1953 foreach my $e (@{$fn->{ELEMENTS}}) {
1954 $self->DeclareArrayVariables($e);
1957 $self->pidl("ndr_print_struct(ndr, name, \"$fn->{NAME}\");");
1958 $self->pidl("ndr->depth++;");
1960 $self->pidl("if (flags & NDR_SET_VALUES) {");
1961 $self->pidl("\tndr->flags |= LIBNDR_PRINT_SET_VALUES;");
1964 $self->pidl("if (flags & NDR_IN) {");
1966 $self->pidl("ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");");
1967 $self->pidl("ndr->depth++;");
1969 my $env = GenerateFunctionInEnv($fn);
1971 foreach my $e (@{$fn->{ELEMENTS}}) {
1972 if (grep(/in/,@{$e->{DIRECTION}})) {
1973 $self->ParseElementPrint($e, $env->{$e->{NAME}}, $env);
1976 $self->pidl("ndr->depth--;");
1980 $self->pidl("if (flags & NDR_OUT) {");
1982 $self->pidl("ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");");
1983 $self->pidl("ndr->depth++;");
1985 $env = GenerateFunctionOutEnv($fn);
1986 foreach my $e (@{$fn->{ELEMENTS}}) {
1987 if (grep(/out/,@{$e->{DIRECTION}})) {
1988 $self->ParseElementPrint($e, $env->{$e->{NAME}}, $env);
1991 if ($fn->{RETURN_TYPE}) {
1992 $self->pidl("ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", r->out.result);");
1994 $self->pidl("ndr->depth--;");
1998 $self->pidl("ndr->depth--;");
2004 #####################################################################
2006 sub ParseFunctionPush($$)
2008 my($self, $fn) = @_;
2010 $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;
2012 return if has_property($fn, "nopush");
2017 foreach my $e (@{$fn->{ELEMENTS}}) {
2018 $self->DeclareArrayVariables($e);
2021 $self->pidl("if (flags & NDR_IN) {");
2024 my $env = GenerateFunctionInEnv($fn);
2026 EnvSubstituteValue($env, $fn);
2028 foreach my $e (@{$fn->{ELEMENTS}}) {
2029 if (grep(/in/,@{$e->{DIRECTION}})) {
2030 $self->ParseElementPush($e, "ndr", $env, 1, 1);
2037 $self->pidl("if (flags & NDR_OUT) {");
2040 $env = GenerateFunctionOutEnv($fn);
2041 foreach my $e (@{$fn->{ELEMENTS}}) {
2042 if (grep(/out/,@{$e->{DIRECTION}})) {
2043 $self->ParseElementPush($e, "ndr", $env, 1, 1);
2047 if ($fn->{RETURN_TYPE}) {
2048 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));");
2053 $self->pidl("return NDR_ERR_SUCCESS;");
2059 sub AllocateArrayLevel($$$$$$)
2061 my ($self,$e,$l,$ndr,$env,$size) = @_;
2063 my $var = ParseExpr($e->{NAME}, $env, $e->{ORIGINAL});
2065 my $pl = GetPrevLevel($e, $l);
2066 if (defined($pl) and
2067 $pl->{TYPE} eq "POINTER" and
2068 $pl->{POINTER_TYPE} eq "ref"
2069 and not $l->{IS_ZERO_TERMINATED}) {
2070 $self->pidl("if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2071 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2073 if (grep(/in/,@{$e->{DIRECTION}}) and
2074 grep(/out/,@{$e->{DIRECTION}})) {
2075 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2080 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2083 #####################################################################
2085 sub ParseFunctionPull($$)
2089 # pull function args
2090 $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;
2095 # declare any internal pointers we need
2096 foreach my $e (@{$fn->{ELEMENTS}}) {
2097 $self->DeclarePtrVariables($e);
2098 $self->DeclareArrayVariables($e);
2101 my %double_cases = ();
2102 foreach my $e (@{$fn->{ELEMENTS}}) {
2103 next if ($e->{TYPE} eq "EMPTY");
2104 next if ($double_cases{"$e->{NAME}"});
2105 $self->DeclareMemCtxVariables($e);
2106 $double_cases{"$e->{NAME}"} = 1;
2109 $self->pidl("if (flags & NDR_IN) {");
2112 # auto-init the out section of a structure. I originally argued that
2113 # this was a bad idea as it hides bugs, but coping correctly
2114 # with initialisation and not wiping ref vars is turning
2115 # out to be too tricky (tridge)
2116 foreach my $e (@{$fn->{ELEMENTS}}) {
2117 next unless grep(/out/, @{$e->{DIRECTION}});
2118 $self->pidl("ZERO_STRUCT(r->out);");
2123 my $env = GenerateFunctionInEnv($fn);
2125 foreach my $e (@{$fn->{ELEMENTS}}) {
2126 next unless (grep(/in/, @{$e->{DIRECTION}}));
2127 $self->ParseElementPull($e, "ndr", $env, 1, 1);
2130 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2131 # own flag rather than be in NDR_IN ?
2133 foreach my $e (@{$fn->{ELEMENTS}}) {
2134 next unless (grep(/out/, @{$e->{DIRECTION}}));
2135 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2136 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2137 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2138 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2139 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2140 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2142 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2143 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2144 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2145 "return ndr_pull_error(ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2146 check_fully_dereferenced($e, $env));
2147 $self->pidl("NDR_PULL_ALLOC_N(ndr, r->out.$e->{NAME}, $size);");
2149 if (grep(/in/, @{$e->{DIRECTION}})) {
2150 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));");
2152 $self->pidl("memset(r->out.$e->{NAME}, 0, $size * sizeof(*r->out.$e->{NAME}));");
2155 $self->pidl("NDR_PULL_ALLOC(ndr, r->out.$e->{NAME});");
2157 if (grep(/in/, @{$e->{DIRECTION}})) {
2158 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2160 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2165 $self->add_deferred();
2169 $self->pidl("if (flags & NDR_OUT) {");
2172 $env = GenerateFunctionOutEnv($fn);
2173 foreach my $e (@{$fn->{ELEMENTS}}) {
2174 next unless grep(/out/, @{$e->{DIRECTION}});
2175 $self->ParseElementPull($e, "ndr", $env, 1, 1);
2178 if ($fn->{RETURN_TYPE}) {
2179 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));");
2182 $self->add_deferred();
2186 $self->pidl("return NDR_ERR_SUCCESS;");
2192 #####################################################################
2193 # produce a function call table
2194 sub FunctionTable($$)
2196 my($self,$interface) = @_;
2198 my $uname = uc $interface->{NAME};
2200 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2201 return unless defined ($interface->{PROPERTIES}->{uuid});
2203 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2204 foreach my $d (@{$interface->{FUNCTIONS}}) {
2205 next if not defined($d->{OPNUM});
2207 $self->pidl("\t\t\"$d->{NAME}\",");
2208 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2209 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2210 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2211 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2212 $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2213 $self->pidl("\t},");
2216 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2220 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2221 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2222 $self->pidl("\t$ep, ");
2224 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2229 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2230 $self->pidl("\t.count\t= $endpoint_count,");
2231 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2235 if (! defined $interface->{PROPERTIES}->{authservice}) {
2236 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2239 my @a = split / /, $interface->{PROPERTIES}->{authservice};
2240 my $authservice_count = $#a + 1;
2242 $self->pidl("static const char * const $interface->{NAME}\_authservice_strings[] = {");
2243 foreach my $ap (@a) {
2244 $self->pidl("\t$ap, ");
2249 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_authservices = {");
2250 $self->pidl("\t.count\t= $endpoint_count,");
2251 $self->pidl("\t.names\t= $interface->{NAME}\_authservice_strings");
2255 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2256 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2257 $self->pidl("\t.syntax_id\t= {");
2258 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2259 $self->pidl("\t\tNDR_$uname\_VERSION");
2260 $self->pidl("\t},");
2261 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2262 $self->pidl("\t.num_calls\t= $count,");
2263 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2264 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2265 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2271 #####################################################################
2272 # generate include statements for imported idl files
2277 foreach (@imports) {
2280 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2284 #####################################################################
2285 # generate include statements for included header files
2290 foreach (@includes) {
2291 $self->pidl_hdr("#include $_");
2295 #####################################################################
2296 # generate prototypes and defines for the interface definitions
2297 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2298 # NDR parser and so do not belong here, technically speaking
2299 sub HeaderInterface($$$)
2301 my($self,$interface,$needed) = @_;
2305 if ($needed->{"compression"}) {
2306 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2309 if (has_property($interface, "object")) {
2310 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2313 if (defined $interface->{PROPERTIES}->{helper}) {
2314 $self->HeaderInclude(split / /, $interface->{PROPERTIES}->{helper});
2317 if (defined $interface->{PROPERTIES}->{uuid}) {
2318 my $name = uc $interface->{NAME};
2319 $self->pidl_hdr("#define NDR_$name\_UUID " .
2320 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2322 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2323 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2325 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2327 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2328 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2330 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2333 foreach (@{$interface->{FUNCTIONS}}) {
2334 next if has_property($_, "noopnum");
2335 next if grep(/$_->{NAME}/,@{$interface->{INHERITED_FUNCTIONS}});
2336 my $u_name = uc $_->{NAME};
2338 my $val = sprintf("0x%02x", $count);
2339 if (defined($interface->{BASE})) {
2340 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2343 $self->pidl_hdr("#define NDR_$u_name ($val)");
2345 $self->pidl_hdr("");
2351 if (defined($interface->{BASE})) {
2352 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2355 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2359 sub ParseTypePush($$$$$)
2361 my ($self,$e,$varname, $primitives, $deferred) = @_;
2363 # save the old relative_base_offset
2364 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);") if defined(has_property($e, "relative_base"));
2365 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $varname);
2366 # restore the old relative_base_offset
2367 $self->pidl("ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2370 sub ParseTypePushFunction($$$)
2372 my ($self, $e, $varname) = @_;
2374 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2375 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *ndr, int ndr_flags, $args)") or return;
2379 $self->ParseTypePush($e, $varname, 1, 1);
2380 $self->pidl("return NDR_ERR_SUCCESS;");
2386 sub ParseTypePull($$$$$)
2388 my ($self, $e, $varname, $primitives, $deferred) = @_;
2390 # save the old relative_base_offset
2391 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);") if defined(has_property($e, "relative_base"));
2392 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $varname);
2393 # restore the old relative_base_offset
2394 $self->pidl("ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2397 sub ParseTypePullFunction($$)
2399 my ($self, $e, $varname) = @_;
2401 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2403 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *ndr, int ndr_flags, $args)") or return;
2407 $self->ParseTypePull($e, $varname, 1, 1);
2408 $self->pidl("return NDR_ERR_SUCCESS;");
2414 sub ParseTypePrint($$$)
2416 my ($self, $e, $varname) = @_;
2418 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $e->{NAME}, $varname);
2421 sub ParseTypePrintFunction($$$)
2423 my ($self, $e, $varname) = @_;
2424 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2426 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2428 return if (has_property($e, "noprint"));
2430 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args)");
2433 $self->ParseTypePrint($e, $varname);
2439 sub ParseTypeNdrSize($$)
2444 my $tf = $typefamily{$t->{TYPE}};
2445 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2447 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2451 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2457 #####################################################################
2458 # parse the interface definitions
2459 sub ParseInterface($$$)
2461 my($self,$interface,$needed) = @_;
2463 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2464 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2466 $self->pidl_hdr("");
2468 $self->HeaderInterface($interface, $needed);
2471 foreach my $d (@{$interface->{TYPES}}) {
2472 next unless(typeHasBody($d));
2474 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2475 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2476 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2478 # Make sure we don't generate a function twice...
2479 $needed->{TypeFunctionName("ndr_push", $d)} =
2480 $needed->{TypeFunctionName("ndr_pull", $d)} =
2481 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2483 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2487 foreach my $d (@{$interface->{FUNCTIONS}}) {
2488 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2489 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2490 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2492 # Make sure we don't generate a function twice...
2493 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2494 $needed->{"ndr_print_$d->{NAME}"} = 0;
2497 $self->FunctionTable($interface);
2499 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2502 sub GenerateIncludes($)
2506 $self->pidl("#include \"includes.h\"");
2508 $self->pidl("#define _GNU_SOURCE");
2509 $self->pidl("#include <stdint.h>");
2510 $self->pidl("#include <stdlib.h>");
2511 $self->pidl("#include <stdio.h>");
2512 $self->pidl("#include <stdbool.h>");
2513 $self->pidl("#include <stdarg.h>");
2514 $self->pidl("#include <string.h>");
2518 #####################################################################
2519 # parse a parsed IDL structure back into an IDL file
2522 my($self, $ndr,$gen_header,$ndr_header) = @_;
2524 $self->pidl_hdr("/* header auto-generated by pidl */");
2525 $self->pidl_hdr("");
2526 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2527 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2528 $self->pidl_hdr("");
2530 $self->pidl("/* parser auto-generated by pidl */");
2532 $self->GenerateIncludes();
2533 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2539 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2543 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2544 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2545 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2548 return ($self->{res_hdr}, $self->{res});
2551 sub NeededElement($$$)
2553 my ($e, $dir, $needed) = @_;
2555 return if ($e->{TYPE} eq "EMPTY");
2557 return if (ref($e->{TYPE}) eq "HASH" and
2558 not defined($e->{TYPE}->{NAME}));
2561 if (ref($e->{TYPE}) eq "HASH") {
2562 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2567 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2568 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2570 $rt = $e->{REPRESENTATION_TYPE};
2573 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2576 if ($dir eq "print") {
2577 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2578 } elsif ($dir eq "pull") {
2579 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2580 push (@fn, "ndr_$t\_to_$rt")
2582 } elsif ($dir eq "push") {
2583 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2584 push (@fn, "ndr_$rt\_to_$t")
2587 die("invalid direction `$dir'");
2591 unless (defined($needed->{$_})) {
2597 sub NeededFunction($$)
2599 my ($fn,$needed) = @_;
2600 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2601 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2602 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2603 foreach my $e (@{$fn->{ELEMENTS}}) {
2605 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2611 sub NeededType($$$);
2612 my ($t,$needed,$req) = @_;
2614 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2616 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2617 return unless defined($t->{ELEMENTS});
2618 for my $e (@{$t->{ELEMENTS}}) {
2620 if (has_property($e, "compression")) {
2621 $needed->{"compression"} = 1;
2623 NeededElement($e, $req, $needed);
2624 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2629 #####################################################################
2630 # work out what parse functions are needed
2631 sub NeededInterface($$)
2633 my ($interface,$needed) = @_;
2634 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2635 foreach (reverse @{$interface->{TYPES}}) {
2636 if (has_property($_, "public")) {
2637 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2638 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2641 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2642 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2643 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2644 if (has_property($_, "gensize")) {
2645 $needed->{"ndr_size_$_->{NAME}"} = 1;
2650 sub TypeFunctionName($$)
2652 my ($prefix, $t) = @_;
2654 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2655 $t->{TYPE} eq "TYPEDEF");
2656 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2657 return "$prefix\_$t";