pidl: Add skip option to elements.
[Samba.git] / pidl / lib / Parse / Pidl / Samba4 / NDR / Parser.pm
blob10a886a41b65939a2f879d54df2e9e11c41fc8dd
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 } else {
202 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
203 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
206 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
207 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
210 if ($l->{IS_VARYING}) {
211 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, 0));"); # array offset
212 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $length));");
215 return $length;
218 sub check_fully_dereferenced($$)
220 my ($element, $env) = @_;
222 return sub ($) {
223 my $origvar = shift;
224 my $check = 0;
226 # Figure out the number of pointers in $ptr
227 my $expandedvar = $origvar;
228 $expandedvar =~ s/^(\**)//;
229 my $ptr = $1;
231 my $var = undef;
232 foreach (keys %$env) {
233 if ($env->{$_} eq $expandedvar) {
234 $var = $_;
235 last;
239 return($origvar) unless (defined($var));
240 my $e;
241 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
242 if ($_->{NAME} eq $var) {
243 $e = $_;
244 last;
248 $e or die("Environment doesn't match siblings");
250 # See if pointer at pointer level $level
251 # needs to be checked.
252 my $nump = 0;
253 foreach (@{$e->{LEVELS}}) {
254 if ($_->{TYPE} eq "POINTER") {
255 $nump = $_->{POINTER_INDEX}+1;
258 warning($element->{ORIGINAL}, "Got pointer for `$e->{NAME}', expected fully derefenced variable") if ($nump > length($ptr));
259 return ($origvar);
263 sub check_null_pointer($$$$)
265 my ($element, $env, $print_fn, $return) = @_;
267 return sub ($) {
268 my $expandedvar = shift;
269 my $check = 0;
271 # Figure out the number of pointers in $ptr
272 $expandedvar =~ s/^(\**)//;
273 my $ptr = $1;
275 my $var = undef;
276 foreach (keys %$env) {
277 if ($env->{$_} eq $expandedvar) {
278 $var = $_;
279 last;
283 if (defined($var)) {
284 my $e;
285 # lookup ptr in $e
286 foreach (@{$element->{PARENT}->{ELEMENTS}}) {
287 if ($_->{NAME} eq $var) {
288 $e = $_;
289 last;
293 $e or die("Environment doesn't match siblings");
295 # See if pointer at pointer level $level
296 # needs to be checked.
297 foreach my $l (@{$e->{LEVELS}}) {
298 if ($l->{TYPE} eq "POINTER" and
299 $l->{POINTER_INDEX} == length($ptr)) {
300 # No need to check ref pointers
301 $check = ($l->{POINTER_TYPE} ne "ref");
302 last;
305 if ($l->{TYPE} eq "DATA") {
306 warning($element, "too much dereferences for `$var'");
309 } else {
310 warning($element, "unknown dereferenced expression `$expandedvar'");
311 $check = 1;
314 $print_fn->("if ($ptr$expandedvar == NULL) $return") if $check;
318 sub ParseArrayPullGetSize($$$$$$)
320 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
322 my $size;
324 if ($l->{IS_CONFORMANT}) {
325 $size = "ndr_get_array_size($ndr, " . get_pointer_to($var_name) . ")";
326 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
327 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
328 } else {
329 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
330 check_null_pointer($e, $env, sub { $self->pidl(shift); },
331 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
332 check_fully_dereferenced($e, $env));
335 $self->pidl("size_$e->{NAME}_$l->{LEVEL_INDEX} = $size;");
336 my $array_size = "size_$e->{NAME}_$l->{LEVEL_INDEX}";
338 if (my $range = has_property($e, "range")) {
339 my ($low, $high) = split(/,/, $range, 2);
340 if ($low < 0) {
341 warning(0, "$low is invalid for the range of an array size");
343 if ($low == 0) {
344 $self->pidl("if ($array_size > $high) {");
345 } else {
346 $self->pidl("if ($array_size < $low || $array_size > $high) {");
348 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
349 $self->pidl("}");
352 return $array_size;
355 #####################################################################
356 # parse an array - pull side
357 sub ParseArrayPullGetLength($$$$$$;$)
359 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
361 if (not defined($array_size)) {
362 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
365 if (not $l->{IS_VARYING}) {
366 return $array_size;
369 my $length = "ndr_get_array_length($ndr, " . get_pointer_to($var_name) .")";
370 $self->pidl("length_$e->{NAME}_$l->{LEVEL_INDEX} = $length;");
371 my $array_length = "length_$e->{NAME}_$l->{LEVEL_INDEX}";
373 if (my $range = has_property($e, "range")) {
374 my ($low, $high) = split(/,/, $range, 2);
375 if ($low < 0) {
376 warning(0, "$low is invalid for the range of an array size");
378 if ($low == 0) {
379 $self->pidl("if ($array_length > $high) {");
380 } else {
381 $self->pidl("if ($array_length < $low || $array_length > $high) {");
383 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
384 $self->pidl("}");
387 return $array_length;
390 #####################################################################
391 # parse an array - pull side
392 sub ParseArrayPullHeader($$$$$$)
394 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
396 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
397 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
400 if ($l->{IS_VARYING}) {
401 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
404 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
405 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
407 if ($array_length ne $array_size) {
408 $self->pidl("if ($array_length > $array_size) {");
409 $self->indent;
410 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
411 $self->deindent;
412 $self->pidl("}");
415 if ($l->{IS_CONFORMANT} and not $l->{IS_ZERO_TERMINATED}) {
416 $self->defer("if ($var_name) {");
417 $self->defer_indent;
418 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
419 check_null_pointer($e, $env, sub { $self->defer(shift); },
420 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
421 check_fully_dereferenced($e, $env));
422 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
423 $self->defer_deindent;
424 $self->defer("}");
427 if ($l->{IS_VARYING} and not $l->{IS_ZERO_TERMINATED}) {
428 $self->defer("if ($var_name) {");
429 $self->defer_indent;
430 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
431 check_null_pointer($e, $env, sub { $self->defer(shift); },
432 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
433 check_fully_dereferenced($e, $env));
434 $self->defer("NDR_CHECK(ndr_check_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
435 $self->defer_deindent;
436 $self->defer("}");
439 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
440 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
443 return $array_length;
446 sub compression_alg($$)
448 my ($e, $l) = @_;
449 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
451 return $alg;
454 sub compression_clen($$$)
456 my ($e, $l, $env) = @_;
457 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
459 return ParseExpr($clen, $env, $e->{ORIGINAL});
462 sub compression_dlen($$$)
464 my ($e,$l,$env) = @_;
465 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
467 return ParseExpr($dlen, $env, $e->{ORIGINAL});
470 sub ParseCompressionPushStart($$$$$)
472 my ($self,$e,$l,$ndr,$env) = @_;
473 my $comndr = "$ndr\_compressed";
474 my $alg = compression_alg($e, $l);
475 my $dlen = compression_dlen($e, $l, $env);
477 $self->pidl("{");
478 $self->indent;
479 $self->pidl("struct ndr_push *$comndr;");
480 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg, $dlen));");
482 return $comndr;
485 sub ParseCompressionPushEnd($$$$$)
487 my ($self,$e,$l,$ndr,$env) = @_;
488 my $comndr = "$ndr\_compressed";
489 my $alg = compression_alg($e, $l);
490 my $dlen = compression_dlen($e, $l, $env);
492 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg, $dlen));");
493 $self->deindent;
494 $self->pidl("}");
497 sub ParseCompressionPullStart($$$$$)
499 my ($self,$e,$l,$ndr,$env) = @_;
500 my $comndr = "$ndr\_compressed";
501 my $alg = compression_alg($e, $l);
502 my $dlen = compression_dlen($e, $l, $env);
504 $self->pidl("{");
505 $self->indent;
506 $self->pidl("struct ndr_pull *$comndr;");
507 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen));");
509 return $comndr;
512 sub ParseCompressionPullEnd($$$$$)
514 my ($self,$e,$l,$ndr,$env) = @_;
515 my $comndr = "$ndr\_compressed";
516 my $alg = compression_alg($e, $l);
517 my $dlen = compression_dlen($e, $l, $env);
519 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
520 $self->deindent;
521 $self->pidl("}");
524 sub ParseSubcontextPushStart($$$$$)
526 my ($self,$e,$l,$ndr,$env) = @_;
527 my $subndr = "_ndr_$e->{NAME}";
528 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
530 $self->pidl("{");
531 $self->indent;
532 $self->pidl("struct ndr_push *$subndr;");
533 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
535 if (defined $l->{COMPRESSION}) {
536 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
539 return $subndr;
542 sub ParseSubcontextPushEnd($$$$$)
544 my ($self,$e,$l,$ndr,$env) = @_;
545 my $subndr = "_ndr_$e->{NAME}";
546 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
548 if (defined $l->{COMPRESSION}) {
549 $self->ParseCompressionPushEnd($e, $l, $subndr, $env);
552 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
553 $self->deindent;
554 $self->pidl("}");
557 sub ParseSubcontextPullStart($$$$$)
559 my ($self,$e,$l,$ndr,$env) = @_;
560 my $subndr = "_ndr_$e->{NAME}";
561 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
563 $self->pidl("{");
564 $self->indent;
565 $self->pidl("struct ndr_pull *$subndr;");
566 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
568 if (defined $l->{COMPRESSION}) {
569 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
572 return $subndr;
575 sub ParseSubcontextPullEnd($$$$$)
577 my ($self,$e,$l,$ndr,$env) = @_;
578 my $subndr = "_ndr_$e->{NAME}";
579 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
581 if (defined $l->{COMPRESSION}) {
582 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
585 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
586 $self->deindent;
587 $self->pidl("}");
590 sub ParseElementPushLevel
592 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
594 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
596 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
597 $var_name = get_pointer_to($var_name);
600 if (defined($ndr_flags)) {
601 if ($l->{TYPE} eq "SUBCONTEXT") {
602 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
603 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
604 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
605 } elsif ($l->{TYPE} eq "POINTER") {
606 $self->ParsePtrPush($e, $l, $ndr, $var_name);
607 } elsif ($l->{TYPE} eq "ARRAY") {
608 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
610 my $nl = GetNextLevel($e, $l);
612 # Allow speedups for arrays of scalar types
613 if (is_charset_array($e,$l)) {
614 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
615 return;
616 } elsif (has_fast_array($e,$l)) {
617 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
618 return;
620 } elsif ($l->{TYPE} eq "SWITCH") {
621 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
622 } elsif ($l->{TYPE} eq "DATA") {
623 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
624 } elsif ($l->{TYPE} eq "TYPEDEF") {
625 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
629 if ($l->{TYPE} eq "POINTER" and $deferred) {
630 my $rel_var_name = $var_name;
631 if ($l->{POINTER_TYPE} ne "ref") {
632 $self->pidl("if ($var_name) {");
633 $self->indent;
634 if ($l->{POINTER_TYPE} eq "relative") {
635 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
637 if ($l->{POINTER_TYPE} eq "relative_short") {
638 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
641 $var_name = get_value_of($var_name);
642 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
644 if ($l->{POINTER_TYPE} ne "ref") {
645 if ($l->{POINTER_TYPE} eq "relative") {
646 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
648 $self->deindent;
649 $self->pidl("}");
651 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
652 not is_charset_array($e, $l)) {
653 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
654 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
656 my $array_pointless = ($length eq "0");
658 if ($array_pointless) {
659 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
662 $var_name = get_array_element($var_name, $counter);
664 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
665 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
666 $self->indent;
667 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
668 $self->deindent;
669 $self->pidl("}");
672 if ($deferred and ContainsDeferred($e, $l) 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, 0, 1);
676 $self->deindent;
677 $self->pidl("}");
679 } elsif ($l->{TYPE} eq "SWITCH") {
680 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
684 #####################################################################
685 # parse scalars in a structure element
686 sub ParseElementPush($$$$$$)
688 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
689 my $subndr = undef;
691 my $var_name = $env->{$e->{NAME}};
693 return if ContainsPipe($e, $e->{LEVELS}[0]);
695 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
697 # Representation type is different from transmit_as
698 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
699 $self->pidl("{");
700 $self->indent;
701 my $transmit_name = "_transmit_$e->{NAME}";
702 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
703 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
704 $var_name = $transmit_name;
707 $var_name = append_prefix($e, $var_name);
709 $self->start_flags($e, $ndr);
711 if (defined(my $value = has_property($e, "value"))) {
712 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
715 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
717 $self->end_flags($e, $ndr);
719 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
720 $self->deindent;
721 $self->pidl("}");
725 #####################################################################
726 # parse a pointer in a struct element or function
727 sub ParsePtrPush($$$$$)
729 my ($self,$e,$l,$ndr,$var_name) = @_;
731 if ($l->{POINTER_TYPE} eq "ref") {
732 $self->pidl("if ($var_name == NULL) {");
733 $self->indent;
734 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
735 $self->deindent;
736 $self->pidl("}");
737 if ($l->{LEVEL} eq "EMBEDDED") {
738 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr));");
740 } elsif ($l->{POINTER_TYPE} eq "relative") {
741 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
742 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
743 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
744 } elsif ($l->{POINTER_TYPE} eq "unique") {
745 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
746 } elsif ($l->{POINTER_TYPE} eq "full") {
747 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
748 } else {
749 die("Unhandled pointer type $l->{POINTER_TYPE}");
753 sub need_pointer_to($$$)
755 my ($e, $l, $scalar_only) = @_;
757 my $t;
758 if (ref($l->{DATA_TYPE})) {
759 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
760 } else {
761 $t = $l->{DATA_TYPE};
764 if (not Parse::Pidl::Typelist::is_scalar($t)) {
765 return 1 if $scalar_only;
768 my $arrays = 0;
770 foreach my $tl (@{$e->{LEVELS}}) {
771 last if $l == $tl;
772 if ($tl->{TYPE} eq "ARRAY") {
773 $arrays++;
777 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
778 return 1 unless $arrays;
781 return 0;
784 sub ParseDataPrint($$$$$)
786 my ($self, $e, $l, $ndr, $var_name) = @_;
788 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
790 if (need_pointer_to($e, $l, 1)) {
791 $var_name = get_pointer_to($var_name);
794 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
795 } else {
796 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
800 #####################################################################
801 # print scalars in a structure element
802 sub ParseElementPrint($$$$$)
804 my($self, $e, $ndr, $var_name, $env) = @_;
806 return if (has_property($e, "noprint"));
808 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
809 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
810 return;
813 $var_name = append_prefix($e, $var_name);
815 if (defined(my $value = has_property($e, "value"))) {
816 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
819 foreach my $l (@{$e->{LEVELS}}) {
820 if ($l->{TYPE} eq "POINTER") {
821 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
822 $self->pidl("$ndr->depth++;");
823 if ($l->{POINTER_TYPE} ne "ref") {
824 $self->pidl("if ($var_name) {");
825 $self->indent;
827 $var_name = get_value_of($var_name);
828 } elsif ($l->{TYPE} eq "ARRAY") {
829 my $length;
831 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
832 $var_name = get_pointer_to($var_name);
835 if ($l->{IS_ZERO_TERMINATED}) {
836 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
837 } else {
838 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
839 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
842 if (is_charset_array($e,$l)) {
843 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
844 last;
845 } elsif (has_fast_array($e, $l)) {
846 my $nl = GetNextLevel($e, $l);
847 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
848 last;
849 } else {
850 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
852 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
853 $self->pidl("$ndr->depth++;");
854 $self->pidl("for ($counter=0;$counter<$length;$counter++) {");
855 $self->indent;
857 $var_name = get_array_element($var_name, $counter);
859 } elsif ($l->{TYPE} eq "DATA") {
860 $self->ParseDataPrint($e, $l, $ndr, $var_name);
861 } elsif ($l->{TYPE} eq "SWITCH") {
862 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
863 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
864 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
868 foreach my $l (reverse @{$e->{LEVELS}}) {
869 if ($l->{TYPE} eq "POINTER") {
870 if ($l->{POINTER_TYPE} ne "ref") {
871 $self->deindent;
872 $self->pidl("}");
874 $self->pidl("$ndr->depth--;");
875 } elsif (($l->{TYPE} eq "ARRAY")
876 and not is_charset_array($e,$l)
877 and not has_fast_array($e,$l)) {
878 $self->deindent;
879 $self->pidl("}");
880 $self->pidl("$ndr->depth--;");
885 #####################################################################
886 # parse scalars in a structure element - pull size
887 sub ParseSwitchPull($$$$$$)
889 my($self,$e,$l,$ndr,$var_name,$env) = @_;
890 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
891 check_null_pointer($e, $env, sub { $self->pidl(shift); },
892 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
893 check_fully_dereferenced($e, $env));
895 $var_name = get_pointer_to($var_name);
896 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
899 #####################################################################
900 # push switch element
901 sub ParseSwitchPush($$$$$$)
903 my($self,$e,$l,$ndr,$var_name,$env) = @_;
904 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
905 check_null_pointer($e, $env, sub { $self->pidl(shift); },
906 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
907 check_fully_dereferenced($e, $env));
909 $var_name = get_pointer_to($var_name);
910 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
913 sub ParseDataPull($$$$$$$)
915 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
917 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
919 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
921 if (need_pointer_to($e, $l, 0)) {
922 $var_name = get_pointer_to($var_name);
925 $var_name = get_pointer_to($var_name);
927 if (has_property($e, "skip")) {
928 $self->pidl("/* [skip] '$var_name' */");
929 } else {
930 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
933 my $pl = GetPrevLevel($e, $l);
935 my $range = has_property($e, "range");
936 if ($range and $pl->{TYPE} ne "ARRAY") {
937 $var_name = get_value_of($var_name);
938 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
939 my ($low, $high) = split(/,/, $range, 2);
940 if ($low < 0 and not $signed) {
941 warning(0, "$low is invalid for the range of an unsigned type");
943 if ($low == 0 and not $signed) {
944 $self->pidl("if ($var_name > $high) {");
945 } else {
946 $self->pidl("if ($var_name < $low || $var_name > $high) {");
948 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
949 $self->pidl("}");
951 } else {
952 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
956 sub ParseDataPush($$$$$$$)
958 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
960 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
962 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
964 # strings are passed by value rather than reference
965 if (need_pointer_to($e, $l, 1)) {
966 $var_name = get_pointer_to($var_name);
969 if (has_property($e, "skip")) {
970 $self->pidl("/* [skip] '$var_name' */");
971 } else {
972 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
974 } else {
975 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
979 sub CalcNdrFlags($$$)
981 my ($l,$primitives,$deferred) = @_;
983 my $scalars = 0;
984 my $buffers = 0;
986 # Add NDR_SCALARS if this one is deferred
987 # and deferreds may be pushed
988 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
990 # Add NDR_SCALARS if this one is not deferred and
991 # primitives may be pushed
992 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
994 # Add NDR_BUFFERS if this one contains deferred stuff
995 # and deferreds may be pushed
996 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
998 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
999 return "NDR_SCALARS" if ($scalars);
1000 return "NDR_BUFFERS" if ($buffers);
1001 return undef;
1004 sub ParseMemCtxPullFlags($$$$)
1006 my ($self, $e, $l) = @_;
1008 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1010 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1011 return undef if has_fast_array($e, $l);
1012 return undef if is_charset_array($e, $l);
1014 my $mem_flags = "0";
1016 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1017 my $nl = GetNextLevel($e, $l);
1018 return undef if ($nl->{TYPE} eq "PIPE");
1019 return undef if ($nl->{TYPE} eq "ARRAY");
1020 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1022 if ($l->{LEVEL} eq "TOP") {
1023 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1027 return $mem_flags;
1030 sub ParseMemCtxPullStart($$$$$)
1032 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1034 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1035 my $mem_c_ctx = $ptr_name;
1036 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1038 return unless defined($mem_c_flags);
1040 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1041 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1044 sub ParseMemCtxPullEnd($$$$)
1046 my ($self, $e, $l, $ndr) = @_;
1048 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1049 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1051 return unless defined($mem_r_flags);
1053 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1056 sub CheckStringTerminator($$$$$)
1058 my ($self,$ndr,$e,$l,$length) = @_;
1059 my $nl = GetNextLevel($e, $l);
1061 # Make sure last element is zero!
1062 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1065 sub ParseElementPullLevel
1067 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1069 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1070 my $array_length = undef;
1072 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1073 $var_name = get_pointer_to($var_name);
1076 # Only pull something if there's actually something to be pulled
1077 if (defined($ndr_flags)) {
1078 if ($l->{TYPE} eq "SUBCONTEXT") {
1079 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1080 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1081 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1082 } elsif ($l->{TYPE} eq "ARRAY") {
1083 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1084 $array_length = $length;
1086 my $nl = GetNextLevel($e, $l);
1088 if (is_charset_array($e,$l)) {
1089 if ($l->{IS_ZERO_TERMINATED}) {
1090 $self->CheckStringTerminator($ndr, $e, $l, $length);
1092 if ($l->{IS_TO_NULL}) {
1093 $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}));");
1094 } else {
1095 $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}));");
1097 return;
1098 } elsif (has_fast_array($e, $l)) {
1099 if ($l->{IS_ZERO_TERMINATED}) {
1100 $self->CheckStringTerminator($ndr,$e,$l,$length);
1102 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1103 return;
1105 } elsif ($l->{TYPE} eq "POINTER") {
1106 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1107 } elsif ($l->{TYPE} eq "SWITCH") {
1108 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1109 } elsif ($l->{TYPE} eq "DATA") {
1110 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1111 } elsif ($l->{TYPE} eq "TYPEDEF") {
1112 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1116 # add additional constructions
1117 if ($l->{TYPE} eq "POINTER" and $deferred) {
1118 if ($l->{POINTER_TYPE} ne "ref") {
1119 $self->pidl("if ($var_name) {");
1120 $self->indent;
1122 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1123 $self->pidl("uint32_t _relative_save_offset;");
1124 $self->pidl("_relative_save_offset = $ndr->offset;");
1125 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1129 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1131 $var_name = get_value_of($var_name);
1132 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1134 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1136 if ($l->{POINTER_TYPE} ne "ref") {
1137 if ($l->{POINTER_TYPE} eq "relative") {
1138 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1139 $self->indent;
1140 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1141 $self->deindent;
1142 $self->pidl("}");
1143 $self->pidl("$ndr->offset = _relative_save_offset;");
1145 $self->deindent;
1146 $self->pidl("}");
1148 } elsif ($l->{TYPE} eq "ARRAY" and
1149 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1150 my $length = $array_length;
1151 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1152 my $array_name = $var_name;
1154 if (not defined($length)) {
1155 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1158 $var_name = get_array_element($var_name, $counter);
1160 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1162 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1163 my $nl = GetNextLevel($e,$l);
1165 if ($l->{IS_ZERO_TERMINATED}) {
1166 $self->CheckStringTerminator($ndr,$e,$l,$length);
1169 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1170 $self->indent;
1171 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1172 $self->deindent;
1173 $self->pidl("}");
1176 if ($deferred and ContainsDeferred($e, $l)) {
1177 $self->pidl("for ($counter = 0; $counter < $length; $counter++) {");
1178 $self->indent;
1179 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1180 $self->deindent;
1181 $self->pidl("}");
1184 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1186 } elsif ($l->{TYPE} eq "SWITCH") {
1187 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, $primitives, $deferred);
1191 #####################################################################
1192 # parse scalars in a structure element - pull size
1193 sub ParseElementPull($$$$$$)
1195 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1197 my $var_name = $env->{$e->{NAME}};
1198 my $represent_name;
1199 my $transmit_name;
1201 return if ContainsPipe($e, $e->{LEVELS}[0]);
1203 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1205 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1206 $self->pidl("{");
1207 $self->indent;
1208 $represent_name = $var_name;
1209 $transmit_name = "_transmit_$e->{NAME}";
1210 $var_name = $transmit_name;
1211 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1214 $var_name = append_prefix($e, $var_name);
1216 $self->start_flags($e, $ndr);
1218 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1220 $self->end_flags($e, $ndr);
1222 # Representation type is different from transmit_as
1223 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1224 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1225 $self->deindent;
1226 $self->pidl("}");
1230 #####################################################################
1231 # parse a pointer in a struct element or function
1232 sub ParsePtrPull($$$$$)
1234 my($self, $e,$l,$ndr,$var_name) = @_;
1236 my $nl = GetNextLevel($e, $l);
1237 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1238 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1239 ($nl->{DATA_TYPE} eq "string"));
1241 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1243 if (!$next_is_array and !$next_is_string) {
1244 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1245 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1246 $self->pidl("}");
1249 return;
1250 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1251 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1252 } elsif (($l->{POINTER_TYPE} eq "unique") or
1253 ($l->{POINTER_TYPE} eq "relative") or
1254 ($l->{POINTER_TYPE} eq "full")) {
1255 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1256 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1257 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1258 } else {
1259 die("Unhandled pointer type $l->{POINTER_TYPE}");
1262 $self->pidl("if (_ptr_$e->{NAME}) {");
1263 $self->indent;
1265 # Don't do this for arrays, they're allocated at the actual level
1266 # of the array
1267 unless ($next_is_array or $next_is_string) {
1268 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1269 } else {
1270 # FIXME: Yes, this is nasty.
1271 # We allocate an array twice
1272 # - once just to indicate that it's there,
1273 # - then the real allocation...
1274 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1277 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1278 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1279 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1281 $self->deindent;
1282 $self->pidl("} else {");
1283 $self->pidl("\t$var_name = NULL;");
1284 $self->pidl("}");
1287 sub ParseStructPushPrimitives($$$$$)
1289 my ($self, $struct, $ndr, $varname, $env) = @_;
1291 # see if the structure contains a conformant array. If it
1292 # does, then it must be the last element of the structure, and
1293 # we need to push the conformant length early, as it fits on
1294 # the wire before the structure (and even before the structure
1295 # alignment)
1296 if (defined($struct->{SURROUNDING_ELEMENT})) {
1297 my $e = $struct->{SURROUNDING_ELEMENT};
1299 if (defined($e->{LEVELS}[0]) and
1300 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1301 my $size;
1303 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1304 if (has_property($e, "charset")) {
1305 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1306 } else {
1307 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1309 } else {
1310 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1313 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1314 } else {
1315 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1319 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1321 if (defined($struct->{PROPERTIES}{relative_base})) {
1322 # set the current offset as base for relative pointers
1323 # and store it based on the toplevel struct/union
1324 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1327 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1329 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1332 sub ParseStructPushDeferred($$$$)
1334 my ($self, $struct, $ndr, $varname, $env) = @_;
1335 if (defined($struct->{PROPERTIES}{relative_base})) {
1336 # retrieve the current offset as base for relative pointers
1337 # based on the toplevel struct/union
1338 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1340 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1343 #####################################################################
1344 # parse a struct
1345 sub ParseStructPush($$$$)
1347 my ($self, $struct, $ndr, $varname) = @_;
1349 return unless defined($struct->{ELEMENTS});
1351 my $env = GenerateStructEnv($struct, $varname);
1353 EnvSubstituteValue($env, $struct);
1355 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1357 $self->start_flags($struct, $ndr);
1359 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1360 $self->indent;
1361 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1362 $self->deindent;
1363 $self->pidl("}");
1365 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1366 $self->indent;
1367 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1368 $self->deindent;
1369 $self->pidl("}");
1371 $self->end_flags($struct, $ndr);
1374 #####################################################################
1375 # generate a push function for an enum
1376 sub ParseEnumPush($$$$)
1378 my($self,$enum,$ndr,$varname) = @_;
1379 my($type_fn) = $enum->{BASE_TYPE};
1381 $self->start_flags($enum, $ndr);
1382 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1383 $self->end_flags($enum, $ndr);
1386 #####################################################################
1387 # generate a pull function for an enum
1388 sub ParseEnumPull($$$$)
1390 my($self,$enum,$ndr,$varname) = @_;
1391 my($type_fn) = $enum->{BASE_TYPE};
1392 my($type_v_decl) = mapTypeName($type_fn);
1394 $self->pidl("$type_v_decl v;");
1395 $self->start_flags($enum, $ndr);
1396 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1397 $self->pidl("*$varname = v;");
1399 $self->end_flags($enum, $ndr);
1402 #####################################################################
1403 # generate a print function for an enum
1404 sub ParseEnumPrint($$$$$)
1406 my($self,$enum,$ndr,$name,$varname) = @_;
1408 $self->pidl("const char *val = NULL;");
1409 $self->pidl("");
1411 $self->start_flags($enum, $ndr);
1413 $self->pidl("switch ($varname) {");
1414 $self->indent;
1415 my $els = \@{$enum->{ELEMENTS}};
1416 foreach my $i (0 .. $#{$els}) {
1417 my $e = ${$els}[$i];
1418 chomp $e;
1419 if ($e =~ /^(.*)=/) {
1420 $e = $1;
1422 $self->pidl("case $e: val = \"$e\"; break;");
1425 $self->deindent;
1426 $self->pidl("}");
1428 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1430 $self->end_flags($enum, $ndr);
1433 sub DeclEnum($$$$)
1435 my ($e,$t,$name,$varname) = @_;
1436 return "enum $name " .
1437 ($t eq "pull"?"*":"") . $varname;
1440 $typefamily{ENUM} = {
1441 DECL => \&DeclEnum,
1442 PUSH_FN_BODY => \&ParseEnumPush,
1443 PULL_FN_BODY => \&ParseEnumPull,
1444 PRINT_FN_BODY => \&ParseEnumPrint,
1447 #####################################################################
1448 # generate a push function for a bitmap
1449 sub ParseBitmapPush($$$$)
1451 my($self,$bitmap,$ndr,$varname) = @_;
1452 my($type_fn) = $bitmap->{BASE_TYPE};
1454 $self->start_flags($bitmap, $ndr);
1456 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1458 $self->end_flags($bitmap, $ndr);
1461 #####################################################################
1462 # generate a pull function for an bitmap
1463 sub ParseBitmapPull($$$$)
1465 my($self,$bitmap,$ndr,$varname) = @_;
1466 my $type_fn = $bitmap->{BASE_TYPE};
1467 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1469 $self->pidl("$type_decl v;");
1470 $self->start_flags($bitmap, $ndr);
1471 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1472 $self->pidl("*$varname = v;");
1474 $self->end_flags($bitmap, $ndr);
1477 #####################################################################
1478 # generate a print function for an bitmap
1479 sub ParseBitmapPrintElement($$$$$$)
1481 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1482 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1483 my($type_fn) = $bitmap->{BASE_TYPE};
1484 my($flag);
1486 if ($e =~ /^(\w+) .*$/) {
1487 $flag = "$1";
1488 } else {
1489 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1492 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1495 #####################################################################
1496 # generate a print function for an bitmap
1497 sub ParseBitmapPrint($$$$$)
1499 my($self,$bitmap,$ndr,$name,$varname) = @_;
1500 my($type_decl) = mapTypeName($bitmap->{TYPE});
1501 my($type_fn) = $bitmap->{BASE_TYPE};
1503 $self->start_flags($bitmap, $ndr);
1505 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1507 $self->pidl("$ndr->depth++;");
1508 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1509 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1511 $self->pidl("$ndr->depth--;");
1513 $self->end_flags($bitmap, $ndr);
1516 sub DeclBitmap($$$$)
1518 my ($e,$t,$name,$varname) = @_;
1519 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1520 ($t eq "pull"?" *":" ") . $varname;
1523 $typefamily{BITMAP} = {
1524 DECL => \&DeclBitmap,
1525 PUSH_FN_BODY => \&ParseBitmapPush,
1526 PULL_FN_BODY => \&ParseBitmapPull,
1527 PRINT_FN_BODY => \&ParseBitmapPrint,
1530 #####################################################################
1531 # generate a struct print function
1532 sub ParseStructPrint($$$$$)
1534 my($self,$struct,$ndr,$name,$varname) = @_;
1536 return unless defined $struct->{ELEMENTS};
1538 my $env = GenerateStructEnv($struct, $varname);
1540 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1542 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1543 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1545 $self->start_flags($struct, $ndr);
1547 $self->pidl("$ndr->depth++;");
1549 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1550 foreach (@{$struct->{ELEMENTS}});
1551 $self->pidl("$ndr->depth--;");
1553 $self->end_flags($struct, $ndr);
1556 sub DeclarePtrVariables($$)
1558 my ($self,$e) = @_;
1559 foreach my $l (@{$e->{LEVELS}}) {
1560 my $size = 32;
1561 if ($l->{TYPE} eq "POINTER" and
1562 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1563 if ($l->{POINTER_TYPE} eq "relative_short") {
1564 $size = 16;
1566 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1567 last;
1572 sub DeclareArrayVariables($$;$)
1574 my ($self,$e,$pull) = @_;
1576 foreach my $l (@{$e->{LEVELS}}) {
1577 next if ($l->{TYPE} ne "ARRAY");
1578 if (defined($pull)) {
1579 $self->pidl("uint32_t size_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1580 if ($l->{IS_VARYING}) {
1581 $self->pidl("uint32_t length_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1584 next if has_fast_array($e,$l);
1585 next if is_charset_array($e,$l);
1586 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1590 sub DeclareArrayVariablesNoZero($$$)
1592 my ($self,$e,$env) = @_;
1594 foreach my $l (@{$e->{LEVELS}}) {
1595 next if ($l->{TYPE} ne "ARRAY");
1596 next if has_fast_array($e,$l);
1597 next if is_charset_array($e,$l);
1598 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1599 if ($length eq "0") {
1600 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1601 } else {
1602 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1607 sub DeclareMemCtxVariables($$)
1609 my ($self,$e) = @_;
1610 foreach my $l (@{$e->{LEVELS}}) {
1611 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1612 if (defined($mem_flags)) {
1613 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX};");
1618 sub ParseStructPullPrimitives($$$$$)
1620 my($self,$struct,$ndr,$varname,$env) = @_;
1622 if (defined $struct->{SURROUNDING_ELEMENT}) {
1623 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1626 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1628 if (defined($struct->{PROPERTIES}{relative_base})) {
1629 # set the current offset as base for relative pointers
1630 # and store it based on the toplevel struct/union
1631 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1634 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1636 $self->add_deferred();
1638 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1641 sub ParseStructPullDeferred($$$$$)
1643 my ($self,$struct,$ndr,$varname,$env) = @_;
1645 if (defined($struct->{PROPERTIES}{relative_base})) {
1646 # retrieve the current offset as base for relative pointers
1647 # based on the toplevel struct/union
1648 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1650 foreach my $e (@{$struct->{ELEMENTS}}) {
1651 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1654 $self->add_deferred();
1657 #####################################################################
1658 # parse a struct - pull side
1659 sub ParseStructPull($$$$)
1661 my($self,$struct,$ndr,$varname) = @_;
1663 return unless defined $struct->{ELEMENTS};
1665 # declare any internal pointers we need
1666 foreach my $e (@{$struct->{ELEMENTS}}) {
1667 $self->DeclarePtrVariables($e);
1668 $self->DeclareArrayVariables($e, "pull");
1669 $self->DeclareMemCtxVariables($e);
1672 $self->start_flags($struct, $ndr);
1674 my $env = GenerateStructEnv($struct, $varname);
1676 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1677 $self->indent;
1678 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1679 $self->deindent;
1680 $self->pidl("}");
1681 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1682 $self->indent;
1683 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1684 $self->deindent;
1685 $self->pidl("}");
1687 $self->end_flags($struct, $ndr);
1690 #####################################################################
1691 # calculate size of ndr struct
1692 sub ParseStructNdrSize($$$$)
1694 my ($self,$t, $name, $varname) = @_;
1695 my $sizevar;
1697 if (my $flags = has_property($t, "flag")) {
1698 $self->pidl("flags |= $flags;");
1700 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1703 sub DeclStruct($$$$)
1705 my ($e,$t,$name,$varname) = @_;
1706 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1709 sub ArgsStructNdrSize($$$)
1711 my ($d, $name, $varname) = @_;
1712 return "const struct $name *$varname, int flags";
1715 $typefamily{STRUCT} = {
1716 PUSH_FN_BODY => \&ParseStructPush,
1717 DECL => \&DeclStruct,
1718 PULL_FN_BODY => \&ParseStructPull,
1719 PRINT_FN_BODY => \&ParseStructPrint,
1720 SIZE_FN_BODY => \&ParseStructNdrSize,
1721 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1724 #####################################################################
1725 # calculate size of ndr struct
1726 sub ParseUnionNdrSize($$$)
1728 my ($self, $t, $name, $varname) = @_;
1729 my $sizevar;
1731 if (my $flags = has_property($t, "flag")) {
1732 $self->pidl("flags |= $flags;");
1735 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1738 sub ParseUnionPushPrimitives($$$$)
1740 my ($self, $e, $ndr ,$varname) = @_;
1742 my $have_default = 0;
1744 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1746 if (defined($e->{SWITCH_TYPE})) {
1747 if (defined($e->{ALIGN})) {
1748 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1751 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1754 if (defined($e->{ALIGN})) {
1755 if ($e->{IS_MS_UNION}) {
1756 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1757 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1758 } else {
1759 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1763 $self->pidl("switch (level) {");
1764 $self->indent;
1765 foreach my $el (@{$e->{ELEMENTS}}) {
1766 if ($el->{CASE} eq "default") {
1767 $have_default = 1;
1769 $self->pidl("$el->{CASE}: {");
1771 if ($el->{TYPE} ne "EMPTY") {
1772 $self->indent;
1773 if (defined($e->{PROPERTIES}{relative_base})) {
1774 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1775 # set the current offset as base for relative pointers
1776 # and store it based on the toplevel struct/union
1777 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1779 $self->DeclareArrayVariables($el);
1780 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1781 $self->deindent;
1783 $self->pidl("break; }");
1784 $self->pidl("");
1786 if (! $have_default) {
1787 $self->pidl("default:");
1788 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1790 $self->deindent;
1791 $self->pidl("}");
1794 sub ParseUnionPushDeferred($$$$)
1796 my ($self,$e,$ndr,$varname) = @_;
1798 my $have_default = 0;
1800 $self->pidl("uint32_t level = ndr_push_get_switch_value($ndr, $varname);");
1801 if (defined($e->{PROPERTIES}{relative_base})) {
1802 # retrieve the current offset as base for relative pointers
1803 # based on the toplevel struct/union
1804 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1806 $self->pidl("switch (level) {");
1807 $self->indent;
1808 foreach my $el (@{$e->{ELEMENTS}}) {
1809 if ($el->{CASE} eq "default") {
1810 $have_default = 1;
1813 $self->pidl("$el->{CASE}:");
1814 if ($el->{TYPE} ne "EMPTY") {
1815 $self->indent;
1816 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1817 $self->deindent;
1819 $self->pidl("break;");
1820 $self->pidl("");
1822 if (! $have_default) {
1823 $self->pidl("default:");
1824 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1826 $self->deindent;
1827 $self->pidl("}");
1830 #####################################################################
1831 # parse a union - push side
1832 sub ParseUnionPush($$$$)
1834 my ($self,$e,$ndr,$varname) = @_;
1835 my $have_default = 0;
1837 $self->start_flags($e, $ndr);
1839 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1840 $self->indent;
1841 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
1842 $self->deindent;
1843 $self->pidl("}");
1844 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1845 $self->indent;
1846 $self->ParseUnionPushDeferred($e, $ndr, $varname);
1847 $self->deindent;
1848 $self->pidl("}");
1849 $self->end_flags($e, $ndr);
1852 #####################################################################
1853 # print a union
1854 sub ParseUnionPrint($$$$$)
1856 my ($self,$e,$ndr,$name,$varname) = @_;
1857 my $have_default = 0;
1859 $self->pidl("uint32_t level;");
1860 foreach my $el (@{$e->{ELEMENTS}}) {
1861 $self->DeclareArrayVariables($el);
1864 $self->start_flags($e, $ndr);
1866 $self->pidl("level = ndr_print_get_switch_value($ndr, $varname);");
1868 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
1870 $self->pidl("switch (level) {");
1871 $self->indent;
1872 foreach my $el (@{$e->{ELEMENTS}}) {
1873 if ($el->{CASE} eq "default") {
1874 $have_default = 1;
1876 $self->pidl("$el->{CASE}:");
1877 if ($el->{TYPE} ne "EMPTY") {
1878 $self->indent;
1879 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
1880 $self->deindent;
1882 $self->pidl("break;");
1883 $self->pidl("");
1885 if (! $have_default) {
1886 $self->pidl("default:");
1887 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
1889 $self->deindent;
1890 $self->pidl("}");
1892 $self->end_flags($e, $ndr);
1895 sub ParseUnionPullPrimitives($$$$$)
1897 my ($self,$e,$ndr,$varname,$switch_type) = @_;
1898 my $have_default = 0;
1901 if (defined($switch_type)) {
1902 if (defined($e->{ALIGN})) {
1903 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1906 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
1907 $self->pidl("if (_level != level) {");
1908 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
1909 $self->pidl("}");
1912 if (defined($e->{ALIGN})) {
1913 if ($e->{IS_MS_UNION}) {
1914 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1915 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
1916 } else {
1917 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
1921 $self->pidl("switch (level) {");
1922 $self->indent;
1923 foreach my $el (@{$e->{ELEMENTS}}) {
1924 if ($el->{CASE} eq "default") {
1925 $have_default = 1;
1927 $self->pidl("$el->{CASE}: {");
1929 if ($el->{TYPE} ne "EMPTY") {
1930 $self->indent;
1931 if (defined($e->{PROPERTIES}{relative_base})) {
1932 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
1933 # set the current offset as base for relative pointers
1934 # and store it based on the toplevel struct/union
1935 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1937 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
1938 $self->deindent;
1940 $self->pidl("break; }");
1941 $self->pidl("");
1943 if (! $have_default) {
1944 $self->pidl("default:");
1945 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1947 $self->deindent;
1948 $self->pidl("}");
1951 sub ParseUnionPullDeferred($$$$)
1953 my ($self,$e,$ndr,$varname) = @_;
1954 my $have_default = 0;
1956 if (defined($e->{PROPERTIES}{relative_base})) {
1957 # retrieve the current offset as base for relative pointers
1958 # based on the toplevel struct/union
1959 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1961 $self->pidl("switch (level) {");
1962 $self->indent;
1963 foreach my $el (@{$e->{ELEMENTS}}) {
1964 if ($el->{CASE} eq "default") {
1965 $have_default = 1;
1968 $self->pidl("$el->{CASE}:");
1969 if ($el->{TYPE} ne "EMPTY") {
1970 $self->indent;
1971 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1972 $self->deindent;
1974 $self->pidl("break;");
1975 $self->pidl("");
1977 if (! $have_default) {
1978 $self->pidl("default:");
1979 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
1981 $self->deindent;
1982 $self->pidl("}");
1987 #####################################################################
1988 # parse a union - pull side
1989 sub ParseUnionPull($$$$)
1991 my ($self,$e,$ndr,$varname) = @_;
1992 my $switch_type = $e->{SWITCH_TYPE};
1994 $self->pidl("uint32_t level;");
1995 if (defined($switch_type)) {
1996 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
1997 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
1999 $self->pidl(mapTypeName($switch_type) . " _level;");
2002 my %double_cases = ();
2003 foreach my $el (@{$e->{ELEMENTS}}) {
2004 next if ($el->{TYPE} eq "EMPTY");
2005 next if ($double_cases{"$el->{NAME}"});
2006 $self->DeclareMemCtxVariables($el);
2007 $self->DeclarePtrVariables($el);
2008 $self->DeclareArrayVariables($el, "pull");
2009 $double_cases{"$el->{NAME}"} = 1;
2012 $self->start_flags($e, $ndr);
2014 $self->pidl("level = ndr_pull_get_switch_value($ndr, $varname);");
2016 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2017 $self->indent;
2018 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2019 $self->deindent;
2020 $self->pidl("}");
2022 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2023 $self->indent;
2024 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2025 $self->deindent;
2026 $self->pidl("}");
2028 $self->add_deferred();
2030 $self->end_flags($e, $ndr);
2033 sub DeclUnion($$$$)
2035 my ($e,$t,$name,$varname) = @_;
2036 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2039 sub ArgsUnionNdrSize($$)
2041 my ($d,$name) = @_;
2042 return "const union $name *r, uint32_t level, int flags";
2045 $typefamily{UNION} = {
2046 PUSH_FN_BODY => \&ParseUnionPush,
2047 DECL => \&DeclUnion,
2048 PULL_FN_BODY => \&ParseUnionPull,
2049 PRINT_FN_BODY => \&ParseUnionPrint,
2050 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2051 SIZE_FN_BODY => \&ParseUnionNdrSize,
2054 #####################################################################
2055 # parse a typedef - push side
2056 sub ParseTypedefPush($$$$)
2058 my($self,$e,$ndr,$varname) = @_;
2060 my $env;
2062 $env->{$e->{NAME}} = $varname;
2064 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2067 #####################################################################
2068 # parse a typedef - pull side
2069 sub ParseTypedefPull($$$$)
2071 my($self,$e,$ndr,$varname) = @_;
2073 my $env;
2075 $env->{$e->{NAME}} = $varname;
2077 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2080 #####################################################################
2081 # parse a typedef - print side
2082 sub ParseTypedefPrint($$$$$)
2084 my($self,$e,$ndr,$name,$varname) = @_;
2086 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2089 #####################################################################
2090 ## calculate the size of a structure
2091 sub ParseTypedefNdrSize($$$$)
2093 my($self,$t,$name,$varname) = @_;
2095 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2098 sub DeclTypedef($$$$)
2100 my ($e, $t, $name, $varname) = @_;
2102 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2105 sub ArgsTypedefNdrSize($$$)
2107 my ($d, $name, $varname) = @_;
2108 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2111 $typefamily{TYPEDEF} = {
2112 PUSH_FN_BODY => \&ParseTypedefPush,
2113 DECL => \&DeclTypedef,
2114 PULL_FN_BODY => \&ParseTypedefPull,
2115 PRINT_FN_BODY => \&ParseTypedefPrint,
2116 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2117 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2120 sub ParsePipePushChunk($$)
2122 my ($self, $t) = @_;
2124 my $pipe = $t;
2125 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2126 my $struct = $pipe->{DATA};
2128 my $name = "$struct->{NAME}";
2129 my $ndr = "ndr";
2130 my $varname = "r";
2132 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2134 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2136 return if has_property($t, "nopush");
2138 $self->pidl("{");
2139 $self->indent;
2141 $self->ParseStructPush($struct, $ndr, $varname);
2142 $self->pidl("");
2144 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2145 $self->pidl("");
2147 $self->pidl("return NDR_ERR_SUCCESS;");
2148 $self->deindent;
2149 $self->pidl("}");
2150 $self->pidl("");
2153 sub ParsePipePullChunk($$)
2155 my ($self, $t) = @_;
2157 my $pipe = $t;
2158 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2159 my $struct = $pipe->{DATA};
2161 my $name = "$struct->{NAME}";
2162 my $ndr = "ndr";
2163 my $varname = "r";
2165 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2167 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2169 return if has_property($struct, "nopull");
2171 $self->pidl("{");
2172 $self->indent;
2174 $self->ParseStructPull($struct, $ndr, $varname);
2175 $self->pidl("");
2177 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2178 $self->pidl("");
2180 $self->pidl("return NDR_ERR_SUCCESS;");
2181 $self->deindent;
2182 $self->pidl("}");
2183 $self->pidl("");
2186 sub ParsePipePrintChunk($$)
2188 my ($self, $t) = @_;
2190 my $pipe = $t;
2191 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2192 my $struct = $pipe->{DATA};
2194 my $name = "$struct->{NAME}";
2195 my $ndr = "ndr";
2196 my $varname = "r";
2198 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2200 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2202 return if (has_property($t, "noprint"));
2204 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2205 $self->pidl("{");
2206 $self->indent;
2207 $self->ParseTypePrint($struct, $ndr, $varname);
2208 $self->deindent;
2209 $self->pidl("}");
2210 $self->pidl("");
2213 #####################################################################
2214 # parse a function - print side
2215 sub ParseFunctionPrint($$)
2217 my($self, $fn) = @_;
2218 my $ndr = "ndr";
2220 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2222 return if has_property($fn, "noprint");
2224 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2225 $self->pidl("{");
2226 $self->indent;
2228 foreach my $e (@{$fn->{ELEMENTS}}) {
2229 $self->DeclareArrayVariables($e);
2232 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2233 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2234 $self->pidl("$ndr->depth++;");
2236 $self->pidl("if (flags & NDR_SET_VALUES) {");
2237 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2238 $self->pidl("}");
2240 $self->pidl("if (flags & NDR_IN) {");
2241 $self->indent;
2242 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2243 $self->pidl("$ndr->depth++;");
2245 my $env = GenerateFunctionInEnv($fn);
2247 foreach my $e (@{$fn->{ELEMENTS}}) {
2248 if (grep(/in/,@{$e->{DIRECTION}})) {
2249 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2252 $self->pidl("$ndr->depth--;");
2253 $self->deindent;
2254 $self->pidl("}");
2256 $self->pidl("if (flags & NDR_OUT) {");
2257 $self->indent;
2258 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2259 $self->pidl("$ndr->depth++;");
2261 $env = GenerateFunctionOutEnv($fn);
2262 foreach my $e (@{$fn->{ELEMENTS}}) {
2263 if (grep(/out/,@{$e->{DIRECTION}})) {
2264 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2267 if ($fn->{RETURN_TYPE}) {
2268 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2270 $self->pidl("$ndr->depth--;");
2271 $self->deindent;
2272 $self->pidl("}");
2274 $self->pidl("$ndr->depth--;");
2275 $self->deindent;
2276 $self->pidl("}");
2277 $self->pidl("");
2280 #####################################################################
2281 # parse a function
2282 sub ParseFunctionPush($$)
2284 my($self, $fn) = @_;
2285 my $ndr = "ndr";
2287 $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;
2289 return if has_property($fn, "nopush");
2291 $self->pidl("{");
2292 $self->indent;
2294 foreach my $e (@{$fn->{ELEMENTS}}) {
2295 $self->DeclareArrayVariables($e);
2298 $self->pidl("if (flags & NDR_IN) {");
2299 $self->indent;
2301 my $env = GenerateFunctionInEnv($fn);
2303 EnvSubstituteValue($env, $fn);
2305 foreach my $e (@{$fn->{ELEMENTS}}) {
2306 if (grep(/in/,@{$e->{DIRECTION}})) {
2307 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2311 $self->deindent;
2312 $self->pidl("}");
2314 $self->pidl("if (flags & NDR_OUT) {");
2315 $self->indent;
2317 $env = GenerateFunctionOutEnv($fn);
2318 foreach my $e (@{$fn->{ELEMENTS}}) {
2319 if (grep(/out/,@{$e->{DIRECTION}})) {
2320 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2324 if ($fn->{RETURN_TYPE}) {
2325 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2328 $self->deindent;
2329 $self->pidl("}");
2330 $self->pidl("return NDR_ERR_SUCCESS;");
2331 $self->deindent;
2332 $self->pidl("}");
2333 $self->pidl("");
2336 sub AllocateArrayLevel($$$$$$)
2338 my ($self,$e,$l,$ndr,$var,$size) = @_;
2340 my $pl = GetPrevLevel($e, $l);
2341 if (defined($pl) and
2342 $pl->{TYPE} eq "POINTER" and
2343 $pl->{POINTER_TYPE} eq "ref"
2344 and not $l->{IS_ZERO_TERMINATED}) {
2345 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2346 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2347 $self->pidl("}");
2348 if (grep(/in/,@{$e->{DIRECTION}}) and
2349 grep(/out/,@{$e->{DIRECTION}})) {
2350 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2352 return;
2355 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2358 #####################################################################
2359 # parse a function
2360 sub ParseFunctionPull($$)
2362 my($self,$fn) = @_;
2363 my $ndr = "ndr";
2365 # pull function args
2366 $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;
2368 $self->pidl("{");
2369 $self->indent;
2371 # declare any internal pointers we need
2372 foreach my $e (@{$fn->{ELEMENTS}}) {
2373 $self->DeclarePtrVariables($e);
2374 $self->DeclareArrayVariables($e, "pull");
2377 my %double_cases = ();
2378 foreach my $e (@{$fn->{ELEMENTS}}) {
2379 next if ($e->{TYPE} eq "EMPTY");
2380 next if ($double_cases{"$e->{NAME}"});
2381 $self->DeclareMemCtxVariables($e);
2382 $double_cases{"$e->{NAME}"} = 1;
2385 $self->pidl("if (flags & NDR_IN) {");
2386 $self->indent;
2388 # auto-init the out section of a structure. I originally argued that
2389 # this was a bad idea as it hides bugs, but coping correctly
2390 # with initialisation and not wiping ref vars is turning
2391 # out to be too tricky (tridge)
2392 foreach my $e (@{$fn->{ELEMENTS}}) {
2393 next unless grep(/out/, @{$e->{DIRECTION}});
2394 $self->pidl("ZERO_STRUCT(r->out);");
2395 $self->pidl("");
2396 last;
2399 my $env = GenerateFunctionInEnv($fn);
2401 foreach my $e (@{$fn->{ELEMENTS}}) {
2402 next unless (grep(/in/, @{$e->{DIRECTION}}));
2403 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2406 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2407 # own flag rather than be in NDR_IN ?
2409 foreach my $e (@{$fn->{ELEMENTS}}) {
2410 next unless (grep(/out/, @{$e->{DIRECTION}}));
2411 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2412 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2413 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2414 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2415 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2416 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2417 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2419 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2420 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2421 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2422 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2423 check_fully_dereferenced($e, $env));
2424 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2426 if (grep(/in/, @{$e->{DIRECTION}})) {
2427 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2428 } else {
2429 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2431 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2432 if (grep(/in/, @{$e->{DIRECTION}})) {
2433 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2434 } else {
2435 $self->pidl("r->out.$e->{NAME} = NULL;");
2437 } else {
2438 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2440 if (grep(/in/, @{$e->{DIRECTION}})) {
2441 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2442 } else {
2443 $self->pidl("ZERO_STRUCTP(r->out.$e->{NAME});");
2448 $self->add_deferred();
2449 $self->deindent;
2450 $self->pidl("}");
2452 $self->pidl("if (flags & NDR_OUT) {");
2453 $self->indent;
2455 $env = GenerateFunctionOutEnv($fn);
2456 foreach my $e (@{$fn->{ELEMENTS}}) {
2457 next unless grep(/out/, @{$e->{DIRECTION}});
2458 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2461 if ($fn->{RETURN_TYPE}) {
2462 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2465 $self->add_deferred();
2466 $self->deindent;
2467 $self->pidl("}");
2469 $self->pidl("return NDR_ERR_SUCCESS;");
2470 $self->deindent;
2471 $self->pidl("}");
2472 $self->pidl("");
2475 sub AuthServiceStruct($$$)
2477 my ($self, $ifacename, $authservice) = @_;
2478 my @a = split /,/, $authservice;
2479 my $authservice_count = $#a + 1;
2481 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2482 foreach my $ap (@a) {
2483 $self->pidl("\t$ap, ");
2485 $self->pidl("};");
2486 $self->pidl("");
2488 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2489 $self->pidl("\t.count\t= $authservice_count,");
2490 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2491 $self->pidl("};");
2492 $self->pidl("");
2495 sub ParseGeneratePipeArray($$$)
2497 my ($self, $fn, $direction) = @_;
2499 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2500 $self->indent;
2502 foreach my $e (@{$fn->{ELEMENTS}}) {
2503 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2504 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2506 my $cname = "$e->{TYPE}_chunk";
2508 $self->pidl("{");
2509 $self->indent;
2510 $self->pidl("\"$direction.$e->{NAME}\",");
2511 $self->pidl("\"$cname\",");
2512 $self->pidl("sizeof(struct $cname),");
2513 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2514 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2515 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2516 $self->deindent;
2517 $self->pidl("},");
2519 $self->pidl("{ NULL, NULL, 0, NULL, NULL, NULL }");
2520 $self->deindent;
2521 $self->pidl("};");
2522 $self->pidl("");
2525 sub FunctionCallPipes($$)
2527 my ($self, $d) = @_;
2528 return if not defined($d->{OPNUM});
2530 my $in_pipes = 0;
2531 my $out_pipes = 0;
2533 foreach my $e (@{$d->{ELEMENTS}}) {
2534 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2536 if (grep(/in/, @{$e->{DIRECTION}})) {
2537 $in_pipes++;
2539 if (grep(/out/, @{$e->{DIRECTION}})) {
2540 $out_pipes++;
2544 if ($in_pipes) {
2545 $self->ParseGeneratePipeArray($d, "in");
2548 if ($out_pipes) {
2549 $self->ParseGeneratePipeArray($d, "out");
2553 sub FunctionCallEntry($$)
2555 my ($self, $d) = @_;
2556 return 0 if not defined($d->{OPNUM});
2558 my $in_pipes = 0;
2559 my $out_pipes = 0;
2561 foreach my $e (@{$d->{ELEMENTS}}) {
2562 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2564 if (grep(/in/, @{$e->{DIRECTION}})) {
2565 $in_pipes++;
2567 if (grep(/out/, @{$e->{DIRECTION}})) {
2568 $out_pipes++;
2572 my $in_pipes_ptr = "NULL";
2573 my $out_pipes_ptr = "NULL";
2575 if ($in_pipes) {
2576 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2579 if ($out_pipes) {
2580 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2583 $self->pidl("\t{");
2584 $self->pidl("\t\t\"$d->{NAME}\",");
2585 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2586 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2587 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2588 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2589 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2590 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2591 $self->pidl("\t},");
2592 return 1;
2595 #####################################################################
2596 # produce a function call table
2597 sub FunctionTable($$)
2599 my($self,$interface) = @_;
2600 my $count = 0;
2601 my $uname = uc $interface->{NAME};
2603 return if ($#{$interface->{FUNCTIONS}}+1 == 0);
2604 return unless defined ($interface->{PROPERTIES}->{uuid});
2606 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2607 $self->FunctionCallPipes($d);
2610 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2612 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2613 $count += $self->FunctionCallEntry($d);
2615 $self->pidl("\t{ NULL, 0, NULL, NULL, NULL }");
2616 $self->pidl("};");
2617 $self->pidl("");
2619 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2620 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2621 $self->pidl("\t$ep, ");
2623 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2625 $self->pidl("};");
2626 $self->pidl("");
2628 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2629 $self->pidl("\t.count\t= $endpoint_count,");
2630 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2631 $self->pidl("};");
2632 $self->pidl("");
2634 if (! defined $interface->{PROPERTIES}->{authservice}) {
2635 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2638 $self->AuthServiceStruct($interface->{NAME},
2639 $interface->{PROPERTIES}->{authservice});
2641 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2642 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2643 $self->pidl("\t.syntax_id\t= {");
2644 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2645 $self->pidl("\t\tNDR_$uname\_VERSION");
2646 $self->pidl("\t},");
2647 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2648 $self->pidl("\t.num_calls\t= $count,");
2649 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2650 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2651 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2652 $self->pidl("};");
2653 $self->pidl("");
2657 #####################################################################
2658 # generate include statements for imported idl files
2659 sub HeaderImport
2661 my $self = shift;
2662 my @imports = @_;
2663 foreach (@imports) {
2664 $_ = unmake_str($_);
2665 s/\.idl$//;
2666 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2670 #####################################################################
2671 # generate include statements for included header files
2672 sub HeaderInclude
2674 my $self = shift;
2675 my @includes = @_;
2676 foreach (@includes) {
2677 $self->pidl_hdr("#include $_");
2681 #####################################################################
2682 # generate prototypes and defines for the interface definitions
2683 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2684 # NDR parser and so do not belong here, technically speaking
2685 sub HeaderInterface($$$)
2687 my($self,$interface,$needed) = @_;
2689 my $count = 0;
2691 if ($needed->{"compression"}) {
2692 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2695 if (has_property($interface, "object")) {
2696 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2699 if (defined $interface->{PROPERTIES}->{helper}) {
2700 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2703 if (defined $interface->{PROPERTIES}->{uuid}) {
2704 my $name = uc $interface->{NAME};
2705 $self->pidl_hdr("#define NDR_$name\_UUID " .
2706 Parse::Pidl::Util::make_str(lc($interface->{PROPERTIES}->{uuid})));
2708 if(!defined $interface->{PROPERTIES}->{version}) { $interface->{PROPERTIES}->{version} = "0.0"; }
2709 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{PROPERTIES}->{version}");
2711 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2713 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2714 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2716 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2719 foreach (@{$interface->{FUNCTIONS}}) {
2720 next if has_property($_, "noopnum");
2721 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2722 my $u_name = uc $_->{NAME};
2724 my $val = sprintf("0x%02x", $count);
2725 if (defined($interface->{BASE})) {
2726 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2729 $self->pidl_hdr("#define NDR_$u_name ($val)");
2731 $self->pidl_hdr("");
2732 $count++;
2735 my $val = $count;
2737 if (defined($interface->{BASE})) {
2738 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
2741 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
2745 sub ParseTypePush($$$$$$)
2747 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
2749 # save the old relative_base_offset
2750 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2751 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
2752 # restore the old relative_base_offset
2753 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2756 sub ParseTypePushFunction($$$)
2758 my ($self, $e, $varname) = @_;
2759 my $ndr = "ndr";
2761 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
2763 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2765 $self->pidl("{");
2766 $self->indent;
2767 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
2768 $self->pidl("return NDR_ERR_SUCCESS;");
2769 $self->deindent;
2770 $self->pidl("}");
2771 $self->pidl("");;
2774 sub ParseTypePull($$$$$$)
2776 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
2778 # save the old relative_base_offset
2779 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
2780 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
2781 # restore the old relative_base_offset
2782 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
2785 sub ParseTypePullFunction($$)
2787 my ($self, $e, $varname) = @_;
2788 my $ndr = "ndr";
2790 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
2792 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2794 $self->pidl("{");
2795 $self->indent;
2796 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
2797 $self->pidl("return NDR_ERR_SUCCESS;");
2798 $self->deindent;
2799 $self->pidl("}");
2800 $self->pidl("");
2803 sub ParseTypePrint($$$$)
2805 my ($self, $e, $ndr, $varname) = @_;
2807 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
2810 sub ParseTypePrintFunction($$$)
2812 my ($self, $e, $varname) = @_;
2813 my $ndr = "ndr";
2815 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
2817 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
2819 return if (has_property($e, "noprint"));
2821 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
2822 $self->pidl("{");
2823 $self->indent;
2824 $self->ParseTypePrint($e, $ndr, $varname);
2825 $self->deindent;
2826 $self->pidl("}");
2827 $self->pidl("");
2830 sub ParseTypeNdrSize($$)
2832 my ($self,$t) = @_;
2834 my $varname = "r";
2835 my $tf = $typefamily{$t->{TYPE}};
2836 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
2838 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
2840 $self->pidl("{");
2841 $self->indent;
2842 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
2843 $self->deindent;
2844 $self->pidl("}");
2845 $self->pidl("");
2848 #####################################################################
2849 # parse the interface definitions
2850 sub ParseInterface($$$)
2852 my($self,$interface,$needed) = @_;
2854 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
2855 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
2857 $self->pidl_hdr("");
2859 $self->HeaderInterface($interface, $needed);
2861 # Typedefs
2862 foreach my $d (@{$interface->{TYPES}}) {
2863 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
2864 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
2865 $self->ParsePipePushChunk($d);
2866 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
2867 $self->ParsePipePullChunk($d);
2868 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
2869 $self->ParsePipePrintChunk($d);
2871 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
2872 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
2873 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2874 next;
2877 next unless(typeHasBody($d));
2879 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
2880 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
2881 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
2883 # Make sure we don't generate a function twice...
2884 $needed->{TypeFunctionName("ndr_push", $d)} =
2885 $needed->{TypeFunctionName("ndr_pull", $d)} =
2886 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
2888 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
2891 # Functions
2892 foreach my $d (@{$interface->{FUNCTIONS}}) {
2893 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
2894 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
2895 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
2898 $self->FunctionTable($interface);
2900 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
2903 sub GenerateIncludes($)
2905 my ($self) = @_;
2906 if (is_intree()) {
2907 $self->pidl("#include \"includes.h\"");
2908 } else {
2909 $self->pidl("#ifndef _GNU_SOURCE");
2910 $self->pidl("#define _GNU_SOURCE");
2911 $self->pidl("#endif");
2912 $self->pidl("#include <stdint.h>");
2913 $self->pidl("#include <stdlib.h>");
2914 $self->pidl("#include <stdio.h>");
2915 $self->pidl("#include <stdbool.h>");
2916 $self->pidl("#include <stdarg.h>");
2917 $self->pidl("#include <string.h>");
2921 #####################################################################
2922 # parse a parsed IDL structure back into an IDL file
2923 sub Parse($$$$)
2925 my($self, $ndr,$gen_header,$ndr_header) = @_;
2927 $self->pidl_hdr("/* header auto-generated by pidl */");
2928 $self->pidl_hdr("");
2929 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
2930 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
2931 $self->pidl_hdr("");
2933 $self->pidl("/* parser auto-generated by pidl */");
2934 $self->pidl("");
2935 $self->GenerateIncludes();
2936 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
2937 $self->pidl("");
2939 my %needed = ();
2941 foreach (@{$ndr}) {
2942 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
2945 foreach (@{$ndr}) {
2946 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
2947 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
2948 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
2951 return ($self->{res_hdr}, $self->{res});
2954 sub NeededElement($$$)
2956 my ($e, $dir, $needed) = @_;
2958 return if ($e->{TYPE} eq "EMPTY");
2960 return if (ref($e->{TYPE}) eq "HASH" and
2961 not defined($e->{TYPE}->{NAME}));
2963 my ($t, $rt);
2964 if (ref($e->{TYPE}) eq "HASH") {
2965 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
2966 } else {
2967 $t = $e->{TYPE};
2970 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
2971 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
2972 } else {
2973 $rt = $e->{REPRESENTATION_TYPE};
2976 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
2978 my @fn = ();
2979 if ($dir eq "print") {
2980 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
2981 } elsif ($dir eq "pull") {
2982 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
2983 push (@fn, "ndr_$t\_to_$rt")
2984 if ($rt ne $t);
2985 } elsif ($dir eq "push") {
2986 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
2987 push (@fn, "ndr_$rt\_to_$t")
2988 if ($rt ne $t);
2989 } else {
2990 die("invalid direction `$dir'");
2993 foreach (@fn) {
2994 unless (defined($needed->{$_})) {
2995 $needed->{$_} = 1;
3000 sub NeededFunction($$)
3002 my ($fn,$needed) = @_;
3003 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
3004 $needed->{"ndr_push_$fn->{NAME}"} = 1;
3005 $needed->{"ndr_print_$fn->{NAME}"} = 1;
3006 foreach my $e (@{$fn->{ELEMENTS}}) {
3007 $e->{PARENT} = $fn;
3008 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3012 sub NeededType($$$)
3014 sub NeededType($$$);
3015 my ($t,$needed,$req) = @_;
3017 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3018 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3020 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3021 return unless defined($t->{ELEMENTS});
3022 for my $e (@{$t->{ELEMENTS}}) {
3023 $e->{PARENT} = $t;
3024 if (has_property($e, "compression")) {
3025 $needed->{"compression"} = 1;
3027 NeededElement($e, $req, $needed);
3028 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3033 #####################################################################
3034 # work out what parse functions are needed
3035 sub NeededInterface($$)
3037 my ($interface,$needed) = @_;
3038 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3039 foreach (reverse @{$interface->{TYPES}}) {
3041 if (has_property($_, "public")) {
3042 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3043 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3046 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3047 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3048 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3049 if (has_property($_, "gensize")) {
3050 $needed->{"ndr_size_$_->{NAME}"} = 1;
3055 sub TypeFunctionName($$)
3057 my ($prefix, $t) = @_;
3059 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3060 $t->{TYPE} eq "TYPEDEF");
3061 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3062 return "$prefix\_$t";