1 ###################################################
2 # Samba4 NDR parser generator for IDL structures
3 # Copyright tridge@samba.org 2000-2003
4 # Copyright tpot@samba.org 2001
5 # Copyright jelmer@samba.org 2004-2006
6 # released under the GNU GPL
8 package Parse::Pidl::Samba4::NDR::Parser;
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid unmake_str);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
21 use Parse::Pidl qw(warning);
23 use vars qw($VERSION);
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
38 return $typefamily{$n};
43 my ($e, $var_name) = @_;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
50 } elsif ($l->{TYPE} eq "ARRAY") {
52 if (($pointers == 0) and
53 (not $l->{IS_FIXED}) and
54 (not $l->{IS_INLINE})) {
55 return get_value_of($var_name);
57 } elsif ($l->{TYPE} eq "DATA") {
58 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
59 return get_value_of($var_name) unless ($pointers or $arrays);
67 sub has_fast_array($$)
71 return 0 if ($l->{TYPE} ne "ARRAY");
73 my $nl = GetNextLevel($e,$l);
74 return 0 unless ($nl->{TYPE} eq "DATA");
75 return 0 unless (hasType($nl->{DATA_TYPE}));
77 my $t = getType($nl->{DATA_TYPE});
79 # Only uint8 and string have fast array functions at the moment
80 return ($t->{NAME} eq "uint8") or ($t->{NAME} eq "string");
84 ####################################
85 # pidl() is our basic output routine
90 $self->{res} .= $self->{tabs};
96 sub pidl_hdr($$) { my ($self, $d) = @_; $self->{res_hdr} .= "$d\n"; }
98 ####################################
99 # defer() is like pidl(), but adds to
100 # a deferred buffer which is then added to the
101 # output buffer at the end of the structure/union/function
102 # This is needed to cope with code that must be pushed back
103 # to the end of a block of elements
104 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
105 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
129 $self->{tabs} .= "\t";
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
153 $self->pidl("static $decl");
159 ###################################################################
160 # setup any special flags for an element or structure
163 my ($self, $e, $ndr) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
168 $self->pidl("uint32_t _flags_save_$e->{TYPE} = $ndr->flags;");
169 $self->pidl("ndr_set_flags(&$ndr->flags, $flags);");
173 ###################################################################
174 # end any special flags for an element or structure
177 my ($self, $e, $ndr) = @_;
178 my $flags = has_property($e, "flag");
179 if (defined $flags) {
180 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
203 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
206 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
207 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
210 if ($l->{IS_VARYING}) {
211 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, 0));"); # array offset
212 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $length));");
218 sub check_fully_dereferenced($$)
220 my ($element, $env) = @_;
226 # Figure out the number of pointers in $ptr
227 my $expandedvar = $origvar;
228 $expandedvar =~ s/^(\**)//;
232 foreach (keys %$env) {
233 if ($env->{$_} eq $expandedvar) {
239 return($origvar) unless (defined($var));
241 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
242 if ($_->{NAME} eq $var) {
248 $e or die("Environment doesn't match siblings");
250 # See if pointer at pointer level $level
251 # needs to be checked.
253 foreach (@{$e->{LEVELS}}) {
254 if ($_->{TYPE} eq "POINTER") {
255 $nump = $_->{POINTER_INDEX}+1;
258 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
263 sub check_null_pointer($$$$)
265 my ($element, $env, $print_fn, $return) = @_;
268 my $expandedvar = shift;
271 # Figure out the number of pointers in $ptr
272 $expandedvar =~ s/^(\**)//;
276 foreach (keys %$env) {
277 if ($env->{$_} eq $expandedvar) {
286 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
287 if ($_->{NAME} eq $var) {
293 $e or die("Environment doesn't match siblings");
295 # See if pointer at pointer level $level
296 # needs to be checked.
297 foreach my $l (@{$e->{LEVELS}}) {
298 if ($l->{TYPE} eq "POINTER" and
299 $l->{POINTER_INDEX} == length($ptr)) {
300 # No need to check ref pointers
301 $check = ($l->{POINTER_TYPE} ne "ref");
305 if ($l->{TYPE} eq "DATA") {
306 warning($element, "too much dereferences for `$var'");
310 warning($element, "unknown dereferenced expression `$expandedvar'");
314 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
318 sub ParseArrayPullGetSize($$$$$$)
320 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
324 if ($l->{IS_CONFORMANT}) {
325 $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
326 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
327 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
329 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
330 check_null_pointer($e, $env, sub { $self->pidl(shift); },
331 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
332 check_fully_dereferenced($e, $env));
335 my $array_size = $size;
340 #####################################################################
341 # parse an array - pull side
342 sub ParseArrayPullGetLength($$$$$$;$)
344 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
346 if (not defined($array_size)) {
347 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
350 my $array_length = $array_size;
351 if ($l->{IS_VARYING}) {
352 my $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
353 $array_length = $length;
356 return $array_length;
359 #####################################################################
360 # parse an array - pull side
361 sub ParseArrayPullHeader($$$$$$)
363 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
365 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
366 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
369 if ($l->{IS_VARYING}) {
370 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
373 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
374 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
376 if ($array_length ne $array_size) {
377 $self->pidl("if ($array_length > $array_size) {");
379 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
384 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
385 $self->defer("if ($var_name) {");
387 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
388 check_null_pointer($e, $env, sub { $self->defer(shift); },
389 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
390 check_fully_dereferenced($e, $env));
391 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
392 $self->defer_deindent;
396 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
397 $self->defer("if ($var_name) {");
399 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
400 check_null_pointer($e, $env, sub { $self->defer(shift); },
401 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
402 check_fully_dereferenced($e, $env));
403 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
404 $self->defer_deindent;
408 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
409 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
412 return $array_length;
415 sub compression_alg($$)
418 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
423 sub compression_clen($$$)
425 my ($e, $l, $env) = @_;
426 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
428 return ParseExpr($clen, $env, $e->{ORIGINAL});
431 sub compression_dlen($$$)
433 my ($e,$l,$env) = @_;
434 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
436 return ParseExpr($dlen, $env, $e->{ORIGINAL});
439 sub ParseCompressionPushStart($$$$$)
441 my ($self,$e,$l,$ndr,$env) = @_;
442 my $comndr = "$ndr\_compressed";
443 my $alg = compression_alg($e, $l);
444 my $dlen = compression_dlen($e, $l, $env);
448 $self->pidl("struct ndr_push *$comndr;");
449 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
454 sub ParseCompressionPushEnd($$$$$)
456 my ($self,$e,$l,$ndr,$env) = @_;
457 my $comndr = "$ndr\_compressed";
458 my $alg = compression_alg($e, $l);
459 my $dlen = compression_dlen($e, $l, $env);
461 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
466 sub ParseCompressionPullStart($$$$$)
468 my ($self,$e,$l,$ndr,$env) = @_;
469 my $comndr = "$ndr\_compressed";
470 my $alg = compression_alg($e, $l);
471 my $dlen = compression_dlen($e, $l, $env);
475 $self->pidl("struct ndr_pull *$comndr;");
476 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
481 sub ParseCompressionPullEnd($$$$$)
483 my ($self,$e,$l,$ndr,$env) = @_;
484 my $comndr = "$ndr\_compressed";
485 my $alg = compression_alg($e, $l);
486 my $dlen = compression_dlen($e, $l, $env);
488 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
493 sub ParseSubcontextPushStart($$$$$)
495 my ($self,$e,$l,$ndr,$env) = @_;
496 my $subndr = "_ndr_$e->{NAME}";
497 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
501 $self->pidl("struct ndr_push *$subndr;");
502 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
504 if (defined $l->{COMPRESSION}) {
505 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
511 sub ParseSubcontextPushEnd($$$$$)
513 my ($self,$e,$l,$ndr,$env) = @_;
514 my $subndr = "_ndr_$e->{NAME}";
515 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
517 if (defined $l->{COMPRESSION}) {
518 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
521 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
526 sub ParseSubcontextPullStart($$$$$)
528 my ($self,$e,$l,$ndr,$env) = @_;
529 my $subndr = "_ndr_$e->{NAME}";
530 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
534 $self->pidl("struct ndr_pull *$subndr;");
535 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
537 if (defined $l->{COMPRESSION}) {
538 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
544 sub ParseSubcontextPullEnd($$$$$)
546 my ($self,$e,$l,$ndr,$env) = @_;
547 my $subndr = "_ndr_$e->{NAME}";
548 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
550 if (defined $l->{COMPRESSION}) {
551 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
554 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
559 sub ParseElementPushLevel
561 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
563 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
565 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
566 $var_name = get_pointer_to($var_name);
569 if (defined($ndr_flags)) {
570 if ($l->{TYPE} eq "SUBCONTEXT") {
571 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
572 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
573 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
574 } elsif ($l->{TYPE} eq "POINTER") {
575 $self->ParsePtrPush($e, $l, $ndr, $var_name);
576 } elsif ($l->{TYPE} eq "ARRAY") {
577 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
579 my $nl = GetNextLevel($e, $l);
581 # Allow speedups for arrays of scalar types
582 if (is_charset_array($e,$l)) {
583 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
585 } elsif (has_fast_array($e,$l)) {
586 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
589 } elsif ($l->{TYPE} eq "SWITCH") {
590 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
591 } elsif ($l->{TYPE} eq "DATA") {
592 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
593 } elsif ($l->{TYPE} eq "TYPEDEF") {
594 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
598 if ($l->{TYPE} eq "POINTER" and $deferred) {
599 my $rel_var_name = $var_name;
600 if ($l->{POINTER_TYPE} ne "ref") {
601 $self->pidl("if ($var_name) {");
603 if ($l->{POINTER_TYPE} eq "relative") {
604 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
607 $var_name = get_value_of($var_name);
608 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
610 if ($l->{POINTER_TYPE} ne "ref") {
611 if ($l->{POINTER_TYPE} eq "relative") {
612 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
617 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
618 not is_charset_array($e, $l)) {
619 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
620 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
622 my $array_pointless = ($length eq "0");
624 if ($array_pointless) {
625 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
628 $var_name = get_array_element($var_name, $counter);
630 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
631 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
633 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
638 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
639 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
641 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
645 } elsif ($l->{TYPE} eq "SWITCH") {
646 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
650 #####################################################################
651 # parse scalars in a structure element
652 sub ParseElementPush($$$$$$)
654 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
657 my $var_name = $env->{$e->{NAME}};
659 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
661 # Representation type is different from transmit_as
662 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
665 my $transmit_name = "_transmit_$e->{NAME}";
666 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
667 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
668 $var_name = $transmit_name;
671 $var_name = append_prefix($e, $var_name);
673 $self->start_flags($e, $ndr);
675 if (defined(my $value = has_property($e, "value"))) {
676 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
679 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
681 $self->end_flags($e, $ndr);
683 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
689 #####################################################################
690 # parse a pointer in a struct element or function
691 sub ParsePtrPush($$$$$)
693 my ($self,$e,$l,$ndr,$var_name) = @_;
695 if ($l->{POINTER_TYPE} eq "ref") {
696 $self->pidl("if ($var_name == NULL) {");
698 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
701 if ($l->{LEVEL} eq "EMBEDDED") {
702 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
704 } elsif ($l->{POINTER_TYPE} eq "relative") {
705 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
706 } elsif ($l->{POINTER_TYPE} eq "unique") {
707 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
708 } elsif ($l->{POINTER_TYPE} eq "full") {
709 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
711 die("Unhandled pointer type $l->{POINTER_TYPE}");
715 sub need_pointer_to($$$)
717 my ($e, $l, $scalar_only) = @_;
720 if (ref($l->{DATA_TYPE})) {
721 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
723 $t = $l->{DATA_TYPE};
726 if (not Parse::Pidl::Typelist::is_scalar($t)) {
727 return 1 if $scalar_only;
732 foreach my $tl (@{$e->{LEVELS}}) {
734 if ($tl->{TYPE} eq "ARRAY") {
739 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
740 return 1 unless $arrays;
746 sub ParseDataPrint($$$$$)
748 my ($self, $e, $l, $ndr, $var_name) = @_;
750 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
752 if (need_pointer_to($e, $l, 1)) {
753 $var_name = get_pointer_to($var_name);
756 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
758 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
762 #####################################################################
763 # print scalars in a structure element
764 sub ParseElementPrint($$$$$)
766 my($self, $e, $ndr, $var_name, $env) = @_;
768 return if (has_property($e, "noprint"));
770 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
771 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
775 $var_name = append_prefix($e, $var_name);
777 if (defined(my $value = has_property($e, "value"))) {
778 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
781 foreach my $l (@{$e->{LEVELS}}) {
782 if ($l->{TYPE} eq "POINTER") {
783 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
784 $self->pidl("$ndr->depth++;");
785 if ($l->{POINTER_TYPE} ne "ref") {
786 $self->pidl("if ($var_name) {");
789 $var_name = get_value_of($var_name);
790 } elsif ($l->{TYPE} eq "ARRAY") {
793 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
794 $var_name = get_pointer_to($var_name);
797 if ($l->{IS_ZERO_TERMINATED}) {
798 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
800 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
801 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
804 if (is_charset_array($e,$l)) {
805 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
807 } elsif (has_fast_array($e, $l)) {
808 my $nl = GetNextLevel($e, $l);
809 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
812 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
814 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
815 $self->pidl("$ndr->depth++;");
816 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
818 $self->pidl("char *idx_$l->{LEVEL_INDEX}=NULL;");
819 $self->pidl("if (asprintf(&idx_$l->{LEVEL_INDEX}, \"[\%d]\", $counter) != -1) {");
822 $var_name = get_array_element($var_name, $counter);
824 } elsif ($l->{TYPE} eq "DATA") {
825 $self->ParseDataPrint($e, $l, $ndr, $var_name);
826 } elsif ($l->{TYPE} eq "SWITCH") {
827 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
828 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
829 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
833 foreach my $l (reverse @{$e->{LEVELS}}) {
834 if ($l->{TYPE} eq "POINTER") {
835 if ($l->{POINTER_TYPE} ne "ref") {
839 $self->pidl("$ndr->depth--;");
840 } elsif (($l->{TYPE} eq "ARRAY")
841 and not is_charset_array($e,$l)
842 and not has_fast_array($e,$l)) {
843 $self->pidl("free(idx_$l->{LEVEL_INDEX});");
848 $self->pidl("$ndr->depth--;");
853 #####################################################################
854 # parse scalars in a structure element - pull size
855 sub ParseSwitchPull($$$$$$)
857 my($self,$e,$l,$ndr,$var_name,$env) = @_;
858 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
859 check_null_pointer($e, $env, sub { $self->pidl(shift); },
860 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
861 check_fully_dereferenced($e, $env));
863 $var_name = get_pointer_to($var_name);
864 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
867 #####################################################################
868 # push switch element
869 sub ParseSwitchPush($$$$$$)
871 my($self,$e,$l,$ndr,$var_name,$env) = @_;
872 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
873 check_null_pointer($e, $env, sub { $self->pidl(shift); },
874 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
875 check_fully_dereferenced($e, $env));
877 $var_name = get_pointer_to($var_name);
878 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
881 sub ParseDataPull($$$$$$$)
883 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
885 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
887 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
889 if (need_pointer_to($e, $l, 0)) {
890 $var_name = get_pointer_to($var_name);
893 $var_name = get_pointer_to($var_name);
895 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
897 my $pl = GetPrevLevel($e, $l);
899 my $range = has_property($e, "range");
900 if ($range and $pl->{TYPE} ne "ARRAY") {
901 $var_name = get_value_of($var_name);
902 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
903 my ($low, $high) = split(/,/, $range, 2);
904 if ($low < 0 and not $signed) {
905 warning(0, "$low is invalid for the range of an unsigned type");
907 if ($low == 0 and not $signed) {
908 $self->pidl("if ($var_name > $high) {");
910 $self->pidl("if ($var_name < $low || $var_name > $high) {");
912 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
916 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
920 sub ParseDataPush($$$$$$$)
922 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
924 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
926 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
928 # strings are passed by value rather than reference
929 if (need_pointer_to($e, $l, 1)) {
930 $var_name = get_pointer_to($var_name);
933 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
935 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
939 sub CalcNdrFlags($$$)
941 my ($l,$primitives,$deferred) = @_;
946 # Add NDR_SCALARS if this one is deferred
947 # and deferreds may be pushed
948 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
950 # Add NDR_SCALARS if this one is not deferred and
951 # primitives may be pushed
952 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
954 # Add NDR_BUFFERS if this one contains deferred stuff
955 # and deferreds may be pushed
956 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
958 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
959 return "NDR_SCALARS" if ($scalars);
960 return "NDR_BUFFERS" if ($buffers);
964 sub ParseMemCtxPullFlags($$$$)
966 my ($self, $e, $l) = @_;
968 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
970 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
971 return undef if has_fast_array($e, $l);
972 return undef if is_charset_array($e, $l);
976 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
977 my $nl = GetNextLevel($e, $l);
978 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
979 my $next_is_string = (($nl->{TYPE} eq "DATA") and
980 ($nl->{DATA_TYPE} eq "string"));
981 if ($next_is_array or $next_is_string) {
983 } elsif ($l->{LEVEL} eq "TOP") {
984 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
991 sub ParseMemCtxPullStart($$$$$)
993 my ($self, $e, $l, $ndr, $ptr_name) = @_;
995 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
996 my $mem_c_ctx = $ptr_name;
997 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
999 return unless defined($mem_c_flags);
1001 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1002 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1005 sub ParseMemCtxPullEnd($$$$)
1007 my ($self, $e, $l, $ndr) = @_;
1009 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1010 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1012 return unless defined($mem_r_flags);
1014 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1017 sub CheckStringTerminator($$$$$)
1019 my ($self,$ndr,$e,$l,$length) = @_;
1020 my $nl = GetNextLevel($e, $l);
1022 # Make sure last element is zero!
1023 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1026 sub ParseElementPullLevel
1028 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1030 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1031 my $array_length = undef;
1033 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1034 $var_name = get_pointer_to($var_name);
1037 # Only pull something if there's actually something to be pulled
1038 if (defined($ndr_flags)) {
1039 if ($l->{TYPE} eq "SUBCONTEXT") {
1040 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1041 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1042 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1043 } elsif ($l->{TYPE} eq "ARRAY") {
1044 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1045 $array_length = $length;
1047 if (my $range = has_property($e, "range")) {
1048 my ($low, $high) = split(/,/, $range, 2);
1050 warning(0, "$low is invalid for the range of an array size");
1053 $self->pidl("if ($length > $high) {");
1055 $self->pidl("if ($length < $low || $length > $high) {");
1057 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1061 my $nl = GetNextLevel($e, $l);
1063 if (is_charset_array($e,$l)) {
1064 if ($l->{IS_ZERO_TERMINATED}) {
1065 $self->CheckStringTerminator($ndr, $e, $l, $length);
1067 $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}));");
1069 } elsif (has_fast_array($e, $l)) {
1070 if ($l->{IS_ZERO_TERMINATED}) {
1071 $self->CheckStringTerminator($ndr,$e,$l,$length);
1073 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1076 } elsif ($l->{TYPE} eq "POINTER") {
1077 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1078 } elsif ($l->{TYPE} eq "SWITCH") {
1079 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1080 } elsif ($l->{TYPE} eq "DATA") {
1081 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1082 } elsif ($l->{TYPE} eq "TYPEDEF") {
1083 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1087 # add additional constructions
1088 if ($l->{TYPE} eq "POINTER" and $deferred) {
1089 if ($l->{POINTER_TYPE} ne "ref") {
1090 $self->pidl("if ($var_name) {");
1093 if ($l->{POINTER_TYPE} eq "relative") {
1094 $self->pidl("uint32_t _relative_save_offset;");
1095 $self->pidl("_relative_save_offset = $ndr->offset;");
1096 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1100 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1102 $var_name = get_value_of($var_name);
1103 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1105 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1107 if ($l->{POINTER_TYPE} ne "ref") {
1108 if ($l->{POINTER_TYPE} eq "relative") {
1109 $self->pidl("$ndr->offset = _relative_save_offset;");
1114 } elsif ($l->{TYPE} eq "ARRAY" and
1115 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1116 my $length = $array_length;
1117 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1118 my $array_name = $var_name;
1120 if (not defined($length)) {
1121 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1124 if (my $range = has_property($e, "range")) {
1125 my ($low, $high) = split(/,/, $range, 2);
1127 warning(0, "$low is invalid for the range of an array size");
1130 $self->pidl("if ($length > $high) {");
1132 $self->pidl("if ($length < $low || $length > $high) {");
1134 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1138 $var_name = get_array_element($var_name, $counter);
1140 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1142 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1143 my $nl = GetNextLevel($e,$l);
1145 if ($l->{IS_ZERO_TERMINATED}) {
1146 $self->CheckStringTerminator($ndr,$e,$l,$length);
1149 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1151 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1156 if ($deferred and ContainsDeferred($e, $l)) {
1157 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1159 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1164 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1166 } elsif ($l->{TYPE} eq "SWITCH") {
1167 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1171 #####################################################################
1172 # parse scalars in a structure element - pull size
1173 sub ParseElementPull($$$$$$)
1175 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1177 my $var_name = $env->{$e->{NAME}};
1181 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1183 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1186 $represent_name = $var_name;
1187 $transmit_name = "_transmit_$e->{NAME}";
1188 $var_name = $transmit_name;
1189 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1192 $var_name = append_prefix($e, $var_name);
1194 $self->start_flags($e, $ndr);
1196 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1198 $self->end_flags($e, $ndr);
1200 # Representation type is different from transmit_as
1201 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1202 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1208 #####################################################################
1209 # parse a pointer in a struct element or function
1210 sub ParsePtrPull($$$$$)
1212 my($self, $e,$l,$ndr,$var_name) = @_;
1214 my $nl = GetNextLevel($e, $l);
1215 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1216 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1217 ($nl->{DATA_TYPE} eq "string"));
1219 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1221 if (!$next_is_array and !$next_is_string) {
1222 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1223 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1228 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1229 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1230 } elsif (($l->{POINTER_TYPE} eq "unique") or
1231 ($l->{POINTER_TYPE} eq "relative") or
1232 ($l->{POINTER_TYPE} eq "full")) {
1233 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1235 die("Unhandled pointer type $l->{POINTER_TYPE}");
1238 $self->pidl("if (_ptr_$e->{NAME}) {");
1241 # Don't do this for arrays, they're allocated at the actual level
1243 unless ($next_is_array or $next_is_string) {
1244 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1246 # FIXME: Yes, this is nasty.
1247 # We allocate an array twice
1248 # - once just to indicate that it's there,
1249 # - then the real allocation...
1250 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1253 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1254 if ($l->{POINTER_TYPE} eq "relative") {
1255 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1258 $self->pidl("} else {");
1259 $self->pidl("\t$var_name = NULL;");
1263 sub ParseStructPushPrimitives($$$$$)
1265 my ($self, $struct, $ndr, $varname, $env) = @_;
1267 # see if the structure contains a conformant array. If it
1268 # does, then it must be the last element of the structure, and
1269 # we need to push the conformant length early, as it fits on
1270 # the wire before the structure (and even before the structure
1272 if (defined($struct->{SURROUNDING_ELEMENT})) {
1273 my $e = $struct->{SURROUNDING_ELEMENT};
1275 if (defined($e->{LEVELS}[0]) and
1276 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1279 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1280 if (has_property($e, "charset")) {
1281 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1283 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1286 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1289 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, $size));");
1291 $self->pidl("NDR_CHECK(ndr_push_uint32($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1295 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1297 if (defined($struct->{PROPERTIES}{relative_base})) {
1298 # set the current offset as base for relative pointers
1299 # and store it based on the toplevel struct/union
1300 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1303 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1306 sub ParseStructPushDeferred($$$$)
1308 my ($self, $struct, $ndr, $varname, $env) = @_;
1309 if (defined($struct->{PROPERTIES}{relative_base})) {
1310 # retrieve the current offset as base for relative pointers
1311 # based on the toplevel struct/union
1312 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1314 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1317 #####################################################################
1319 sub ParseStructPush($$$$)
1321 my ($self, $struct, $ndr, $varname) = @_;
1323 return unless defined($struct->{ELEMENTS});
1325 my $env = GenerateStructEnv($struct, $varname);
1327 EnvSubstituteValue($env, $struct);
1329 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1331 $self->start_flags($struct, $ndr);
1333 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1335 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1339 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1341 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1345 $self->end_flags($struct, $ndr);
1348 #####################################################################
1349 # generate a push function for an enum
1350 sub ParseEnumPush($$$$)
1352 my($self,$enum,$ndr,$varname) = @_;
1353 my($type_fn) = $enum->{BASE_TYPE};
1355 $self->start_flags($enum, $ndr);
1356 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1357 $self->end_flags($enum, $ndr);
1360 #####################################################################
1361 # generate a pull function for an enum
1362 sub ParseEnumPull($$$$)
1364 my($self,$enum,$ndr,$varname) = @_;
1365 my($type_fn) = $enum->{BASE_TYPE};
1366 my($type_v_decl) = mapTypeName($type_fn);
1368 $self->pidl("$type_v_decl v;");
1369 $self->start_flags($enum, $ndr);
1370 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1371 $self->pidl("*$varname = v;");
1373 $self->end_flags($enum, $ndr);
1376 #####################################################################
1377 # generate a print function for an enum
1378 sub ParseEnumPrint($$$$$)
1380 my($self,$enum,$ndr,$name,$varname) = @_;
1382 $self->pidl("const char *val = NULL;");
1385 $self->start_flags($enum, $ndr);
1387 $self->pidl("switch ($varname) {");
1389 my $els = \@{$enum->{ELEMENTS}};
1390 foreach my $i (0 .. $#{$els}) {
1391 my $e = ${$els}[$i];
1393 if ($e =~ /^(.*)=/) {
1396 $self->pidl("case $e: val = \"$e\"; break;");
1402 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1404 $self->end_flags($enum, $ndr);
1409 my ($e,$t,$name,$varname) = @_;
1410 return "enum $name " .
1411 ($t eq "pull"?"*":"") . $varname;
1414 $typefamily{ENUM} = {
1416 PUSH_FN_BODY => \&ParseEnumPush,
1417 PULL_FN_BODY => \&ParseEnumPull,
1418 PRINT_FN_BODY => \&ParseEnumPrint,
1421 #####################################################################
1422 # generate a push function for a bitmap
1423 sub ParseBitmapPush($$$$)
1425 my($self,$bitmap,$ndr,$varname) = @_;
1426 my($type_fn) = $bitmap->{BASE_TYPE};
1428 $self->start_flags($bitmap, $ndr);
1430 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1432 $self->end_flags($bitmap, $ndr);
1435 #####################################################################
1436 # generate a pull function for an bitmap
1437 sub ParseBitmapPull($$$$)
1439 my($self,$bitmap,$ndr,$varname) = @_;
1440 my $type_fn = $bitmap->{BASE_TYPE};
1441 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1443 $self->pidl("$type_decl v;");
1444 $self->start_flags($bitmap, $ndr);
1445 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1446 $self->pidl("*$varname = v;");
1448 $self->end_flags($bitmap, $ndr);
1451 #####################################################################
1452 # generate a print function for an bitmap
1453 sub ParseBitmapPrintElement($$$$$$)
1455 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1456 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1457 my($type_fn) = $bitmap->{BASE_TYPE};
1460 if ($e =~ /^(\w+) .*$/) {
1463 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1466 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1469 #####################################################################
1470 # generate a print function for an bitmap
1471 sub ParseBitmapPrint($$$$$)
1473 my($self,$bitmap,$ndr,$name,$varname) = @_;
1474 my($type_decl) = mapTypeName($bitmap->{TYPE});
1475 my($type_fn) = $bitmap->{BASE_TYPE};
1477 $self->start_flags($bitmap, $ndr);
1479 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1481 $self->pidl("$ndr->depth++;");
1482 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1483 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1485 $self->pidl("$ndr->depth--;");
1487 $self->end_flags($bitmap, $ndr);
1490 sub DeclBitmap($$$$)
1492 my ($e,$t,$name,$varname) = @_;
1493 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1494 ($t eq "pull"?" *":" ") . $varname;
1497 $typefamily{BITMAP} = {
1498 DECL => \&DeclBitmap,
1499 PUSH_FN_BODY => \&ParseBitmapPush,
1500 PULL_FN_BODY => \&ParseBitmapPull,
1501 PRINT_FN_BODY => \&ParseBitmapPrint,
1504 #####################################################################
1505 # generate a struct print function
1506 sub ParseStructPrint($$$$$)
1508 my($self,$struct,$ndr,$name,$varname) = @_;
1510 return unless defined $struct->{ELEMENTS};
1512 my $env = GenerateStructEnv($struct, $varname);
1514 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1516 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1518 $self->start_flags($struct, $ndr);
1520 $self->pidl("$ndr->depth++;");
1522 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1523 foreach (@{$struct->{ELEMENTS}});
1524 $self->pidl("$ndr->depth--;");
1526 $self->end_flags($struct, $ndr);
1529 sub DeclarePtrVariables($$)
1532 foreach my $l (@{$e->{LEVELS}}) {
1533 if ($l->{TYPE} eq "POINTER" and
1534 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1535 $self->pidl("uint32_t _ptr_$e->{NAME};");
1541 sub DeclareArrayVariables($$)
1545 foreach my $l (@{$e->{LEVELS}}) {
1546 next if ($l->{TYPE} ne "ARRAY");
1547 next if has_fast_array($e,$l);
1548 next if is_charset_array($e,$l);
1549 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1553 sub DeclareArrayVariablesNoZero($$$)
1555 my ($self,$e,$env) = @_;
1557 foreach my $l (@{$e->{LEVELS}}) {
1558 next if ($l->{TYPE} ne "ARRAY");
1559 next if has_fast_array($e,$l);
1560 next if is_charset_array($e,$l);
1561 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1562 if ($length eq "0") {
1563 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1565 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1570 sub DeclareMemCtxVariables($$)
1573 foreach my $l (@{$e->{LEVELS}}) {
1574 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1575 if (defined($mem_flags)) {
1576 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1581 sub ParseStructPullPrimitives($$$$$)
1583 my($self,$struct,$ndr,$varname,$env) = @_;
1585 if (defined $struct->{SURROUNDING_ELEMENT}) {
1586 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1589 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1591 if (defined($struct->{PROPERTIES}{relative_base})) {
1592 # set the current offset as base for relative pointers
1593 # and store it based on the toplevel struct/union
1594 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1597 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1599 $self->add_deferred();
1602 sub ParseStructPullDeferred($$$$$)
1604 my ($self,$struct,$ndr,$varname,$env) = @_;
1606 if (defined($struct->{PROPERTIES}{relative_base})) {
1607 # retrieve the current offset as base for relative pointers
1608 # based on the toplevel struct/union
1609 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1611 foreach my $e (@{$struct->{ELEMENTS}}) {
1612 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1615 $self->add_deferred();
1618 #####################################################################
1619 # parse a struct - pull side
1620 sub ParseStructPull($$$$)
1622 my($self,$struct,$ndr,$varname) = @_;
1624 return unless defined $struct->{ELEMENTS};
1626 # declare any internal pointers we need
1627 foreach my $e (@{$struct->{ELEMENTS}}) {
1628 $self->DeclarePtrVariables($e);
1629 $self->DeclareArrayVariables($e);
1630 $self->DeclareMemCtxVariables($e);
1633 $self->start_flags($struct, $ndr);
1635 my $env = GenerateStructEnv($struct, $varname);
1637 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1639 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1642 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1644 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1648 $self->end_flags($struct, $ndr);
1651 #####################################################################
1652 # calculate size of ndr struct
1653 sub ParseStructNdrSize($$$$)
1655 my ($self,$t, $name, $varname) = @_;
1658 if (my $flags = has_property($t, "flag")) {
1659 $self->pidl("flags |= $flags;");
1661 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1664 sub DeclStruct($$$$)
1666 my ($e,$t,$name,$varname) = @_;
1667 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1670 sub ArgsStructNdrSize($$$)
1672 my ($d, $name, $varname) = @_;
1673 return "const struct $name *$varname, struct smb_iconv_convenience *ic, int flags";
1676 $typefamily{STRUCT} = {
1677 PUSH_FN_BODY => \&ParseStructPush,
1678 DECL => \&DeclStruct,
1679 PULL_FN_BODY => \&ParseStructPull,
1680 PRINT_FN_BODY => \&ParseStructPrint,
1681 SIZE_FN_BODY => \&ParseStructNdrSize,
1682 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1685 #####################################################################
1686 # calculate size of ndr struct
1687 sub ParseUnionNdrSize($$$)
1689 my ($self, $t, $name, $varname) = @_;
1692 if (my $flags = has_property($t, "flag")) {
1693 $self->pidl("flags |= $flags;");
1696 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name, ic);");
1699 sub ParseUnionPushPrimitives($$$$)
1701 my ($self, $e, $ndr ,$varname) = @_;
1703 my $have_default = 0;
1705 $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1707 if (defined($e->{SWITCH_TYPE})) {
1708 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1711 $self->pidl("switch (level) {");
1713 foreach my $el (@{$e->{ELEMENTS}}) {
1714 if ($el->{CASE} eq "default") {
1717 $self->pidl("$el->{CASE}: {");
1719 if ($el->{TYPE} ne "EMPTY") {
1721 if (defined($e->{PROPERTIES}{relative_base})) {
1722 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1723 # set the current offset as base for relative pointers
1724 # and store it based on the toplevel struct/union
1725 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1727 $self->DeclareArrayVariables($el);
1728 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1731 $self->pidl("break; }");
1734 if (! $have_default) {
1735 $self->pidl("default:");
1736 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1742 sub ParseUnionPushDeferred($$$$)
1744 my ($self,$e,$ndr,$varname) = @_;
1746 my $have_default = 0;
1748 $self->pidl("int level = ndr_push_get_switch_value($ndr, $varname);");
1749 if (defined($e->{PROPERTIES}{relative_base})) {
1750 # retrieve the current offset as base for relative pointers
1751 # based on the toplevel struct/union
1752 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1754 $self->pidl("switch (level) {");
1756 foreach my $el (@{$e->{ELEMENTS}}) {
1757 if ($el->{CASE} eq "default") {
1761 $self->pidl("$el->{CASE}:");
1762 if ($el->{TYPE} ne "EMPTY") {
1764 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1767 $self->pidl("break;");
1770 if (! $have_default) {
1771 $self->pidl("default:");
1772 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1778 #####################################################################
1779 # parse a union - push side
1780 sub ParseUnionPush($$$$)
1782 my ($self,$e,$ndr,$varname) = @_;
1783 my $have_default = 0;
1785 $self->start_flags($e, $ndr);
1787 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1789 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1792 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1794 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1797 $self->end_flags($e, $ndr);
1800 #####################################################################
1802 sub ParseUnionPrint($$$$$)
1804 my ($self,$e,$ndr,$name,$varname) = @_;
1805 my $have_default = 0;
1807 $self->pidl("int level;");
1808 foreach my $el (@{$e->{ELEMENTS}}) {
1809 $self->DeclareArrayVariables($el);
1812 $self->start_flags($e, $ndr);
1814 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1816 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1818 $self->pidl("switch (level) {");
1820 foreach my $el (@{$e->{ELEMENTS}}) {
1821 if ($el->{CASE} eq "default") {
1824 $self->pidl("$el->{CASE}:");
1825 if ($el->{TYPE} ne "EMPTY") {
1827 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1830 $self->pidl("break;");
1833 if (! $have_default) {
1834 $self->pidl("default:");
1835 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1840 $self->end_flags($e, $ndr);
1843 sub ParseUnionPullPrimitives($$$$$)
1845 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1846 my $have_default = 0;
1848 if (defined($switch_type)) {
1849 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1850 $self->pidl("if (_level != level) {");
1851 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname\", _level);");
1855 $self->pidl("switch (level) {");
1857 foreach my $el (@{$e->{ELEMENTS}}) {
1858 if ($el->{CASE} eq "default") {
1861 $self->pidl("$el->{CASE}: {");
1863 if ($el->{TYPE} ne "EMPTY") {
1865 if (defined($e->{PROPERTIES}{relative_base})) {
1866 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1867 # set the current offset as base for relative pointers
1868 # and store it based on the toplevel struct/union
1869 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1871 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1874 $self->pidl("break; }");
1877 if (! $have_default) {
1878 $self->pidl("default:");
1879 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1885 sub ParseUnionPullDeferred($$$$)
1887 my ($self,$e,$ndr,$varname) = @_;
1888 my $have_default = 0;
1890 if (defined($e->{PROPERTIES}{relative_base})) {
1891 # retrieve the current offset as base for relative pointers
1892 # based on the toplevel struct/union
1893 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1895 $self->pidl("switch (level) {");
1897 foreach my $el (@{$e->{ELEMENTS}}) {
1898 if ($el->{CASE} eq "default") {
1902 $self->pidl("$el->{CASE}:");
1903 if ($el->{TYPE} ne "EMPTY") {
1905 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1908 $self->pidl("break;");
1911 if (! $have_default) {
1912 $self->pidl("default:");
1913 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1921 #####################################################################
1922 # parse a union - pull side
1923 sub ParseUnionPull($$$$)
1925 my ($self,$e,$ndr,$varname) = @_;
1926 my $switch_type = $e->{SWITCH_TYPE};
1928 $self->pidl("int level;");
1929 if (defined($switch_type)) {
1930 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1931 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1933 $self->pidl(mapTypeName($switch_type) . " _level;");
1936 my %double_cases = ();
1937 foreach my $el (@{$e->{ELEMENTS}}) {
1938 next if ($el->{TYPE} eq "EMPTY");
1939 next if ($double_cases{"$el->{NAME}"});
1940 $self->DeclareMemCtxVariables($el);
1941 $self->DeclarePtrVariables($el);
1942 $self->DeclareArrayVariables($el);
1943 $double_cases{"$el->{NAME}"} = 1;
1946 $self->start_flags($e, $ndr);
1948 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
1950 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1952 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
1956 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1958 $self->ParseUnionPullDeferred($e,$ndr,$varname);
1962 $self->add_deferred();
1964 $self->end_flags($e, $ndr);
1969 my ($e,$t,$name,$varname) = @_;
1970 return ($t ne "pull"?"const ":"") . "union $name *$varname";
1973 sub ArgsUnionNdrSize($$)
1976 return "const union $name *r, uint32_t level, struct smb_iconv_convenience *ic, int flags";
1979 $typefamily{UNION} = {
1980 PUSH_FN_BODY => \&ParseUnionPush,
1981 DECL => \&DeclUnion,
1982 PULL_FN_BODY => \&ParseUnionPull,
1983 PRINT_FN_BODY => \&ParseUnionPrint,
1984 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
1985 SIZE_FN_BODY => \&ParseUnionNdrSize,
1988 #####################################################################
1989 # parse a typedef - push side
1990 sub ParseTypedefPush($$$$)
1992 my($self,$e,$ndr,$varname) = @_;
1996 $env->{$e->{NAME}} = $varname;
1998 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2001 #####################################################################
2002 # parse a typedef - pull side
2003 sub ParseTypedefPull($$$$)
2005 my($self,$e,$ndr,$varname) = @_;
2009 $env->{$e->{NAME}} = $varname;
2011 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2014 #####################################################################
2015 # parse a typedef - print side
2016 sub ParseTypedefPrint($$$$$)
2018 my($self,$e,$ndr,$name,$varname) = @_;
2020 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2023 #####################################################################
2024 ## calculate the size of a structure
2025 sub ParseTypedefNdrSize($$$$)
2027 my($self,$t,$name,$varname) = @_;
2029 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2032 sub DeclTypedef($$$$)
2034 my ($e, $t, $name, $varname) = @_;
2036 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2039 sub ArgsTypedefNdrSize($$$)
2041 my ($d, $name, $varname) = @_;
2042 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2045 $typefamily{TYPEDEF} = {
2046 PUSH_FN_BODY => \&ParseTypedefPush,
2047 DECL => \&DeclTypedef,
2048 PULL_FN_BODY => \&ParseTypedefPull,
2049 PRINT_FN_BODY => \&ParseTypedefPrint,
2050 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2051 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2054 #####################################################################
2055 # parse a function - print side
2056 sub ParseFunctionPrint($$)
2058 my($self, $fn) = @_;
2061 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2063 return if has_property($fn, "noprint");
2065 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2069 foreach my $e (@{$fn->{ELEMENTS}}) {
2070 $self->DeclareArrayVariables($e);
2073 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2074 $self->pidl("$ndr->depth++;");
2076 $self->pidl("if (flags & NDR_SET_VALUES) {");
2077 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2080 $self->pidl("if (flags & NDR_IN) {");
2082 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2083 $self->pidl("$ndr->depth++;");
2085 my $env = GenerateFunctionInEnv($fn);
2087 foreach my $e (@{$fn->{ELEMENTS}}) {
2088 if (grep(/in/,@{$e->{DIRECTION}})) {
2089 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2092 $self->pidl("$ndr->depth--;");
2096 $self->pidl("if (flags & NDR_OUT) {");
2098 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2099 $self->pidl("$ndr->depth++;");
2101 $env = GenerateFunctionOutEnv($fn);
2102 foreach my $e (@{$fn->{ELEMENTS}}) {
2103 if (grep(/out/,@{$e->{DIRECTION}})) {
2104 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2107 if ($fn->{RETURN_TYPE}) {
2108 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2110 $self->pidl("$ndr->depth--;");
2114 $self->pidl("$ndr->depth--;");
2120 #####################################################################
2122 sub ParseFunctionPush($$)
2124 my($self, $fn) = @_;
2127 $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;
2129 return if has_property($fn, "nopush");
2134 foreach my $e (@{$fn->{ELEMENTS}}) {
2135 $self->DeclareArrayVariables($e);
2138 $self->pidl("if (flags & NDR_IN) {");
2141 my $env = GenerateFunctionInEnv($fn);
2143 EnvSubstituteValue($env, $fn);
2145 foreach my $e (@{$fn->{ELEMENTS}}) {
2146 if (grep(/in/,@{$e->{DIRECTION}})) {
2147 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2154 $self->pidl("if (flags & NDR_OUT) {");
2157 $env = GenerateFunctionOutEnv($fn);
2158 foreach my $e (@{$fn->{ELEMENTS}}) {
2159 if (grep(/out/,@{$e->{DIRECTION}})) {
2160 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2164 if ($fn->{RETURN_TYPE}) {
2165 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2170 $self->pidl("return NDR_ERR_SUCCESS;");
2176 sub AllocateArrayLevel($$$$$$)
2178 my ($self,$e,$l,$ndr,$var,$size) = @_;
2180 my $pl = GetPrevLevel($e, $l);
2181 if (defined($pl) and
2182 $pl->{TYPE} eq "POINTER" and
2183 $pl->{POINTER_TYPE} eq "ref"
2184 and not $l->{IS_ZERO_TERMINATED}) {
2185 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2186 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2188 if (grep(/in/,@{$e->{DIRECTION}}) and
2189 grep(/out/,@{$e->{DIRECTION}})) {
2190 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2195 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2198 #####################################################################
2200 sub ParseFunctionPull($$)
2205 # pull function args
2206 $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;
2211 # declare any internal pointers we need
2212 foreach my $e (@{$fn->{ELEMENTS}}) {
2213 $self->DeclarePtrVariables($e);
2214 $self->DeclareArrayVariables($e);
2217 my %double_cases = ();
2218 foreach my $e (@{$fn->{ELEMENTS}}) {
2219 next if ($e->{TYPE} eq "EMPTY");
2220 next if ($double_cases{"$e->{NAME}"});
2221 $self->DeclareMemCtxVariables($e);
2222 $double_cases{"$e->{NAME}"} = 1;
2225 $self->pidl("if (flags & NDR_IN) {");
2228 # auto-init the out section of a structure. I originally argued that
2229 # this was a bad idea as it hides bugs, but coping correctly
2230 # with initialisation and not wiping ref vars is turning
2231 # out to be too tricky (tridge)
2232 foreach my $e (@{$fn->{ELEMENTS}}) {
2233 next unless grep(/out/, @{$e->{DIRECTION}});
2234 $self->pidl("ZERO_STRUCT(r->out);");
2239 my $env = GenerateFunctionInEnv($fn);
2241 foreach my $e (@{$fn->{ELEMENTS}}) {
2242 next unless (grep(/in/, @{$e->{DIRECTION}}));
2243 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2246 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2247 # own flag rather than be in NDR_IN ?
2249 foreach my $e (@{$fn->{ELEMENTS}}) {
2250 next unless (grep(/out/, @{$e->{DIRECTION}}));
2251 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2252 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2253 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2254 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2255 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2256 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2258 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2259 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2260 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2261 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2262 check_fully_dereferenced($e, $env));
2263 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2265 if (grep(/in/, @{$e->{DIRECTION}})) {
2266 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2268 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2271 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2273 if (grep(/in/, @{$e->{DIRECTION}})) {
2274 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2276 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2281 $self->add_deferred();
2285 $self->pidl("if (flags & NDR_OUT) {");
2288 $env = GenerateFunctionOutEnv($fn);
2289 foreach my $e (@{$fn->{ELEMENTS}}) {
2290 next unless grep(/out/, @{$e->{DIRECTION}});
2291 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2294 if ($fn->{RETURN_TYPE}) {
2295 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2298 $self->add_deferred();
2302 $self->pidl("return NDR_ERR_SUCCESS;");
2308 sub AuthServiceStruct($$$)
2310 my ($self, $ifacename, $authservice) = @_;
2311 my @a = split /,/, $authservice;
2312 my $authservice_count = $#a + 1;
2314 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2315 foreach my $ap (@a) {
2316 $self->pidl("\t$ap, ");
2321 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2322 $self->pidl("\t.count\t= $authservice_count,");
2323 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2328 sub FunctionCallEntry($$)
2330 my ($self, $d) = @_;
2331 return 0 if not defined($d->{OPNUM});
2333 $self->pidl("\t\t\"$d->{NAME}\",");
2334 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2335 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2336 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2337 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2338 $self->pidl("\t\t".($d->{ASYNC}?"true":"false").",");
2339 $self->pidl("\t},");
2343 #####################################################################
2344 # produce a function call table
2345 sub FunctionTable($$)
2347 my($self,$interface) = @_;
2349 my $uname = uc $interface->{NAME};
2351 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2352 return unless defined ($interface->{PROPERTIES}->{uuid});
2354 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2356 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2357 $count += $self->FunctionCallEntry($d);
2359 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL, false }");
2363 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2364 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2365 $self->pidl("\t$ep, ");
2367 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2372 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2373 $self->pidl("\t.count\t= $endpoint_count,");
2374 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2378 if (! defined $interface->{PROPERTIES}->{authservice}) {
2379 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2382 $self->AuthServiceStruct($interface->{NAME},
2383 $interface->{PROPERTIES}->{authservice});
2385 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2386 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2387 $self->pidl("\t.syntax_id\t= {");
2388 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2389 $self->pidl("\t\tNDR_$uname\_VERSION");
2390 $self->pidl("\t},");
2391 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2392 $self->pidl("\t.num_calls\t= $count,");
2393 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2394 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2395 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2401 #####################################################################
2402 # generate include statements for imported idl files
2407 foreach (@imports) {
2408 $_ = unmake_str($_);
2410 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2414 #####################################################################
2415 # generate include statements for included header files
2420 foreach (@includes) {
2421 $self->pidl_hdr("#include $_");
2425 #####################################################################
2426 # generate prototypes and defines for the interface definitions
2427 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2428 # NDR parser and so do not belong here, technically speaking
2429 sub HeaderInterface($$$)
2431 my($self,$interface,$needed) = @_;
2435 if ($needed->{"compression"}) {
2436 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2439 if (has_property($interface, "object")) {
2440 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2443 if (defined $interface->{PROPERTIES}->{helper}) {
2444 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2447 if (defined $interface->{PROPERTIES}->{uuid}) {
2448 my $name = uc $interface->{NAME};
2449 $self->pidl_hdr("#define NDR_$name\_UUID " .
2450 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2452 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2453 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2455 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2457 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2458 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2460 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2463 foreach (@{$interface->{FUNCTIONS}}) {
2464 next if has_property($_, "noopnum");
2465 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2466 my $u_name = uc $_->{NAME};
2468 my $val = sprintf("0x%02x", $count);
2469 if (defined($interface->{BASE})) {
2470 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2473 $self->pidl_hdr("#define NDR_$u_name ($val)");
2475 $self->pidl_hdr("");
2481 if (defined($interface->{BASE})) {
2482 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2485 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2489 sub ParseTypePush($$$$$$)
2491 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2493 # save the old relative_base_offset
2494 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2495 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2496 # restore the old relative_base_offset
2497 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2500 sub ParseTypePushFunction($$$)
2502 my ($self, $e, $varname) = @_;
2505 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2507 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2511 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2512 $self->pidl("return NDR_ERR_SUCCESS;");
2518 sub ParseTypePull($$$$$$)
2520 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2522 # save the old relative_base_offset
2523 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2524 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2525 # restore the old relative_base_offset
2526 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2529 sub ParseTypePullFunction($$)
2531 my ($self, $e, $varname) = @_;
2534 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2536 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2540 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2541 $self->pidl("return NDR_ERR_SUCCESS;");
2547 sub ParseTypePrint($$$$)
2549 my ($self, $e, $ndr, $varname) = @_;
2551 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2554 sub ParseTypePrintFunction($$$)
2556 my ($self, $e, $varname) = @_;
2559 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2561 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2563 return if (has_property($e, "noprint"));
2565 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2568 $self->ParseTypePrint($e, $ndr, $varname);
2574 sub ParseTypeNdrSize($$)
2579 my $tf = $typefamily{$t->{TYPE}};
2580 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2582 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2586 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2592 #####################################################################
2593 # parse the interface definitions
2594 sub ParseInterface($$$)
2596 my($self,$interface,$needed) = @_;
2598 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2599 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2601 $self->pidl_hdr("");
2603 $self->HeaderInterface($interface, $needed);
2606 foreach my $d (@{$interface->{TYPES}}) {
2607 next unless(typeHasBody($d));
2609 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2610 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2611 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2613 # Make sure we don't generate a function twice...
2614 $needed->{TypeFunctionName("ndr_push", $d)} =
2615 $needed->{TypeFunctionName("ndr_pull", $d)} =
2616 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2618 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2622 foreach my $d (@{$interface->{FUNCTIONS}}) {
2623 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2624 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2625 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2627 # Make sure we don't generate a function twice...
2628 $needed->{"ndr_push_$d->{NAME}"} = $needed->{"ndr_pull_$d->{NAME}"} =
2629 $needed->{"ndr_print_$d->{NAME}"} = 0;
2632 $self->FunctionTable($interface);
2634 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2637 sub GenerateIncludes($)
2641 $self->pidl("#include \"includes.h\"");
2643 $self->pidl("#ifndef _GNU_SOURCE");
2644 $self->pidl("#define _GNU_SOURCE");
2645 $self->pidl("#endif");
2646 $self->pidl("#include <stdint.h>");
2647 $self->pidl("#include <stdlib.h>");
2648 $self->pidl("#include <stdio.h>");
2649 $self->pidl("#include <stdbool.h>");
2650 $self->pidl("#include <stdarg.h>");
2651 $self->pidl("#include <string.h>");
2655 #####################################################################
2656 # parse a parsed IDL structure back into an IDL file
2659 my($self, $ndr,$gen_header,$ndr_header) = @_;
2661 $self->pidl_hdr("/* header auto-generated by pidl */");
2662 $self->pidl_hdr("");
2663 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2664 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2665 $self->pidl_hdr("");
2667 $self->pidl("/* parser auto-generated by pidl */");
2669 $self->GenerateIncludes();
2670 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2676 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2680 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2681 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2682 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2685 return ($self->{res_hdr}, $self->{res});
2688 sub NeededElement($$$)
2690 my ($e, $dir, $needed) = @_;
2692 return if ($e->{TYPE} eq "EMPTY");
2694 return if (ref($e->{TYPE}) eq "HASH" and
2695 not defined($e->{TYPE}->{NAME}));
2698 if (ref($e->{TYPE}) eq "HASH") {
2699 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2704 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2705 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2707 $rt = $e->{REPRESENTATION_TYPE};
2710 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2713 if ($dir eq "print") {
2714 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2715 } elsif ($dir eq "pull") {
2716 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2717 push (@fn, "ndr_$t\_to_$rt")
2719 } elsif ($dir eq "push") {
2720 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2721 push (@fn, "ndr_$rt\_to_$t")
2724 die("invalid direction `$dir'");
2728 unless (defined($needed->{$_})) {
2734 sub NeededFunction($$)
2736 my ($fn,$needed) = @_;
2737 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
2738 $needed->{"ndr_push_$fn->{NAME}"} = 1;
2739 $needed->{"ndr_print_$fn->{NAME}"} = 1;
2740 foreach my $e (@{$fn->{ELEMENTS}}) {
2742 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
2748 sub NeededType($$$);
2749 my ($t,$needed,$req) = @_;
2751 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
2753 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
2754 return unless defined($t->{ELEMENTS});
2755 for my $e (@{$t->{ELEMENTS}}) {
2757 if (has_property($e, "compression")) {
2758 $needed->{"compression"} = 1;
2760 NeededElement($e, $req, $needed);
2761 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
2766 #####################################################################
2767 # work out what parse functions are needed
2768 sub NeededInterface($$)
2770 my ($interface,$needed) = @_;
2771 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
2772 foreach (reverse @{$interface->{TYPES}}) {
2773 if (has_property($_, "public")) {
2774 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
2775 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
2778 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
2779 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
2780 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
2781 if (has_property($_, "gensize")) {
2782 $needed->{"ndr_size_$_->{NAME}"} = 1;
2787 sub TypeFunctionName($$)
2789 my ($prefix, $t) = @_;
2791 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
2792 $t->{TYPE} eq "TYPEDEF");
2793 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
2794 return "$prefix\_$t";