Remove a bunch of "unused variable _relative_save_offset" warnings.
[Samba/vl.git] / pidl / lib / Parse / Pidl / Samba4 / NDR / Parser.pm
blobed86571aa20e4d39adbca39fc3e2a62741651dff
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;
10 require Exporter;
11 @ISA = qw(Exporter);
12 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
14 use strict;
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
16 use Parse::Pidl::Util qw(has_property ParseExpr ParseExprExt print_uuid unmake_str);
17 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
19 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
21 use Parse::Pidl qw(warning);
23 use vars qw($VERSION);
24 $VERSION = '0.01';
26 # list of known types
27 my %typefamily;
29 sub new($$) {
30 my ($class) = @_;
31 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
32 bless($self, $class);
35 sub get_typefamily($)
37 my $n = shift;
38 return $typefamily{$n};
41 sub append_prefix($$)
43 my ($e, $var_name) = @_;
44 my $pointers = 0;
45 my $arrays = 0;
47 foreach my $l (@{$e->{LEVELS}}) {
48 if ($l->{TYPE} eq "POINTER") {
49 $pointers++;
50 } elsif ($l->{TYPE} eq "ARRAY") {
51 $arrays++;
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);
64 return $var_name;
67 sub has_fast_array($$)
69 my ($e,$l) = @_;
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
86 sub pidl($$)
88 my ($self, $d) = @_;
89 if ($d) {
90 $self->{res} .= $self->{tabs};
91 $self->{res} .= $d;
93 $self->{res} .="\n";
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); }
107 sub defer($$)
109 my ($self, $d) = @_;
110 if ($d) {
111 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
115 ########################################
116 # add the deferred content to the current
117 # output
118 sub add_deferred($)
120 my ($self) = @_;
121 $self->pidl($_) foreach (@{$self->{deferred}});
122 $self->{deferred} = [];
123 $self->{defer_tabs} = "";
126 sub indent($)
128 my ($self) = @_;
129 $self->{tabs} .= "\t";
132 sub deindent($)
134 my ($self) = @_;
135 $self->{tabs} = substr($self->{tabs}, 0, -1);
138 #####################################################################
139 # declare a function public or static, depending on its attributes
140 sub fn_declare($$$$)
142 my ($self,$type,$fn,$decl) = @_;
144 if (has_property($fn, "no$type")) {
145 $self->pidl_hdr("$decl;");
146 return 0;
149 if (has_property($fn, "public")) {
150 $self->pidl_hdr("$decl;");
151 $self->pidl("_PUBLIC_ $decl");
152 } else {
153 $self->pidl("static $decl");
156 return 1;
159 ###################################################################
160 # setup any special flags for an element or structure
161 sub start_flags($$$)
163 my ($self, $e, $ndr) = @_;
164 my $flags = has_property($e, "flag");
165 if (defined $flags) {
166 $self->pidl("{");
167 $self->indent;
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
175 sub end_flags($$$)
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};");
181 $self->deindent;
182 $self->pidl("}");
186 #####################################################################
187 # parse the data of an array - push side
188 sub ParseArrayPushHeader($$$$$$)
190 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
192 my $size;
193 my $length;
195 if ($l->{IS_ZERO_TERMINATED}) {
196 if (has_property($e, "charset")) {
197 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
198 } else {
199 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
201 if (defined($l->{SIZE_IS})) {
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
204 if (defined($l->{LENGTH_IS})) {
205 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
207 } else {
208 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
209 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
212 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
213 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
216 if ($l->{IS_VARYING}) {
217 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));"); # array offset
218 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
221 return $length;
224 sub check_fully_dereferenced($$)
226 my ($element, $env) = @_;
228 return sub ($) {
229 my $origvar = shift;
230 my $check = 0;
232 # Figure out the number of pointers in $ptr
233 my $expandedvar = $origvar;
234 $expandedvar =~ s/^(\**)//;
235 my $ptr = $1;
237 my $var = undef;
238 foreach (keys %$env) {
239 if ($env->{$_} eq $expandedvar) {
240 $var = $_;
241 last;
245 return($origvar) unless (defined($var));
246 my $e;
247 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
248 if ($_->{NAME} eq $var) {
249 $e = $_;
250 last;
254 $e or die("Environment doesn't match siblings");
256 # See if pointer at pointer level $level
257 # needs to be checked.
258 my $nump = 0;
259 foreach (@{$e->{LEVELS}}) {
260 if ($_->{TYPE} eq "POINTER") {
261 $nump = $_->{POINTER_INDEX}+1;
264 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
265 return ($origvar);
269 sub check_null_pointer($$$$)
271 my ($element, $env, $print_fn, $return) = @_;
273 return sub ($) {
274 my $expandedvar = shift;
275 my $check = 0;
277 # Figure out the number of pointers in $ptr
278 $expandedvar =~ s/^(\**)//;
279 my $ptr = $1;
281 my $var = undef;
282 foreach (keys %$env) {
283 if ($env->{$_} eq $expandedvar) {
284 $var = $_;
285 last;
289 if (defined($var)) {
290 my $e;
291 # lookup ptr in $e
292 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
293 if ($_->{NAME} eq $var) {
294 $e = $_;
295 last;
299 $e or die("Environment doesn't match siblings");
301 # See if pointer at pointer level $level
302 # needs to be checked.
303 foreach my $l (@{$e->{LEVELS}}) {
304 if ($l->{TYPE} eq "POINTER" and
305 $l->{POINTER_INDEX} == length($ptr)) {
306 # No need to check ref pointers
307 $check = ($l->{POINTER_TYPE} ne "ref");
308 last;
311 if ($l->{TYPE} eq "DATA") {
312 warning($element, "too much dereferences for `$var'");
315 } else {
316 warning($element, "unknown dereferenced expression `$expandedvar'");
317 $check = 1;
320 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
324 sub ParseArrayPullGetSize($$$$$$)
326 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
328 my $size;
330 if ($l->{IS_CONFORMANT}) {
331 $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
332 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
333 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
334 } else {
335 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
336 check_null_pointer($e, $env, sub { $self->pidl(shift); },
337 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
338 check_fully_dereferenced($e, $env));
341 $self->pidl("size_$e->{NAME}_$l->{LEVEL_INDEX} = $size;");
342 my $array_size = "size_$e->{NAME}_$l->{LEVEL_INDEX}";
344 if (my $range = has_property($e, "range")) {
345 my ($low, $high) = split(/,/, $range, 2);
346 if ($low < 0) {
347 warning(0, "$low is invalid for the range of an array size");
349 if ($low == 0) {
350 $self->pidl("if ($array_size > $high) {");
351 } else {
352 $self->pidl("if ($array_size < $low || $array_size > $high) {");
354 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
355 $self->pidl("}");
358 return $array_size;
361 #####################################################################
362 # parse an array - pull side
363 sub ParseArrayPullGetLength($$$$$$;$)
365 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
367 if (not defined($array_size)) {
368 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
371 if (not $l->{IS_VARYING}) {
372 return $array_size;
375 my $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
376 $self->pidl("length_$e->{NAME}_$l->{LEVEL_INDEX} = $length;");
377 my $array_length = "length_$e->{NAME}_$l->{LEVEL_INDEX}";
379 if (my $range = has_property($e, "range")) {
380 my ($low, $high) = split(/,/, $range, 2);
381 if ($low < 0) {
382 warning(0, "$low is invalid for the range of an array size");
384 if ($low == 0) {
385 $self->pidl("if ($array_length > $high) {");
386 } else {
387 $self->pidl("if ($array_length < $low || $array_length > $high) {");
389 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
390 $self->pidl("}");
393 return $array_length;
396 #####################################################################
397 # parse an array - pull side
398 sub ParseArrayPullHeader($$$$$$)
400 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
402 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
403 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
406 if ($l->{IS_VARYING}) {
407 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
410 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
411 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
413 if ($array_length ne $array_size) {
414 $self->pidl("if ($array_length > $array_size) {");
415 $self->indent;
416 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
417 $self->deindent;
418 $self->pidl("}");
421 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
422 $self->defer("if ($var_name) {");
423 $self->defer_indent;
424 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
425 check_null_pointer($e, $env, sub { $self->defer(shift); },
426 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
427 check_fully_dereferenced($e, $env));
428 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
429 $self->defer_deindent;
430 $self->defer("}");
433 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
434 $self->defer("if ($var_name) {");
435 $self->defer_indent;
436 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
437 check_null_pointer($e, $env, sub { $self->defer(shift); },
438 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
439 check_fully_dereferenced($e, $env));
440 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
441 $self->defer_deindent;
442 $self->defer("}");
445 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
446 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
449 return $array_length;
452 sub compression_alg($$)
454 my ($e, $l) = @_;
455 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
457 return $alg;
460 sub compression_clen($$$)
462 my ($e, $l, $env) = @_;
463 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
465 return ParseExpr($clen, $env, $e->{ORIGINAL});
468 sub compression_dlen($$$)
470 my ($e,$l,$env) = @_;
471 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
473 return ParseExpr($dlen, $env, $e->{ORIGINAL});
476 sub ParseCompressionPushStart($$$$$)
478 my ($self,$e,$l,$ndr,$env) = @_;
479 my $comndr = "$ndr\_compressed";
480 my $alg = compression_alg($e, $l);
481 my $dlen = compression_dlen($e, $l, $env);
483 $self->pidl("{");
484 $self->indent;
485 $self->pidl("struct ndr_push *$comndr;");
486 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
488 return $comndr;
491 sub ParseCompressionPushEnd($$$$$)
493 my ($self,$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 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
499 $self->deindent;
500 $self->pidl("}");
503 sub ParseCompressionPullStart($$$$$)
505 my ($self,$e,$l,$ndr,$env) = @_;
506 my $comndr = "$ndr\_compressed";
507 my $alg = compression_alg($e, $l);
508 my $dlen = compression_dlen($e, $l, $env);
510 $self->pidl("{");
511 $self->indent;
512 $self->pidl("struct ndr_pull *$comndr;");
513 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
515 return $comndr;
518 sub ParseCompressionPullEnd($$$$$)
520 my ($self,$e,$l,$ndr,$env) = @_;
521 my $comndr = "$ndr\_compressed";
522 my $alg = compression_alg($e, $l);
523 my $dlen = compression_dlen($e, $l, $env);
525 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
526 $self->deindent;
527 $self->pidl("}");
530 sub ParseSubcontextPushStart($$$$$)
532 my ($self,$e,$l,$ndr,$env) = @_;
533 my $subndr = "_ndr_$e->{NAME}";
534 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
536 $self->pidl("{");
537 $self->indent;
538 $self->pidl("struct ndr_push *$subndr;");
539 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
541 if (defined $l->{COMPRESSION}) {
542 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
545 return $subndr;
548 sub ParseSubcontextPushEnd($$$$$)
550 my ($self,$e,$l,$ndr,$env) = @_;
551 my $subndr = "_ndr_$e->{NAME}";
552 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
554 if (defined $l->{COMPRESSION}) {
555 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
558 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
559 $self->deindent;
560 $self->pidl("}");
563 sub ParseSubcontextPullStart($$$$$)
565 my ($self,$e,$l,$ndr,$env) = @_;
566 my $subndr = "_ndr_$e->{NAME}";
567 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
569 $self->pidl("{");
570 $self->indent;
571 $self->pidl("struct ndr_pull *$subndr;");
572 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
574 if (defined $l->{COMPRESSION}) {
575 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
578 return $subndr;
581 sub ParseSubcontextPullEnd($$$$$)
583 my ($self,$e,$l,$ndr,$env) = @_;
584 my $subndr = "_ndr_$e->{NAME}";
585 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
587 if (defined $l->{COMPRESSION}) {
588 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
591 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
592 $self->deindent;
593 $self->pidl("}");
596 sub ParseElementPushLevel
598 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
600 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
602 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
603 $var_name = get_pointer_to($var_name);
606 if (defined($ndr_flags)) {
607 if ($l->{TYPE} eq "SUBCONTEXT") {
608 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
609 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
610 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
611 } elsif ($l->{TYPE} eq "POINTER") {
612 $self->ParsePtrPush($e, $l, $ndr, $var_name);
613 } elsif ($l->{TYPE} eq "ARRAY") {
614 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
616 my $nl = GetNextLevel($e, $l);
618 # Allow speedups for arrays of scalar types
619 if (is_charset_array($e,$l)) {
620 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
621 return;
622 } elsif (has_fast_array($e,$l)) {
623 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
624 return;
626 } elsif ($l->{TYPE} eq "SWITCH") {
627 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
628 } elsif ($l->{TYPE} eq "DATA") {
629 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
630 } elsif ($l->{TYPE} eq "TYPEDEF") {
631 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
635 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
636 $self->pidl("/* [ignore] '$e->{NAME}' */");
637 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
638 my $rel_var_name = $var_name;
639 if ($l->{POINTER_TYPE} ne "ref") {
640 $self->pidl("if ($var_name) {");
641 $self->indent;
642 if ($l->{POINTER_TYPE} eq "relative") {
643 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
645 if ($l->{POINTER_TYPE} eq "relative_short") {
646 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
649 $var_name = get_value_of($var_name);
650 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
652 if ($l->{POINTER_TYPE} ne "ref") {
653 if ($l->{POINTER_TYPE} eq "relative") {
654 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
656 $self->deindent;
657 $self->pidl("}");
659 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
660 not is_charset_array($e, $l)) {
661 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
662 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
664 my $array_pointless = ($length eq "0");
666 if ($array_pointless) {
667 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
670 $var_name = get_array_element($var_name, $counter);
672 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
673 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
674 $self->indent;
675 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
676 $self->deindent;
677 $self->pidl("}");
680 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
681 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
682 $self->indent;
683 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
684 $self->deindent;
685 $self->pidl("}");
687 } elsif ($l->{TYPE} eq "SWITCH") {
688 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
692 #####################################################################
693 # parse scalars in a structure element
694 sub ParseElementPush($$$$$$)
696 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
697 my $subndr = undef;
699 my $var_name = $env->{$e->{NAME}};
701 return if ContainsPipe($e, $e->{LEVELS}[0]);
703 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
705 # Representation type is different from transmit_as
706 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
707 $self->pidl("{");
708 $self->indent;
709 my $transmit_name = "_transmit_$e->{NAME}";
710 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
711 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
712 $var_name = $transmit_name;
715 $var_name = append_prefix($e, $var_name);
717 $self->start_flags($e, $ndr);
719 if (defined(my $value = has_property($e, "value"))) {
720 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
723 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
725 $self->end_flags($e, $ndr);
727 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
728 $self->deindent;
729 $self->pidl("}");
733 #####################################################################
734 # parse a pointer in a struct element or function
735 sub ParsePtrPush($$$$$)
737 my ($self,$e,$l,$ndr,$var_name) = @_;
739 if ($l->{POINTER_TYPE} eq "ref") {
740 $self->pidl("if ($var_name == NULL) {");
741 $self->indent;
742 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
743 $self->deindent;
744 $self->pidl("}");
745 if ($l->{LEVEL} eq "EMBEDDED") {
746 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
748 } elsif ($l->{POINTER_TYPE} eq "relative") {
749 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
750 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
751 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
752 } elsif ($l->{POINTER_TYPE} eq "unique") {
753 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
754 } elsif ($l->{POINTER_TYPE} eq "full") {
755 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
756 } elsif ($l->{POINTER_TYPE} eq "ignore") {
757 # We don't want this pointer to appear on the wire at all
758 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
759 } else {
760 die("Unhandled pointer type $l->{POINTER_TYPE}");
764 sub need_pointer_to($$$)
766 my ($e, $l, $scalar_only) = @_;
768 my $t;
769 if (ref($l->{DATA_TYPE})) {
770 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
771 } else {
772 $t = $l->{DATA_TYPE};
775 if (not Parse::Pidl::Typelist::is_scalar($t)) {
776 return 1 if $scalar_only;
779 my $arrays = 0;
781 foreach my $tl (@{$e->{LEVELS}}) {
782 last if $l == $tl;
783 if ($tl->{TYPE} eq "ARRAY") {
784 $arrays++;
788 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
789 return 1 unless $arrays;
792 return 0;
795 sub ParseDataPrint($$$$$)
797 my ($self, $e, $l, $ndr, $var_name) = @_;
799 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
801 if (need_pointer_to($e, $l, 1)) {
802 $var_name = get_pointer_to($var_name);
805 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
806 } else {
807 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
811 #####################################################################
812 # print scalars in a structure element
813 sub ParseElementPrint($$$$$)
815 my($self, $e, $ndr, $var_name, $env) = @_;
817 return if (has_property($e, "noprint"));
818 my $cur_depth = 0;
819 my $ignore_depth = 0xFFFF;
821 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
822 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
823 return;
826 $var_name = append_prefix($e, $var_name);
828 if (defined(my $value = has_property($e, "value"))) {
829 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
832 foreach my $l (@{$e->{LEVELS}}) {
833 $cur_depth += 1;
835 if ($cur_depth > $ignore_depth) {
836 next;
839 if ($l->{TYPE} eq "POINTER") {
840 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
841 if ($l->{POINTER_TYPE} eq "ignore") {
842 $self->pidl("/* [ignore] '$e->{NAME}' */");
843 $ignore_depth = $cur_depth;
844 last;
846 $self->pidl("$ndr->depth++;");
847 if ($l->{POINTER_TYPE} ne "ref") {
848 $self->pidl("if ($var_name) {");
849 $self->indent;
851 $var_name = get_value_of($var_name);
852 } elsif ($l->{TYPE} eq "ARRAY") {
853 my $length;
855 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
856 $var_name = get_pointer_to($var_name);
859 if ($l->{IS_ZERO_TERMINATED} and not defined($l->{LENGTH_IS})) {
860 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
861 } else {
862 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
863 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
866 if (is_charset_array($e,$l)) {
867 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
868 last;
869 } elsif (has_fast_array($e, $l)) {
870 my $nl = GetNextLevel($e, $l);
871 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
872 last;
873 } else {
874 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
876 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
877 $self->pidl("$ndr->depth++;");
878 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
879 $self->indent;
881 $var_name = get_array_element($var_name, $counter);
883 } elsif ($l->{TYPE} eq "DATA") {
884 $self->ParseDataPrint($e, $l, $ndr, $var_name);
885 } elsif ($l->{TYPE} eq "SWITCH") {
886 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
887 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
888 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
892 foreach my $l (reverse @{$e->{LEVELS}}) {
893 $cur_depth -= 1;
895 if ($cur_depth > $ignore_depth) {
896 next;
899 if ($l->{TYPE} eq "POINTER") {
900 if ($l->{POINTER_TYPE} eq "ignore") {
901 next;
904 if ($l->{POINTER_TYPE} ne "ref") {
905 $self->deindent;
906 $self->pidl("}");
908 $self->pidl("$ndr->depth--;");
909 } elsif (($l->{TYPE} eq "ARRAY")
910 and not is_charset_array($e,$l)
911 and not has_fast_array($e,$l)) {
912 $self->deindent;
913 $self->pidl("}");
914 $self->pidl("$ndr->depth--;");
919 #####################################################################
920 # parse scalars in a structure element - pull size
921 sub ParseSwitchPull($$$$$$)
923 my($self,$e,$l,$ndr,$var_name,$env) = @_;
924 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
925 check_null_pointer($e, $env, sub { $self->pidl(shift); },
926 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
927 check_fully_dereferenced($e, $env));
929 $var_name = get_pointer_to($var_name);
930 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
933 #####################################################################
934 # push switch element
935 sub ParseSwitchPush($$$$$$)
937 my($self,$e,$l,$ndr,$var_name,$env) = @_;
938 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
939 check_null_pointer($e, $env, sub { $self->pidl(shift); },
940 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
941 check_fully_dereferenced($e, $env));
943 $var_name = get_pointer_to($var_name);
944 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
947 sub ParseDataPull($$$$$$$)
949 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
951 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
953 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
955 if (need_pointer_to($e, $l, 0)) {
956 $var_name = get_pointer_to($var_name);
959 $var_name = get_pointer_to($var_name);
961 if (has_property($e, "skip")) {
962 $self->pidl("/* [skip] '$var_name' */");
963 } else {
964 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
967 my $pl = GetPrevLevel($e, $l);
969 my $range = has_property($e, "range");
970 if ($range and $pl->{TYPE} ne "ARRAY") {
971 $var_name = get_value_of($var_name);
972 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
973 my ($low, $high) = split(/,/, $range, 2);
974 if ($low < 0 and not $signed) {
975 warning(0, "$low is invalid for the range of an unsigned type");
977 if ($low == 0 and not $signed) {
978 $self->pidl("if ($var_name > $high) {");
979 } else {
980 $self->pidl("if ($var_name < $low || $var_name > $high) {");
982 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
983 $self->pidl("}");
985 } else {
986 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
990 sub ParseDataPush($$$$$$$)
992 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
994 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
996 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
998 # strings are passed by value rather than reference
999 if (need_pointer_to($e, $l, 1)) {
1000 $var_name = get_pointer_to($var_name);
1003 if (has_property($e, "skip")) {
1004 $self->pidl("/* [skip] '$var_name' */");
1005 } else {
1006 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
1008 } else {
1009 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1013 sub CalcNdrFlags($$$)
1015 my ($l,$primitives,$deferred) = @_;
1017 my $scalars = 0;
1018 my $buffers = 0;
1020 # Add NDR_SCALARS if this one is deferred
1021 # and deferreds may be pushed
1022 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
1024 # Add NDR_SCALARS if this one is not deferred and
1025 # primitives may be pushed
1026 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
1028 # Add NDR_BUFFERS if this one contains deferred stuff
1029 # and deferreds may be pushed
1030 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
1032 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
1033 return "NDR_SCALARS" if ($scalars);
1034 return "NDR_BUFFERS" if ($buffers);
1035 return undef;
1038 sub ParseMemCtxPullFlags($$$$)
1040 my ($self, $e, $l) = @_;
1042 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1043 return undef if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore"));
1045 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1046 return undef if has_fast_array($e, $l);
1047 return undef if is_charset_array($e, $l);
1049 my $mem_flags = "0";
1051 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1052 my $nl = GetNextLevel($e, $l);
1053 return undef if ($nl->{TYPE} eq "PIPE");
1054 return undef if ($nl->{TYPE} eq "ARRAY");
1055 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1057 if ($l->{LEVEL} eq "TOP") {
1058 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1062 return $mem_flags;
1065 sub ParseMemCtxPullStart($$$$$)
1067 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1069 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1070 my $mem_c_ctx = $ptr_name;
1071 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1073 return unless defined($mem_c_flags);
1075 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1076 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1079 sub ParseMemCtxPullEnd($$$$)
1081 my ($self, $e, $l, $ndr) = @_;
1083 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1084 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1086 return unless defined($mem_r_flags);
1088 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1091 sub CheckStringTerminator($$$$$)
1093 my ($self,$ndr,$e,$l,$length) = @_;
1094 my $nl = GetNextLevel($e, $l);
1096 # Make sure last element is zero!
1097 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1100 sub ParseElementPullLevel
1102 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1104 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1105 my $array_length = undef;
1107 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1108 $var_name = get_pointer_to($var_name);
1111 # Only pull something if there's actually something to be pulled
1112 if (defined($ndr_flags)) {
1113 if ($l->{TYPE} eq "SUBCONTEXT") {
1114 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1115 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1116 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1117 } elsif ($l->{TYPE} eq "ARRAY") {
1118 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1119 $array_length = $length;
1121 my $nl = GetNextLevel($e, $l);
1123 if (is_charset_array($e,$l)) {
1124 if ($l->{IS_ZERO_TERMINATED}) {
1125 $self->CheckStringTerminator($ndr, $e, $l, $length);
1127 if ($l->{IS_TO_NULL}) {
1128 $self->pidl("NDR_CHECK(ndr_pull_charset_to_null($ndr, $ndr_flags, ".get_pointer_to($var_name).", $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
1129 } else {
1130 $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}));");
1132 return;
1133 } elsif (has_fast_array($e, $l)) {
1134 if ($l->{IS_ZERO_TERMINATED}) {
1135 $self->CheckStringTerminator($ndr,$e,$l,$length);
1137 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1138 return;
1140 } elsif ($l->{TYPE} eq "POINTER") {
1141 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1142 } elsif ($l->{TYPE} eq "SWITCH") {
1143 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1144 } elsif ($l->{TYPE} eq "DATA") {
1145 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1146 } elsif ($l->{TYPE} eq "TYPEDEF") {
1147 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1151 # add additional constructions
1152 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
1153 $self->pidl("/* [ignore] '$e->{NAME}' */");
1154 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
1155 if ($l->{POINTER_TYPE} ne "ref") {
1156 $self->pidl("if ($var_name) {");
1157 $self->indent;
1159 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1160 if ($l->{POINTER_TYPE} eq "relative") {
1161 $self->pidl("uint32_t _relative_save_offset;");
1162 $self->pidl("_relative_save_offset = $ndr->offset;");
1164 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1168 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1170 $var_name = get_value_of($var_name);
1171 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1173 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1175 if ($l->{POINTER_TYPE} ne "ref") {
1176 if ($l->{POINTER_TYPE} eq "relative") {
1177 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1178 $self->indent;
1179 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1180 $self->deindent;
1181 $self->pidl("}");
1182 $self->pidl("$ndr->offset = _relative_save_offset;");
1184 $self->deindent;
1185 $self->pidl("}");
1187 } elsif ($l->{TYPE} eq "ARRAY" and
1188 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1189 my $length = $array_length;
1190 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1191 my $array_name = $var_name;
1193 if (not defined($length)) {
1194 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1197 $var_name = get_array_element($var_name, $counter);
1199 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1201 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1202 my $nl = GetNextLevel($e,$l);
1204 if ($l->{IS_ZERO_TERMINATED}) {
1205 $self->CheckStringTerminator($ndr,$e,$l,$length);
1208 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1209 $self->indent;
1210 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1211 $self->deindent;
1212 $self->pidl("}");
1215 if ($deferred and ContainsDeferred($e, $l)) {
1216 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1217 $self->indent;
1218 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1219 $self->deindent;
1220 $self->pidl("}");
1223 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1225 } elsif ($l->{TYPE} eq "SWITCH") {
1226 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1230 #####################################################################
1231 # parse scalars in a structure element - pull size
1232 sub ParseElementPull($$$$$$)
1234 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1236 my $var_name = $env->{$e->{NAME}};
1237 my $represent_name;
1238 my $transmit_name;
1240 return if ContainsPipe($e, $e->{LEVELS}[0]);
1242 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1244 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1245 $self->pidl("{");
1246 $self->indent;
1247 $represent_name = $var_name;
1248 $transmit_name = "_transmit_$e->{NAME}";
1249 $var_name = $transmit_name;
1250 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1253 $var_name = append_prefix($e, $var_name);
1255 $self->start_flags($e, $ndr);
1257 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1259 $self->end_flags($e, $ndr);
1261 # Representation type is different from transmit_as
1262 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1263 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1264 $self->deindent;
1265 $self->pidl("}");
1269 #####################################################################
1270 # parse a pointer in a struct element or function
1271 sub ParsePtrPull($$$$$)
1273 my($self, $e,$l,$ndr,$var_name) = @_;
1275 my $nl = GetNextLevel($e, $l);
1276 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1277 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1278 ($nl->{DATA_TYPE} eq "string"));
1280 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1282 if (!$next_is_array and !$next_is_string) {
1283 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1284 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1285 $self->pidl("}");
1288 return;
1289 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1290 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1291 } elsif (($l->{POINTER_TYPE} eq "unique") or
1292 ($l->{POINTER_TYPE} eq "relative") or
1293 ($l->{POINTER_TYPE} eq "full")) {
1294 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1295 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1296 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1297 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1298 #We want to consume the pointer bytes, but ignore the pointer value
1299 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1300 $self->pidl("_ptr_$e->{NAME} = 0;");
1301 } else {
1302 die("Unhandled pointer type $l->{POINTER_TYPE}");
1305 $self->pidl("if (_ptr_$e->{NAME}) {");
1306 $self->indent;
1308 if ($l->{POINTER_TYPE} eq "ignore") {
1309 # Don't do anything, we don't want to do the
1310 # allocation, as we forced it to NULL just above, and
1311 # we may not know the declared type anyway.
1312 } else {
1313 # Don't do this for arrays, they're allocated at the actual level
1314 # of the array
1315 unless ($next_is_array or $next_is_string) {
1316 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1317 } else {
1318 # FIXME: Yes, this is nasty.
1319 # We allocate an array twice
1320 # - once just to indicate that it's there,
1321 # - then the real allocation...
1322 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1326 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1327 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1328 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1330 $self->deindent;
1331 $self->pidl("} else {");
1332 $self->pidl("\t$var_name = NULL;");
1333 $self->pidl("}");
1336 sub ParseStructPushPrimitives($$$$$)
1338 my ($self, $struct, $ndr, $varname, $env) = @_;
1340 # see if the structure contains a conformant array. If it
1341 # does, then it must be the last element of the structure, and
1342 # we need to push the conformant length early, as it fits on
1343 # the wire before the structure (and even before the structure
1344 # alignment)
1345 if (defined($struct->{SURROUNDING_ELEMENT})) {
1346 my $e = $struct->{SURROUNDING_ELEMENT};
1348 if (defined($e->{LEVELS}[0]) and
1349 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1350 my $size;
1352 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1353 if (has_property($e, "charset")) {
1354 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1355 } else {
1356 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1358 if (defined($e->{LEVELS}[0]->{SIZE_IS})) {
1359 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1361 } else {
1362 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1365 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1366 } else {
1367 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1371 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1373 if (defined($struct->{PROPERTIES}{relative_base})) {
1374 # set the current offset as base for relative pointers
1375 # and store it based on the toplevel struct/union
1376 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1379 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1381 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1384 sub ParseStructPushDeferred($$$$)
1386 my ($self, $struct, $ndr, $varname, $env) = @_;
1387 if (defined($struct->{PROPERTIES}{relative_base})) {
1388 # retrieve the current offset as base for relative pointers
1389 # based on the toplevel struct/union
1390 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1392 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1395 #####################################################################
1396 # parse a struct
1397 sub ParseStructPush($$$$)
1399 my ($self, $struct, $ndr, $varname) = @_;
1401 return unless defined($struct->{ELEMENTS});
1403 my $env = GenerateStructEnv($struct, $varname);
1405 EnvSubstituteValue($env, $struct);
1407 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1409 $self->start_flags($struct, $ndr);
1411 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1412 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1413 $self->indent;
1414 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1415 $self->deindent;
1416 $self->pidl("}");
1418 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1419 $self->indent;
1420 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1421 $self->deindent;
1422 $self->pidl("}");
1424 $self->end_flags($struct, $ndr);
1427 #####################################################################
1428 # generate a push function for an enum
1429 sub ParseEnumPush($$$$)
1431 my($self,$enum,$ndr,$varname) = @_;
1432 my($type_fn) = $enum->{BASE_TYPE};
1434 $self->start_flags($enum, $ndr);
1435 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1436 $self->end_flags($enum, $ndr);
1439 #####################################################################
1440 # generate a pull function for an enum
1441 sub ParseEnumPull($$$$)
1443 my($self,$enum,$ndr,$varname) = @_;
1444 my($type_fn) = $enum->{BASE_TYPE};
1445 my($type_v_decl) = mapTypeName($type_fn);
1447 $self->pidl("$type_v_decl v;");
1448 $self->start_flags($enum, $ndr);
1449 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1450 $self->pidl("*$varname = v;");
1452 $self->end_flags($enum, $ndr);
1455 #####################################################################
1456 # generate a print function for an enum
1457 sub ParseEnumPrint($$$$$)
1459 my($self,$enum,$ndr,$name,$varname) = @_;
1461 $self->pidl("const char *val = NULL;");
1462 $self->pidl("");
1464 $self->start_flags($enum, $ndr);
1466 $self->pidl("switch ($varname) {");
1467 $self->indent;
1468 my $els = \@{$enum->{ELEMENTS}};
1469 foreach my $i (0 .. $#{$els}) {
1470 my $e = ${$els}[$i];
1471 chomp $e;
1472 if ($e =~ /^(.*)=/) {
1473 $e = $1;
1475 $self->pidl("case $e: val = \"$e\"; break;");
1478 $self->deindent;
1479 $self->pidl("}");
1481 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1483 $self->end_flags($enum, $ndr);
1486 sub DeclEnum($$$$)
1488 my ($e,$t,$name,$varname) = @_;
1489 return "enum $name " .
1490 ($t eq "pull"?"*":"") . $varname;
1493 $typefamily{ENUM} = {
1494 DECL => \&DeclEnum,
1495 PUSH_FN_BODY => \&ParseEnumPush,
1496 PULL_FN_BODY => \&ParseEnumPull,
1497 PRINT_FN_BODY => \&ParseEnumPrint,
1500 #####################################################################
1501 # generate a push function for a bitmap
1502 sub ParseBitmapPush($$$$)
1504 my($self,$bitmap,$ndr,$varname) = @_;
1505 my($type_fn) = $bitmap->{BASE_TYPE};
1507 $self->start_flags($bitmap, $ndr);
1509 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1511 $self->end_flags($bitmap, $ndr);
1514 #####################################################################
1515 # generate a pull function for an bitmap
1516 sub ParseBitmapPull($$$$)
1518 my($self,$bitmap,$ndr,$varname) = @_;
1519 my $type_fn = $bitmap->{BASE_TYPE};
1520 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1522 $self->pidl("$type_decl v;");
1523 $self->start_flags($bitmap, $ndr);
1524 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1525 $self->pidl("*$varname = v;");
1527 $self->end_flags($bitmap, $ndr);
1530 #####################################################################
1531 # generate a print function for an bitmap
1532 sub ParseBitmapPrintElement($$$$$$)
1534 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1535 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1536 my($type_fn) = $bitmap->{BASE_TYPE};
1537 my($flag);
1539 if ($e =~ /^(\w+) .*$/) {
1540 $flag = "$1";
1541 } else {
1542 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1545 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1548 #####################################################################
1549 # generate a print function for an bitmap
1550 sub ParseBitmapPrint($$$$$)
1552 my($self,$bitmap,$ndr,$name,$varname) = @_;
1553 my($type_decl) = mapTypeName($bitmap->{TYPE});
1554 my($type_fn) = $bitmap->{BASE_TYPE};
1556 $self->start_flags($bitmap, $ndr);
1558 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1560 $self->pidl("$ndr->depth++;");
1561 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1562 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1564 $self->pidl("$ndr->depth--;");
1566 $self->end_flags($bitmap, $ndr);
1569 sub DeclBitmap($$$$)
1571 my ($e,$t,$name,$varname) = @_;
1572 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1573 ($t eq "pull"?" *":" ") . $varname;
1576 $typefamily{BITMAP} = {
1577 DECL => \&DeclBitmap,
1578 PUSH_FN_BODY => \&ParseBitmapPush,
1579 PULL_FN_BODY => \&ParseBitmapPull,
1580 PRINT_FN_BODY => \&ParseBitmapPrint,
1583 #####################################################################
1584 # generate a struct print function
1585 sub ParseStructPrint($$$$$)
1587 my($self,$struct,$ndr,$name,$varname) = @_;
1589 return unless defined $struct->{ELEMENTS};
1591 my $env = GenerateStructEnv($struct, $varname);
1593 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1595 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1596 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1598 $self->start_flags($struct, $ndr);
1600 $self->pidl("$ndr->depth++;");
1602 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1603 foreach (@{$struct->{ELEMENTS}});
1604 $self->pidl("$ndr->depth--;");
1606 $self->end_flags($struct, $ndr);
1609 sub DeclarePtrVariables($$)
1611 my ($self,$e) = @_;
1612 foreach my $l (@{$e->{LEVELS}}) {
1613 my $size = 32;
1614 if ($l->{TYPE} eq "POINTER" and
1615 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1616 if ($l->{POINTER_TYPE} eq "relative_short") {
1617 $size = 16;
1619 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1620 last;
1625 sub DeclareArrayVariables($$;$)
1627 my ($self,$e,$pull) = @_;
1629 foreach my $l (@{$e->{LEVELS}}) {
1630 next if ($l->{TYPE} ne "ARRAY");
1631 if (defined($pull)) {
1632 $self->pidl("uint32_t size_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1633 if ($l->{IS_VARYING}) {
1634 $self->pidl("uint32_t length_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1637 next if has_fast_array($e,$l);
1638 next if is_charset_array($e,$l);
1639 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1643 sub DeclareArrayVariablesNoZero($$$)
1645 my ($self,$e,$env) = @_;
1647 foreach my $l (@{$e->{LEVELS}}) {
1648 next if ($l->{TYPE} ne "ARRAY");
1649 next if has_fast_array($e,$l);
1650 next if is_charset_array($e,$l);
1651 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1652 if ($length eq "0") {
1653 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1654 } else {
1655 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1660 sub DeclareMemCtxVariables($$)
1662 my ($self,$e) = @_;
1663 foreach my $l (@{$e->{LEVELS}}) {
1664 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1666 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore")) {
1667 last;
1670 if (defined($mem_flags)) {
1671 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1676 sub ParseStructPullPrimitives($$$$$)
1678 my($self,$struct,$ndr,$varname,$env) = @_;
1680 if (defined $struct->{SURROUNDING_ELEMENT}) {
1681 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1684 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1686 if (defined($struct->{PROPERTIES}{relative_base})) {
1687 # set the current offset as base for relative pointers
1688 # and store it based on the toplevel struct/union
1689 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1692 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1694 $self->add_deferred();
1696 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1699 sub ParseStructPullDeferred($$$$$)
1701 my ($self,$struct,$ndr,$varname,$env) = @_;
1703 if (defined($struct->{PROPERTIES}{relative_base})) {
1704 # retrieve the current offset as base for relative pointers
1705 # based on the toplevel struct/union
1706 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1708 foreach my $e (@{$struct->{ELEMENTS}}) {
1709 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1712 $self->add_deferred();
1715 #####################################################################
1716 # parse a struct - pull side
1717 sub ParseStructPull($$$$)
1719 my($self,$struct,$ndr,$varname) = @_;
1721 return unless defined $struct->{ELEMENTS};
1723 # declare any internal pointers we need
1724 foreach my $e (@{$struct->{ELEMENTS}}) {
1725 $self->DeclarePtrVariables($e);
1726 $self->DeclareArrayVariables($e, "pull");
1727 $self->DeclareMemCtxVariables($e);
1730 $self->start_flags($struct, $ndr);
1732 my $env = GenerateStructEnv($struct, $varname);
1734 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
1735 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1736 $self->indent;
1737 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1738 $self->deindent;
1739 $self->pidl("}");
1740 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1741 $self->indent;
1742 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1743 $self->deindent;
1744 $self->pidl("}");
1746 $self->end_flags($struct, $ndr);
1749 #####################################################################
1750 # calculate size of ndr struct
1751 sub ParseStructNdrSize($$$$)
1753 my ($self,$t, $name, $varname) = @_;
1754 my $sizevar;
1756 if (my $flags = has_property($t, "flag")) {
1757 $self->pidl("flags |= $flags;");
1759 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1762 sub DeclStruct($$$$)
1764 my ($e,$t,$name,$varname) = @_;
1765 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1768 sub ArgsStructNdrSize($$$)
1770 my ($d, $name, $varname) = @_;
1771 return "const struct $name *$varname, int flags";
1774 $typefamily{STRUCT} = {
1775 PUSH_FN_BODY => \&ParseStructPush,
1776 DECL => \&DeclStruct,
1777 PULL_FN_BODY => \&ParseStructPull,
1778 PRINT_FN_BODY => \&ParseStructPrint,
1779 SIZE_FN_BODY => \&ParseStructNdrSize,
1780 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1783 #####################################################################
1784 # calculate size of ndr struct
1785 sub ParseUnionNdrSize($$$)
1787 my ($self, $t, $name, $varname) = @_;
1788 my $sizevar;
1790 if (my $flags = has_property($t, "flag")) {
1791 $self->pidl("flags |= $flags;");
1794 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1797 sub ParseUnionPushPrimitives($$$$)
1799 my ($self, $e, $ndr ,$varname) = @_;
1801 my $have_default = 0;
1803 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1805 if (defined($e->{SWITCH_TYPE})) {
1806 if (defined($e->{ALIGN})) {
1807 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1810 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1813 if (defined($e->{ALIGN})) {
1814 if ($e->{IS_MS_UNION}) {
1815 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1816 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1817 } else {
1818 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1822 $self->pidl("switch (level) {");
1823 $self->indent;
1824 foreach my $el (@{$e->{ELEMENTS}}) {
1825 if ($el->{CASE} eq "default") {
1826 $have_default = 1;
1828 $self->pidl("$el->{CASE}: {");
1830 if ($el->{TYPE} ne "EMPTY") {
1831 $self->indent;
1832 if (defined($e->{PROPERTIES}{relative_base})) {
1833 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1834 # set the current offset as base for relative pointers
1835 # and store it based on the toplevel struct/union
1836 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1838 $self->DeclareArrayVariables($el);
1839 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1840 $self->deindent;
1842 $self->pidl("break; }");
1843 $self->pidl("");
1845 if (! $have_default) {
1846 $self->pidl("default:");
1847 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1849 $self->deindent;
1850 $self->pidl("}");
1853 sub ParseUnionPushDeferred($$$$)
1855 my ($self,$e,$ndr,$varname) = @_;
1857 my $have_default = 0;
1859 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1860 if (defined($e->{PROPERTIES}{relative_base})) {
1861 # retrieve the current offset as base for relative pointers
1862 # based on the toplevel struct/union
1863 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1865 $self->pidl("switch (level) {");
1866 $self->indent;
1867 foreach my $el (@{$e->{ELEMENTS}}) {
1868 if ($el->{CASE} eq "default") {
1869 $have_default = 1;
1872 $self->pidl("$el->{CASE}:");
1873 if ($el->{TYPE} ne "EMPTY") {
1874 $self->indent;
1875 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1876 $self->deindent;
1878 $self->pidl("break;");
1879 $self->pidl("");
1881 if (! $have_default) {
1882 $self->pidl("default:");
1883 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1885 $self->deindent;
1886 $self->pidl("}");
1889 #####################################################################
1890 # parse a union - push side
1891 sub ParseUnionPush($$$$)
1893 my ($self,$e,$ndr,$varname) = @_;
1894 my $have_default = 0;
1896 $self->start_flags($e, $ndr);
1898 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1899 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1900 $self->indent;
1901 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1902 $self->deindent;
1903 $self->pidl("}");
1904 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1905 $self->indent;
1906 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1907 $self->deindent;
1908 $self->pidl("}");
1909 $self->end_flags($e, $ndr);
1912 #####################################################################
1913 # print a union
1914 sub ParseUnionPrint($$$$$)
1916 my ($self,$e,$ndr,$name,$varname) = @_;
1917 my $have_default = 0;
1919 $self->pidl("uint32_t level;");
1920 foreach my $el (@{$e->{ELEMENTS}}) {
1921 $self->DeclareArrayVariables($el);
1924 $self->start_flags($e, $ndr);
1926 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1928 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1930 $self->pidl("switch (level) {");
1931 $self->indent;
1932 foreach my $el (@{$e->{ELEMENTS}}) {
1933 if ($el->{CASE} eq "default") {
1934 $have_default = 1;
1936 $self->pidl("$el->{CASE}:");
1937 if ($el->{TYPE} ne "EMPTY") {
1938 $self->indent;
1939 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1940 $self->deindent;
1942 $self->pidl("break;");
1943 $self->pidl("");
1945 if (! $have_default) {
1946 $self->pidl("default:");
1947 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1949 $self->deindent;
1950 $self->pidl("}");
1952 $self->end_flags($e, $ndr);
1955 sub ParseUnionPullPrimitives($$$$$)
1957 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1958 my $have_default = 0;
1961 if (defined($switch_type)) {
1962 if (defined($e->{ALIGN})) {
1963 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1966 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1967 $self->pidl("if (_level != level) {");
1968 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1969 $self->pidl("}");
1972 if (defined($e->{ALIGN})) {
1973 if ($e->{IS_MS_UNION}) {
1974 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1975 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1976 } else {
1977 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1981 $self->pidl("switch (level) {");
1982 $self->indent;
1983 foreach my $el (@{$e->{ELEMENTS}}) {
1984 if ($el->{CASE} eq "default") {
1985 $have_default = 1;
1987 $self->pidl("$el->{CASE}: {");
1989 if ($el->{TYPE} ne "EMPTY") {
1990 $self->indent;
1991 if (defined($e->{PROPERTIES}{relative_base})) {
1992 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1993 # set the current offset as base for relative pointers
1994 # and store it based on the toplevel struct/union
1995 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1997 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1998 $self->deindent;
2000 $self->pidl("break; }");
2001 $self->pidl("");
2003 if (! $have_default) {
2004 $self->pidl("default:");
2005 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2007 $self->deindent;
2008 $self->pidl("}");
2011 sub ParseUnionPullDeferred($$$$)
2013 my ($self,$e,$ndr,$varname) = @_;
2014 my $have_default = 0;
2016 if (defined($e->{PROPERTIES}{relative_base})) {
2017 # retrieve the current offset as base for relative pointers
2018 # based on the toplevel struct/union
2019 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
2021 $self->pidl("switch (level) {");
2022 $self->indent;
2023 foreach my $el (@{$e->{ELEMENTS}}) {
2024 if ($el->{CASE} eq "default") {
2025 $have_default = 1;
2028 $self->pidl("$el->{CASE}:");
2029 if ($el->{TYPE} ne "EMPTY") {
2030 $self->indent;
2031 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
2032 $self->deindent;
2034 $self->pidl("break;");
2035 $self->pidl("");
2037 if (! $have_default) {
2038 $self->pidl("default:");
2039 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2041 $self->deindent;
2042 $self->pidl("}");
2047 #####################################################################
2048 # parse a union - pull side
2049 sub ParseUnionPull($$$$)
2051 my ($self,$e,$ndr,$varname) = @_;
2052 my $switch_type = $e->{SWITCH_TYPE};
2054 $self->pidl("uint32_t level;");
2055 if (defined($switch_type)) {
2056 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
2057 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
2059 $self->pidl(mapTypeName($switch_type) . " _level;");
2062 my %double_cases = ();
2063 foreach my $el (@{$e->{ELEMENTS}}) {
2064 next if ($el->{TYPE} eq "EMPTY");
2065 next if ($double_cases{"$el->{NAME}"});
2066 $self->DeclareMemCtxVariables($el);
2067 $self->DeclarePtrVariables($el);
2068 $self->DeclareArrayVariables($el, "pull");
2069 $double_cases{"$el->{NAME}"} = 1;
2072 $self->start_flags($e, $ndr);
2074 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
2076 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
2077 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2078 $self->indent;
2079 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2080 $self->deindent;
2081 $self->pidl("}");
2083 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2084 $self->indent;
2085 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2086 $self->deindent;
2087 $self->pidl("}");
2089 $self->add_deferred();
2091 $self->end_flags($e, $ndr);
2094 sub DeclUnion($$$$)
2096 my ($e,$t,$name,$varname) = @_;
2097 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2100 sub ArgsUnionNdrSize($$)
2102 my ($d,$name) = @_;
2103 return "const union $name *r, uint32_t level, int flags";
2106 $typefamily{UNION} = {
2107 PUSH_FN_BODY => \&ParseUnionPush,
2108 DECL => \&DeclUnion,
2109 PULL_FN_BODY => \&ParseUnionPull,
2110 PRINT_FN_BODY => \&ParseUnionPrint,
2111 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2112 SIZE_FN_BODY => \&ParseUnionNdrSize,
2115 #####################################################################
2116 # parse a typedef - push side
2117 sub ParseTypedefPush($$$$)
2119 my($self,$e,$ndr,$varname) = @_;
2121 my $env;
2123 $env->{$e->{NAME}} = $varname;
2125 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2128 #####################################################################
2129 # parse a typedef - pull side
2130 sub ParseTypedefPull($$$$)
2132 my($self,$e,$ndr,$varname) = @_;
2134 my $env;
2136 $env->{$e->{NAME}} = $varname;
2138 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2141 #####################################################################
2142 # parse a typedef - print side
2143 sub ParseTypedefPrint($$$$$)
2145 my($self,$e,$ndr,$name,$varname) = @_;
2147 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2150 #####################################################################
2151 ## calculate the size of a structure
2152 sub ParseTypedefNdrSize($$$$)
2154 my($self,$t,$name,$varname) = @_;
2156 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2159 sub DeclTypedef($$$$)
2161 my ($e, $t, $name, $varname) = @_;
2163 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2166 sub ArgsTypedefNdrSize($$$)
2168 my ($d, $name, $varname) = @_;
2169 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2172 $typefamily{TYPEDEF} = {
2173 PUSH_FN_BODY => \&ParseTypedefPush,
2174 DECL => \&DeclTypedef,
2175 PULL_FN_BODY => \&ParseTypedefPull,
2176 PRINT_FN_BODY => \&ParseTypedefPrint,
2177 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2178 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2181 sub ParsePipePushChunk($$)
2183 my ($self, $t) = @_;
2185 my $pipe = $t;
2186 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2187 my $struct = $pipe->{DATA};
2189 my $name = "$struct->{NAME}";
2190 my $ndr = "ndr";
2191 my $varname = "r";
2193 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2195 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2197 return if has_property($t, "nopush");
2199 $self->pidl("{");
2200 $self->indent;
2202 $self->ParseStructPush($struct, $ndr, $varname);
2203 $self->pidl("");
2205 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2206 $self->pidl("");
2208 $self->pidl("return NDR_ERR_SUCCESS;");
2209 $self->deindent;
2210 $self->pidl("}");
2211 $self->pidl("");
2214 sub ParsePipePullChunk($$)
2216 my ($self, $t) = @_;
2218 my $pipe = $t;
2219 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2220 my $struct = $pipe->{DATA};
2222 my $name = "$struct->{NAME}";
2223 my $ndr = "ndr";
2224 my $varname = "r";
2226 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2228 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2230 return if has_property($struct, "nopull");
2232 $self->pidl("{");
2233 $self->indent;
2235 $self->ParseStructPull($struct, $ndr, $varname);
2236 $self->pidl("");
2238 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2239 $self->pidl("");
2241 $self->pidl("return NDR_ERR_SUCCESS;");
2242 $self->deindent;
2243 $self->pidl("}");
2244 $self->pidl("");
2247 sub ParsePipePrintChunk($$)
2249 my ($self, $t) = @_;
2251 my $pipe = $t;
2252 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2253 my $struct = $pipe->{DATA};
2255 my $name = "$struct->{NAME}";
2256 my $ndr = "ndr";
2257 my $varname = "r";
2259 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2261 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2263 return if (has_property($t, "noprint"));
2265 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2266 $self->pidl("{");
2267 $self->indent;
2268 $self->ParseTypePrint($struct, $ndr, $varname);
2269 $self->deindent;
2270 $self->pidl("}");
2271 $self->pidl("");
2274 #####################################################################
2275 # parse a function - print side
2276 sub ParseFunctionPrint($$)
2278 my($self, $fn) = @_;
2279 my $ndr = "ndr";
2281 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2283 return if has_property($fn, "noprint");
2285 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2286 $self->pidl("{");
2287 $self->indent;
2289 foreach my $e (@{$fn->{ELEMENTS}}) {
2290 $self->DeclareArrayVariables($e);
2293 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2294 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2295 $self->pidl("$ndr->depth++;");
2297 $self->pidl("if (flags & NDR_SET_VALUES) {");
2298 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2299 $self->pidl("}");
2301 $self->pidl("if (flags & NDR_IN) {");
2302 $self->indent;
2303 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2304 $self->pidl("$ndr->depth++;");
2306 my $env = GenerateFunctionInEnv($fn);
2308 foreach my $e (@{$fn->{ELEMENTS}}) {
2309 if (grep(/in/,@{$e->{DIRECTION}})) {
2310 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2313 $self->pidl("$ndr->depth--;");
2314 $self->deindent;
2315 $self->pidl("}");
2317 $self->pidl("if (flags & NDR_OUT) {");
2318 $self->indent;
2319 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2320 $self->pidl("$ndr->depth++;");
2322 $env = GenerateFunctionOutEnv($fn);
2323 foreach my $e (@{$fn->{ELEMENTS}}) {
2324 if (grep(/out/,@{$e->{DIRECTION}})) {
2325 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2328 if ($fn->{RETURN_TYPE}) {
2329 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2331 $self->pidl("$ndr->depth--;");
2332 $self->deindent;
2333 $self->pidl("}");
2335 $self->pidl("$ndr->depth--;");
2336 $self->deindent;
2337 $self->pidl("}");
2338 $self->pidl("");
2341 #####################################################################
2342 # parse a function
2343 sub ParseFunctionPush($$)
2345 my($self, $fn) = @_;
2346 my $ndr = "ndr";
2348 $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;
2350 return if has_property($fn, "nopush");
2352 $self->pidl("{");
2353 $self->indent;
2355 foreach my $e (@{$fn->{ELEMENTS}}) {
2356 $self->DeclareArrayVariables($e);
2359 $self->pidl("NDR_PUSH_CHECK_FN_FLAGS(ndr, flags);");
2361 $self->pidl("if (flags & NDR_IN) {");
2362 $self->indent;
2364 my $env = GenerateFunctionInEnv($fn);
2366 EnvSubstituteValue($env, $fn);
2368 foreach my $e (@{$fn->{ELEMENTS}}) {
2369 if (grep(/in/,@{$e->{DIRECTION}})) {
2370 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2374 $self->deindent;
2375 $self->pidl("}");
2377 $self->pidl("if (flags & NDR_OUT) {");
2378 $self->indent;
2380 $env = GenerateFunctionOutEnv($fn);
2381 foreach my $e (@{$fn->{ELEMENTS}}) {
2382 if (grep(/out/,@{$e->{DIRECTION}})) {
2383 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2387 if ($fn->{RETURN_TYPE}) {
2388 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2391 $self->deindent;
2392 $self->pidl("}");
2393 $self->pidl("return NDR_ERR_SUCCESS;");
2394 $self->deindent;
2395 $self->pidl("}");
2396 $self->pidl("");
2399 sub AllocateArrayLevel($$$$$$)
2401 my ($self,$e,$l,$ndr,$var,$size) = @_;
2403 my $pl = GetPrevLevel($e, $l);
2404 if (defined($pl) and
2405 $pl->{TYPE} eq "POINTER" and
2406 $pl->{POINTER_TYPE} eq "ref"
2407 and not $l->{IS_ZERO_TERMINATED}) {
2408 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2409 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2410 $self->pidl("}");
2411 if (grep(/in/,@{$e->{DIRECTION}}) and
2412 grep(/out/,@{$e->{DIRECTION}})) {
2413 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2415 return;
2418 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2421 #####################################################################
2422 # parse a function
2423 sub ParseFunctionPull($$)
2425 my($self,$fn) = @_;
2426 my $ndr = "ndr";
2428 # pull function args
2429 $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;
2431 $self->pidl("{");
2432 $self->indent;
2434 # declare any internal pointers we need
2435 foreach my $e (@{$fn->{ELEMENTS}}) {
2436 $self->DeclarePtrVariables($e);
2437 $self->DeclareArrayVariables($e, "pull");
2440 my %double_cases = ();
2441 foreach my $e (@{$fn->{ELEMENTS}}) {
2442 next if ($e->{TYPE} eq "EMPTY");
2443 next if ($double_cases{"$e->{NAME}"});
2444 $self->DeclareMemCtxVariables($e);
2445 $double_cases{"$e->{NAME}"} = 1;
2448 $self->pidl("NDR_PULL_CHECK_FN_FLAGS(ndr, flags);");
2450 $self->pidl("if (flags & NDR_IN) {");
2451 $self->indent;
2453 # auto-init the out section of a structure. I originally argued that
2454 # this was a bad idea as it hides bugs, but coping correctly
2455 # with initialisation and not wiping ref vars is turning
2456 # out to be too tricky (tridge)
2457 foreach my $e (@{$fn->{ELEMENTS}}) {
2458 next unless grep(/out/, @{$e->{DIRECTION}});
2459 $self->pidl("ZERO_STRUCT(r->out);");
2460 $self->pidl("");
2461 last;
2464 my $env = GenerateFunctionInEnv($fn);
2466 foreach my $e (@{$fn->{ELEMENTS}}) {
2467 next unless (grep(/in/, @{$e->{DIRECTION}}));
2468 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2471 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2472 # own flag rather than be in NDR_IN ?
2474 foreach my $e (@{$fn->{ELEMENTS}}) {
2475 next unless (grep(/out/, @{$e->{DIRECTION}}));
2476 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2477 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2478 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2479 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2480 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2481 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2482 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2484 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2485 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2486 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2487 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2488 check_fully_dereferenced($e, $env));
2489 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2491 if (grep(/in/, @{$e->{DIRECTION}})) {
2492 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2493 } else {
2494 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2496 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2497 if (grep(/in/, @{$e->{DIRECTION}})) {
2498 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2499 } else {
2500 $self->pidl("r->out.$e->{NAME} = NULL;");
2502 } else {
2503 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2505 if (grep(/in/, @{$e->{DIRECTION}})) {
2506 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2507 } else {
2508 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2513 $self->add_deferred();
2514 $self->deindent;
2515 $self->pidl("}");
2517 $self->pidl("if (flags & NDR_OUT) {");
2518 $self->indent;
2520 $env = GenerateFunctionOutEnv($fn);
2521 foreach my $e (@{$fn->{ELEMENTS}}) {
2522 next unless grep(/out/, @{$e->{DIRECTION}});
2523 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2526 if ($fn->{RETURN_TYPE}) {
2527 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2530 $self->add_deferred();
2531 $self->deindent;
2532 $self->pidl("}");
2534 $self->pidl("return NDR_ERR_SUCCESS;");
2535 $self->deindent;
2536 $self->pidl("}");
2537 $self->pidl("");
2540 sub AuthServiceStruct($$$)
2542 my ($self, $ifacename, $authservice) = @_;
2543 my @a = split /,/, $authservice;
2544 my $authservice_count = $#a + 1;
2546 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2547 foreach my $ap (@a) {
2548 $self->pidl("\t$ap, ");
2550 $self->pidl("};");
2551 $self->pidl("");
2553 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2554 $self->pidl("\t.count\t= $authservice_count,");
2555 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2556 $self->pidl("};");
2557 $self->pidl("");
2560 sub ParseGeneratePipeArray($$$)
2562 my ($self, $fn, $direction) = @_;
2564 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2565 $self->indent;
2567 foreach my $e (@{$fn->{ELEMENTS}}) {
2568 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2569 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2571 my $cname = "$e->{TYPE}_chunk";
2573 $self->pidl("{");
2574 $self->indent;
2575 $self->pidl("\"$direction.$e->{NAME}\",");
2576 $self->pidl("\"$cname\",");
2577 $self->pidl("sizeof(struct $cname),");
2578 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2579 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2580 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2581 $self->deindent;
2582 $self->pidl("},");
2584 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2585 $self->deindent;
2586 $self->pidl("};");
2587 $self->pidl("");
2590 sub FunctionCallPipes($$)
2592 my ($self, $d) = @_;
2593 return if not defined($d->{OPNUM});
2595 my $in_pipes = 0;
2596 my $out_pipes = 0;
2598 foreach my $e (@{$d->{ELEMENTS}}) {
2599 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2601 if (grep(/in/, @{$e->{DIRECTION}})) {
2602 $in_pipes++;
2604 if (grep(/out/, @{$e->{DIRECTION}})) {
2605 $out_pipes++;
2609 if ($in_pipes) {
2610 $self->ParseGeneratePipeArray($d, "in");
2613 if ($out_pipes) {
2614 $self->ParseGeneratePipeArray($d, "out");
2618 sub FunctionCallEntry($$)
2620 my ($self, $d) = @_;
2621 return 0 if not defined($d->{OPNUM});
2623 my $in_pipes = 0;
2624 my $out_pipes = 0;
2626 foreach my $e (@{$d->{ELEMENTS}}) {
2627 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2629 if (grep(/in/, @{$e->{DIRECTION}})) {
2630 $in_pipes++;
2632 if (grep(/out/, @{$e->{DIRECTION}})) {
2633 $out_pipes++;
2637 my $in_pipes_ptr = "NULL";
2638 my $out_pipes_ptr = "NULL";
2640 if ($in_pipes) {
2641 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2644 if ($out_pipes) {
2645 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2648 $self->pidl("\t{");
2649 $self->pidl("\t\t\"$d->{NAME}\",");
2650 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2651 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2652 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2653 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2654 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2655 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2656 $self->pidl("\t},");
2657 return 1;
2660 #####################################################################
2661 # produce a function call table
2662 sub FunctionTable($$)
2664 my($self,$interface) = @_;
2665 my $count = 0;
2666 my $uname = uc $interface->{NAME};
2668 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2669 return unless defined ($interface->{PROPERTIES}->{uuid});
2671 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2672 $self->FunctionCallPipes($d);
2675 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2677 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2678 $count += $self->FunctionCallEntry($d);
2680 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2681 $self->pidl("};");
2682 $self->pidl("");
2684 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2685 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2686 $self->pidl("\t$ep, ");
2688 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2690 $self->pidl("};");
2691 $self->pidl("");
2693 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2694 $self->pidl("\t.count\t= $endpoint_count,");
2695 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2696 $self->pidl("};");
2697 $self->pidl("");
2699 if (! defined $interface->{PROPERTIES}->{authservice}) {
2700 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2703 $self->AuthServiceStruct($interface->{NAME},
2704 $interface->{PROPERTIES}->{authservice});
2706 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2707 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2708 $self->pidl("\t.syntax_id\t= {");
2709 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2710 $self->pidl("\t\tNDR_$uname\_VERSION");
2711 $self->pidl("\t},");
2712 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2713 $self->pidl("\t.num_calls\t= $count,");
2714 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2715 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2716 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2717 $self->pidl("};");
2718 $self->pidl("");
2722 #####################################################################
2723 # generate include statements for imported idl files
2724 sub HeaderImport
2726 my $self = shift;
2727 my @imports = @_;
2728 foreach (@imports) {
2729 $_ = unmake_str($_);
2730 s/\.idl$//;
2731 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2735 #####################################################################
2736 # generate include statements for included header files
2737 sub HeaderInclude
2739 my $self = shift;
2740 my @includes = @_;
2741 foreach (@includes) {
2742 $self->pidl_hdr("#include $_");
2746 #####################################################################
2747 # generate prototypes and defines for the interface definitions
2748 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2749 # NDR parser and so do not belong here, technically speaking
2750 sub HeaderInterface($$$)
2752 my($self,$interface,$needed) = @_;
2754 my $count = 0;
2756 if ($needed->{"compression"}) {
2757 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2760 if (has_property($interface, "object")) {
2761 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2764 if (defined $interface->{PROPERTIES}->{helper}) {
2765 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2768 if (defined $interface->{PROPERTIES}->{uuid}) {
2769 my $name = uc $interface->{NAME};
2770 $self->pidl_hdr("#define NDR_$name\_UUID " .
2771 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
2773 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
2775 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2777 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2778 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2780 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2783 foreach (@{$interface->{FUNCTIONS}}) {
2784 next if has_property($_, "noopnum");
2785 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2786 my $u_name = uc $_->{NAME};
2788 my $val = sprintf("0x%02x", $count);
2789 if (defined($interface->{BASE})) {
2790 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2793 $self->pidl_hdr("#define NDR_$u_name ($val)");
2795 $self->pidl_hdr("");
2796 $count++;
2799 my $val = $count;
2801 if (defined($interface->{BASE})) {
2802 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2805 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2809 sub ParseTypePush($$$$$$)
2811 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2813 # save the old relative_base_offset
2814 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2815 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2816 # restore the old relative_base_offset
2817 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2820 sub ParseTypePushFunction($$$)
2822 my ($self, $e, $varname) = @_;
2823 my $ndr = "ndr";
2825 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2827 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2829 $self->pidl("{");
2830 $self->indent;
2831 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2832 $self->pidl("return NDR_ERR_SUCCESS;");
2833 $self->deindent;
2834 $self->pidl("}");
2835 $self->pidl("");;
2838 sub ParseTypePull($$$$$$)
2840 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2842 # save the old relative_base_offset
2843 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2844 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2845 # restore the old relative_base_offset
2846 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2849 sub ParseTypePullFunction($$)
2851 my ($self, $e, $varname) = @_;
2852 my $ndr = "ndr";
2854 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2856 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2858 $self->pidl("{");
2859 $self->indent;
2860 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2861 $self->pidl("return NDR_ERR_SUCCESS;");
2862 $self->deindent;
2863 $self->pidl("}");
2864 $self->pidl("");
2867 sub ParseTypePrint($$$$)
2869 my ($self, $e, $ndr, $varname) = @_;
2871 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2874 sub ParseTypePrintFunction($$$)
2876 my ($self, $e, $varname) = @_;
2877 my $ndr = "ndr";
2879 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2881 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2883 return if (has_property($e, "noprint"));
2885 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2886 $self->pidl("{");
2887 $self->indent;
2888 $self->ParseTypePrint($e, $ndr, $varname);
2889 $self->deindent;
2890 $self->pidl("}");
2891 $self->pidl("");
2894 sub ParseTypeNdrSize($$)
2896 my ($self,$t) = @_;
2898 my $varname = "r";
2899 my $tf = $typefamily{$t->{TYPE}};
2900 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2902 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2904 $self->pidl("{");
2905 $self->indent;
2906 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2907 $self->deindent;
2908 $self->pidl("}");
2909 $self->pidl("");
2912 #####################################################################
2913 # parse the interface definitions
2914 sub ParseInterface($$$)
2916 my($self,$interface,$needed) = @_;
2918 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2919 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2921 $self->pidl_hdr("");
2923 $self->HeaderInterface($interface, $needed);
2925 # Typedefs
2926 foreach my $d (@{$interface->{TYPES}}) {
2927 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2928 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2929 $self->ParsePipePushChunk($d);
2930 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2931 $self->ParsePipePullChunk($d);
2932 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2933 $self->ParsePipePrintChunk($d);
2935 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2936 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2937 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2938 next;
2941 next unless(typeHasBody($d));
2943 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2944 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2945 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2947 # Make sure we don't generate a function twice...
2948 $needed->{TypeFunctionName("ndr_push", $d)} =
2949 $needed->{TypeFunctionName("ndr_pull", $d)} =
2950 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2952 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2955 # Functions
2956 foreach my $d (@{$interface->{FUNCTIONS}}) {
2957 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2958 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2959 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2962 $self->FunctionTable($interface);
2964 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2967 sub GenerateIncludes($)
2969 my ($self) = @_;
2970 if (is_intree()) {
2971 $self->pidl("#include \"includes.h\"");
2972 } else {
2973 $self->pidl("#ifndef _GNU_SOURCE");
2974 $self->pidl("#define _GNU_SOURCE");
2975 $self->pidl("#endif");
2976 $self->pidl("#include <stdint.h>");
2977 $self->pidl("#include <stdlib.h>");
2978 $self->pidl("#include <stdio.h>");
2979 $self->pidl("#include <stdbool.h>");
2980 $self->pidl("#include <stdarg.h>");
2981 $self->pidl("#include <string.h>");
2985 #####################################################################
2986 # parse a parsed IDL structure back into an IDL file
2987 sub Parse($$$$)
2989 my($self, $ndr,$gen_header,$ndr_header) = @_;
2991 $self->pidl_hdr("/* header auto-generated by pidl */");
2992 $self->pidl_hdr("");
2993 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2994 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2995 $self->pidl_hdr("");
2997 $self->pidl("/* parser auto-generated by pidl */");
2998 $self->pidl("");
2999 $self->GenerateIncludes();
3000 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
3001 $self->pidl("");
3003 my %needed = ();
3005 foreach (@{$ndr}) {
3006 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
3009 foreach (@{$ndr}) {
3010 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
3011 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
3012 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
3015 return ($self->{res_hdr}, $self->{res});
3018 sub NeededElement($$$)
3020 my ($e, $dir, $needed) = @_;
3022 return if ($e->{TYPE} eq "EMPTY");
3024 return if (ref($e->{TYPE}) eq "HASH" and
3025 not defined($e->{TYPE}->{NAME}));
3027 my ($t, $rt);
3028 if (ref($e->{TYPE}) eq "HASH") {
3029 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
3030 } else {
3031 $t = $e->{TYPE};
3034 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
3035 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
3036 } else {
3037 $rt = $e->{REPRESENTATION_TYPE};
3040 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
3042 my @fn = ();
3043 if ($dir eq "print") {
3044 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
3045 } elsif ($dir eq "pull") {
3046 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
3047 push (@fn, "ndr_$t\_to_$rt")
3048 if ($rt ne $t);
3049 } elsif ($dir eq "push") {
3050 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
3051 push (@fn, "ndr_$rt\_to_$t")
3052 if ($rt ne $t);
3053 } else {
3054 die("invalid direction `$dir'");
3057 foreach (@fn) {
3058 unless (defined($needed->{$_})) {
3059 $needed->{$_} = 1;
3064 sub NeededFunction($$)
3066 my ($fn,$needed) = @_;
3067 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
3068 $needed->{"ndr_push_$fn->{NAME}"} = 1;
3069 $needed->{"ndr_print_$fn->{NAME}"} = 1;
3070 foreach my $e (@{$fn->{ELEMENTS}}) {
3071 $e->{PARENT} = $fn;
3072 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3076 sub NeededType($$$)
3078 sub NeededType($$$);
3079 my ($t,$needed,$req) = @_;
3081 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3082 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3084 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3085 return unless defined($t->{ELEMENTS});
3086 for my $e (@{$t->{ELEMENTS}}) {
3087 $e->{PARENT} = $t;
3088 if (has_property($e, "compression")) {
3089 $needed->{"compression"} = 1;
3091 NeededElement($e, $req, $needed);
3092 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3097 #####################################################################
3098 # work out what parse functions are needed
3099 sub NeededInterface($$)
3101 my ($interface,$needed) = @_;
3102 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3103 foreach (reverse @{$interface->{TYPES}}) {
3105 if (has_property($_, "public")) {
3106 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3107 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3110 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3111 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3112 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3113 if (has_property($_, "gensize")) {
3114 $needed->{"ndr_size_$_->{NAME}"} = 1;
3119 sub TypeFunctionName($$)
3121 my ($prefix, $t) = @_;
3123 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3124 $t->{TYPE} eq "TYPEDEF");
3125 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3126 return "$prefix\_$t";