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 = qw(is_charset_array);
13 @EXPORT_OK = qw(check_null_pointer);
16 use Parse::Pidl::Typelist qw(hasType getType mapType);
17 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header);
20 use Parse::Pidl qw(warning);
22 use vars qw($VERSION);
31 return $typefamily{$n};
36 my ($e, $var_name) = @_;
39 foreach my $l (@{$e->{LEVELS}}) {
40 if ($l->{TYPE} eq "POINTER") {
42 } elsif ($l->{TYPE} eq "ARRAY") {
43 if (($pointers == 0) and
44 (not $l->{IS_FIXED}) and
45 (not $l->{IS_INLINE})) {
46 return get_value_of($var_name);
48 } elsif ($l->{TYPE} eq "DATA") {
49 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
50 return get_value_of($var_name) unless ($pointers);
58 sub has_fast_array($$)
62 return 0 if ($l->{TYPE} ne "ARRAY");
64 my $nl = GetNextLevel($e,$l);
65 return 0 unless ($nl->{TYPE} eq "DATA");
66 return 0 unless (hasType($nl->{DATA_TYPE}));
68 my $t = getType($nl->{DATA_TYPE});
70 # Only uint8 and string have fast array functions at the moment
71 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
74 sub is_charset_array($$)
78 return 0 if ($l->{TYPE} ne "ARRAY");
80 my $nl = GetNextLevel($e,$l);
82 return 0 unless ($nl->{TYPE} eq "DATA");
84 return has_property($e, "charset");
91 if ($var_name =~ /^\*(.*)$/) {
93 } elsif ($var_name =~ /^\&(.*)$/) {
94 return "&($var_name)";
102 my $var_name = shift;
104 if ($var_name =~ /^\&(.*)$/) {
115 ####################################
116 # pidl() is our basic output routine
129 sub pidl_hdr ($) { my $d = shift; $res_hdr .= "$d\n"; }
131 ####################################
132 # defer() is like pidl(), but adds to
133 # a deferred buffer which is then added to the
134 # output buffer at the end of the structure/union/function
135 # This is needed to cope with code that must be pushed back
136 # to the end of a block of elements
138 sub defer_indent() { $defer_tabs.="\t"; }
139 sub defer_deindent() { $defer_tabs=substr($defer_tabs, 0, -1); }
145 push(@$deferred, $defer_tabs.$d);
149 ########################################
150 # add the deferred content to the current
154 pidl $_ foreach (@$deferred);
166 $tabs = substr($tabs, 0, -1);
169 #####################################################################
170 # declare a function public or static, depending on its attributes
173 my ($type,$fn,$decl) = @_;
175 if (has_property($fn, "no$type")) {
180 if (has_property($fn, "public")) {
182 pidl "_PUBLIC_ $decl";
190 ###################################################################
191 # setup any special flags for an element or structure
195 my $flags = has_property($e, "flag");
196 if (defined $flags) {
199 pidl "uint32_t _flags_save_$e->{TYPE} = ndr->flags;";
200 pidl "ndr_set_flags(&ndr->flags, $flags);";
204 ###################################################################
205 # end any special flags for an element or structure
209 my $flags = has_property($e, "flag");
210 if (defined $flags) {
211 pidl "ndr->flags = _flags_save_$e->{TYPE};";
217 sub GenerateStructEnv($)
222 foreach my $e (@{$x->{ELEMENTS}}) {
223 $env{$e->{NAME}} = "r->$e->{NAME}";
231 sub EnvSubstituteValue($$)
235 # Substitute the value() values in the env
236 foreach my $e (@{$s->{ELEMENTS}}) {
237 next unless (my $v = has_property($e, "value"));
239 $env->{$e->{NAME}} = ParseExpr($v, $env, $e);
245 sub GenerateFunctionInEnv($)
250 foreach my $e (@{$fn->{ELEMENTS}}) {
251 if (grep (/in/, @{$e->{DIRECTION}})) {
252 $env{$e->{NAME}} = "r->in.$e->{NAME}";
259 sub GenerateFunctionOutEnv($)
264 foreach my $e (@{$fn->{ELEMENTS}}) {
265 if (grep (/out/, @{$e->{DIRECTION}})) {
266 $env{$e->{NAME}} = "r->out.$e->{NAME}";
267 } elsif (grep (/in/, @{$e->{DIRECTION}})) {
268 $env{$e->{NAME}} = "r->in.$e->{NAME}";
275 #####################################################################
276 # parse the data of an array - push side
277 sub ParseArrayPushHeader($$$$$)
279 my ($e,$l,$ndr,$var_name,$env) = @_;
284 if ($l->{IS_ZERO_TERMINATED}) {
285 if (has_property($e, "charset")) {
286 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
288 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
291 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
292 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
295 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
296 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));";
299 if ($l->{IS_VARYING}) {
300 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"; # array offset
301 pidl "NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));";
307 sub check_null_pointer($$$)
309 my ($element, $env, $print_fn) = @_;
312 my $expandedvar = shift;
315 # Figure out the number of pointers in $ptr
316 $expandedvar =~ s/^(\**)//;
320 foreach (keys %$env) {
321 if ($env->{$_} eq $expandedvar) {
330 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
331 if ($_->{NAME} eq $var) {
337 $e or die("Environment doesn't match siblings");
339 # See if pointer at pointer level $level
340 # needs to be checked.
341 foreach my $l (@{$e->{LEVELS}}) {
342 if ($l->{TYPE} eq "POINTER" and
343 $l->{POINTER_INDEX} == length($ptr)) {
344 # No need to check ref pointers
345 $check = ($l->{POINTER_TYPE} ne "ref");
349 if ($l->{TYPE} eq "DATA") {
350 warning($element, "too much dereferences for `$var'");
354 warning($element, "unknown dereferenced expression `$expandedvar'");
358 $print_fn->("if ($ptr$expandedvar == NULL) return NT_STATUS_INVALID_PARAMETER_MIX;") if $check;
362 #####################################################################
363 # parse an array - pull side
364 sub ParseArrayPullHeader($$$$$)
366 my ($e,$l,$ndr,$var_name,$env) = @_;
371 if ($l->{IS_CONFORMANT}) {
372 $length = $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
373 } elsif ($l->{IS_ZERO_TERMINATED}) { # Noheader arrays
374 $length = $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
376 $length = $size = ParseExprExt($l->{SIZE_IS}, $env, $e,
377 check_null_pointer($e, $env, \&pidl));
380 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
381 pidl "NDR_CHECK(ndr_pull_array_size(ndr, " . get_pointer_to($var_name) . "));";
384 if ($l->{IS_VARYING}) {
385 pidl "NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));";
386 $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
389 if ($length ne $size) {
390 pidl "if ($length > $size) {";
392 pidl "return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $size, $length);";
397 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
398 defer "if ($var_name) {";
400 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e, check_null_pointer($e, $env, \&defer));
401 defer "NDR_CHECK(ndr_check_array_size(ndr, (void*)" . get_pointer_to($var_name) . ", $size));";
406 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
407 defer "if ($var_name) {";
409 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e, check_null_pointer($e, $env, \&defer));
410 defer "NDR_CHECK(ndr_check_array_length(ndr, (void*)" . get_pointer_to($var_name) . ", $length));";
415 if (not $l->{IS_FIXED} and not is_charset_array($e, $l)) {
416 AllocateArrayLevel($e,$l,$ndr,$env,$size);
422 sub compression_alg($$)
425 my $compression = $l->{COMPRESSION};
426 my ($alg, $clen, $dlen) = split(/ /, $compression);
431 sub compression_clen($$$)
433 my ($e,$l,$env) = @_;
434 my $compression = $l->{COMPRESSION};
435 my ($alg, $clen, $dlen) = split(/ /, $compression);
437 return ParseExpr($clen, $env, $e);
440 sub compression_dlen($$$)
442 my ($e,$l,$env) = @_;
443 my $compression = $l->{COMPRESSION};
444 my ($alg, $clen, $dlen) = split(/ /, $compression);
446 return ParseExpr($dlen, $env, $e);
449 sub ParseCompressionPushStart($$$$)
451 my ($e,$l,$ndr,$env) = @_;
452 my $comndr = "$ndr\_compressed";
453 my $alg = compression_alg($e, $l);
454 my $dlen = compression_dlen($e, $l, $env);
458 pidl "struct ndr_push *$comndr;";
459 pidl "NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));";
464 sub ParseCompressionPushEnd($$$$)
466 my ($e,$l,$ndr,$env) = @_;
467 my $comndr = "$ndr\_compressed";
468 my $alg = compression_alg($e, $l);
469 my $dlen = compression_dlen($e, $l, $env);
471 pidl "NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));";
476 sub ParseCompressionPullStart($$$$)
478 my ($e,$l,$ndr,$env) = @_;
479 my $comndr = "$ndr\_compressed";
480 my $alg = compression_alg($e, $l);
481 my $dlen = compression_dlen($e, $l, $env);
485 pidl "struct ndr_pull *$comndr;";
486 pidl "NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));";
491 sub ParseCompressionPullEnd($$$$)
493 my ($e,$l,$ndr,$env) = @_;
494 my $comndr = "$ndr\_compressed";
495 my $alg = compression_alg($e, $l);
496 my $dlen = compression_dlen($e, $l, $env);
498 pidl "NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));";
503 sub ParseSubcontextPushStart($$$$)
505 my ($e,$l,$ndr,$env) = @_;
506 my $subndr = "_ndr_$e->{NAME}";
507 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE},$env, $e);
511 pidl "struct ndr_push *$subndr;";
512 pidl "NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));";
514 if (defined $l->{COMPRESSION}) {
515 $subndr = ParseCompressionPushStart($e, $l, $subndr, $env);
521 sub ParseSubcontextPushEnd($$$$)
523 my ($e,$l,$ndr,$env) = @_;
524 my $subndr = "_ndr_$e->{NAME}";
525 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE},$env, $e);
527 if (defined $l->{COMPRESSION}) {
528 ParseCompressionPushEnd($e, $l, $subndr, $env);
531 pidl "NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));";
536 sub ParseSubcontextPullStart($$$$)
538 my ($e,$l,$ndr,$env) = @_;
539 my $subndr = "_ndr_$e->{NAME}";
540 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE},$env, $e);
544 pidl "struct ndr_pull *$subndr;";
545 pidl "NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));";
547 if (defined $l->{COMPRESSION}) {
548 $subndr = ParseCompressionPullStart($e, $l, $subndr, $env);
554 sub ParseSubcontextPullEnd($$$$)
556 my ($e,$l,$ndr,$env) = @_;
557 my $subndr = "_ndr_$e->{NAME}";
558 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE},$env, $e);
560 if (defined $l->{COMPRESSION}) {
561 ParseCompressionPullEnd($e, $l, $subndr, $env);
564 pidl "NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));";
569 sub ParseElementPushLevel
571 my ($e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
573 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
575 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
576 $var_name = get_pointer_to($var_name);
579 if (defined($ndr_flags)) {
580 if ($l->{TYPE} eq "SUBCONTEXT") {
581 my $subndr = ParseSubcontextPushStart($e, $l, $ndr, $env);
582 ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
583 ParseSubcontextPushEnd($e, $l, $ndr, $env);
584 } elsif ($l->{TYPE} eq "POINTER") {
585 ParsePtrPush($e, $l, $var_name);
586 } elsif ($l->{TYPE} eq "ARRAY") {
587 my $length = ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
589 my $nl = GetNextLevel($e, $l);
591 # Allow speedups for arrays of scalar types
592 if (is_charset_array($e,$l)) {
593 pidl "NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapType($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));";
595 } elsif (has_fast_array($e,$l)) {
596 pidl "NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));";
599 } elsif ($l->{TYPE} eq "SWITCH") {
600 ParseSwitchPush($e, $l, $ndr, $var_name, $ndr_flags, $env);
601 } elsif ($l->{TYPE} eq "DATA") {
602 ParseDataPush($e, $l, $ndr, $var_name, $ndr_flags);
606 if ($l->{TYPE} eq "POINTER" and $deferred) {
607 if ($l->{POINTER_TYPE} ne "ref") {
608 pidl "if ($var_name) {";
610 if ($l->{POINTER_TYPE} eq "relative") {
611 pidl "NDR_CHECK(ndr_push_relative_ptr2(ndr, $var_name));";
614 $var_name = get_value_of($var_name);
615 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
617 if ($l->{POINTER_TYPE} ne "ref") {
621 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
622 not is_charset_array($e, $l)) {
623 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
624 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
626 $var_name = $var_name . "[$counter]";
628 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
629 pidl "for ($counter = 0; $counter < $length; $counter++) {";
631 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
636 if ($deferred and ContainsDeferred($e, $l)) {
637 pidl "for ($counter = 0; $counter < $length; $counter++) {";
639 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
643 } elsif ($l->{TYPE} eq "SWITCH") {
644 ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
648 #####################################################################
649 # parse scalars in a structure element
650 sub ParseElementPush($$$$$$)
652 my ($e,$ndr,$var_prefix,$env,$primitives,$deferred) = @_;
655 my $var_name = $var_prefix.$e->{NAME};
657 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
659 # Representation type is different from transmit_as
660 if ($e->{REPRESENTATION_TYPE}) {
663 my $transmit_name = "_transmit_$e->{NAME}";
664 pidl mapType($e->{TYPE}) ." $transmit_name;";
665 pidl "NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));";
666 $var_name = $transmit_name;
669 $var_name = append_prefix($e, $var_name);
673 if (my $value = has_property($e, "value")) {
674 $var_name = ParseExpr($value, $env, $e);
677 ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
681 if ($e->{REPRESENTATION_TYPE}) {
687 #####################################################################
688 # parse a pointer in a struct element or function
689 sub ParsePtrPush($$$)
691 my ($e,$l,$var_name) = @_;
693 if ($l->{POINTER_TYPE} eq "ref") {
694 pidl "if ($var_name == NULL) return NT_STATUS_INVALID_PARAMETER_MIX;";
695 if ($l->{LEVEL} eq "EMBEDDED") {
696 pidl "NDR_CHECK(ndr_push_ref_ptr(ndr));";
698 } elsif ($l->{POINTER_TYPE} eq "relative") {
699 pidl "NDR_CHECK(ndr_push_relative_ptr1(ndr, $var_name));";
700 } elsif ($l->{POINTER_TYPE} eq "unique") {
701 pidl "NDR_CHECK(ndr_push_unique_ptr(ndr, $var_name));";
702 } elsif ($l->{POINTER_TYPE} eq "full") {
703 pidl "NDR_CHECK(ndr_push_full_ptr(ndr, $var_name));";
705 die("Unhandled pointer type $l->{POINTER_TYPE}");
709 #####################################################################
710 # print scalars in a structure element
711 sub ParseElementPrint($$$)
713 my($e,$var_name,$env) = @_;
715 return if (has_property($e, "noprint"));
717 if ($e->{REPRESENTATION_TYPE}) {
718 pidl "ndr_print_$e->{REPRESENTATION_TYPE}(ndr, \"$e->{NAME}\", $var_name);";
722 $var_name = append_prefix($e, $var_name);
724 if (my $value = has_property($e, "value")) {
725 $var_name = "(ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e) . ":$var_name";
728 foreach my $l (@{$e->{LEVELS}}) {
729 if ($l->{TYPE} eq "POINTER") {
730 pidl "ndr_print_ptr(ndr, \"$e->{NAME}\", $var_name);";
731 pidl "ndr->depth++;";
732 if ($l->{POINTER_TYPE} ne "ref") {
733 pidl "if ($var_name) {";
736 $var_name = get_value_of($var_name);
737 } elsif ($l->{TYPE} eq "ARRAY") {
740 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
741 $var_name = get_pointer_to($var_name);
744 if ($l->{IS_ZERO_TERMINATED}) {
745 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
747 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
750 if (is_charset_array($e,$l)) {
751 pidl "ndr_print_string(ndr, \"$e->{NAME}\", $var_name);";
753 } elsif (has_fast_array($e, $l)) {
754 my $nl = GetNextLevel($e, $l);
755 pidl "ndr_print_array_$nl->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name, $length);";
758 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
760 pidl "ndr->print(ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", $length);";
761 pidl 'ndr->depth++;';
762 pidl "for ($counter=0;$counter<$length;$counter++) {";
764 pidl "char *idx_$l->{LEVEL_INDEX}=NULL;";
765 pidl "asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter);";
766 pidl "if (idx_$l->{LEVEL_INDEX}) {";
769 $var_name = $var_name . "[$counter]";
771 } elsif ($l->{TYPE} eq "DATA") {
772 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE}) or Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
773 $var_name = get_pointer_to($var_name);
775 pidl "ndr_print_$l->{DATA_TYPE}(ndr, \"$e->{NAME}\", $var_name);";
776 } elsif ($l->{TYPE} eq "SWITCH") {
777 my $switch_var = ParseExpr($l->{SWITCH_IS}, $env, $e);
778 pidl "ndr_print_set_switch_value(ndr, " . get_pointer_to($var_name) . ", $switch_var);";
782 foreach my $l (reverse @{$e->{LEVELS}}) {
783 if ($l->{TYPE} eq "POINTER") {
784 if ($l->{POINTER_TYPE} ne "ref") {
788 pidl "ndr->depth--;";
789 } elsif (($l->{TYPE} eq "ARRAY")
790 and not is_charset_array($e,$l)
791 and not has_fast_array($e,$l)) {
792 pidl "free(idx_$l->{LEVEL_INDEX});";
797 pidl "ndr->depth--;";
802 #####################################################################
803 # parse scalars in a structure element - pull size
804 sub ParseSwitchPull($$$$$$)
806 my($e,$l,$ndr,$var_name,$ndr_flags,$env) = @_;
807 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e, check_null_pointer($e, $env, \&pidl));
809 $var_name = get_pointer_to($var_name);
810 pidl "NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));";
813 #####################################################################
814 # push switch element
815 sub ParseSwitchPush($$$$$$)
817 my($e,$l,$ndr,$var_name,$ndr_flags,$env) = @_;
818 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e, check_null_pointer($e, $env, \&pidl));
820 $var_name = get_pointer_to($var_name);
821 pidl "NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));";
824 sub ParseDataPull($$$$$)
826 my ($e,$l,$ndr,$var_name,$ndr_flags) = @_;
828 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
829 $var_name = get_pointer_to($var_name);
832 $var_name = get_pointer_to($var_name);
834 pidl "NDR_CHECK(ndr_pull_$l->{DATA_TYPE}($ndr, $ndr_flags, $var_name));";
836 if (my $range = has_property($e, "range")) {
837 $var_name = get_value_of($var_name);
838 my ($low, $high) = split(/ /, $range, 2);
839 pidl "if ($var_name < $low || $var_name > $high) {";
840 pidl "\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");";
845 sub ParseDataPush($$$$$)
847 my ($e,$l,$ndr,$var_name,$ndr_flags) = @_;
849 # strings are passed by value rather than reference
850 if (not Parse::Pidl::Typelist::is_scalar($l->{DATA_TYPE}) or Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
851 $var_name = get_pointer_to($var_name);
854 pidl "NDR_CHECK(ndr_push_$l->{DATA_TYPE}($ndr, $ndr_flags, $var_name));";
857 sub CalcNdrFlags($$$)
859 my ($l,$primitives,$deferred) = @_;
864 # Add NDR_SCALARS if this one is deferred
865 # and deferreds may be pushed
866 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
868 # Add NDR_SCALARS if this one is not deferred and
869 # primitives may be pushed
870 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
872 # Add NDR_BUFFERS if this one contains deferred stuff
873 # and deferreds may be pushed
874 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
876 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
877 return "NDR_SCALARS" if ($scalars);
878 return "NDR_BUFFERS" if ($buffers);
882 sub ParseMemCtxPullStart($$$)
886 my $ptr_name = shift;
888 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
889 my $mem_c_ctx = $ptr_name;
890 my $mem_c_flags = "0";
892 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
894 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
895 my $nl = GetNextLevel($e, $l);
896 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
897 my $next_is_string = (($nl->{TYPE} eq "DATA") and
898 ($nl->{DATA_TYPE} eq "string"));
899 if ($next_is_array or $next_is_string) {
902 $mem_c_flags = "LIBNDR_FLAG_REF_ALLOC";
906 pidl "$mem_r_ctx = NDR_PULL_GET_MEM_CTX(ndr);";
907 pidl "NDR_PULL_SET_MEM_CTX(ndr, $mem_c_ctx, $mem_c_flags);";
910 sub ParseMemCtxPullEnd($$)
915 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
916 my $mem_r_flags = "0";
918 return if ($l->{TYPE} eq "ARRAY" and $l->{IS_FIXED});
920 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
921 my $nl = GetNextLevel($e, $l);
922 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
923 my $next_is_string = (($nl->{TYPE} eq "DATA") and
924 ($nl->{DATA_TYPE} eq "string"));
925 if ($next_is_array or $next_is_string) {
928 $mem_r_flags = "LIBNDR_FLAG_REF_ALLOC";
932 pidl "NDR_PULL_SET_MEM_CTX(ndr, $mem_r_ctx, $mem_r_flags);";
935 sub CheckStringTerminator($$$$)
937 my ($ndr,$e,$l,$length) = @_;
938 my $nl = GetNextLevel($e, $l);
940 # Make sure last element is zero!
941 pidl "NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));";
944 sub ParseElementPullLevel
946 my($e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
948 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
950 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
951 $var_name = get_pointer_to($var_name);
954 # Only pull something if there's actually something to be pulled
955 if (defined($ndr_flags)) {
956 if ($l->{TYPE} eq "SUBCONTEXT") {
957 my $subndr = ParseSubcontextPullStart($e, $l, $ndr, $env);
958 ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
959 ParseSubcontextPullEnd($e, $l, $ndr, $env);
960 } elsif ($l->{TYPE} eq "ARRAY") {
961 my $length = ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
963 my $nl = GetNextLevel($e, $l);
965 if (is_charset_array($e,$l)) {
966 if ($l->{IS_ZERO_TERMINATED}) {
967 CheckStringTerminator($ndr, $e, $l, $length);
969 pidl "NDR_CHECK(ndr_pull_charset($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapType($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));";
971 } elsif (has_fast_array($e, $l)) {
972 if ($l->{IS_ZERO_TERMINATED}) {
973 CheckStringTerminator($ndr,$e,$l,$length);
975 pidl "NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));";
978 } elsif ($l->{TYPE} eq "POINTER") {
979 ParsePtrPull($e, $l, $ndr, $var_name);
980 } elsif ($l->{TYPE} eq "SWITCH") {
981 ParseSwitchPull($e, $l, $ndr, $var_name, $ndr_flags, $env);
982 } elsif ($l->{TYPE} eq "DATA") {
983 ParseDataPull($e, $l, $ndr, $var_name, $ndr_flags);
987 # add additional constructions
988 if ($l->{TYPE} eq "POINTER" and $deferred) {
989 if ($l->{POINTER_TYPE} ne "ref") {
990 pidl "if ($var_name) {";
993 if ($l->{POINTER_TYPE} eq "relative") {
994 pidl "struct ndr_pull_save _relative_save;";
995 pidl "ndr_pull_save(ndr, &_relative_save);";
996 pidl "NDR_CHECK(ndr_pull_relative_ptr2(ndr, $var_name));";
1000 ParseMemCtxPullStart($e,$l, $var_name);
1002 $var_name = get_value_of($var_name);
1003 ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1005 ParseMemCtxPullEnd($e,$l);
1007 if ($l->{POINTER_TYPE} ne "ref") {
1008 if ($l->{POINTER_TYPE} eq "relative") {
1009 pidl "ndr_pull_restore(ndr, &_relative_save);";
1014 } elsif ($l->{TYPE} eq "ARRAY" and
1015 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1016 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
1017 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1018 my $array_name = $var_name;
1020 $var_name = $var_name . "[$counter]";
1022 ParseMemCtxPullStart($e,$l, $array_name);
1024 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1025 my $nl = GetNextLevel($e,$l);
1027 if ($l->{IS_ZERO_TERMINATED}) {
1028 CheckStringTerminator($ndr,$e,$l,$length);
1031 pidl "for ($counter = 0; $counter < $length; $counter++) {";
1033 ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1038 if ($deferred and ContainsDeferred($e, $l)) {
1039 pidl "for ($counter = 0; $counter < $length; $counter++) {";
1041 ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1046 ParseMemCtxPullEnd($e,$l);
1048 } elsif ($l->{TYPE} eq "SWITCH") {
1049 ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1053 #####################################################################
1054 # parse scalars in a structure element - pull size
1055 sub ParseElementPull($$$$$$)
1057 my($e,$ndr,$var_prefix,$env,$primitives,$deferred) = @_;
1059 my $var_name = $var_prefix.$e->{NAME};
1063 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1065 if ($e->{REPRESENTATION_TYPE}) {
1068 $represent_name = $var_name;
1069 $transmit_name = "_transmit_$e->{NAME}";
1070 $var_name = $transmit_name;
1071 pidl mapType($e->{TYPE})." $var_name;";
1074 $var_name = append_prefix($e, $var_name);
1078 ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1082 # Representation type is different from transmit_as
1083 if ($e->{REPRESENTATION_TYPE}) {
1084 pidl "NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));";
1090 #####################################################################
1091 # parse a pointer in a struct element or function
1092 sub ParsePtrPull($$$$)
1094 my($e,$l,$ndr,$var_name) = @_;
1096 my $nl = GetNextLevel($e, $l);
1097 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1098 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1099 ($nl->{DATA_TYPE} eq "string"));
1101 if ($l->{POINTER_TYPE} eq "ref") {
1102 if ($l->{LEVEL} eq "EMBEDDED") {
1103 pidl "NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));";
1106 if (!$next_is_array and !$next_is_string) {
1107 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
1108 pidl "\tNDR_PULL_ALLOC($ndr, $var_name);";
1113 } elsif (($l->{POINTER_TYPE} eq "unique") or
1114 ($l->{POINTER_TYPE} eq "relative") or
1115 ($l->{POINTER_TYPE} eq "full")) {
1116 pidl "NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));";
1117 pidl "if (_ptr_$e->{NAME}) {";
1120 die("Unhandled pointer type $l->{POINTER_TYPE}");
1123 # Don't do this for arrays, they're allocated at the actual level
1125 unless ($next_is_array or $next_is_string) {
1126 pidl "NDR_PULL_ALLOC($ndr, $var_name);";
1128 # FIXME: Yes, this is nasty.
1129 # We allocate an array twice
1130 # - once just to indicate that it's there,
1131 # - then the real allocation...
1132 pidl "NDR_PULL_ALLOC($ndr, $var_name);";
1135 #pidl "memset($var_name, 0, sizeof($var_name));";
1136 if ($l->{POINTER_TYPE} eq "relative") {
1137 pidl "NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));";
1141 pidl "\t$var_name = NULL;";
1145 #####################################################################
1147 sub ParseStructPush($$)
1149 my($struct,$name) = @_;
1151 return unless defined($struct->{ELEMENTS});
1153 my $env = GenerateStructEnv($struct);
1155 EnvSubstituteValue($env, $struct);
1157 # save the old relative_base_offset
1158 pidl "uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);" if defined($struct->{PROPERTIES}{relative_base});
1160 foreach my $e (@{$struct->{ELEMENTS}}) {
1161 DeclareArrayVariables($e);
1164 start_flags($struct);
1166 # see if the structure contains a conformant array. If it
1167 # does, then it must be the last element of the structure, and
1168 # we need to push the conformant length early, as it fits on
1169 # the wire before the structure (and even before the structure
1171 if (defined($struct->{SURROUNDING_ELEMENT})) {
1172 my $e = $struct->{SURROUNDING_ELEMENT};
1174 if (defined($e->{LEVELS}[0]) and
1175 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1178 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1179 if (has_property($e, "charset")) {
1180 $size = "ndr_charset_length(r->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1182 $size = "ndr_string_length(r->$e->{NAME}, sizeof(*r->$e->{NAME}))";
1185 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e);
1188 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, $size));";
1190 pidl "NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr_string_array_size(ndr, r->$e->{NAME})));";
1194 pidl "if (ndr_flags & NDR_SCALARS) {";
1197 pidl "NDR_CHECK(ndr_push_align(ndr, $struct->{ALIGN}));";
1199 if (defined($struct->{PROPERTIES}{relative_base})) {
1200 # set the current offset as base for relative pointers
1201 # and store it based on the toplevel struct/union
1202 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, r, ndr->offset));";
1205 foreach my $e (@{$struct->{ELEMENTS}}) {
1206 ParseElementPush($e, "ndr", "r->", $env, 1, 0);
1212 pidl "if (ndr_flags & NDR_BUFFERS) {";
1214 if (defined($struct->{PROPERTIES}{relative_base})) {
1215 # retrieve the current offset as base for relative pointers
1216 # based on the toplevel struct/union
1217 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, r));";
1219 foreach my $e (@{$struct->{ELEMENTS}}) {
1220 ParseElementPush($e, "ndr", "r->", $env, 0, 1);
1227 # restore the old relative_base_offset
1228 pidl "ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($struct->{PROPERTIES}{relative_base});
1231 #####################################################################
1232 # generate a push function for an enum
1233 sub ParseEnumPush($$)
1235 my($enum,$name) = @_;
1236 my($type_fn) = $enum->{BASE_TYPE};
1239 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1243 #####################################################################
1244 # generate a pull function for an enum
1245 sub ParseEnumPull($$)
1247 my($enum,$name) = @_;
1248 my($type_fn) = $enum->{BASE_TYPE};
1249 my($type_v_decl) = mapType($type_fn);
1251 pidl "$type_v_decl v;";
1253 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1259 #####################################################################
1260 # generate a print function for an enum
1261 sub ParseEnumPrint($$)
1263 my($enum,$name) = @_;
1265 pidl "const char *val = NULL;";
1270 pidl "switch (r) {";
1272 my $els = \@{$enum->{ELEMENTS}};
1273 foreach my $i (0 .. $#{$els}) {
1274 my $e = ${$els}[$i];
1276 if ($e =~ /^(.*)=/) {
1279 pidl "case $e: val = \"$e\"; break;";
1285 pidl "ndr_print_enum(ndr, name, \"$enum->{TYPE}\", val, r);";
1293 return "enum $e->{NAME} " .
1294 ($t eq "pull"?"*":"") . "r";
1297 $typefamily{ENUM} = {
1299 PUSH_FN_BODY => \&ParseEnumPush,
1300 PULL_FN_BODY => \&ParseEnumPull,
1301 PRINT_FN_BODY => \&ParseEnumPrint,
1304 #####################################################################
1305 # generate a push function for a bitmap
1306 sub ParseBitmapPush($$)
1308 my($bitmap,$name) = @_;
1309 my($type_fn) = $bitmap->{BASE_TYPE};
1311 start_flags($bitmap);
1313 pidl "NDR_CHECK(ndr_push_$type_fn(ndr, NDR_SCALARS, r));";
1318 #####################################################################
1319 # generate a pull function for an bitmap
1320 sub ParseBitmapPull($$)
1322 my($bitmap,$name) = @_;
1323 my $type_fn = $bitmap->{BASE_TYPE};
1324 my($type_decl) = mapType($bitmap->{BASE_TYPE});
1326 pidl "$type_decl v;";
1327 start_flags($bitmap);
1328 pidl "NDR_CHECK(ndr_pull_$type_fn(ndr, NDR_SCALARS, &v));";
1334 #####################################################################
1335 # generate a print function for an bitmap
1336 sub ParseBitmapPrintElement($$$)
1338 my($e,$bitmap,$name) = @_;
1339 my($type_decl) = mapType($bitmap->{BASE_TYPE});
1340 my($type_fn) = $bitmap->{BASE_TYPE};
1343 if ($e =~ /^(\w+) .*$/) {
1346 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1349 pidl "ndr_print_bitmap_flag(ndr, sizeof($type_decl), \"$flag\", $flag, r);";
1352 #####################################################################
1353 # generate a print function for an bitmap
1354 sub ParseBitmapPrint($$)
1356 my($bitmap,$name) = @_;
1357 my($type_decl) = mapType($bitmap->{TYPE});
1358 my($type_fn) = $bitmap->{BASE_TYPE};
1360 start_flags($bitmap);
1362 pidl "ndr_print_$type_fn(ndr, name, r);";
1364 pidl "ndr->depth++;";
1365 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1366 ParseBitmapPrintElement($e, $bitmap, $name);
1368 pidl "ndr->depth--;";
1376 return mapType(Parse::Pidl::Typelist::bitmap_type_fn($e->{DATA})) .
1377 ($t eq "pull"?" *":" ") . "r";
1380 $typefamily{BITMAP} = {
1381 DECL => \&DeclBitmap,
1382 PUSH_FN_BODY => \&ParseBitmapPush,
1383 PULL_FN_BODY => \&ParseBitmapPull,
1384 PRINT_FN_BODY => \&ParseBitmapPrint,
1387 #####################################################################
1388 # generate a struct print function
1389 sub ParseStructPrint($$)
1391 my($struct,$name) = @_;
1393 return unless defined $struct->{ELEMENTS};
1395 my $env = GenerateStructEnv($struct);
1397 EnvSubstituteValue($env, $struct);
1399 DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1401 pidl "ndr_print_struct(ndr, name, \"$name\");";
1403 start_flags($struct);
1405 pidl "ndr->depth++;";
1407 ParseElementPrint($_, "r->$_->{NAME}", $env) foreach (@{$struct->{ELEMENTS}});
1408 pidl "ndr->depth--;";
1413 sub DeclarePtrVariables($)
1416 foreach my $l (@{$e->{LEVELS}}) {
1417 if ($l->{TYPE} eq "POINTER" and
1418 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1419 pidl "uint32_t _ptr_$e->{NAME};";
1425 sub DeclareArrayVariables($)
1429 foreach my $l (@{$e->{LEVELS}}) {
1430 next if has_fast_array($e,$l);
1431 next if is_charset_array($e,$l);
1432 if ($l->{TYPE} eq "ARRAY") {
1433 pidl "uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};";
1438 sub need_decl_mem_ctx($$)
1442 return 0 if has_fast_array($e,$l);
1443 return 0 if is_charset_array($e,$l);
1444 return 1 if (($l->{TYPE} eq "ARRAY") and not $l->{IS_FIXED});
1446 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1447 my $nl = GetNextLevel($e, $l);
1448 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1449 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1450 ($nl->{DATA_TYPE} eq "string"));
1451 return 0 if ($next_is_array or $next_is_string);
1453 return 1 if ($l->{TYPE} eq "POINTER");
1458 sub DeclareMemCtxVariables($)
1461 foreach my $l (@{$e->{LEVELS}}) {
1462 if (need_decl_mem_ctx($e, $l)) {
1463 pidl "TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};";
1468 #####################################################################
1469 # parse a struct - pull side
1470 sub ParseStructPull($$)
1472 my($struct,$name) = @_;
1474 return unless defined $struct->{ELEMENTS};
1476 my $env = GenerateStructEnv($struct);
1478 # declare any internal pointers we need
1479 foreach my $e (@{$struct->{ELEMENTS}}) {
1480 DeclarePtrVariables($e);
1481 DeclareArrayVariables($e);
1482 DeclareMemCtxVariables($e);
1485 # save the old relative_base_offset
1486 pidl "uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);" if defined($struct->{PROPERTIES}{relative_base});
1488 start_flags($struct);
1490 pidl "if (ndr_flags & NDR_SCALARS) {";
1493 if (defined $struct->{SURROUNDING_ELEMENT}) {
1494 pidl "NDR_CHECK(ndr_pull_array_size(ndr, &r->$struct->{SURROUNDING_ELEMENT}->{NAME}));";
1497 pidl "NDR_CHECK(ndr_pull_align(ndr, $struct->{ALIGN}));";
1499 if (defined($struct->{PROPERTIES}{relative_base})) {
1500 # set the current offset as base for relative pointers
1501 # and store it based on the toplevel struct/union
1502 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, r, ndr->offset));";
1505 foreach my $e (@{$struct->{ELEMENTS}}) {
1506 ParseElementPull($e, "ndr", "r->", $env, 1, 0);
1513 pidl "if (ndr_flags & NDR_BUFFERS) {";
1515 if (defined($struct->{PROPERTIES}{relative_base})) {
1516 # retrieve the current offset as base for relative pointers
1517 # based on the toplevel struct/union
1518 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, r));";
1520 foreach my $e (@{$struct->{ELEMENTS}}) {
1521 ParseElementPull($e, "ndr", "r->", $env, 0, 1);
1530 # restore the old relative_base_offset
1531 pidl "ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($struct->{PROPERTIES}{relative_base});
1534 #####################################################################
1535 # calculate size of ndr struct
1536 sub ParseStructNdrSize($)
1541 if (my $flags = has_property($t, "flag")) {
1542 pidl "flags |= $flags;";
1544 pidl "return ndr_size_struct(r, flags, (ndr_push_flags_fn_t)ndr_push_$t->{NAME});";
1550 return ($t ne "pull"?"const ":"") . "struct $e->{NAME} *r";
1553 sub ArgsStructNdrSize($)
1556 return "const struct $d->{NAME} *r, int flags";
1559 $typefamily{STRUCT} = {
1560 PUSH_FN_BODY => \&ParseStructPush,
1561 DECL => \&DeclStruct,
1562 PULL_FN_BODY => \&ParseStructPull,
1563 PRINT_FN_BODY => \&ParseStructPrint,
1564 SIZE_FN_BODY => \&ParseStructNdrSize,
1565 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1568 #####################################################################
1569 # calculate size of ndr struct
1570 sub ParseUnionNdrSize($)
1575 if (my $flags = has_property($t, "flag")) {
1576 pidl "flags |= $flags;";
1579 pidl "return ndr_size_union(r, flags, level, (ndr_push_flags_fn_t)ndr_push_$t->{NAME});";
1582 #####################################################################
1583 # parse a union - push side
1584 sub ParseUnionPush($$)
1587 my $have_default = 0;
1589 # save the old relative_base_offset
1590 pidl "uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset(ndr);" if defined($e->{PROPERTIES}{relative_base});
1595 pidl "level = ndr_push_get_switch_value(ndr, r);";
1597 pidl "if (ndr_flags & NDR_SCALARS) {";
1600 if (defined($e->{SWITCH_TYPE})) {
1601 pidl "NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}(ndr, NDR_SCALARS, level));";
1604 pidl "switch (level) {";
1606 foreach my $el (@{$e->{ELEMENTS}}) {
1607 if ($el->{CASE} eq "default") {
1610 pidl "$el->{CASE}:";
1612 if ($el->{TYPE} ne "EMPTY") {
1614 if (defined($e->{PROPERTIES}{relative_base})) {
1615 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 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset1(ndr, r, ndr->offset));";
1620 DeclareArrayVariables($el);
1621 ParseElementPush($el, "ndr", "r->", {}, 1, 0);
1627 if (! $have_default) {
1629 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1635 pidl "if (ndr_flags & NDR_BUFFERS) {";
1637 if (defined($e->{PROPERTIES}{relative_base})) {
1638 # retrieve the current offset as base for relative pointers
1639 # based on the toplevel struct/union
1640 pidl "NDR_CHECK(ndr_push_setup_relative_base_offset2(ndr, r));";
1642 pidl "switch (level) {";
1644 foreach my $el (@{$e->{ELEMENTS}}) {
1645 pidl "$el->{CASE}:";
1646 if ($el->{TYPE} ne "EMPTY") {
1648 ParseElementPush($el, "ndr", "r->", {}, 0, 1);
1654 if (! $have_default) {
1656 pidl "\treturn ndr_push_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1664 # restore the old relative_base_offset
1665 pidl "ndr_push_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($e->{PROPERTIES}{relative_base});
1668 #####################################################################
1670 sub ParseUnionPrint($$)
1673 my $have_default = 0;
1676 foreach my $el (@{$e->{ELEMENTS}}) {
1677 DeclareArrayVariables($el);
1682 pidl "level = ndr_print_get_switch_value(ndr, r);";
1684 pidl "ndr_print_union(ndr, name, level, \"$name\");";
1686 pidl "switch (level) {";
1688 foreach my $el (@{$e->{ELEMENTS}}) {
1689 if ($el->{CASE} eq "default") {
1692 pidl "$el->{CASE}:";
1693 if ($el->{TYPE} ne "EMPTY") {
1695 ParseElementPrint($el, "r->$el->{NAME}", {});
1701 if (! $have_default) {
1703 pidl "\tndr_print_bad_level(ndr, name, level);";
1711 #####################################################################
1712 # parse a union - pull side
1713 sub ParseUnionPull($$)
1716 my $have_default = 0;
1717 my $switch_type = $e->{SWITCH_TYPE};
1719 # save the old relative_base_offset
1720 pidl "uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset(ndr);" if defined($e->{PROPERTIES}{relative_base});
1722 if (defined($switch_type)) {
1723 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1724 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1726 pidl mapType($switch_type) . " _level;";
1729 my %double_cases = ();
1730 foreach my $el (@{$e->{ELEMENTS}}) {
1731 next if ($el->{TYPE} eq "EMPTY");
1732 next if ($double_cases{"$el->{NAME}"});
1733 DeclareMemCtxVariables($el);
1734 $double_cases{"$el->{NAME}"} = 1;
1739 pidl "level = ndr_pull_get_switch_value(ndr, r);";
1741 pidl "if (ndr_flags & NDR_SCALARS) {";
1744 if (defined($switch_type)) {
1745 pidl "NDR_CHECK(ndr_pull_$switch_type(ndr, NDR_SCALARS, &_level));";
1746 pidl "if (_level != level) {";
1747 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $name\", _level);";
1751 pidl "switch (level) {";
1753 foreach my $el (@{$e->{ELEMENTS}}) {
1754 if ($el->{CASE} eq "default") {
1757 pidl "$el->{CASE}: {";
1759 if ($el->{TYPE} ne "EMPTY") {
1761 DeclarePtrVariables($el);
1762 DeclareArrayVariables($el);
1763 if (defined($e->{PROPERTIES}{relative_base})) {
1764 pidl "NDR_CHECK(ndr_pull_align(ndr, $el->{ALIGN}));";
1765 # set the current offset as base for relative pointers
1766 # and store it based on the toplevel struct/union
1767 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset1(ndr, r, ndr->offset));";
1769 ParseElementPull($el, "ndr", "r->", {}, 1, 0);
1775 if (! $have_default) {
1777 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1783 pidl "if (ndr_flags & NDR_BUFFERS) {";
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 pidl "NDR_CHECK(ndr_pull_setup_relative_base_offset2(ndr, r));";
1790 pidl "switch (level) {";
1792 foreach my $el (@{$e->{ELEMENTS}}) {
1793 pidl "$el->{CASE}:";
1794 if ($el->{TYPE} ne "EMPTY") {
1796 ParseElementPull($el, "ndr", "r->", {}, 0, 1);
1802 if (! $have_default) {
1804 pidl "\treturn ndr_pull_error(ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);";
1815 # restore the old relative_base_offset
1816 pidl "ndr_pull_restore_relative_base_offset(ndr, _save_relative_base_offset);" if defined($e->{PROPERTIES}{relative_base});
1822 return ($t ne "pull"?"const ":"") . "union $e->{NAME} *r";
1825 sub ArgsUnionNdrSize($)
1828 return "const union $d->{NAME} *r, uint32_t level, int flags";
1831 $typefamily{UNION} = {
1832 PUSH_FN_BODY => \&ParseUnionPush,
1833 DECL => \&DeclUnion,
1834 PULL_FN_BODY => \&ParseUnionPull,
1835 PRINT_FN_BODY => \&ParseUnionPrint,
1836 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1837 SIZE_FN_BODY => \&ParseUnionNdrSize,
1840 #####################################################################
1841 # parse a typedef - push side
1842 sub ParseTypedefPush($)
1846 my $args = $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e,"push");
1847 fn_declare("push", $e, "NTSTATUS ndr_push_$e->{NAME}(struct ndr_push *ndr, int ndr_flags, $args)") or return;
1851 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($e->{DATA}, $e->{NAME});
1852 pidl "return NT_STATUS_OK;";
1858 #####################################################################
1859 # parse a typedef - pull side
1860 sub ParseTypedefPull($)
1864 my $args = $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e,"pull");
1866 fn_declare("pull", $e, "NTSTATUS ndr_pull_$e->{NAME}(struct ndr_pull *ndr, int ndr_flags, $args)") or return;
1870 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($e->{DATA}, $e->{NAME});
1871 pidl "return NT_STATUS_OK;";
1877 #####################################################################
1878 # parse a typedef - print side
1879 sub ParseTypedefPrint($)
1883 my $args = $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e,"print");
1885 pidl_hdr "void ndr_print_$e->{NAME}(struct ndr_print *ndr, const char *name, $args);";
1887 return if (has_property($e, "noprint"));
1889 pidl "_PUBLIC_ void ndr_print_$e->{NAME}(struct ndr_print *ndr, const char *name, $args)";
1892 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($e->{DATA}, $e->{NAME});
1898 #####################################################################
1899 ## calculate the size of a structure
1900 sub ParseTypedefNdrSize($)
1904 my $tf = $typefamily{$t->{DATA}->{TYPE}};
1905 my $args = $tf->{SIZE_FN_ARGS}->($t);
1907 fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
1911 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($t);
1917 #####################################################################
1918 # parse a function - print side
1919 sub ParseFunctionPrint($)
1923 pidl_hdr "void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r);";
1925 return if has_property($fn, "noprint");
1927 pidl "_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *ndr, const char *name, int flags, const struct $fn->{NAME} *r)";
1931 foreach my $e (@{$fn->{ELEMENTS}}) {
1932 DeclareArrayVariables($e);
1935 pidl "ndr_print_struct(ndr, name, \"$fn->{NAME}\");";
1936 pidl "ndr->depth++;";
1938 pidl "if (flags & NDR_SET_VALUES) {";
1939 pidl "\tndr->flags |= LIBNDR_PRINT_SET_VALUES;";
1942 pidl "if (flags & NDR_IN) {";
1944 pidl "ndr_print_struct(ndr, \"in\", \"$fn->{NAME}\");";
1945 pidl "ndr->depth++;";
1947 my $env = GenerateFunctionInEnv($fn);
1948 EnvSubstituteValue($env, $fn);
1950 foreach my $e (@{$fn->{ELEMENTS}}) {
1951 if (grep(/in/,@{$e->{DIRECTION}})) {
1952 ParseElementPrint($e, "r->in.$e->{NAME}", $env);
1955 pidl "ndr->depth--;";
1959 pidl "if (flags & NDR_OUT) {";
1961 pidl "ndr_print_struct(ndr, \"out\", \"$fn->{NAME}\");";
1962 pidl "ndr->depth++;";
1964 $env = GenerateFunctionOutEnv($fn);
1965 foreach my $e (@{$fn->{ELEMENTS}}) {
1966 if (grep(/out/,@{$e->{DIRECTION}})) {
1967 ParseElementPrint($e, "r->out.$e->{NAME}", $env);
1970 if ($fn->{RETURN_TYPE}) {
1971 pidl "ndr_print_$fn->{RETURN_TYPE}(ndr, \"result\", r->out.result);";
1973 pidl "ndr->depth--;";
1977 pidl "ndr->depth--;";
1983 #####################################################################
1985 sub ParseFunctionPush($)
1989 fn_declare("push", $fn, "NTSTATUS ndr_push_$fn->{NAME}(struct ndr_push *ndr, int flags, const struct $fn->{NAME} *r)") or return;
1991 return if has_property($fn, "nopush");
1996 foreach my $e (@{$fn->{ELEMENTS}}) {
1997 DeclareArrayVariables($e);
2000 pidl "if (flags & NDR_IN) {";
2003 my $env = GenerateFunctionInEnv($fn);
2005 EnvSubstituteValue($env, $fn);
2007 foreach my $e (@{$fn->{ELEMENTS}}) {
2008 if (grep(/in/,@{$e->{DIRECTION}})) {
2009 ParseElementPush($e, "ndr", "r->in.", $env, 1, 1);
2016 pidl "if (flags & NDR_OUT) {";
2019 $env = GenerateFunctionOutEnv($fn);
2020 foreach my $e (@{$fn->{ELEMENTS}}) {
2021 if (grep(/out/,@{$e->{DIRECTION}})) {
2022 ParseElementPush($e, "ndr", "r->out.", $env, 1, 1);
2026 if ($fn->{RETURN_TYPE}) {
2027 pidl "NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, r->out.result));";
2032 pidl "return NT_STATUS_OK;";
2038 sub AllocateArrayLevel($$$$$)
2040 my ($e,$l,$ndr,$env,$size) = @_;
2042 my $var = ParseExpr($e->{NAME}, $env, $e);
2044 my $pl = GetPrevLevel($e, $l);
2045 if (defined($pl) and
2046 $pl->{TYPE} eq "POINTER" and
2047 $pl->{POINTER_TYPE} eq "ref"
2048 and not $l->{IS_ZERO_TERMINATED}) {
2049 pidl "if (ndr->flags & LIBNDR_FLAG_REF_ALLOC) {";
2050 pidl "\tNDR_PULL_ALLOC_N($ndr, $var, $size);";
2052 if (grep(/in/,@{$e->{DIRECTION}}) and
2053 grep(/out/,@{$e->{DIRECTION}})) {
2054 pidl "memcpy(r->out.$e->{NAME},r->in.$e->{NAME},$size * sizeof(*r->in.$e->{NAME}));";
2059 pidl "NDR_PULL_ALLOC_N($ndr, $var, $size);";
2062 #####################################################################
2064 sub ParseFunctionPull($)
2068 # pull function args
2069 fn_declare("pull", $fn, "NTSTATUS ndr_pull_$fn->{NAME}(struct ndr_pull *ndr, int flags, struct $fn->{NAME} *r)") or return;
2074 # declare any internal pointers we need
2075 foreach my $e (@{$fn->{ELEMENTS}}) {
2076 DeclarePtrVariables($e);
2077 DeclareArrayVariables($e);
2080 my %double_cases = ();
2081 foreach my $e (@{$fn->{ELEMENTS}}) {
2082 next if ($e->{TYPE} eq "EMPTY");
2083 next if ($double_cases{"$e->{NAME}"});
2084 DeclareMemCtxVariables($e);
2085 $double_cases{"$e->{NAME}"} = 1;
2088 pidl "if (flags & NDR_IN) {";
2091 # auto-init the out section of a structure. I originally argued that
2092 # this was a bad idea as it hides bugs, but coping correctly
2093 # with initialisation and not wiping ref vars is turning
2094 # out to be too tricky (tridge)
2095 foreach my $e (@{$fn->{ELEMENTS}}) {
2096 next unless grep(/out/, @{$e->{DIRECTION}});
2097 pidl "ZERO_STRUCT(r->out);";
2102 my $env = GenerateFunctionInEnv($fn);
2104 foreach my $e (@{$fn->{ELEMENTS}}) {
2105 next unless (grep(/in/, @{$e->{DIRECTION}}));
2106 ParseElementPull($e, "ndr", "r->in.", $env, 1, 1);
2109 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2110 # own flag rather than be in NDR_IN ?
2112 foreach my $e (@{$fn->{ELEMENTS}}) {
2113 next unless (grep(/out/, @{$e->{DIRECTION}}));
2114 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2115 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2116 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2117 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2118 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2119 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2121 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2122 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e, check_null_pointer($e, $env, \&pidl));
2124 pidl "NDR_PULL_ALLOC_N(ndr, r->out.$e->{NAME}, $size);";
2126 if (grep(/in/, @{$e->{DIRECTION}})) {
2127 pidl "memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, $size * sizeof(*r->in.$e->{NAME}));";
2129 pidl "memset(r->out.$e->{NAME}, 0, $size * sizeof(*r->out.$e->{NAME}));";
2132 pidl "NDR_PULL_ALLOC(ndr, r->out.$e->{NAME});";
2134 if (grep(/in/, @{$e->{DIRECTION}})) {
2135 pidl "*r->out.$e->{NAME} = *r->in.$e->{NAME};";
2137 pidl "ZERO_STRUCTP(r->out.$e->{NAME});";
2146 pidl "if (flags & NDR_OUT) {";
2149 $env = GenerateFunctionOutEnv($fn);
2150 foreach my $e (@{$fn->{ELEMENTS}}) {
2151 next unless grep(/out/, @{$e->{DIRECTION}});
2152 ParseElementPull($e, "ndr", "r->out.", $env, 1, 1);
2155 if ($fn->{RETURN_TYPE}) {
2156 pidl "NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}(ndr, NDR_SCALARS, &r->out.result));";
2163 pidl "return NT_STATUS_OK;";
2169 #####################################################################
2170 # produce a function call table
2171 sub FunctionTable($)
2173 my($interface) = shift;
2175 my $uname = uc $interface->{NAME};
2177 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2178 return unless defined ($interface->{PROPERTIES}->{uuid});
2180 pidl "static const struct dcerpc_interface_call $interface->{NAME}\_calls[] = {";
2181 foreach my $d (@{$interface->{FUNCTIONS}}) {
2182 next if not defined($d->{OPNUM});
2184 pidl "\t\t\"$d->{NAME}\",";
2185 pidl "\t\tsizeof(struct $d->{NAME}),";
2186 pidl "\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},";
2187 pidl "\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},";
2188 pidl "\t\t(ndr_print_function_t) ndr_print_$d->{NAME},";
2189 pidl "\t\t".($d->{ASYNC}?"True":"False").",";
2193 pidl "\t{ NULL, 0, NULL, NULL, NULL, False }";
2197 pidl "static const char * const $interface->{NAME}\_endpoint_strings[] = {";
2198 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2201 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2206 pidl "static const struct dcerpc_endpoint_list $interface->{NAME}\_endpoints = {";
2207 pidl "\t.count\t= $endpoint_count,";
2208 pidl "\t.names\t= $interface->{NAME}\_endpoint_strings";
2212 if (! defined $interface->{PROPERTIES}->{authservice}) {
2213 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2216 my @a = split / /, $interface->{PROPERTIES}->{authservice};
2217 my $authservice_count = $#a + 1;
2219 pidl "static const char * const $interface->{NAME}\_authservice_strings[] = {";
2220 foreach my $ap (@a) {
2226 pidl "static const struct dcerpc_authservice_list $interface->{NAME}\_authservices = {";
2227 pidl "\t.count\t= $endpoint_count,";
2228 pidl "\t.names\t= $interface->{NAME}\_authservice_strings";
2232 pidl "\nconst struct dcerpc_interface_table dcerpc_table_$interface->{NAME} = {";
2233 pidl "\t.name\t\t= \"$interface->{NAME}\",";
2234 pidl "\t.syntax_id\t= {";
2235 pidl "\t\t" . print_uuid($interface->{UUID}) .",";
2236 pidl "\t\tDCERPC_$uname\_VERSION";
2238 pidl "\t.helpstring\t= DCERPC_$uname\_HELPSTRING,";
2239 pidl "\t.num_calls\t= $count,";
2240 pidl "\t.calls\t\t= $interface->{NAME}\_calls,";
2241 pidl "\t.endpoints\t= &$interface->{NAME}\_endpoints,";
2242 pidl "\t.authservices\t= &$interface->{NAME}\_authservices";
2248 #####################################################################
2249 # generate include statements for imported idl files
2253 foreach (@imports) {
2256 pidl choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h");
2260 #####################################################################
2261 # generate include statements for included header files
2265 foreach (@includes) {
2266 pidl_hdr "#include $_";
2270 #####################################################################
2271 # generate prototypes and defines for the interface definitions
2272 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2273 # NDR parser and so do not belong here, technically speaking
2274 sub HeaderInterface($)
2276 my($interface) = shift;
2280 pidl_hdr choose_header("librpc/ndr/libndr.h", "ndr.h");
2282 if (has_property($interface, "object")) {
2283 pidl choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h");
2286 if (defined $interface->{PROPERTIES}->{helper}) {
2287 HeaderInclude(split / /, $interface->{PROPERTIES}->{helper});
2290 if (defined $interface->{PROPERTIES}->{uuid}) {
2291 my $name = uc $interface->{NAME};
2292 pidl_hdr "#define DCERPC_$name\_UUID " .
2293 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid}));
2295 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2296 pidl_hdr "#define DCERPC_$name\_VERSION $interface->{PROPERTIES}->{version}";
2298 pidl_hdr "#define DCERPC_$name\_NAME \"$interface->{NAME}\"";
2300 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2301 pidl_hdr "#define DCERPC_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}";
2303 pidl_hdr "extern const struct dcerpc_interface_table dcerpc_table_$interface->{NAME};";
2304 pidl_hdr "NTSTATUS dcerpc_server_$interface->{NAME}_init(void);";
2307 foreach (@{$interface->{FUNCTIONS}}) {
2308 next if has_property($_, "noopnum");
2309 next if grep(/$_->{NAME}/,@{$interface->{INHERITED_FUNCTIONS}});
2310 my $u_name = uc $_->{NAME};
2312 my $val = sprintf("0x%02x", $count);
2313 if (defined($interface->{BASE})) {
2314 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2317 pidl_hdr "#define DCERPC_$u_name ($val)";
2325 if (defined($interface->{BASE})) {
2326 $val .= " + DCERPC_" . uc $interface->{BASE} . "_CALL_COUNT";
2329 pidl_hdr "#define DCERPC_" . uc $interface->{NAME} . "_CALL_COUNT ($val)";
2333 #####################################################################
2334 # parse the interface definitions
2335 sub ParseInterface($$)
2337 my($interface,$needed) = @_;
2339 pidl_hdr "#ifndef _HEADER_NDR_$interface->{NAME}";
2340 pidl_hdr "#define _HEADER_NDR_$interface->{NAME}";
2344 if ($needed->{"compression"}) {
2345 pidl choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h");
2348 HeaderInterface($interface);
2351 foreach my $d (@{$interface->{TYPES}}) {
2352 ($needed->{"push_$d->{NAME}"}) && ParseTypedefPush($d);
2353 ($needed->{"pull_$d->{NAME}"}) && ParseTypedefPull($d);
2354 ($needed->{"print_$d->{NAME}"}) && ParseTypedefPrint($d);
2356 # Make sure we don't generate a function twice...
2357 $needed->{"push_$d->{NAME}"} = $needed->{"pull_$d->{NAME}"} =
2358 $needed->{"print_$d->{NAME}"} = 0;
2360 ($needed->{"ndr_size_$d->{NAME}"}) && ParseTypedefNdrSize($d);
2364 foreach my $d (@{$interface->{FUNCTIONS}}) {
2365 ($needed->{"push_$d->{NAME}"}) && ParseFunctionPush($d);
2366 ($needed->{"pull_$d->{NAME}"}) && ParseFunctionPull($d);
2367 ($needed->{"print_$d->{NAME}"}) && ParseFunctionPrint($d);
2369 # Make sure we don't generate a function twice...
2370 $needed->{"push_$d->{NAME}"} = $needed->{"pull_$d->{NAME}"} =
2371 $needed->{"print_$d->{NAME}"} = 0;
2374 FunctionTable($interface);
2376 pidl_hdr "#endif /* _HEADER_NDR_$interface->{NAME} */";
2379 sub GenerateIncludes()
2382 pidl "#include \"includes.h\"";
2384 pidl "#define _GNU_SOURCE";
2385 pidl "#include <stdint.h>";
2386 pidl "#include <stdlib.h>";
2387 pidl "#include <stdio.h>";
2388 pidl "#include <stdbool.h>";
2389 pidl "#include <stdarg.h>";
2390 pidl "#include <string.h>";
2393 # Samba3 has everything in include/includes.h
2394 if (is_intree() != 3) {
2395 pidl choose_header("libcli/util/nterr.h", "core/nterr.h");
2396 pidl choose_header("librpc/gen_ndr/ndr_misc.h", "gen_ndr/ndr_misc.h");
2397 pidl choose_header("librpc/gen_ndr/ndr_dcerpc.h", "gen_ndr/ndr_dcerpc.h");
2398 pidl choose_header("librpc/rpc/dcerpc.h", "dcerpc.h"); #FIXME: This shouldn't be here!
2402 #####################################################################
2403 # parse a parsed IDL structure back into an IDL file
2406 my($ndr,$gen_header,$ndr_header) = @_;
2412 pidl_hdr "/* header auto-generated by pidl */";
2414 pidl_hdr "#include \"$gen_header\"" if ($gen_header);
2417 pidl "/* parser auto-generated by pidl */";
2420 pidl "#include \"$ndr_header\"" if ($ndr_header);
2426 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2430 ($_->{TYPE} eq "INTERFACE") && ParseInterface($_, \%needed);
2431 ($_->{TYPE} eq "IMPORT") && HeaderImport(@{$_->{PATHS}});
2432 ($_->{TYPE} eq "INCLUDE") && HeaderInclude(@{$_->{PATHS}});
2435 return ($res_hdr, $res);
2438 sub NeededFunction($$)
2440 my ($fn,$needed) = @_;
2441 $needed->{"pull_$fn->{NAME}"} = 1;
2442 $needed->{"push_$fn->{NAME}"} = 1;
2443 $needed->{"print_$fn->{NAME}"} = 1;
2444 foreach my $e (@{$fn->{ELEMENTS}}) {
2446 unless(defined($needed->{"pull_$e->{TYPE}"})) {
2447 $needed->{"pull_$e->{TYPE}"} = 1;
2449 unless(defined($needed->{"push_$e->{TYPE}"})) {
2450 $needed->{"push_$e->{TYPE}"} = 1;
2452 unless(defined($needed->{"print_$e->{TYPE}"})) {
2453 $needed->{"print_$e->{TYPE}"} = 1;
2458 sub NeededTypedef($$)
2460 my ($t,$needed) = @_;
2461 if (has_property($t, "public")) {
2462 $needed->{"pull_$t->{NAME}"} = 1;
2463 $needed->{"push_$t->{NAME}"} = 1;
2464 $needed->{"print_$t->{NAME}"} = 1;
2467 if ($t->{DATA}->{TYPE} eq "STRUCT" or $t->{DATA}->{TYPE} eq "UNION") {
2468 if (has_property($t, "gensize")) {
2469 $needed->{"ndr_size_$t->{NAME}"} = 1;
2472 for my $e (@{$t->{DATA}->{ELEMENTS}}) {
2473 $e->{PARENT} = $t->{DATA};
2474 if (has_property($e, "compression")) {
2475 $needed->{"compression"} = 1;
2477 if ($needed->{"pull_$t->{NAME}"} and
2478 not defined($needed->{"pull_$e->{TYPE}"})) {
2479 $needed->{"pull_$e->{TYPE}"} = 1;
2481 if ($needed->{"push_$t->{NAME}"} and
2482 not defined($needed->{"push_$e->{TYPE}"})) {
2483 $needed->{"push_$e->{TYPE}"} = 1;
2485 if ($needed->{"print_$t->{NAME}"} and
2486 not defined($needed->{"print_$e->{TYPE}"})) {
2487 $needed->{"print_$e->{TYPE}"} = 1;
2493 #####################################################################
2494 # work out what parse functions are needed
2495 sub NeededInterface($$)
2497 my ($interface,$needed) = @_;
2498 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2499 NeededTypedef($_, $needed) foreach (reverse @{$interface->{TYPES}});