pidl: Automatically manage creating and freeing the compression state in generated...
[Samba.git] / pidl / lib / Parse / Pidl / Samba4 / NDR / Parser.pm
blob230b42dbbbf989cd97afe0135784c686eed2a3ef
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;
9 use parent Parse::Pidl::Base;
11 require Exporter;
12 push @ISA, qw(Exporter);
13 @EXPORT_OK = qw(check_null_pointer NeededFunction NeededElement NeededType $res NeededInterface TypeFunctionName ParseElementPrint);
15 use strict;
16 use warnings;
17 use Parse::Pidl::Typelist qw(hasType getType mapTypeName typeHasBody);
18 use Parse::Pidl::Util qw(has_property
19 ParseExpr
20 ParseExprExt
21 print_uuid
22 unmake_str
23 parse_int
24 parse_range);
25 use Parse::Pidl::CUtil qw(get_pointer_to get_value_of get_array_element);
26 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe is_charset_array);
27 use Parse::Pidl::Samba4 qw(is_intree choose_header ArrayDynamicallyAllocated);
28 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
29 use Parse::Pidl qw(warning);
31 use vars qw($VERSION);
32 $VERSION = '0.01';
34 # list of known types
35 my %typefamily;
37 sub new($$) {
38 my ($class) = @_;
39 my $self = { res => "", res_hdr => "", deferred => [], tabs => "", defer_tabs => "" };
40 bless($self, $class);
43 sub get_typefamily($)
45 my $n = shift;
46 return $typefamily{$n};
49 sub append_prefix($$)
51 my ($e, $var_name) = @_;
52 my $pointers = 0;
53 my $arrays = 0;
55 foreach my $l (@{$e->{LEVELS}}) {
56 if ($l->{TYPE} eq "POINTER") {
57 $pointers++;
58 } elsif ($l->{TYPE} eq "ARRAY") {
59 $arrays++;
60 if (($pointers == 0) and
61 (not $l->{IS_FIXED}) and
62 (not $l->{IS_INLINE})) {
63 return get_value_of($var_name);
65 } elsif ($l->{TYPE} eq "DATA") {
66 if (Parse::Pidl::Typelist::scalar_is_reference($l->{DATA_TYPE})) {
67 return get_value_of($var_name) unless ($pointers or $arrays);
72 return $var_name;
75 sub has_fast_array($$)
77 my ($e,$l) = @_;
79 return 0 if ($l->{TYPE} ne "ARRAY");
81 my $nl = GetNextLevel($e,$l);
82 return 0 unless ($nl->{TYPE} eq "DATA");
83 return 0 unless (hasType($nl->{DATA_TYPE}));
85 my $t = getType($nl->{DATA_TYPE});
87 # Only uint8 has a fast array function at the moment
88 return ($t->{NAME} eq "uint8");
91 sub is_public_struct
93 my ($d) = @_;
94 if (!has_property($d, "public")) {
95 return 0;
97 my $t = $d;
98 if ($d->{TYPE} eq "TYPEDEF") {
99 $t = $d->{DATA};
101 return $t->{TYPE} eq "STRUCT";
104 ####################################
105 # defer() is like pidl(), but adds to
106 # a deferred buffer which is then added to the
107 # output buffer at the end of the structure/union/function
108 # This is needed to cope with code that must be pushed back
109 # to the end of a block of elements
110 sub defer_indent($) { my ($self) = @_; $self->{defer_tabs}.="\t"; }
111 sub defer_deindent($) { my ($self) = @_; $self->{defer_tabs}=substr($self->{defer_tabs}, 0, -1); }
113 sub defer($$)
115 my ($self, $d) = @_;
116 if ($d) {
117 push(@{$self->{deferred}}, $self->{defer_tabs}.$d);
121 ########################################
122 # add the deferred content to the current
123 # output
124 sub add_deferred($)
126 my ($self) = @_;
127 $self->pidl($_) foreach (@{$self->{deferred}});
128 $self->{deferred} = [];
129 $self->{defer_tabs} = "";
132 #####################################################################
133 # declare a function public or static, depending on its attributes
134 sub fn_declare($$$$)
136 my ($self,$type,$fn,$decl) = @_;
138 if (has_property($fn, "no$type")) {
139 $self->pidl_hdr("$decl;");
140 return 0;
143 if (has_property($fn, "public")) {
144 $self->pidl_hdr("$decl;");
145 $self->pidl("_PUBLIC_ $decl");
146 } else {
147 $self->pidl("static $decl");
150 return 1;
153 ###################################################################
154 # setup any special flags for an element or structure
155 sub start_flags($$$)
157 my ($self, $e, $ndr) = @_;
158 my $flags = has_property($e, "flag");
159 if (defined $flags) {
160 $self->pidl("{");
161 $self->indent;
162 $self->pidl("uint32_t _flags_save_$e->{TYPE} = $ndr->flags;");
163 $self->pidl("ndr_set_flags(&$ndr->flags, $flags);");
167 ###################################################################
168 # end any special flags for an element or structure
169 sub end_flags($$$)
171 my ($self, $e, $ndr) = @_;
172 my $flags = has_property($e, "flag");
173 if (defined $flags) {
174 $self->pidl("$ndr->flags = _flags_save_$e->{TYPE};");
175 $self->deindent;
176 $self->pidl("}");
180 #####################################################################
181 # parse the data of an array - push side
182 sub ParseArrayPushHeader($$$$$$)
184 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
186 my $size;
187 my $length;
189 if ($l->{IS_ZERO_TERMINATED}) {
190 if (has_property($e, "charset")) {
191 $size = $length = "ndr_charset_length($var_name, CH_$e->{PROPERTIES}->{charset})";
192 } else {
193 $size = $length = "ndr_string_length($var_name, sizeof(*$var_name))";
195 if (defined($l->{SIZE_IS})) {
196 $size = ParseExpr($l->{SIZE_IS}, $env, $e);
198 if (defined($l->{LENGTH_IS})) {
199 $length = ParseExpr($l->{LENGTH_IS}, $env, $e);
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 dereferenced 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 is_deferred_switch_non_empty($)
320 # 1 if there needs to be a deferred branch in an ndr_pull/push,
321 # 0 otherwise.
322 my ($e) = @_;
323 my $have_default = 0;
324 foreach my $el (@{$e->{ELEMENTS}}) {
325 if ($el->{CASE} eq "default") {
326 $have_default = 1;
328 if ($el->{TYPE} ne "EMPTY") {
329 if (ContainsDeferred($el, $el->{LEVELS}[0])) {
330 return 1;
334 return ! $have_default;
337 sub ParseArrayPullGetSize($$$$$$)
339 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
341 my $size;
343 my $array_size = "size_$e->{NAME}_$l->{LEVEL_INDEX}";
345 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
346 $self->pidl("NDR_CHECK(ndr_get_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_size));");
348 } elsif ($l->{IS_CONFORMANT}) {
349 # This will be the last use of the array_size token
350 $self->pidl("NDR_CHECK(ndr_steal_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_size));");
352 } elsif ($l->{IS_ZERO_TERMINATED} and $l->{SIZE_IS} == 0 and $l->{LENGTH_IS} == 0) { # Noheader arrays
353 $size = "ndr_get_string_size($ndr, sizeof(*$var_name))";
354 $self->pidl("$array_size = $size;");
356 } else {
357 $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
358 check_null_pointer($e, $env, sub { $self->pidl(shift); },
359 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
360 check_fully_dereferenced($e, $env));
361 $self->pidl("$array_size = $size;");
364 if (my $range = has_property($e, "range")) {
365 my ($low, $high) = parse_range($range);
366 if ($low < 0) {
367 warning(0, "$low is invalid for the range of an array size");
369 if ($low == 0) {
370 $self->pidl("if ($array_size > $high) {");
371 } else {
372 $self->pidl("if ($array_size < $low || $array_size > $high) {");
374 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
375 $self->pidl("}");
378 return $array_size;
381 #####################################################################
382 # parse an array - pull side
383 sub ParseArrayPullGetLength($$$$$$;$)
385 my ($self,$e,$l,$ndr,$var_name,$env,$array_size) = @_;
387 if (not defined($array_size)) {
388 $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
391 if (not $l->{IS_VARYING}) {
392 return $array_size;
395 my $array_length = "length_$e->{NAME}_$l->{LEVEL_INDEX}";
396 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
397 $self->pidl("NDR_CHECK(ndr_get_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_length));");
398 } else {
399 # This will be the last use of the array_length token
400 $self->pidl("NDR_CHECK(ndr_steal_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", &$array_length));");
403 if (my $range = has_property($e, "range")) {
404 my ($low, $high) = parse_range($range);
405 if ($low < 0) {
406 warning(0, "$low is invalid for the range of an array size");
408 if ($low == 0) {
409 $self->pidl("if ($array_length > $high) {");
410 } else {
411 $self->pidl("if ($array_length < $low || $array_length > $high) {");
413 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
414 $self->pidl("}");
417 return $array_length;
420 #####################################################################
421 # parse an array - pull side
422 sub ParseArrayPullHeader($$$$$$)
424 my ($self,$e,$l,$ndr,$var_name,$env) = @_;
426 if ((!$l->{IS_SURROUNDING}) and $l->{IS_CONFORMANT}) {
427 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, " . get_pointer_to($var_name) . "));");
430 if ($l->{IS_VARYING}) {
431 $self->pidl("NDR_CHECK(ndr_pull_array_length($ndr, " . get_pointer_to($var_name) . "));");
434 my $array_size = $self->ParseArrayPullGetSize($e, $l, $ndr, $var_name, $env);
435 my $array_length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env, $array_size);
437 if ($array_length ne $array_size) {
438 $self->pidl("if ($array_length > $array_size) {");
439 $self->indent;
440 $self->pidl("return ndr_pull_error($ndr, NDR_ERR_ARRAY_SIZE, \"Bad array size %u should exceed array length %u\", $array_size, $array_length);");
441 $self->deindent;
442 $self->pidl("}");
445 if ($l->{IS_CONFORMANT} and (defined($l->{SIZE_IS}) or not $l->{IS_ZERO_TERMINATED})) {
446 $self->defer("if ($var_name) {");
447 $self->defer_indent;
448 my $size = ParseExprExt($l->{SIZE_IS}, $env, $e->{ORIGINAL},
449 check_null_pointer($e, $env, sub { $self->defer(shift); },
450 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
451 check_fully_dereferenced($e, $env));
452 if (ContainsDeferred($e, $l)) {
453 # We will be needing the array_size token in
454 # the NDR_BUFFERS call, so don't steal it now
455 $self->defer("NDR_CHECK(ndr_check_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
456 } else {
457 # This will be deferred until after the last ndr_get_array_size()
458 $self->defer("NDR_CHECK(ndr_check_steal_array_size($ndr, (void*)" . get_pointer_to($var_name) . ", $size));");
460 $self->defer_deindent;
461 $self->defer("}");
464 if ($l->{IS_VARYING} and (defined($l->{LENGTH_IS}) or not $l->{IS_ZERO_TERMINATED})) {
465 $self->defer("if ($var_name) {");
466 $self->defer_indent;
467 my $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
468 check_null_pointer($e, $env, sub { $self->defer(shift); },
469 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for length_is()\");"),
470 check_fully_dereferenced($e, $env));
471 # This will be deferred until after the last ndr_get_array_length()
472 $self->defer("NDR_CHECK(ndr_check_steal_array_length($ndr, (void*)" . get_pointer_to($var_name) . ", $length));");
473 $self->defer_deindent;
474 $self->defer("}");
477 if (ArrayDynamicallyAllocated($e,$l) and not is_charset_array($e,$l)) {
478 $self->AllocateArrayLevel($e,$l,$ndr,$var_name,$array_size);
481 return $array_length;
484 sub compression_alg($$$)
486 my ($e, $l, $env) = @_;
487 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
489 return ParseExpr($alg, $env, $e->{ORIGINAL});
492 sub compression_clen($$$)
494 my ($e, $l, $env) = @_;
495 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
497 return ParseExpr($clen, $env, $e->{ORIGINAL});
500 sub compression_dlen($$$)
502 my ($e,$l,$env) = @_;
503 my ($alg, $clen, $dlen) = split(/,/, $l->{COMPRESSION});
505 return ParseExpr($dlen, $env, $e->{ORIGINAL});
508 sub ParseCompressionPushStart($$$$$)
510 my ($self,$e,$l,$ndr,$env) = @_;
511 my $comndr = "$ndr\_compressed";
512 my $alg = compression_alg($e, $l, $env);
514 $self->pidl("{");
515 $self->indent;
516 $self->pidl("struct ndr_push *$comndr;");
517 $self->pidl("NDR_CHECK(ndr_push_compression_state_init($ndr, $alg, &$ndr->cstate));");
518 $self->pidl("NDR_CHECK(ndr_push_compression_start($ndr, &$comndr, $alg));");
520 return $comndr;
523 sub ParseCompressionPushEnd($$$$$)
525 my ($self,$e,$l,$ndr,$env) = @_;
526 my $comndr = "$ndr\_compressed";
527 my $alg = compression_alg($e, $l, $env);
529 $self->pidl("NDR_CHECK(ndr_push_compression_end($ndr, $comndr, $alg));");
530 $self->pidl("NDR_CHECK(ndr_push_compression_state_free($ndr->cstate));");
531 $self->deindent;
532 $self->pidl("}");
535 sub ParseCompressionPullStart($$$$$)
537 my ($self,$e,$l,$ndr,$env) = @_;
538 my $comndr = "$ndr\_compressed";
539 my $alg = compression_alg($e, $l, $env);
540 my $dlen = compression_dlen($e, $l, $env);
541 my $clen = compression_clen($e, $l, $env);
543 $self->pidl("{");
544 $self->indent;
545 $self->pidl("struct ndr_pull *$comndr;");
546 $self->pidl("NDR_CHECK(ndr_pull_compression_start($ndr, &$comndr, $alg, $dlen, $clen));");
548 return $comndr;
551 sub ParseCompressionPullEnd($$$$$)
553 my ($self,$e,$l,$ndr,$env) = @_;
554 my $comndr = "$ndr\_compressed";
555 my $alg = compression_alg($e, $l, $env);
556 my $dlen = compression_dlen($e, $l, $env);
558 $self->pidl("NDR_CHECK(ndr_pull_compression_end($ndr, $comndr, $alg, $dlen));");
559 $self->deindent;
560 $self->pidl("}");
563 sub ParseSubcontextPushStart($$$$$)
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_push *$subndr;");
572 $self->pidl("NDR_CHECK(ndr_push_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
574 if (defined $l->{COMPRESSION}) {
575 $subndr = $self->ParseCompressionPushStart($e, $l, $subndr, $env);
578 return $subndr;
581 sub ParseSubcontextPushEnd($$$$$)
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->ParseCompressionPushEnd($e, $l, $subndr, $env);
591 $self->pidl("NDR_CHECK(ndr_push_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
592 $self->deindent;
593 $self->pidl("}");
596 sub ParseSubcontextPullStart($$$$$)
598 my ($self,$e,$l,$ndr,$env) = @_;
599 my $subndr = "_ndr_$e->{NAME}";
600 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
602 $self->pidl("{");
603 $self->indent;
604 $self->pidl("struct ndr_pull *$subndr;");
605 $self->pidl("NDR_CHECK(ndr_pull_subcontext_start($ndr, &$subndr, $l->{HEADER_SIZE}, $subcontext_size));");
607 if (defined $l->{COMPRESSION}) {
608 $subndr = $self->ParseCompressionPullStart($e, $l, $subndr, $env);
611 return $subndr;
614 sub ParseSubcontextPullEnd($$$$$)
616 my ($self,$e,$l,$ndr,$env) = @_;
617 my $subndr = "_ndr_$e->{NAME}";
618 my $subcontext_size = ParseExpr($l->{SUBCONTEXT_SIZE}, $env, $e->{ORIGINAL});
620 if (defined $l->{COMPRESSION}) {
621 $self->ParseCompressionPullEnd($e, $l, $subndr, $env);
624 $self->pidl("NDR_CHECK(ndr_pull_subcontext_end($ndr, $subndr, $l->{HEADER_SIZE}, $subcontext_size));");
625 $self->deindent;
626 $self->pidl("}");
629 sub ParseElementPushLevel
631 my ($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
633 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
635 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_CONFORMANT} or $l->{IS_VARYING})) {
636 $var_name = get_pointer_to($var_name);
639 if (defined($ndr_flags)) {
640 if ($l->{TYPE} eq "SUBCONTEXT") {
641 my $subndr = $self->ParseSubcontextPushStart($e, $l, $ndr, $env);
642 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $subndr, $var_name, $env, 1, 1);
643 $self->ParseSubcontextPushEnd($e, $l, $ndr, $env);
644 } elsif ($l->{TYPE} eq "POINTER") {
645 $self->ParsePtrPush($e, $l, $ndr, $var_name);
646 } elsif ($l->{TYPE} eq "ARRAY") {
647 my $length = $self->ParseArrayPushHeader($e, $l, $ndr, $var_name, $env);
649 my $nl = GetNextLevel($e, $l);
651 # Allow speedups for arrays of scalar types
652 if (is_charset_array($e,$l)) {
653 if ($l->{IS_TO_NULL}) {
654 $self->pidl("NDR_CHECK(ndr_push_charset_to_null($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
655 } else {
656 $self->pidl("NDR_CHECK(ndr_push_charset($ndr, $ndr_flags, $var_name, $length, sizeof(" . mapTypeName($nl->{DATA_TYPE}) . "), CH_$e->{PROPERTIES}->{charset}));");
658 return;
659 } elsif (has_fast_array($e,$l)) {
660 $self->pidl("NDR_CHECK(ndr_push_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
661 return;
663 } elsif ($l->{TYPE} eq "DATA") {
664 $self->ParseDataPush($e, $l, $ndr, $var_name, $primitives, $deferred);
665 } elsif ($l->{TYPE} eq "TYPEDEF") {
666 $typefamily{$e->{DATA}->{TYPE}}->{PUSH_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
670 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
671 $self->pidl("/* [ignore] '$e->{NAME}' */");
672 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
673 my $rel_var_name = $var_name;
674 if ($l->{POINTER_TYPE} ne "ref") {
675 $self->pidl("if ($var_name) {");
676 $self->indent;
677 if ($l->{POINTER_TYPE} eq "relative") {
678 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_start($ndr, $rel_var_name));");
680 if ($l->{POINTER_TYPE} eq "relative_short") {
681 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr2($ndr, $var_name));");
684 $var_name = get_value_of($var_name);
685 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 1);
687 if ($l->{POINTER_TYPE} ne "ref") {
688 if ($l->{POINTER_TYPE} eq "relative") {
689 $self->pidl("NDR_CHECK(ndr_push_relative_ptr2_end($ndr, $rel_var_name));");
691 $self->deindent;
692 $self->pidl("}");
694 } elsif ($l->{TYPE} eq "ARRAY" and not has_fast_array($e,$l) and
695 not is_charset_array($e, $l)) {
696 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
697 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
699 my $array_pointless = ($length eq "0");
701 if ($array_pointless) {
702 warning($e->{ORIGINAL}, "pointless array `$e->{NAME}' will always have size 0");
705 $var_name = get_array_element($var_name, $counter);
707 if ((($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) and not $array_pointless) {
708 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
709 $self->indent;
710 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 1, 0);
711 $self->deindent;
712 $self->pidl("}");
715 if ($deferred and ContainsDeferred($e, $l) and not $array_pointless) {
716 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
717 $self->indent;
718 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, 0, 1);
719 $self->deindent;
720 $self->pidl("}");
722 } elsif ($l->{TYPE} eq "SWITCH") {
723 my $nl = GetNextLevel($e,$l);
724 my $needs_deferred_switch = is_deferred_switch_non_empty($nl);
726 # Avoid setting a switch value if it will not be
727 # consumed again in the NDR_BUFFERS pull
728 if ($needs_deferred_switch or !$deferred) {
729 $self->ParseSwitchPush($e, $l, $ndr, $var_name, $env);
731 $self->ParseElementPushLevel($e, GetNextLevel($e, $l), $ndr, $var_name, $env, $primitives, $deferred);
735 #####################################################################
736 # parse scalars in a structure element
737 sub ParseElementPush($$$$$$)
739 my ($self,$e,$ndr,$env,$primitives,$deferred) = @_;
740 my $subndr = undef;
742 my $var_name = $env->{$e->{NAME}};
744 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
745 $self->pidl("/* [skip] '$var_name' */");
746 return;
749 return if ContainsPipe($e, $e->{LEVELS}[0]);
751 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
753 # Representation type is different from transmit_as
754 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
755 $self->pidl("{");
756 $self->indent;
757 my $transmit_name = "_transmit_$e->{NAME}";
758 $self->pidl(mapTypeName($e->{TYPE}) ." $transmit_name;");
759 $self->pidl("NDR_CHECK(ndr_$e->{REPRESENTATION_TYPE}_to_$e->{TYPE}($var_name, " . get_pointer_to($transmit_name) . "));");
760 $var_name = $transmit_name;
763 $var_name = append_prefix($e, $var_name);
765 $self->start_flags($e, $ndr);
767 if (defined(my $value = has_property($e, "value"))) {
768 $var_name = ParseExpr($value, $env, $e->{ORIGINAL});
771 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $var_name, $env, $primitives, $deferred);
773 $self->end_flags($e, $ndr);
775 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
776 $self->deindent;
777 $self->pidl("}");
781 #####################################################################
782 # parse a pointer in a struct element or function
783 sub ParsePtrPush($$$$$)
785 my ($self,$e,$l,$ndr,$var_name) = @_;
787 if ($l->{POINTER_TYPE} eq "ref") {
788 if ($l->{LEVEL_INDEX} > 0) {
789 $self->pidl("if ($var_name == NULL) {");
790 $self->indent;
791 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
792 $self->deindent;
793 $self->pidl("}");
795 if ($l->{LEVEL} eq "EMBEDDED") {
796 $self->pidl("NDR_CHECK(ndr_push_ref_ptr(ndr)); /* $var_name */");
798 } elsif ($l->{POINTER_TYPE} eq "relative") {
799 $self->pidl("NDR_CHECK(ndr_push_relative_ptr1($ndr, $var_name));");
800 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
801 $self->pidl("NDR_CHECK(ndr_push_short_relative_ptr1($ndr, $var_name));");
802 } elsif ($l->{POINTER_TYPE} eq "unique") {
803 $self->pidl("NDR_CHECK(ndr_push_unique_ptr($ndr, $var_name));");
804 } elsif ($l->{POINTER_TYPE} eq "full") {
805 $self->pidl("NDR_CHECK(ndr_push_full_ptr($ndr, $var_name));");
806 } elsif ($l->{POINTER_TYPE} eq "ignore") {
807 # We don't want this pointer to appear on the wire at all
808 $self->pidl("NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, 0));");
809 } else {
810 die("Unhandled pointer type $l->{POINTER_TYPE}");
814 sub need_pointer_to($$$)
816 my ($e, $l, $scalar_only) = @_;
818 my $t;
819 if (ref($l->{DATA_TYPE})) {
820 $t = "$l->{DATA_TYPE}->{TYPE}_$l->{DATA_TYPE}->{NAME}";
821 } else {
822 $t = $l->{DATA_TYPE};
825 if (not Parse::Pidl::Typelist::is_scalar($t)) {
826 return 1 if $scalar_only;
829 my $arrays = 0;
831 foreach my $tl (@{$e->{LEVELS}}) {
832 last if $l == $tl;
833 if ($tl->{TYPE} eq "ARRAY") {
834 $arrays++;
838 if (Parse::Pidl::Typelist::scalar_is_reference($t)) {
839 return 1 unless $arrays;
842 return 0;
845 sub ParseDataPrint($$$$$)
847 my ($self, $e, $l, $ndr, $var_name) = @_;
849 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
851 if (need_pointer_to($e, $l, 1)) {
852 $var_name = get_pointer_to($var_name);
855 $self->pidl(TypeFunctionName("ndr_print", $l->{DATA_TYPE})."($ndr, \"$e->{NAME}\", $var_name);");
856 } else {
857 $self->ParseTypePrint($l->{DATA_TYPE}, $ndr, $var_name);
861 #####################################################################
862 # print scalars in a structure element
863 sub ParseElementPrint($$$$$)
865 my($self, $e, $ndr, $var_name, $env) = @_;
867 return if (has_property($e, "noprint"));
868 my $cur_depth = 0;
869 my $ignore_depth = 0xFFFF;
871 $self->start_flags($e, $ndr);
872 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
873 $self->pidl("ndr_print_$e->{REPRESENTATION_TYPE}($ndr, \"$e->{NAME}\", $var_name);");
874 $self->end_flags($e, $ndr);
875 return;
878 $var_name = append_prefix($e, $var_name);
880 if (defined(my $value = has_property($e, "value"))) {
881 $var_name = "($ndr->flags & LIBNDR_PRINT_SET_VALUES)?" . ParseExpr($value,$env, $e->{ORIGINAL}) . ":$var_name";
884 foreach my $l (@{$e->{LEVELS}}) {
885 $cur_depth += 1;
887 if ($cur_depth > $ignore_depth) {
888 next;
891 if ($l->{TYPE} eq "POINTER") {
892 $self->pidl("ndr_print_ptr($ndr, \"$e->{NAME}\", $var_name);");
893 if ($l->{POINTER_TYPE} eq "ignore") {
894 $self->pidl("/* [ignore] '$e->{NAME}' */");
895 $ignore_depth = $cur_depth;
896 last;
898 $self->pidl("$ndr->depth++;");
899 if ($l->{POINTER_TYPE} ne "ref") {
900 $self->pidl("if ($var_name) {");
901 $self->indent;
903 $var_name = get_value_of($var_name);
904 } elsif ($l->{TYPE} eq "ARRAY") {
905 my $length;
907 if ($l->{IS_CONFORMANT} or $l->{IS_VARYING}) {
908 $var_name = get_pointer_to($var_name);
911 if ($l->{IS_ZERO_TERMINATED} and not defined($l->{LENGTH_IS})) {
912 $length = "ndr_string_length($var_name, sizeof(*$var_name))";
913 } else {
914 $length = ParseExprExt($l->{LENGTH_IS}, $env, $e->{ORIGINAL},
915 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
918 if (is_charset_array($e,$l)) {
919 $self->pidl("ndr_print_string($ndr, \"$e->{NAME}\", $var_name);");
920 last;
921 } elsif (has_fast_array($e, $l)) {
922 my $nl = GetNextLevel($e, $l);
923 $self->pidl("ndr_print_array_$nl->{DATA_TYPE}($ndr, \"$e->{NAME}\", $var_name, $length);");
924 last;
925 } else {
926 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
928 $self->pidl("$ndr->print($ndr, \"\%s: ARRAY(\%d)\", \"$e->{NAME}\", (int)$length);");
929 $self->pidl("$ndr->depth++;");
930 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
931 $self->indent;
933 $var_name = get_array_element($var_name, $counter);
935 } elsif ($l->{TYPE} eq "DATA") {
936 $self->ParseDataPrint($e, $l, $ndr, $var_name);
937 } elsif ($l->{TYPE} eq "SWITCH") {
938 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
939 check_null_pointer($e, $env, sub { $self->pidl(shift); }, "return;"), check_fully_dereferenced($e, $env));
940 $self->pidl("ndr_print_set_switch_value($ndr, " . get_pointer_to($var_name) . ", $switch_var);");
944 foreach my $l (reverse @{$e->{LEVELS}}) {
945 $cur_depth -= 1;
947 if ($cur_depth > $ignore_depth) {
948 next;
951 if ($l->{TYPE} eq "POINTER") {
952 if ($l->{POINTER_TYPE} eq "ignore") {
953 next;
956 if ($l->{POINTER_TYPE} ne "ref") {
957 $self->deindent;
958 $self->pidl("}");
960 $self->pidl("$ndr->depth--;");
961 } elsif (($l->{TYPE} eq "ARRAY")
962 and not is_charset_array($e,$l)
963 and not has_fast_array($e,$l)) {
964 $self->deindent;
965 $self->pidl("}");
966 $self->pidl("$ndr->depth--;");
970 $self->end_flags($e, $ndr);
973 #####################################################################
974 # parse scalars in a structure element - pull size
975 sub ParseSwitchPull($$$$$$)
977 my($self,$e,$l,$ndr,$var_name,$env) = @_;
978 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
979 check_null_pointer($e, $env, sub { $self->pidl(shift); },
980 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
981 check_fully_dereferenced($e, $env));
983 $var_name = get_pointer_to($var_name);
984 $self->pidl("NDR_CHECK(ndr_pull_set_switch_value($ndr, $var_name, $switch_var));");
987 #####################################################################
988 # push switch element
989 sub ParseSwitchPush($$$$$$)
991 my($self,$e,$l,$ndr,$var_name,$env) = @_;
992 my $switch_var = ParseExprExt($l->{SWITCH_IS}, $env, $e->{ORIGINAL},
993 check_null_pointer($e, $env, sub { $self->pidl(shift); },
994 "return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for switch_is()\");"),
995 check_fully_dereferenced($e, $env));
997 $var_name = get_pointer_to($var_name);
998 $self->pidl("NDR_CHECK(ndr_push_set_switch_value($ndr, $var_name, $switch_var));");
1001 sub ParseDataPull($$$$$$$)
1003 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
1005 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
1007 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1009 if (need_pointer_to($e, $l, 0)) {
1010 $var_name = get_pointer_to($var_name);
1013 $var_name = get_pointer_to($var_name);
1015 if (my $depth = has_property($e, "max_recursion")) {
1016 my $d = parse_int($depth);
1017 $self->pidl("NDR_RECURSION_CHECK($ndr, $d);");
1019 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_pull", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
1020 if (has_property($e, "max_recursion")) {
1021 $self->pidl("NDR_RECURSION_UNWIND($ndr);");
1024 my $pl = GetPrevLevel($e, $l);
1026 my $range = has_property($e, "range");
1027 if ($range and (not $pl or $pl->{TYPE} ne "ARRAY")) {
1028 $var_name = get_value_of($var_name);
1029 my $signed = Parse::Pidl::Typelist::is_signed($l->{DATA_TYPE});
1030 my ($low, $high) = parse_range($range);
1031 if ($low < 0 and not $signed) {
1032 warning(0, "$low is invalid for the range of an unsigned type");
1034 if ($low == 0 and not $signed) {
1035 $self->pidl("if ($var_name > $high) {");
1036 } else {
1037 $self->pidl("if ($var_name < $low || $var_name > $high) {");
1039 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_RANGE, \"value out of range\");");
1040 $self->pidl("}");
1042 } else {
1043 $self->ParseTypePull($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1047 sub ParseDataPush($$$$$$$)
1049 my ($self,$e,$l,$ndr,$var_name,$primitives,$deferred) = @_;
1051 if (not ref($l->{DATA_TYPE}) or defined($l->{DATA_TYPE}->{NAME})) {
1053 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1055 # strings are passed by value rather than reference
1056 if (need_pointer_to($e, $l, 1)) {
1057 $var_name = get_pointer_to($var_name);
1060 $self->pidl("NDR_CHECK(".TypeFunctionName("ndr_push", $l->{DATA_TYPE})."($ndr, $ndr_flags, $var_name));");
1061 } else {
1062 $self->ParseTypePush($l->{DATA_TYPE}, $ndr, $var_name, $primitives, $deferred);
1066 sub CalcNdrFlags($$$)
1068 my ($l,$primitives,$deferred) = @_;
1070 my $scalars = 0;
1071 my $buffers = 0;
1073 # Add NDR_SCALARS if this one is deferred
1074 # and deferreds may be pushed
1075 $scalars = 1 if ($l->{IS_DEFERRED} and $deferred);
1077 # Add NDR_SCALARS if this one is not deferred and
1078 # primitives may be pushed
1079 $scalars = 1 if (!$l->{IS_DEFERRED} and $primitives);
1081 # Add NDR_BUFFERS if this one contains deferred stuff
1082 # and deferreds may be pushed
1083 $buffers = 1 if ($l->{CONTAINS_DEFERRED} and $deferred);
1085 return "NDR_SCALARS|NDR_BUFFERS" if ($scalars and $buffers);
1086 return "NDR_SCALARS" if ($scalars);
1087 return "NDR_BUFFERS" if ($buffers);
1088 return undef;
1091 sub ParseMemCtxPullFlags($$$$)
1093 my ($self, $e, $l) = @_;
1095 return undef unless ($l->{TYPE} eq "POINTER" or $l->{TYPE} eq "ARRAY");
1096 return undef if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore"));
1098 return undef unless ($l->{TYPE} ne "ARRAY" or ArrayDynamicallyAllocated($e,$l));
1099 return undef if has_fast_array($e, $l);
1100 return undef if is_charset_array($e, $l);
1102 my $mem_flags = "0";
1104 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ref")) {
1105 my $nl = GetNextLevel($e, $l);
1106 return undef if ($nl->{TYPE} eq "PIPE");
1107 return undef if ($nl->{TYPE} eq "ARRAY");
1108 return undef if (($nl->{TYPE} eq "DATA") and ($nl->{DATA_TYPE} eq "string"));
1110 if ($l->{LEVEL} eq "TOP") {
1111 $mem_flags = "LIBNDR_FLAG_REF_ALLOC";
1115 return $mem_flags;
1118 sub ParseMemCtxPullStart($$$$$)
1120 my ($self, $e, $l, $ndr, $ptr_name) = @_;
1122 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1123 my $mem_c_ctx = $ptr_name;
1124 my $mem_c_flags = $self->ParseMemCtxPullFlags($e, $l);
1126 return unless defined($mem_c_flags);
1128 $self->pidl("$mem_r_ctx = NDR_PULL_GET_MEM_CTX($ndr);");
1129 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_c_ctx, $mem_c_flags);");
1132 sub ParseMemCtxPullEnd($$$$)
1134 my ($self, $e, $l, $ndr) = @_;
1136 my $mem_r_ctx = "_mem_save_$e->{NAME}_$l->{LEVEL_INDEX}";
1137 my $mem_r_flags = $self->ParseMemCtxPullFlags($e, $l);
1139 return unless defined($mem_r_flags);
1141 $self->pidl("NDR_PULL_SET_MEM_CTX($ndr, $mem_r_ctx, $mem_r_flags);");
1144 sub CheckStringTerminator($$$$$)
1146 my ($self,$ndr,$e,$l,$length) = @_;
1147 my $nl = GetNextLevel($e, $l);
1149 # Make sure last element is zero!
1150 $self->pidl("NDR_CHECK(ndr_check_string_terminator($ndr, $length, sizeof($nl->{DATA_TYPE}_t)));");
1153 sub ParseElementPullLevel
1155 my($self,$e,$l,$ndr,$var_name,$env,$primitives,$deferred) = @_;
1157 my $ndr_flags = CalcNdrFlags($l, $primitives, $deferred);
1158 my $array_length = undef;
1160 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1161 $self->pidl("/* [skip] '$var_name' */");
1162 if (not has_property($e, "skip_noinit")) {
1163 $self->pidl("NDR_ZERO_STRUCT($var_name);");
1165 return;
1168 if ($l->{TYPE} eq "ARRAY" and ($l->{IS_VARYING} or $l->{IS_CONFORMANT})) {
1169 $var_name = get_pointer_to($var_name);
1172 # Only pull something if there's actually something to be pulled
1173 if (defined($ndr_flags)) {
1174 if ($l->{TYPE} eq "SUBCONTEXT") {
1175 my $subndr = $self->ParseSubcontextPullStart($e, $l, $ndr, $env);
1176 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $subndr, $var_name, $env, 1, 1);
1177 $self->ParseSubcontextPullEnd($e, $l, $ndr, $env);
1178 } elsif ($l->{TYPE} eq "ARRAY") {
1179 my $length = $self->ParseArrayPullHeader($e, $l, $ndr, $var_name, $env);
1180 $array_length = $length;
1182 my $nl = GetNextLevel($e, $l);
1184 if (is_charset_array($e,$l)) {
1185 if ($l->{IS_ZERO_TERMINATED}) {
1186 $self->CheckStringTerminator($ndr, $e, $l, $length);
1188 if ($l->{IS_TO_NULL}) {
1189 $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}));");
1190 } else {
1191 $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}));");
1193 return;
1194 } elsif (has_fast_array($e, $l)) {
1195 if ($l->{IS_ZERO_TERMINATED}) {
1196 $self->CheckStringTerminator($ndr,$e,$l,$length);
1198 $self->pidl("NDR_CHECK(ndr_pull_array_$nl->{DATA_TYPE}($ndr, $ndr_flags, $var_name, $length));");
1199 return;
1201 } elsif ($l->{TYPE} eq "POINTER") {
1202 $self->ParsePtrPull($e, $l, $ndr, $var_name);
1203 } elsif ($l->{TYPE} eq "DATA") {
1204 $self->ParseDataPull($e, $l, $ndr, $var_name, $primitives, $deferred);
1205 } elsif ($l->{TYPE} eq "TYPEDEF") {
1206 $typefamily{$e->{DATA}->{TYPE}}->{PULL_FN_BODY}->($self, $e->{DATA}, $ndr, $var_name);
1210 # add additional constructions
1211 if ($l->{TYPE} eq "POINTER" and $l->{POINTER_TYPE} eq "ignore") {
1212 $self->pidl("/* [ignore] '$e->{NAME}' */");
1213 } elsif ($l->{TYPE} eq "POINTER" and $deferred) {
1214 if ($l->{POINTER_TYPE} ne "ref") {
1215 $self->pidl("if ($var_name) {");
1216 $self->indent;
1218 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1219 $self->pidl("uint32_t _relative_save_offset;");
1220 $self->pidl("_relative_save_offset = $ndr->offset;");
1221 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr2($ndr, $var_name));");
1225 $self->ParseMemCtxPullStart($e, $l, $ndr, $var_name);
1227 $var_name = get_value_of($var_name);
1228 $self->ParseElementPullLevel($e, GetNextLevel($e,$l), $ndr, $var_name, $env, 1, 1);
1230 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1232 if ($l->{POINTER_TYPE} ne "ref") {
1233 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1234 $self->pidl("if ($ndr->offset > $ndr->relative_highest_offset) {");
1235 $self->indent;
1236 $self->pidl("$ndr->relative_highest_offset = $ndr->offset;");
1237 $self->deindent;
1238 $self->pidl("}");
1239 $self->pidl("$ndr->offset = _relative_save_offset;");
1241 $self->deindent;
1242 $self->pidl("}");
1244 } elsif ($l->{TYPE} eq "ARRAY" and
1245 not has_fast_array($e,$l) and not is_charset_array($e, $l)) {
1246 my $length = $array_length;
1247 my $counter = "cntr_$e->{NAME}_$l->{LEVEL_INDEX}";
1248 my $array_name = $var_name;
1250 if (not defined($length)) {
1251 $length = $self->ParseArrayPullGetLength($e, $l, $ndr, $var_name, $env);
1254 $var_name = get_array_element($var_name, $counter);
1256 $self->ParseMemCtxPullStart($e, $l, $ndr, $array_name);
1258 if (($primitives and not $l->{IS_DEFERRED}) or ($deferred and $l->{IS_DEFERRED})) {
1259 my $nl = GetNextLevel($e,$l);
1261 if ($l->{IS_ZERO_TERMINATED}) {
1262 $self->CheckStringTerminator($ndr,$e,$l,$length);
1265 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1266 $self->indent;
1267 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, 1, 0);
1268 $self->deindent;
1269 $self->pidl("}");
1272 if ($deferred and ContainsDeferred($e, $l)) {
1273 $self->pidl("for ($counter = 0; $counter < ($length); $counter++) {");
1274 $self->defer("for ($counter = 0; $counter < ($length); $counter++) {");
1275 $self->defer_indent;
1276 $self->indent;
1277 $self->ParseElementPullLevel($e,GetNextLevel($e,$l), $ndr, $var_name, $env, 0, 1);
1278 $self->deindent;
1279 $self->defer_deindent;
1280 $self->pidl("}");
1281 $self->defer("}");
1284 $self->ParseMemCtxPullEnd($e, $l, $ndr);
1286 } elsif ($l->{TYPE} eq "SWITCH") {
1287 my $nl = GetNextLevel($e,$l);
1288 my $needs_deferred_switch = is_deferred_switch_non_empty($nl);
1290 # Avoid setting a switch value if it will not be
1291 # consumed again in the NDR_BUFFERS pull
1292 if ($needs_deferred_switch or !$deferred) {
1293 $self->ParseSwitchPull($e, $l, $ndr, $var_name, $env);
1295 $self->ParseElementPullLevel($e, $nl, $ndr, $var_name, $env, $primitives, $deferred);
1299 #####################################################################
1300 # parse scalars in a structure element - pull size
1301 sub ParseElementPull($$$$$$)
1303 my($self,$e,$ndr,$env,$primitives,$deferred) = @_;
1305 my $var_name = $env->{$e->{NAME}};
1306 my $represent_name;
1307 my $transmit_name;
1309 return if ContainsPipe($e, $e->{LEVELS}[0]);
1311 return unless $primitives or ($deferred and ContainsDeferred($e, $e->{LEVELS}[0]));
1313 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1314 $self->pidl("{");
1315 $self->indent;
1316 $represent_name = $var_name;
1317 $transmit_name = "_transmit_$e->{NAME}";
1318 $var_name = $transmit_name;
1319 $self->pidl(mapTypeName($e->{TYPE})." $var_name;");
1322 $var_name = append_prefix($e, $var_name);
1324 $self->start_flags($e, $ndr);
1326 $self->ParseElementPullLevel($e,$e->{LEVELS}[0],$ndr,$var_name,$env,$primitives,$deferred);
1328 $self->end_flags($e, $ndr);
1330 # Representation type is different from transmit_as
1331 if ($e->{REPRESENTATION_TYPE} ne $e->{TYPE}) {
1332 $self->pidl("NDR_CHECK(ndr_$e->{TYPE}_to_$e->{REPRESENTATION_TYPE}($transmit_name, ".get_pointer_to($represent_name)."));");
1333 $self->deindent;
1334 $self->pidl("}");
1338 #####################################################################
1339 # parse a pointer in a struct element or function
1340 sub ParsePtrPull($$$$$)
1342 my($self, $e,$l,$ndr,$var_name) = @_;
1344 my $nl = GetNextLevel($e, $l);
1345 my $next_is_array = ($nl->{TYPE} eq "ARRAY");
1346 my $next_is_string = (($nl->{TYPE} eq "DATA") and
1347 ($nl->{DATA_TYPE} eq "string"));
1349 if ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP") {
1351 if (!$next_is_array and !$next_is_string) {
1352 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
1353 $self->pidl("\tNDR_PULL_ALLOC($ndr, $var_name);");
1354 $self->pidl("}");
1357 return;
1358 } elsif ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "EMBEDDED") {
1359 $self->pidl("NDR_CHECK(ndr_pull_ref_ptr($ndr, &_ptr_$e->{NAME}));");
1360 } elsif (($l->{POINTER_TYPE} eq "unique") or
1361 ($l->{POINTER_TYPE} eq "relative") or
1362 ($l->{POINTER_TYPE} eq "full")) {
1363 $self->pidl("NDR_CHECK(ndr_pull_generic_ptr($ndr, &_ptr_$e->{NAME}));");
1364 } elsif ($l->{POINTER_TYPE} eq "relative_short") {
1365 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr_short($ndr, &_ptr_$e->{NAME}));");
1366 } elsif ($l->{POINTER_TYPE} eq "ignore") {
1367 #We want to consume the pointer bytes, but ignore the pointer value
1368 $self->pidl("NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &_ptr_$e->{NAME}));");
1369 $self->pidl("_ptr_$e->{NAME} = 0;");
1370 } else {
1371 die("Unhandled pointer type $l->{POINTER_TYPE}");
1374 $self->pidl("if (_ptr_$e->{NAME}) {");
1375 $self->indent;
1377 if ($l->{POINTER_TYPE} eq "ignore") {
1378 # Don't do anything, we don't want to do the
1379 # allocation, as we forced it to NULL just above, and
1380 # we may not know the declared type anyway.
1381 } else {
1382 # Don't do this for arrays, they're allocated at the actual level
1383 # of the array
1384 unless ($next_is_array or $next_is_string) {
1385 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1386 } else {
1387 # FIXME: Yes, this is nasty.
1388 # We allocate an array twice
1389 # - once just to indicate that it's there,
1390 # - then the real allocation...
1391 $self->pidl("NDR_PULL_ALLOC($ndr, $var_name);");
1395 #$self->pidl("memset($var_name, 0, sizeof($var_name));");
1396 if ($l->{POINTER_TYPE} eq "relative" or $l->{POINTER_TYPE} eq "relative_short") {
1397 $self->pidl("NDR_CHECK(ndr_pull_relative_ptr1($ndr, $var_name, _ptr_$e->{NAME}));");
1399 $self->deindent;
1400 $self->pidl("} else {");
1401 $self->pidl("\t$var_name = NULL;");
1402 $self->pidl("}");
1405 sub CheckRefPtrs($$$$)
1407 my ($self,$e,$ndr,$env) = @_;
1409 return if ContainsPipe($e, $e->{LEVELS}[0]);
1410 return if ($e->{LEVELS}[0]->{TYPE} ne "POINTER");
1411 return if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref");
1413 my $var_name = $env->{$e->{NAME}};
1414 $var_name = append_prefix($e, $var_name);
1416 $self->pidl("if ($var_name == NULL) {");
1417 $self->indent;
1418 $self->pidl("return ndr_push_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL [ref] pointer\");");
1419 $self->deindent;
1420 $self->pidl("}");
1423 sub ParseStructPushPrimitives($$$$$)
1425 my ($self, $struct, $ndr, $varname, $env) = @_;
1427 $self->CheckRefPtrs($_, $ndr, $env) foreach (@{$struct->{ELEMENTS}});
1429 # see if the structure contains a conformant array. If it
1430 # does, then it must be the last element of the structure, and
1431 # we need to push the conformant length early, as it fits on
1432 # the wire before the structure (and even before the structure
1433 # alignment)
1434 if (defined($struct->{SURROUNDING_ELEMENT})) {
1435 my $e = $struct->{SURROUNDING_ELEMENT};
1437 if (defined($e->{LEVELS}[0]) and
1438 $e->{LEVELS}[0]->{TYPE} eq "ARRAY") {
1439 my $size;
1441 if ($e->{LEVELS}[0]->{IS_ZERO_TERMINATED}) {
1442 if (has_property($e, "charset")) {
1443 $size = "ndr_charset_length($varname->$e->{NAME}, CH_$e->{PROPERTIES}->{charset})";
1444 } else {
1445 $size = "ndr_string_length($varname->$e->{NAME}, sizeof(*$varname->$e->{NAME}))";
1447 if (defined($e->{LEVELS}[0]->{SIZE_IS})) {
1448 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1450 } else {
1451 $size = ParseExpr($e->{LEVELS}[0]->{SIZE_IS}, $env, $e->{ORIGINAL});
1454 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, $size));");
1455 } else {
1456 $self->pidl("NDR_CHECK(ndr_push_uint3264($ndr, NDR_SCALARS, ndr_string_array_size($ndr, $varname->$e->{NAME})));");
1460 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $struct->{ALIGN}));");
1462 if (defined($struct->{PROPERTIES}{relative_base})) {
1463 # set the current offset as base for relative pointers
1464 # and store it based on the toplevel struct/union
1465 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1468 $self->ParseElementPush($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1470 $self->pidl("NDR_CHECK(ndr_push_trailer_align($ndr, $struct->{ALIGN}));");
1473 sub ParseStructPushDeferred($$$$)
1475 my ($self, $struct, $ndr, $varname, $env) = @_;
1476 if (defined($struct->{PROPERTIES}{relative_base})) {
1477 # retrieve the current offset as base for relative pointers
1478 # based on the toplevel struct/union
1479 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1481 $self->ParseElementPush($_, $ndr, $env, 0, 1) foreach (@{$struct->{ELEMENTS}});
1484 #####################################################################
1485 # parse a struct
1486 sub ParseStructPush($$$$)
1488 my ($self, $struct, $ndr, $varname) = @_;
1490 return unless defined($struct->{ELEMENTS});
1492 my $env = GenerateStructEnv($struct, $varname);
1494 EnvSubstituteValue($env, $struct);
1496 $self->DeclareArrayVariablesNoZero($_, $env) foreach (@{$struct->{ELEMENTS}});
1498 $self->start_flags($struct, $ndr);
1500 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
1501 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1502 $self->indent;
1503 $self->ParseStructPushPrimitives($struct, $ndr, $varname, $env);
1504 $self->deindent;
1505 $self->pidl("}");
1507 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1508 $self->indent;
1509 $self->ParseStructPushDeferred($struct, $ndr, $varname, $env);
1510 $self->deindent;
1511 $self->pidl("}");
1513 $self->end_flags($struct, $ndr);
1516 #####################################################################
1517 # generate a push function for an enum
1518 sub ParseEnumPush($$$$)
1520 my($self,$enum,$ndr,$varname) = @_;
1521 my($type_fn) = $enum->{BASE_TYPE};
1523 $self->start_flags($enum, $ndr);
1524 $self->pidl("NDR_CHECK(ndr_push_enum_$type_fn($ndr, NDR_SCALARS, $varname));");
1525 $self->end_flags($enum, $ndr);
1528 #####################################################################
1529 # generate a pull function for an enum
1530 sub ParseEnumPull($$$$)
1532 my($self,$enum,$ndr,$varname) = @_;
1533 my($type_fn) = $enum->{BASE_TYPE};
1534 my($type_v_decl) = mapTypeName($type_fn);
1536 $self->pidl("$type_v_decl v;");
1537 $self->start_flags($enum, $ndr);
1538 $self->pidl("NDR_CHECK(ndr_pull_enum_$type_fn($ndr, NDR_SCALARS, &v));");
1539 $self->pidl("*$varname = v;");
1541 $self->end_flags($enum, $ndr);
1544 #####################################################################
1545 # generate a print function for an enum
1546 sub ParseEnumPrint($$$$$)
1548 my($self,$enum,$ndr,$name,$varname) = @_;
1550 $self->pidl("const char *val = NULL;");
1551 $self->pidl("");
1553 $self->start_flags($enum, $ndr);
1555 $self->pidl("switch ($varname) {");
1556 $self->indent;
1557 my $els = \@{$enum->{ELEMENTS}};
1558 foreach my $i (0 .. $#{$els}) {
1559 my $e = ${$els}[$i];
1560 chomp $e;
1561 if ($e =~ /^(.*)=/) {
1562 $e = $1;
1564 $self->pidl("case $e: val = \"$e\"; break;");
1567 $self->deindent;
1568 $self->pidl("}");
1570 $self->pidl("ndr_print_enum($ndr, name, \"$enum->{TYPE}\", val, $varname);");
1572 $self->end_flags($enum, $ndr);
1575 sub DeclEnum($$$$)
1577 my ($e,$t,$name,$varname) = @_;
1578 return "enum $name " .
1579 ($t eq "pull"?"*":"") . $varname;
1582 $typefamily{ENUM} = {
1583 DECL => \&DeclEnum,
1584 PUSH_FN_BODY => \&ParseEnumPush,
1585 PULL_FN_BODY => \&ParseEnumPull,
1586 PRINT_FN_BODY => \&ParseEnumPrint,
1589 #####################################################################
1590 # generate a push function for a bitmap
1591 sub ParseBitmapPush($$$$)
1593 my($self,$bitmap,$ndr,$varname) = @_;
1594 my($type_fn) = $bitmap->{BASE_TYPE};
1596 $self->start_flags($bitmap, $ndr);
1598 $self->pidl("NDR_CHECK(ndr_push_$type_fn($ndr, NDR_SCALARS, $varname));");
1600 $self->end_flags($bitmap, $ndr);
1603 #####################################################################
1604 # generate a pull function for an bitmap
1605 sub ParseBitmapPull($$$$)
1607 my($self,$bitmap,$ndr,$varname) = @_;
1608 my $type_fn = $bitmap->{BASE_TYPE};
1609 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1611 $self->pidl("$type_decl v;");
1612 $self->start_flags($bitmap, $ndr);
1613 $self->pidl("NDR_CHECK(ndr_pull_$type_fn($ndr, NDR_SCALARS, &v));");
1614 $self->pidl("*$varname = v;");
1616 $self->end_flags($bitmap, $ndr);
1619 #####################################################################
1620 # generate a print function for an bitmap
1621 sub ParseBitmapPrintElement($$$$$$)
1623 my($self,$e,$bitmap,$ndr,$name,$varname) = @_;
1624 my($type_decl) = mapTypeName($bitmap->{BASE_TYPE});
1625 my($type_fn) = $bitmap->{BASE_TYPE};
1626 my($flag);
1628 if ($e =~ /^(\w+) .*$/) {
1629 $flag = "$1";
1630 } else {
1631 die "Bitmap: \"$name\" invalid Flag: \"$e\"";
1634 $self->pidl("ndr_print_bitmap_flag($ndr, sizeof($type_decl), \"$flag\", $flag, $varname);");
1637 #####################################################################
1638 # generate a print function for an bitmap
1639 sub ParseBitmapPrint($$$$$)
1641 my($self,$bitmap,$ndr,$name,$varname) = @_;
1642 my($type_decl) = mapTypeName($bitmap->{TYPE});
1643 my($type_fn) = $bitmap->{BASE_TYPE};
1645 $self->start_flags($bitmap, $ndr);
1647 $self->pidl("ndr_print_$type_fn($ndr, name, $varname);");
1649 $self->pidl("$ndr->depth++;");
1650 foreach my $e (@{$bitmap->{ELEMENTS}}) {
1651 $self->ParseBitmapPrintElement($e, $bitmap, $ndr, $name, $varname);
1653 $self->pidl("$ndr->depth--;");
1655 $self->end_flags($bitmap, $ndr);
1658 sub DeclBitmap($$$$)
1660 my ($e,$t,$name,$varname) = @_;
1661 return mapTypeName(Parse::Pidl::Typelist::bitmap_type_fn($e)) .
1662 ($t eq "pull"?" *":" ") . $varname;
1665 $typefamily{BITMAP} = {
1666 DECL => \&DeclBitmap,
1667 PUSH_FN_BODY => \&ParseBitmapPush,
1668 PULL_FN_BODY => \&ParseBitmapPull,
1669 PRINT_FN_BODY => \&ParseBitmapPrint,
1672 #####################################################################
1673 # generate a struct print function
1674 sub ParseStructPrint($$$$$)
1676 my($self,$struct,$ndr,$name,$varname) = @_;
1678 return unless defined $struct->{ELEMENTS};
1680 my $env = GenerateStructEnv($struct, $varname);
1682 $self->DeclareArrayVariables($_) foreach (@{$struct->{ELEMENTS}});
1684 $self->pidl("ndr_print_struct($ndr, name, \"$name\");");
1685 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
1687 $self->start_flags($struct, $ndr);
1689 $self->pidl("$ndr->depth++;");
1691 $self->ParseElementPrint($_, $ndr, $env->{$_->{NAME}}, $env)
1692 foreach (@{$struct->{ELEMENTS}});
1693 $self->pidl("$ndr->depth--;");
1695 $self->end_flags($struct, $ndr);
1698 sub DeclarePtrVariables($$)
1700 my ($self,$e) = @_;
1702 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1703 return;
1706 foreach my $l (@{$e->{LEVELS}}) {
1707 my $size = 32;
1708 if ($l->{TYPE} eq "POINTER" and
1709 not ($l->{POINTER_TYPE} eq "ref" and $l->{LEVEL} eq "TOP")) {
1710 if ($l->{POINTER_TYPE} eq "relative_short") {
1711 $size = 16;
1713 $self->pidl("uint${size}_t _ptr_$e->{NAME};");
1714 last;
1719 sub DeclareArrayVariables($$;$)
1721 my ($self,$e,$pull) = @_;
1723 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1724 return;
1727 foreach my $l (@{$e->{LEVELS}}) {
1728 next if ($l->{TYPE} ne "ARRAY");
1729 if (defined($pull)) {
1730 $self->pidl("uint32_t size_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1731 if ($l->{IS_VARYING}) {
1732 $self->pidl("uint32_t length_$e->{NAME}_$l->{LEVEL_INDEX} = 0;");
1735 next if has_fast_array($e,$l);
1736 next if is_charset_array($e,$l);
1737 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1741 sub DeclareArrayVariablesNoZero($$$)
1743 my ($self,$e,$env) = @_;
1745 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1746 return;
1749 foreach my $l (@{$e->{LEVELS}}) {
1750 next if ($l->{TYPE} ne "ARRAY");
1751 next if has_fast_array($e,$l);
1752 next if is_charset_array($e,$l);
1753 my $length = ParseExpr($l->{LENGTH_IS}, $env, $e->{ORIGINAL});
1754 if ($length eq "0") {
1755 warning($e->{ORIGINAL}, "pointless array cntr: 'cntr_$e->{NAME}_$l->{LEVEL_INDEX}': length=$length");
1756 } else {
1757 $self->pidl("uint32_t cntr_$e->{NAME}_$l->{LEVEL_INDEX};");
1762 sub DeclareMemCtxVariables($$)
1764 my ($self,$e) = @_;
1766 if (has_property($e, "skip") or has_property($e, "skip_noinit")) {
1767 return;
1770 foreach my $l (@{$e->{LEVELS}}) {
1771 my $mem_flags = $self->ParseMemCtxPullFlags($e, $l);
1773 if (($l->{TYPE} eq "POINTER") and ($l->{POINTER_TYPE} eq "ignore")) {
1774 last;
1777 if (defined($mem_flags)) {
1778 $self->pidl("TALLOC_CTX *_mem_save_$e->{NAME}_$l->{LEVEL_INDEX} = NULL;");
1783 sub ParseStructPullPrimitives($$$$$)
1785 my($self,$struct,$ndr,$varname,$env) = @_;
1787 if (defined $struct->{SURROUNDING_ELEMENT}) {
1788 $self->pidl("NDR_CHECK(ndr_pull_array_size($ndr, &$varname->$struct->{SURROUNDING_ELEMENT}->{NAME}));");
1791 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $struct->{ALIGN}));");
1793 if (defined($struct->{PROPERTIES}{relative_base})) {
1794 # set the current offset as base for relative pointers
1795 # and store it based on the toplevel struct/union
1796 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1799 $self->ParseElementPull($_, $ndr, $env, 1, 0) foreach (@{$struct->{ELEMENTS}});
1801 $self->add_deferred();
1803 $self->pidl("NDR_CHECK(ndr_pull_trailer_align($ndr, $struct->{ALIGN}));");
1806 sub ParseStructPullDeferred($$$$$)
1808 my ($self,$struct,$ndr,$varname,$env) = @_;
1810 if (defined($struct->{PROPERTIES}{relative_base})) {
1811 # retrieve the current offset as base for relative pointers
1812 # based on the toplevel struct/union
1813 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
1815 foreach my $e (@{$struct->{ELEMENTS}}) {
1816 $self->ParseElementPull($e, $ndr, $env, 0, 1);
1819 $self->add_deferred();
1822 #####################################################################
1823 # parse a struct - pull side
1824 sub ParseStructPull($$$$)
1826 my($self,$struct,$ndr,$varname) = @_;
1828 return unless defined $struct->{ELEMENTS};
1830 # declare any internal pointers we need
1831 foreach my $e (@{$struct->{ELEMENTS}}) {
1832 $self->DeclarePtrVariables($e);
1833 $self->DeclareArrayVariables($e, "pull");
1834 $self->DeclareMemCtxVariables($e);
1837 $self->start_flags($struct, $ndr);
1839 my $env = GenerateStructEnv($struct, $varname);
1841 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
1842 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
1843 $self->indent;
1844 $self->ParseStructPullPrimitives($struct,$ndr,$varname,$env);
1845 $self->deindent;
1846 $self->pidl("}");
1847 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
1848 $self->indent;
1849 $self->ParseStructPullDeferred($struct,$ndr,$varname,$env);
1850 $self->deindent;
1851 $self->pidl("}");
1853 $self->end_flags($struct, $ndr);
1856 #####################################################################
1857 # calculate size of ndr struct
1858 sub ParseStructNdrSize($$$$)
1860 my ($self,$t, $name, $varname) = @_;
1861 my $sizevar;
1863 if (my $flags = has_property($t, "flag")) {
1864 $self->pidl("flags |= $flags;");
1866 $self->pidl("return ndr_size_struct($varname, flags, (ndr_push_flags_fn_t)ndr_push_$name);");
1869 sub DeclStruct($$$$)
1871 my ($e,$t,$name,$varname) = @_;
1872 if ($t eq "base") {
1873 return "struct $name $varname";
1875 return ($t ne "pull"?"const ":"") . "struct $name *$varname";
1878 sub ArgsStructNdrSize($$$)
1880 my ($d, $name, $varname) = @_;
1881 return "const struct $name *$varname, int flags";
1884 $typefamily{STRUCT} = {
1885 PUSH_FN_BODY => \&ParseStructPush,
1886 DECL => \&DeclStruct,
1887 PULL_FN_BODY => \&ParseStructPull,
1888 PRINT_FN_BODY => \&ParseStructPrint,
1889 SIZE_FN_BODY => \&ParseStructNdrSize,
1890 SIZE_FN_ARGS => \&ArgsStructNdrSize,
1893 #####################################################################
1894 # calculate size of ndr struct
1895 sub ParseUnionNdrSize($$$)
1897 my ($self, $t, $name, $varname) = @_;
1898 my $sizevar;
1900 if (my $flags = has_property($t, "flag")) {
1901 $self->pidl("flags |= $flags;");
1904 $self->pidl("return ndr_size_union($varname, flags, level, (ndr_push_flags_fn_t)ndr_push_$name);");
1907 sub ParseUnionPushPrimitives($$$$)
1909 my ($self, $e, $ndr ,$varname) = @_;
1911 my $have_default = 0;
1913 if (defined($e->{SWITCH_TYPE})) {
1914 if (defined($e->{ALIGN})) {
1915 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
1918 $self->pidl("NDR_CHECK(ndr_push_$e->{SWITCH_TYPE}($ndr, NDR_SCALARS, level));");
1921 if (defined($e->{ALIGN})) {
1922 if ($e->{IS_MS_UNION}) {
1923 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
1924 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $e->{ALIGN}));");
1925 } else {
1926 $self->pidl("NDR_CHECK(ndr_push_union_align($ndr, $e->{ALIGN}));");
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}: {");
1938 if ($el->{TYPE} ne "EMPTY") {
1939 $self->indent;
1940 if (defined($e->{PROPERTIES}{relative_base})) {
1941 $self->pidl("NDR_CHECK(ndr_push_align($ndr, $el->{ALIGN}));");
1942 # set the current offset as base for relative pointers
1943 # and store it based on the toplevel struct/union
1944 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
1946 $self->DeclareArrayVariables($el);
1947 my $el_env = {$el->{NAME} => "$varname->$el->{NAME}"};
1948 $self->CheckRefPtrs($el, $ndr, $el_env);
1949 $self->ParseElementPush($el, $ndr, $el_env, 1, 0);
1950 $self->deindent;
1952 $self->pidl("break; }");
1953 $self->pidl("");
1955 if (! $have_default) {
1956 $self->pidl("default:");
1957 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1959 $self->deindent;
1960 $self->pidl("}");
1963 sub ParseUnionPushDeferred($$$$)
1965 my ($self,$e,$ndr,$varname) = @_;
1967 my $have_default = 0;
1969 if (defined($e->{PROPERTIES}{relative_base})) {
1970 # retrieve the current offset as base for relative pointers
1971 # based on the toplevel struct/union
1972 $self->pidl("NDR_CHECK(ndr_push_setup_relative_base_offset2($ndr, $varname));");
1974 $self->pidl("switch (level) {");
1975 $self->indent;
1976 foreach my $el (@{$e->{ELEMENTS}}) {
1977 if ($el->{CASE} eq "default") {
1978 $have_default = 1;
1981 $self->pidl("$el->{CASE}:");
1982 if ($el->{TYPE} ne "EMPTY") {
1983 $self->indent;
1984 $self->ParseElementPush($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
1985 $self->deindent;
1987 $self->pidl("break;");
1988 $self->pidl("");
1990 if (! $have_default) {
1991 $self->pidl("default:");
1992 $self->pidl("\treturn ndr_push_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u\", level);");
1994 $self->deindent;
1995 $self->pidl("}");
1998 #####################################################################
1999 # parse a union - push side
2000 sub ParseUnionPush($$$$)
2002 my ($self,$e,$ndr,$varname) = @_;
2003 my $have_default = 0;
2005 $self->pidl("uint32_t level;");
2006 $self->start_flags($e, $ndr);
2008 $self->pidl("NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);");
2009 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2010 $self->indent;
2011 $self->pidl("/* This token is not used again (except perhaps below in the NDR_BUFFERS case) */");
2012 $self->pidl("NDR_CHECK(ndr_push_steal_switch_value($ndr, $varname, &level));");
2014 $self->ParseUnionPushPrimitives($e, $ndr, $varname);
2015 $self->deindent;
2016 $self->pidl("}");
2017 if (is_deferred_switch_non_empty($e)) {
2018 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2019 $self->indent;
2020 # In case we had ndr_flags of NDR_SCALERS|NDR_BUFFERS
2021 $self->pidl("if (!(ndr_flags & NDR_SCALARS)) {");
2022 $self->indent;
2023 $self->pidl("/* We didn't get it above, and the token is not needed after this. */");
2024 $self->pidl("NDR_CHECK(ndr_push_steal_switch_value($ndr, $varname, &level));");
2025 $self->deindent;
2026 $self->pidl("}");
2027 $self->ParseUnionPushDeferred($e, $ndr, $varname);
2028 $self->deindent;
2029 $self->pidl("}");
2031 $self->end_flags($e, $ndr);
2034 #####################################################################
2035 # print a union
2036 sub ParseUnionPrint($$$$$)
2038 my ($self,$e,$ndr,$name,$varname) = @_;
2039 my $have_default = 0;
2041 $self->pidl("uint32_t level;");
2042 foreach my $el (@{$e->{ELEMENTS}}) {
2043 $self->DeclareArrayVariables($el);
2046 $self->start_flags($e, $ndr);
2048 $self->pidl("level = ndr_print_steal_switch_value($ndr, $varname);");
2050 $self->pidl("ndr_print_union($ndr, name, level, \"$name\");");
2052 $self->pidl("switch (level) {");
2053 $self->indent;
2054 foreach my $el (@{$e->{ELEMENTS}}) {
2055 if ($el->{CASE} eq "default") {
2056 $have_default = 1;
2058 $self->pidl("$el->{CASE}:");
2059 if ($el->{TYPE} ne "EMPTY") {
2060 $self->indent;
2061 $self->ParseElementPrint($el, $ndr, "$varname->$el->{NAME}", {});
2062 $self->deindent;
2064 $self->pidl("break;");
2065 $self->pidl("");
2067 if (! $have_default) {
2068 $self->pidl("default:");
2069 $self->pidl("\tndr_print_bad_level($ndr, name, level);");
2071 $self->deindent;
2072 $self->pidl("}");
2074 $self->end_flags($e, $ndr);
2077 sub ParseUnionPullPrimitives($$$$$)
2079 my ($self,$e,$ndr,$varname,$switch_type) = @_;
2080 my $have_default = 0;
2083 if (defined($switch_type)) {
2084 if (defined($e->{ALIGN})) {
2085 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
2088 $self->pidl("NDR_CHECK(ndr_pull_$switch_type($ndr, NDR_SCALARS, &_level));");
2089 $self->pidl("if (_level != level) {");
2090 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value %u for $varname at \%s\", _level, __location__);");
2091 $self->pidl("}");
2094 if (defined($e->{ALIGN})) {
2095 if ($e->{IS_MS_UNION}) {
2096 $self->pidl("/* ms_union is always aligned to the largest union arm*/");
2097 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $e->{ALIGN}));");
2098 } else {
2099 $self->pidl("NDR_CHECK(ndr_pull_union_align($ndr, $e->{ALIGN}));");
2103 $self->pidl("switch (level) {");
2104 $self->indent;
2105 foreach my $el (@{$e->{ELEMENTS}}) {
2106 if ($el->{CASE} eq "default") {
2107 $have_default = 1;
2109 $self->pidl("$el->{CASE}: {");
2111 if ($el->{TYPE} ne "EMPTY") {
2112 $self->indent;
2113 if (defined($e->{PROPERTIES}{relative_base})) {
2114 $self->pidl("NDR_CHECK(ndr_pull_align($ndr, $el->{ALIGN}));");
2115 # set the current offset as base for relative pointers
2116 # and store it based on the toplevel struct/union
2117 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset1($ndr, $varname, $ndr->offset));");
2119 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 1, 0);
2120 $self->deindent;
2122 $self->pidl("break; }");
2123 $self->pidl("");
2125 if (! $have_default) {
2126 $self->pidl("default:");
2127 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2129 $self->deindent;
2130 $self->pidl("}");
2133 sub ParseUnionPullDeferred($$$$)
2135 my ($self,$e,$ndr,$varname) = @_;
2136 my $have_default = 0;
2138 $self->pidl("switch (level) {");
2139 $self->indent;
2140 foreach my $el (@{$e->{ELEMENTS}}) {
2141 if ($el->{CASE} eq "default") {
2142 $have_default = 1;
2145 $self->pidl("$el->{CASE}:");
2146 if ($el->{TYPE} ne "EMPTY") {
2147 $self->indent;
2148 if (defined($e->{PROPERTIES}{relative_base})) {
2149 # retrieve the current offset as base for relative pointers
2150 # based on the toplevel struct/union
2151 $self->pidl("NDR_CHECK(ndr_pull_setup_relative_base_offset2($ndr, $varname));");
2153 $self->ParseElementPull($el, $ndr, {$el->{NAME} => "$varname->$el->{NAME}"}, 0, 1);
2154 $self->deindent;
2156 $self->pidl("break;");
2157 $self->pidl("");
2159 if (! $have_default) {
2160 $self->pidl("default:");
2161 $self->pidl("\treturn ndr_pull_error($ndr, NDR_ERR_BAD_SWITCH, \"Bad switch value \%u at \%s\", level, __location__);");
2163 $self->deindent;
2164 $self->pidl("}");
2169 #####################################################################
2170 # parse a union - pull side
2171 sub ParseUnionPull($$$$)
2173 my ($self,$e,$ndr,$varname) = @_;
2174 my $switch_type = $e->{SWITCH_TYPE};
2175 my $needs_deferred_switch = is_deferred_switch_non_empty($e);
2176 $self->pidl("uint32_t level;");
2177 if (defined($switch_type)) {
2178 if (Parse::Pidl::Typelist::typeIs($switch_type, "ENUM")) {
2179 $switch_type = Parse::Pidl::Typelist::enum_type_fn(getType($switch_type)->{DATA});
2181 $self->pidl(mapTypeName($switch_type) . " _level;");
2184 my %double_cases = ();
2185 foreach my $el (@{$e->{ELEMENTS}}) {
2186 next if ($el->{TYPE} eq "EMPTY");
2187 next if ($double_cases{"$el->{NAME}"});
2188 $self->DeclareMemCtxVariables($el);
2189 $self->DeclarePtrVariables($el);
2190 $self->DeclareArrayVariables($el, "pull");
2191 $double_cases{"$el->{NAME}"} = 1;
2194 $self->start_flags($e, $ndr);
2196 $self->pidl("NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);");
2197 $self->pidl("if (ndr_flags & NDR_SCALARS) {");
2198 $self->indent;
2199 $self->pidl("/* This token is not used again (except perhaps below in the NDR_BUFFERS case) */");
2200 $self->pidl("NDR_CHECK(ndr_pull_steal_switch_value($ndr, $varname, &level));");
2201 $self->ParseUnionPullPrimitives($e,$ndr,$varname,$switch_type);
2202 $self->deindent;
2203 $self->pidl("}");
2204 if ($needs_deferred_switch) {
2205 $self->pidl("if (ndr_flags & NDR_BUFFERS) {");
2206 $self->indent;
2207 # In case we had ndr_flags of NDR_SCALERS|NDR_BUFFERS
2208 $self->pidl("if (!(ndr_flags & NDR_SCALARS)) {");
2209 $self->indent;
2210 $self->pidl("/* We didn't get it above, and the token is not needed after this. */");
2211 $self->pidl("NDR_CHECK(ndr_pull_steal_switch_value($ndr, $varname, &level));");
2212 $self->deindent;
2213 $self->pidl("}");
2214 $self->ParseUnionPullDeferred($e,$ndr,$varname);
2215 $self->deindent;
2216 $self->pidl("}");
2218 $self->add_deferred();
2220 $self->end_flags($e, $ndr);
2223 sub DeclUnion($$$$)
2225 my ($e,$t,$name,$varname) = @_;
2226 if ($t eq "base") {
2227 return "union $name $varname";
2229 return ($t ne "pull"?"const ":"") . "union $name *$varname";
2232 sub ArgsUnionNdrSize($$)
2234 my ($d,$name) = @_;
2235 return "const union $name *r, uint32_t level, int flags";
2238 $typefamily{UNION} = {
2239 PUSH_FN_BODY => \&ParseUnionPush,
2240 DECL => \&DeclUnion,
2241 PULL_FN_BODY => \&ParseUnionPull,
2242 PRINT_FN_BODY => \&ParseUnionPrint,
2243 SIZE_FN_ARGS => \&ArgsUnionNdrSize,
2244 SIZE_FN_BODY => \&ParseUnionNdrSize,
2247 #####################################################################
2248 # parse a typedef - push side
2249 sub ParseTypedefPush($$$$)
2251 my($self,$e,$ndr,$varname) = @_;
2253 my $env;
2255 $env->{$e->{NAME}} = $varname;
2257 $self->ParseElementPushLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2260 #####################################################################
2261 # parse a typedef - pull side
2262 sub ParseTypedefPull($$$$)
2264 my($self,$e,$ndr,$varname) = @_;
2266 my $env;
2268 $env->{$e->{NAME}} = $varname;
2270 $self->ParseElementPullLevel($e, $e->{LEVELS}[0], $ndr, $varname, $env, 1, 1);
2273 #####################################################################
2274 # parse a typedef - print side
2275 sub ParseTypedefPrint($$$$$)
2277 my($self,$e,$ndr,$name,$varname) = @_;
2279 $typefamily{$e->{DATA}->{TYPE}}->{PRINT_FN_BODY}->($self, $e->{DATA}, $ndr, $name, $varname);
2282 #####################################################################
2283 ## calculate the size of a structure
2284 sub ParseTypedefNdrSize($$$$)
2286 my($self,$t,$name,$varname) = @_;
2288 $typefamily{$t->{DATA}->{TYPE}}->{SIZE_FN_BODY}->($self, $t->{DATA}, $name, $varname);
2291 sub DeclTypedef($$$$)
2293 my ($e, $t, $name, $varname) = @_;
2295 return $typefamily{$e->{DATA}->{TYPE}}->{DECL}->($e->{DATA}, $t, $name, $varname);
2298 sub ArgsTypedefNdrSize($$$)
2300 my ($d, $name, $varname) = @_;
2301 return $typefamily{$d->{DATA}->{TYPE}}->{SIZE_FN_ARGS}->($d->{DATA}, $name, $varname);
2304 $typefamily{TYPEDEF} = {
2305 PUSH_FN_BODY => \&ParseTypedefPush,
2306 DECL => \&DeclTypedef,
2307 PULL_FN_BODY => \&ParseTypedefPull,
2308 PRINT_FN_BODY => \&ParseTypedefPrint,
2309 SIZE_FN_ARGS => \&ArgsTypedefNdrSize,
2310 SIZE_FN_BODY => \&ParseTypedefNdrSize,
2313 sub ParsePipePushChunk($$)
2315 my ($self, $t) = @_;
2317 my $pipe = $t;
2318 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2319 my $struct = $pipe->{DATA};
2321 my $name = "$struct->{NAME}";
2322 my $ndr = "ndr";
2323 my $varname = "r";
2325 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "push", $name, $varname);
2327 $self->fn_declare("push", $struct, "enum ndr_err_code ndr_push_$name(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
2329 return if has_property($t, "nopush");
2331 $self->pidl("{");
2332 $self->indent;
2334 $self->ParseStructPush($struct, $ndr, $varname);
2335 $self->pidl("");
2337 $self->pidl("NDR_CHECK(ndr_push_pipe_chunk_trailer(ndr, ndr_flags, $varname->count));");
2338 $self->pidl("");
2340 $self->pidl("return NDR_ERR_SUCCESS;");
2341 $self->deindent;
2342 $self->pidl("}");
2343 $self->pidl("");
2346 sub ParsePipePullChunk($$)
2348 my ($self, $t) = @_;
2350 my $pipe = $t;
2351 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2352 my $struct = $pipe->{DATA};
2354 my $name = "$struct->{NAME}";
2355 my $ndr = "ndr";
2356 my $varname = "r";
2358 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "pull", $name, $varname);
2360 $self->fn_declare("pull", $struct, "enum ndr_err_code ndr_pull_$name(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
2362 return if has_property($struct, "nopull");
2364 $self->pidl("{");
2365 $self->indent;
2367 $self->ParseStructPull($struct, $ndr, $varname);
2368 $self->pidl("");
2370 $self->pidl("NDR_CHECK(ndr_check_pipe_chunk_trailer($ndr, ndr_flags, $varname->count));");
2371 $self->pidl("");
2373 $self->pidl("return NDR_ERR_SUCCESS;");
2374 $self->deindent;
2375 $self->pidl("}");
2376 $self->pidl("");
2379 sub ParsePipePrintChunk($$)
2381 my ($self, $t) = @_;
2383 my $pipe = $t;
2384 $pipe = $t->{DATA} if ($t->{TYPE} eq "TYPEDEF");
2385 my $struct = $pipe->{DATA};
2387 my $name = "$struct->{NAME}";
2388 my $ndr = "ndr";
2389 my $varname = "r";
2391 my $args = $typefamily{$struct->{TYPE}}->{DECL}->($struct, "print", $name, $varname);
2393 $self->pidl_hdr("void ndr_print_$name(struct ndr_print *ndr, const char *name, $args);");
2395 return if (has_property($t, "noprint"));
2397 $self->pidl("_PUBLIC_ void ndr_print_$name(struct ndr_print *$ndr, const char *name, $args)");
2398 $self->pidl("{");
2399 $self->indent;
2400 $self->ParseTypePrint($struct, $ndr, $varname);
2401 $self->deindent;
2402 $self->pidl("}");
2403 $self->pidl("");
2406 #####################################################################
2407 # parse a function - print side
2408 sub ParseFunctionPrint($$)
2410 my($self, $fn) = @_;
2411 my $ndr = "ndr";
2413 $self->pidl_hdr("void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r);");
2415 return if has_property($fn, "noprint");
2417 $self->pidl("_PUBLIC_ void ndr_print_$fn->{NAME}(struct ndr_print *$ndr, const char *name, int flags, const struct $fn->{NAME} *r)");
2418 $self->pidl("{");
2419 $self->indent;
2421 foreach my $e (@{$fn->{ELEMENTS}}) {
2422 $self->DeclareArrayVariables($e);
2425 $self->pidl("ndr_print_struct($ndr, name, \"$fn->{NAME}\");");
2426 $self->pidl("if (r == NULL) { ndr_print_null($ndr); return; }");
2427 $self->pidl("$ndr->depth++;");
2429 $self->pidl("if (flags & NDR_SET_VALUES) {");
2430 $self->pidl("\t$ndr->flags |= LIBNDR_PRINT_SET_VALUES;");
2431 $self->pidl("}");
2433 $self->pidl("if (flags & NDR_IN) {");
2434 $self->indent;
2435 $self->pidl("ndr_print_struct($ndr, \"in\", \"$fn->{NAME}\");");
2436 $self->pidl("$ndr->depth++;");
2438 my $env = GenerateFunctionInEnv($fn);
2440 foreach my $e (@{$fn->{ELEMENTS}}) {
2441 if (grep(/in/,@{$e->{DIRECTION}})) {
2442 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2445 $self->pidl("$ndr->depth--;");
2446 $self->deindent;
2447 $self->pidl("}");
2449 $self->pidl("if (flags & NDR_OUT) {");
2450 $self->indent;
2451 $self->pidl("ndr_print_struct($ndr, \"out\", \"$fn->{NAME}\");");
2452 $self->pidl("$ndr->depth++;");
2454 $env = GenerateFunctionOutEnv($fn);
2455 foreach my $e (@{$fn->{ELEMENTS}}) {
2456 if (grep(/out/,@{$e->{DIRECTION}})) {
2457 $self->ParseElementPrint($e, $ndr, $env->{$e->{NAME}}, $env);
2460 if ($fn->{RETURN_TYPE}) {
2461 $self->pidl("ndr_print_$fn->{RETURN_TYPE}($ndr, \"result\", r->out.result);");
2463 $self->pidl("$ndr->depth--;");
2464 $self->deindent;
2465 $self->pidl("}");
2467 $self->pidl("$ndr->depth--;");
2468 $self->deindent;
2469 $self->pidl("}");
2470 $self->pidl("");
2473 #####################################################################
2474 # parse a function
2475 sub ParseFunctionPush($$)
2477 my($self, $fn) = @_;
2478 my $ndr = "ndr";
2480 $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;
2482 return if has_property($fn, "nopush");
2484 $self->pidl("{");
2485 $self->indent;
2487 foreach my $e (@{$fn->{ELEMENTS}}) {
2488 $self->DeclareArrayVariables($e);
2491 $self->pidl("NDR_PUSH_CHECK_FN_FLAGS(ndr, flags);");
2493 $self->pidl("if (flags & NDR_IN) {");
2494 $self->indent;
2496 my $env = GenerateFunctionInEnv($fn);
2498 EnvSubstituteValue($env, $fn);
2500 foreach my $e (@{$fn->{ELEMENTS}}) {
2501 if (grep(/in/,@{$e->{DIRECTION}})) {
2502 $self->CheckRefPtrs($e, $ndr, $env);
2506 foreach my $e (@{$fn->{ELEMENTS}}) {
2507 if (grep(/in/,@{$e->{DIRECTION}})) {
2508 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2512 $self->deindent;
2513 $self->pidl("}");
2515 $self->pidl("if (flags & NDR_OUT) {");
2516 $self->indent;
2518 $env = GenerateFunctionOutEnv($fn);
2519 EnvSubstituteValue($env, $fn);
2521 foreach my $e (@{$fn->{ELEMENTS}}) {
2522 if (grep(/out/,@{$e->{DIRECTION}})) {
2523 $self->CheckRefPtrs($e, $ndr, $env);
2527 foreach my $e (@{$fn->{ELEMENTS}}) {
2528 if (grep(/out/,@{$e->{DIRECTION}})) {
2529 $self->ParseElementPush($e, $ndr, $env, 1, 1);
2533 if ($fn->{RETURN_TYPE}) {
2534 $self->pidl("NDR_CHECK(ndr_push_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, r->out.result));");
2537 $self->deindent;
2538 $self->pidl("}");
2539 $self->pidl("return NDR_ERR_SUCCESS;");
2540 $self->deindent;
2541 $self->pidl("}");
2542 $self->pidl("");
2545 sub AllocateArrayLevel($$$$$$)
2547 my ($self,$e,$l,$ndr,$var,$size) = @_;
2549 my $pl = GetPrevLevel($e, $l);
2550 if (defined($pl) and
2551 $pl->{TYPE} eq "POINTER" and
2552 $pl->{POINTER_TYPE} eq "ref"
2553 and not $l->{IS_ZERO_TERMINATED}) {
2554 $self->pidl("if ($ndr->flags & LIBNDR_FLAG_REF_ALLOC) {");
2555 $self->pidl("\tNDR_PULL_ALLOC_N($ndr, $var, $size);");
2556 $self->pidl("}");
2557 if (grep(/in/,@{$e->{DIRECTION}}) and
2558 grep(/out/,@{$e->{DIRECTION}})) {
2559 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2561 return;
2564 $self->pidl("NDR_PULL_ALLOC_N($ndr, $var, $size);");
2567 #####################################################################
2568 # parse a function
2569 sub ParseFunctionPull($$)
2571 my($self,$fn) = @_;
2572 my $ndr = "ndr";
2574 # pull function args
2575 $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;
2577 $self->pidl("{");
2578 $self->indent;
2580 # declare any internal pointers we need
2581 foreach my $e (@{$fn->{ELEMENTS}}) {
2582 $self->DeclarePtrVariables($e);
2583 $self->DeclareArrayVariables($e, "pull");
2586 my %double_cases = ();
2587 foreach my $e (@{$fn->{ELEMENTS}}) {
2588 next if ($e->{TYPE} eq "EMPTY");
2589 next if ($double_cases{"$e->{NAME}"});
2590 $self->DeclareMemCtxVariables($e);
2591 $double_cases{"$e->{NAME}"} = 1;
2594 $self->pidl("NDR_PULL_CHECK_FN_FLAGS(ndr, flags);");
2596 $self->pidl("if (flags & NDR_IN) {");
2597 $self->indent;
2599 # auto-init the out section of a structure. I originally argued that
2600 # this was a bad idea as it hides bugs, but coping correctly
2601 # with initialisation and not wiping ref vars is turning
2602 # out to be too tricky (tridge)
2603 foreach my $e (@{$fn->{ELEMENTS}}) {
2604 next unless grep(/out/, @{$e->{DIRECTION}});
2605 $self->pidl("NDR_ZERO_STRUCT(r->out);");
2606 $self->pidl("");
2607 last;
2610 my $env = GenerateFunctionInEnv($fn);
2612 foreach my $e (@{$fn->{ELEMENTS}}) {
2613 next unless (grep(/in/, @{$e->{DIRECTION}}));
2614 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2617 # allocate the "simple" out ref variables. FIXME: Shouldn't this have it's
2618 # own flag rather than be in NDR_IN ?
2620 foreach my $e (@{$fn->{ELEMENTS}}) {
2621 next unless (grep(/out/, @{$e->{DIRECTION}}));
2622 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2623 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2624 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2625 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2626 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2627 next if (($e->{LEVELS}[1]->{TYPE} eq "ARRAY")
2628 and $e->{LEVELS}[1]->{IS_ZERO_TERMINATED});
2630 if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2631 my $size = ParseExprExt($e->{LEVELS}[1]->{SIZE_IS}, $env, $e->{ORIGINAL},
2632 check_null_pointer($e, $env, sub { $self->pidl(shift); },
2633 "return ndr_pull_error($ndr, NDR_ERR_INVALID_POINTER, \"NULL Pointer for size_is()\");"),
2634 check_fully_dereferenced($e, $env));
2635 $self->pidl("NDR_PULL_ALLOC_N($ndr, r->out.$e->{NAME}, $size);");
2637 if (grep(/in/, @{$e->{DIRECTION}})) {
2638 $self->pidl("memcpy(r->out.$e->{NAME}, r->in.$e->{NAME}, ($size) * sizeof(*r->in.$e->{NAME}));");
2639 } else {
2640 $self->pidl("memset(r->out.$e->{NAME}, 0, ($size) * sizeof(*r->out.$e->{NAME}));");
2642 } elsif ($e->{LEVELS}[1]->{TYPE} eq "ARRAY") {
2643 if (grep(/in/, @{$e->{DIRECTION}})) {
2644 $self->pidl("r->out.$e->{NAME} = r->in.$e->{NAME};");
2645 } else {
2646 $self->pidl("r->out.$e->{NAME} = NULL;");
2648 } else {
2649 $self->pidl("NDR_PULL_ALLOC($ndr, r->out.$e->{NAME});");
2651 if (grep(/in/, @{$e->{DIRECTION}})) {
2652 $self->pidl("*r->out.$e->{NAME} = *r->in.$e->{NAME};");
2653 } else {
2654 $self->pidl("NDR_ZERO_STRUCTP(r->out.$e->{NAME});");
2659 $self->add_deferred();
2660 $self->deindent;
2661 $self->pidl("}");
2663 $self->pidl("if (flags & NDR_OUT) {");
2664 $self->indent;
2666 $self->pidl("#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION");
2668 # This for fuzzers of ndr_pull where the out elements refer to
2669 # in elements in size_is or length_is.
2671 # Not actually very harmful but also not useful outsie a fuzzer
2672 foreach my $e (@{$fn->{ELEMENTS}}) {
2673 next unless (grep(/in/, @{$e->{DIRECTION}}));
2674 next unless ($e->{LEVELS}[0]->{TYPE} eq "POINTER" and
2675 $e->{LEVELS}[0]->{POINTER_TYPE} eq "ref");
2676 next if (($e->{LEVELS}[1]->{TYPE} eq "DATA") and
2677 ($e->{LEVELS}[1]->{DATA_TYPE} eq "string"));
2678 next if ($e->{LEVELS}[1]->{TYPE} eq "PIPE");
2679 next if ($e->{LEVELS}[1]->{TYPE} eq "ARRAY");
2681 $self->pidl("if (r->in.$e->{NAME} == NULL) {");
2682 $self->indent;
2683 $self->pidl("NDR_PULL_ALLOC($ndr, r->in.$e->{NAME});");
2684 $self->pidl("NDR_ZERO_STRUCTP(r->in.$e->{NAME});");
2685 $self->deindent;
2686 $self->pidl("}");
2689 $self->pidl("#endif /* FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION */");
2691 $env = GenerateFunctionOutEnv($fn);
2692 foreach my $e (@{$fn->{ELEMENTS}}) {
2693 next unless grep(/out/, @{$e->{DIRECTION}});
2694 $self->ParseElementPull($e, $ndr, $env, 1, 1);
2697 if ($fn->{RETURN_TYPE}) {
2698 $self->pidl("NDR_CHECK(ndr_pull_$fn->{RETURN_TYPE}($ndr, NDR_SCALARS, &r->out.result));");
2701 $self->add_deferred();
2702 $self->deindent;
2703 $self->pidl("}");
2705 $self->pidl("return NDR_ERR_SUCCESS;");
2706 $self->deindent;
2707 $self->pidl("}");
2708 $self->pidl("");
2711 sub AuthServiceStruct($$$)
2713 my ($self, $ifacename, $authservice) = @_;
2714 my @a = split /,/, $authservice;
2715 my $authservice_count = $#a + 1;
2717 $self->pidl("static const char * const $ifacename\_authservice_strings[] = {");
2718 foreach my $ap (@a) {
2719 $self->pidl("\t$ap, ");
2721 $self->pidl("};");
2722 $self->pidl("");
2724 $self->pidl("static const struct ndr_interface_string_array $ifacename\_authservices = {");
2725 $self->pidl("\t.count\t= $authservice_count,");
2726 $self->pidl("\t.names\t= $ifacename\_authservice_strings");
2727 $self->pidl("};");
2728 $self->pidl("");
2731 sub ParseGeneratePipeArray($$$)
2733 my ($self, $fn, $direction) = @_;
2735 $self->pidl("static const struct ndr_interface_call_pipe $fn->{NAME}\_$direction\_pipes[] = {");
2736 $self->indent;
2738 foreach my $e (@{$fn->{ELEMENTS}}) {
2739 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2740 next unless (grep(/$direction/, @{$e->{DIRECTION}}));
2742 my $cname = "$e->{TYPE}_chunk";
2744 $self->pidl("{");
2745 $self->indent;
2746 $self->pidl("\"$direction.$e->{NAME}\",");
2747 $self->pidl("\"$cname\",");
2748 $self->pidl("sizeof(struct $cname),");
2749 $self->pidl("(ndr_push_flags_fn_t) ndr_push_$cname,");
2750 $self->pidl("(ndr_pull_flags_fn_t) ndr_pull_$cname,");
2751 $self->pidl("(ndr_print_fn_t) ndr_print_$cname,");
2752 $self->deindent;
2753 $self->pidl("},");
2755 $self->pidl("{ .name = NULL }");
2756 $self->deindent;
2757 $self->pidl("};");
2758 $self->pidl("");
2761 sub FunctionCallPipes($$)
2763 my ($self, $d) = @_;
2764 return if not defined($d->{OPNUM});
2766 my $in_pipes = 0;
2767 my $out_pipes = 0;
2769 foreach my $e (@{$d->{ELEMENTS}}) {
2770 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2772 if (grep(/in/, @{$e->{DIRECTION}})) {
2773 $in_pipes++;
2775 if (grep(/out/, @{$e->{DIRECTION}})) {
2776 $out_pipes++;
2780 if ($in_pipes) {
2781 $self->ParseGeneratePipeArray($d, "in");
2784 if ($out_pipes) {
2785 $self->ParseGeneratePipeArray($d, "out");
2789 sub FunctionCallEntry($$)
2791 my ($self, $d) = @_;
2792 return 0 if not defined($d->{OPNUM});
2794 my $in_pipes = 0;
2795 my $out_pipes = 0;
2797 foreach my $e (@{$d->{ELEMENTS}}) {
2798 next unless ContainsPipe($e, $e->{LEVELS}[0]);
2800 if (grep(/in/, @{$e->{DIRECTION}})) {
2801 $in_pipes++;
2803 if (grep(/out/, @{$e->{DIRECTION}})) {
2804 $out_pipes++;
2808 my $in_pipes_ptr = "NULL";
2809 my $out_pipes_ptr = "NULL";
2811 if ($in_pipes) {
2812 $in_pipes_ptr = "$d->{NAME}_in_pipes";
2815 if ($out_pipes) {
2816 $out_pipes_ptr = "$d->{NAME}_out_pipes";
2819 $self->pidl("\t{");
2820 $self->pidl("\t\t\"$d->{NAME}\",");
2821 $self->pidl("\t\tsizeof(struct $d->{NAME}),");
2822 $self->pidl("\t\t(ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2823 $self->pidl("\t\t(ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2824 $self->pidl("\t\t(ndr_print_function_t) ndr_print_$d->{NAME},");
2825 $self->pidl("\t\t{ $in_pipes, $in_pipes_ptr },");
2826 $self->pidl("\t\t{ $out_pipes, $out_pipes_ptr },");
2827 $self->pidl("\t},");
2828 return 1;
2831 sub StructEntry($$)
2833 my ($self, $d) = @_;
2834 my $type_decl = $typefamily{$d->{TYPE}}->{DECL}->($d, "base", $d->{NAME}, "");
2836 $self->pidl("\t{");
2837 $self->pidl("\t\t.name = \"$d->{NAME}\",");
2838 $self->pidl("\t\t.struct_size = sizeof($type_decl),");
2839 $self->pidl("\t\t.ndr_push = (ndr_push_flags_fn_t) ndr_push_$d->{NAME},");
2840 $self->pidl("\t\t.ndr_pull = (ndr_pull_flags_fn_t) ndr_pull_$d->{NAME},");
2841 $self->pidl("\t\t.ndr_print = (ndr_print_function_t) ndr_print_flags_$d->{NAME},");
2842 $self->pidl("\t},");
2843 return 1;
2846 #####################################################################
2847 # produce a function call table
2848 sub FunctionTable($$)
2850 my($self,$interface) = @_;
2851 my $count = 0;
2852 my $count_public_structs = 0;
2853 my $uname = uc $interface->{NAME};
2855 foreach my $d (@{$interface->{TYPES}}) {
2856 next unless (is_public_struct($d));
2857 $count_public_structs += 1;
2859 return if ($#{$interface->{FUNCTIONS}}+1 == 0 and
2860 $count_public_structs == 0);
2862 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2863 $self->FunctionCallPipes($d);
2866 $self->pidl("static const struct ndr_interface_public_struct $interface->{NAME}\_public_structs[] = {");
2868 foreach my $d (@{$interface->{TYPES}}) {
2869 next unless (is_public_struct($d));
2870 $self->StructEntry($d);
2872 $self->pidl("\t{ .name = NULL }");
2873 $self->pidl("};");
2874 $self->pidl("");
2876 $self->pidl("static const struct ndr_interface_call $interface->{NAME}\_calls[] = {");
2878 foreach my $d (@{$interface->{INHERITED_FUNCTIONS}},@{$interface->{FUNCTIONS}}) {
2879 $count += $self->FunctionCallEntry($d);
2881 $self->pidl("\t{ .name = NULL }");
2882 $self->pidl("};");
2883 $self->pidl("");
2885 $self->pidl("static const char * const $interface->{NAME}\_endpoint_strings[] = {");
2886 foreach my $ep (@{$interface->{ENDPOINTS}}) {
2887 $self->pidl("\t$ep, ");
2889 my $endpoint_count = $#{$interface->{ENDPOINTS}}+1;
2891 $self->pidl("};");
2892 $self->pidl("");
2894 $self->pidl("static const struct ndr_interface_string_array $interface->{NAME}\_endpoints = {");
2895 $self->pidl("\t.count\t= $endpoint_count,");
2896 $self->pidl("\t.names\t= $interface->{NAME}\_endpoint_strings");
2897 $self->pidl("};");
2898 $self->pidl("");
2900 if (! defined $interface->{PROPERTIES}->{authservice}) {
2901 $interface->{PROPERTIES}->{authservice} = "\"host\"";
2904 $self->AuthServiceStruct($interface->{NAME},
2905 $interface->{PROPERTIES}->{authservice});
2907 $self->pidl("\nconst struct ndr_interface_table ndr_table_$interface->{NAME} = {");
2908 $self->pidl("\t.name\t\t= \"$interface->{NAME}\",");
2909 if (defined $interface->{PROPERTIES}->{uuid}) {
2910 $self->pidl("\t.syntax_id\t= {");
2911 $self->pidl("\t\t" . print_uuid($interface->{UUID}) .",");
2912 $self->pidl("\t\tNDR_$uname\_VERSION");
2913 $self->pidl("\t},");
2914 $self->pidl("\t.helpstring\t= NDR_$uname\_HELPSTRING,");
2916 $self->pidl("\t.num_calls\t= $count,");
2917 $self->pidl("\t.calls\t\t= $interface->{NAME}\_calls,");
2918 $self->pidl("\t.num_public_structs\t= $count_public_structs,");
2919 $self->pidl("\t.public_structs\t\t= $interface->{NAME}\_public_structs,");
2920 $self->pidl("\t.endpoints\t= &$interface->{NAME}\_endpoints,");
2921 $self->pidl("\t.authservices\t= &$interface->{NAME}\_authservices");
2922 $self->pidl("};");
2923 $self->pidl("");
2927 #####################################################################
2928 # generate include statements for imported idl files
2929 sub HeaderImport
2931 my $self = shift;
2932 my @imports = @_;
2933 foreach (@imports) {
2934 $_ = unmake_str($_);
2935 s/\.idl$//;
2936 $self->pidl(choose_header("librpc/gen_ndr/ndr_$_\.h", "gen_ndr/ndr_$_.h"));
2940 #####################################################################
2941 # generate include statements for included header files
2942 sub HeaderInclude
2944 my $self = shift;
2945 my @includes = @_;
2946 foreach (@includes) {
2947 $self->pidl_hdr("#include $_");
2951 #####################################################################
2952 # generate prototypes and defines for the interface definitions
2953 # FIXME: these prototypes are for the DCE/RPC client functions, not the
2954 # NDR parser and so do not belong here, technically speaking
2955 sub HeaderInterface($$$)
2957 my($self,$interface,$needed) = @_;
2959 my $count = 0;
2961 if ($needed->{"compression"}) {
2962 $self->pidl(choose_header("librpc/ndr/ndr_compression.h", "ndr/compression.h"));
2965 if (has_property($interface, "object")) {
2966 $self->pidl(choose_header("librpc/gen_ndr/ndr_orpc.h", "ndr/orpc.h"));
2969 if (defined $interface->{PROPERTIES}->{helper}) {
2970 $self->HeaderInclude(split /,/, $interface->{PROPERTIES}->{helper});
2973 if (defined $interface->{PROPERTIES}->{uuid}) {
2974 my $name = uc $interface->{NAME};
2975 $self->pidl_hdr("#define NDR_$name\_UUID " .
2976 Parse::Pidl::Util::make_str(lc($interface->{UUID})));
2978 $self->pidl_hdr("#define NDR_$name\_VERSION $interface->{VERSION}");
2980 $self->pidl_hdr("#define NDR_$name\_NAME \"$interface->{NAME}\"");
2982 if(!defined $interface->{PROPERTIES}->{helpstring}) { $interface->{PROPERTIES}->{helpstring} = "NULL"; }
2983 $self->pidl_hdr("#define NDR_$name\_HELPSTRING $interface->{PROPERTIES}->{helpstring}");
2986 my $count_public_structs = 0;
2987 foreach my $d (@{$interface->{TYPES}}) {
2988 next unless (has_property($d, "public"));
2989 $count_public_structs += 1;
2991 if ($#{$interface->{FUNCTIONS}}+1 > 0 or
2992 $count_public_structs > 0) {
2993 $self->pidl_hdr("extern const struct ndr_interface_table ndr_table_$interface->{NAME};");
2996 foreach (@{$interface->{FUNCTIONS}}) {
2997 next if has_property($_, "noopnum");
2998 next if grep(/^$_->{NAME}$/,@{$interface->{INHERITED_FUNCTIONS}});
2999 my $u_name = uc $_->{NAME};
3001 my $val = sprintf("0x%02x", $count);
3002 if (defined($interface->{BASE})) {
3003 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
3006 $self->pidl_hdr("#define NDR_$u_name ($val)");
3008 $self->pidl_hdr("");
3009 $count++;
3012 my $val = $count;
3014 if (defined($interface->{BASE})) {
3015 $val .= " + NDR_" . uc $interface->{BASE} . "_CALL_COUNT";
3018 $self->pidl_hdr("#define NDR_" . uc $interface->{NAME} . "_CALL_COUNT ($val)");
3022 sub ParseTypePush($$$$$$)
3024 my ($self,$e, $ndr, $varname, $primitives, $deferred) = @_;
3026 # save the old relative_base_offset
3027 $self->pidl("uint32_t _save_relative_base_offset = ndr_push_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
3028 $typefamily{$e->{TYPE}}->{PUSH_FN_BODY}->($self, $e, $ndr, $varname);
3029 # restore the old relative_base_offset
3030 $self->pidl("ndr_push_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
3033 sub ParseTypePushFunction($$$)
3035 my ($self, $e, $varname) = @_;
3036 my $ndr = "ndr";
3038 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "push", $e->{NAME}, $varname);
3040 $self->fn_declare("push", $e, "enum ndr_err_code ".TypeFunctionName("ndr_push", $e)."(struct ndr_push *$ndr, int ndr_flags, $args)") or return;
3042 $self->pidl("{");
3043 $self->indent;
3044 $self->ParseTypePush($e, $ndr, $varname, 1, 1);
3045 $self->pidl("return NDR_ERR_SUCCESS;");
3046 $self->deindent;
3047 $self->pidl("}");
3048 $self->pidl("");;
3051 sub ParseTypePull($$$$$$)
3053 my ($self, $e, $ndr, $varname, $primitives, $deferred) = @_;
3055 # save the old relative_base_offset
3056 $self->pidl("uint32_t _save_relative_base_offset = ndr_pull_get_relative_base_offset($ndr);") if defined(has_property($e, "relative_base"));
3057 $typefamily{$e->{TYPE}}->{PULL_FN_BODY}->($self, $e, $ndr, $varname);
3058 # restore the old relative_base_offset
3059 $self->pidl("ndr_pull_restore_relative_base_offset($ndr, _save_relative_base_offset);") if defined(has_property($e, "relative_base"));
3062 sub ParseTypePullFunction($$)
3064 my ($self, $e, $varname) = @_;
3065 my $ndr = "ndr";
3067 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "pull", $e->{NAME}, $varname);
3069 $self->fn_declare("pull", $e, "enum ndr_err_code ".TypeFunctionName("ndr_pull", $e)."(struct ndr_pull *$ndr, int ndr_flags, $args)") or return;
3071 $self->pidl("{");
3072 $self->indent;
3073 $self->ParseTypePull($e, $ndr, $varname, 1, 1);
3074 $self->pidl("return NDR_ERR_SUCCESS;");
3075 $self->deindent;
3076 $self->pidl("}");
3077 $self->pidl("");
3080 sub ParseTypePrint($$$$)
3082 my ($self, $e, $ndr, $varname) = @_;
3084 $typefamily{$e->{TYPE}}->{PRINT_FN_BODY}->($self, $e, $ndr, $e->{NAME}, $varname);
3087 sub ParseTypePrintFunction($$$)
3089 my ($self, $e, $varname) = @_;
3090 my $ndr = "ndr";
3092 my $args = $typefamily{$e->{TYPE}}->{DECL}->($e, "print", $e->{NAME}, $varname);
3094 $self->pidl_hdr("void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *ndr, const char *name, $args);");
3096 if (is_public_struct($e)) {
3097 $self->pidl("static void ".TypeFunctionName("ndr_print_flags", $e).
3098 "(struct ndr_print *$ndr, const char *name, int unused, $args)"
3100 $self->pidl("{");
3101 $self->indent;
3102 $self->pidl(TypeFunctionName("ndr_print", $e)."($ndr, name, $varname);");
3103 $self->deindent;
3104 $self->pidl("}");
3105 $self->pidl("");
3108 return if (has_property($e, "noprint"));
3110 $self->pidl("_PUBLIC_ void ".TypeFunctionName("ndr_print", $e)."(struct ndr_print *$ndr, const char *name, $args)");
3111 $self->pidl("{");
3112 $self->indent;
3113 $self->ParseTypePrint($e, $ndr, $varname);
3114 $self->deindent;
3115 $self->pidl("}");
3116 $self->pidl("");
3119 sub ParseTypeNdrSize($$)
3121 my ($self,$t) = @_;
3123 my $varname = "r";
3124 my $tf = $typefamily{$t->{TYPE}};
3125 my $args = $tf->{SIZE_FN_ARGS}->($t, $t->{NAME}, $varname);
3127 $self->fn_declare("size", $t, "size_t ndr_size_$t->{NAME}($args)") or return;
3129 $self->pidl("{");
3130 $self->indent;
3131 $typefamily{$t->{TYPE}}->{SIZE_FN_BODY}->($self,$t, $t->{NAME}, $varname);
3132 $self->deindent;
3133 $self->pidl("}");
3134 $self->pidl("");
3137 #####################################################################
3138 # parse the interface definitions
3139 sub ParseInterface($$$)
3141 my($self,$interface,$needed) = @_;
3143 $self->pidl_hdr("#ifndef _HEADER_NDR_$interface->{NAME}");
3144 $self->pidl_hdr("#define _HEADER_NDR_$interface->{NAME}");
3146 $self->pidl_hdr("");
3148 $self->HeaderInterface($interface, $needed);
3150 # Typedefs
3151 foreach my $d (@{$interface->{TYPES}}) {
3152 if (Parse::Pidl::Typelist::typeIs($d, "PIPE")) {
3153 ($needed->{TypeFunctionName("ndr_push", $d)}) &&
3154 $self->ParsePipePushChunk($d);
3155 ($needed->{TypeFunctionName("ndr_pull", $d)}) &&
3156 $self->ParsePipePullChunk($d);
3157 ($needed->{TypeFunctionName("ndr_print", $d)}) &&
3158 $self->ParsePipePrintChunk($d);
3160 $needed->{TypeFunctionName("ndr_pull", $d)} = 0;
3161 $needed->{TypeFunctionName("ndr_push", $d)} = 0;
3162 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
3163 next;
3166 next unless(typeHasBody($d));
3168 ($needed->{TypeFunctionName("ndr_push", $d)}) && $self->ParseTypePushFunction($d, "r");
3169 ($needed->{TypeFunctionName("ndr_pull", $d)}) && $self->ParseTypePullFunction($d, "r");
3170 ($needed->{TypeFunctionName("ndr_print", $d)}) && $self->ParseTypePrintFunction($d, "r");
3172 # Make sure we don't generate a function twice...
3173 $needed->{TypeFunctionName("ndr_push", $d)} =
3174 $needed->{TypeFunctionName("ndr_pull", $d)} =
3175 $needed->{TypeFunctionName("ndr_print", $d)} = 0;
3177 ($needed->{"ndr_size_$d->{NAME}"}) && $self->ParseTypeNdrSize($d);
3180 # Functions
3181 foreach my $d (@{$interface->{FUNCTIONS}}) {
3182 ($needed->{"ndr_push_$d->{NAME}"}) && $self->ParseFunctionPush($d);
3183 ($needed->{"ndr_pull_$d->{NAME}"}) && $self->ParseFunctionPull($d);
3184 ($needed->{"ndr_print_$d->{NAME}"}) && $self->ParseFunctionPrint($d);
3187 # Allow compilation of generated files where replacement functions
3188 # for structures declared nopull/nopush have not been provided.
3190 # This makes sense when only the print functions are used
3192 # Otherwise the ndr_table XXX will reference these
3194 $self->pidl("#ifndef SKIP_NDR_TABLE_$interface->{NAME}");
3195 $self->FunctionTable($interface);
3196 $self->pidl("#endif /* SKIP_NDR_TABLE_$interface->{NAME} */");
3198 $self->pidl_hdr("#endif /* _HEADER_NDR_$interface->{NAME} */");
3201 sub GenerateIncludes($)
3203 my ($self) = @_;
3204 if (is_intree()) {
3205 $self->pidl("#include \"includes.h\"");
3206 } else {
3207 $self->pidl("#ifndef _GNU_SOURCE");
3208 $self->pidl("#define _GNU_SOURCE");
3209 $self->pidl("#endif");
3210 $self->pidl("#include <stdint.h>");
3211 $self->pidl("#include <stdlib.h>");
3212 $self->pidl("#include <stdio.h>");
3213 $self->pidl("#include <stdbool.h>");
3214 $self->pidl("#include <stdarg.h>");
3215 $self->pidl("#include <string.h>");
3219 #####################################################################
3220 # parse a parsed IDL structure back into an IDL file
3221 sub Parse($$$$)
3223 my($self, $ndr,$gen_header,$ndr_header) = @_;
3225 $self->pidl_hdr("/* header auto-generated by pidl */");
3226 $self->pidl_hdr("");
3227 $self->pidl_hdr(choose_header("librpc/ndr/libndr.h", "ndr.h"));
3228 $self->pidl_hdr("#include \"$gen_header\"") if ($gen_header);
3229 $self->pidl_hdr("");
3231 $self->pidl("/* parser auto-generated by pidl */");
3232 $self->pidl("");
3233 $self->GenerateIncludes();
3234 $self->pidl("#include \"$ndr_header\"") if ($ndr_header);
3235 $self->pidl("");
3237 my %needed = ();
3239 foreach (@{$ndr}) {
3240 ($_->{TYPE} eq "INTERFACE") && NeededInterface($_, \%needed);
3243 foreach (@{$ndr}) {
3244 ($_->{TYPE} eq "INTERFACE") && $self->ParseInterface($_, \%needed);
3245 ($_->{TYPE} eq "IMPORT") && $self->HeaderImport(@{$_->{PATHS}});
3246 ($_->{TYPE} eq "INCLUDE") && $self->HeaderInclude(@{$_->{PATHS}});
3249 return ($self->{res_hdr}, $self->{res});
3252 sub NeededElement($$$)
3254 my ($e, $dir, $needed) = @_;
3256 return if ($e->{TYPE} eq "EMPTY");
3258 return if (ref($e->{TYPE}) eq "HASH" and
3259 not defined($e->{TYPE}->{NAME}));
3261 my ($t, $rt);
3262 if (ref($e->{TYPE}) eq "HASH") {
3263 $t = $e->{TYPE}->{TYPE}."_".$e->{TYPE}->{NAME};
3264 } else {
3265 $t = $e->{TYPE};
3268 if (ref($e->{REPRESENTATION_TYPE}) eq "HASH") {
3269 $rt = $e->{REPRESENTATION_TYPE}->{TYPE}."_".$e->{REPRESENTATION_TYPE}->{NAME};
3270 } else {
3271 $rt = $e->{REPRESENTATION_TYPE};
3274 die ("$e->{NAME} $t, $rt FOO") unless ($rt ne "");
3276 my @fn = ();
3277 if ($dir eq "print") {
3278 push(@fn, TypeFunctionName("ndr_print", $e->{REPRESENTATION_TYPE}));
3279 } elsif ($dir eq "pull") {
3280 push (@fn, TypeFunctionName("ndr_pull", $e->{TYPE}));
3281 push (@fn, "ndr_$t\_to_$rt")
3282 if ($rt ne $t);
3283 } elsif ($dir eq "push") {
3284 push (@fn, TypeFunctionName("ndr_push", $e->{TYPE}));
3285 push (@fn, "ndr_$rt\_to_$t")
3286 if ($rt ne $t);
3287 } else {
3288 die("invalid direction `$dir'");
3291 foreach (@fn) {
3292 unless (defined($needed->{$_})) {
3293 $needed->{$_} = 1;
3298 sub NeededFunction($$)
3300 my ($fn,$needed) = @_;
3301 $needed->{"ndr_pull_$fn->{NAME}"} = 1;
3302 $needed->{"ndr_push_$fn->{NAME}"} = 1;
3303 $needed->{"ndr_print_$fn->{NAME}"} = 1;
3304 foreach my $e (@{$fn->{ELEMENTS}}) {
3305 $e->{PARENT} = $fn;
3306 NeededElement($e, $_, $needed) foreach ("pull", "push", "print");
3310 sub NeededType($$$)
3312 sub NeededType($$$);
3313 my ($t,$needed,$req) = @_;
3315 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "TYPEDEF");
3316 NeededType($t->{DATA}, $needed, $req) if ($t->{TYPE} eq "PIPE");
3318 if ($t->{TYPE} eq "STRUCT" or $t->{TYPE} eq "UNION") {
3319 return unless defined($t->{ELEMENTS});
3320 for my $e (@{$t->{ELEMENTS}}) {
3321 $e->{PARENT} = $t;
3322 if (has_property($e, "compression")) {
3323 $needed->{"compression"} = 1;
3325 NeededElement($e, $req, $needed);
3326 NeededType($e->{TYPE}, $needed, $req) if (ref($e->{TYPE}) eq "HASH");
3331 #####################################################################
3332 # work out what parse functions are needed
3333 sub NeededInterface($$)
3335 my ($interface,$needed) = @_;
3336 NeededFunction($_, $needed) foreach (@{$interface->{FUNCTIONS}});
3337 foreach (reverse @{$interface->{TYPES}}) {
3339 if (has_property($_, "public")) {
3340 $needed->{TypeFunctionName("ndr_pull", $_)} = $needed->{TypeFunctionName("ndr_push", $_)} =
3341 $needed->{TypeFunctionName("ndr_print", $_)} = 1;
3344 NeededType($_, $needed, "pull") if ($needed->{TypeFunctionName("ndr_pull", $_)});
3345 NeededType($_, $needed, "push") if ($needed->{TypeFunctionName("ndr_push", $_)});
3346 NeededType($_, $needed, "print") if ($needed->{TypeFunctionName("ndr_print", $_)});
3347 if (has_property($_, "gensize")) {
3348 $needed->{"ndr_size_$_->{NAME}"} = 1;
3353 sub TypeFunctionName($$)
3355 my ($prefix, $t) = @_;
3357 return "$prefix\_$t->{NAME}" if (ref($t) eq "HASH" and
3358 $t->{TYPE} eq "TYPEDEF");
3359 return "$prefix\_$t->{TYPE}_$t->{NAME}" if (ref($t) eq "HASH");
3360 return "$prefix\_$t";