1 ###################################################
2 # Samba4 NDR info tree generator
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
12 Parse::Pidl::NDR - NDR parsing information generator
16 Return a table describing the order in which the parts of an element
27 Jelmer Vernooij <jelmer@samba.org>
31 package Parse::Pidl::NDR;
34 use vars qw($VERSION);
37 @EXPORT = qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsPipe ContainsString);
38 @EXPORT_OK = qw(GetElementLevelTable ParseElement ReturnTypeElement ValidElement align_type mapToScalar ParseType can_contain_deferred is_charset_array);
41 use Parse::Pidl qw(warning fatal);
42 use Parse::Pidl::Typelist qw(hasType getType typeIs expandAlias mapScalarType is_fixed_size_scalar);
43 use Parse::Pidl::Util qw(has_property property_matches);
45 # Alignment of the built-in scalar types
46 my $scalar_alignment = {
67 'string_array' => 4, #???
79 'wrepl_nbt_name' => 4,
81 'ipv6address' => 4, #16?
86 sub GetElementLevelTable($$$)
88 my ($e, $pointer_default, $ms_union) = @_;
92 my @bracket_array = ();
97 if (has_property($e, "size_is")) {
98 @size_is = split /,/, has_property($e, "size_is");
101 if (has_property($e, "length_is")) {
102 @length_is = split /,/, has_property($e, "length_is");
105 if (defined($e->{ARRAY_LEN})) {
106 @bracket_array = @{$e->{ARRAY_LEN}};
109 if (has_property($e, "out")) {
112 if (has_property($e, "string") and not has_property($e, "in")) { $needptrs++; }
113 if ($#bracket_array >= 0) { $needptrs = 0; }
115 warning($e, "[out] argument `$e->{NAME}' not a pointer") if ($needptrs > $e->{POINTERS});
118 my $allow_pipe = ($e->{PARENT}->{TYPE} eq "FUNCTION");
119 my $is_pipe = typeIs($e->{TYPE}, "PIPE");
122 if (not $allow_pipe) {
123 fatal($e, "argument `$e->{NAME}' is a pipe and not allowed on $e->{PARENT}->{TYPE}");
126 if ($e->{POINTERS} > 1) {
127 fatal($e, "$e->{POINTERS} are not allowed on pipe element $e->{NAME}");
130 if ($e->{POINTERS} < 0) {
131 fatal($e, "pipe element $e->{NAME} needs pointer");
134 if ($e->{POINTERS} == 1 and pointer_type($e) ne "ref") {
135 fatal($e, "pointer should be 'ref' on pipe element $e->{NAME}");
138 if (scalar(@size_is) > 0) {
139 fatal($e, "size_is() on pipe element");
142 if (scalar(@length_is) > 0) {
143 fatal($e, "length_is() on pipe element");
146 if (scalar(@bracket_array) > 0) {
147 fatal($e, "brackets on pipe element");
150 if (defined(has_property($e, "subcontext"))) {
151 fatal($e, "subcontext on pipe element");
154 if (has_property($e, "switch_is")) {
155 fatal($e, "switch_is on pipe element");
158 if (can_contain_deferred($e->{TYPE})) {
159 fatal($e, "$e->{TYPE} can_contain_deferred - not allowed on pipe element");
163 # Parse the [][][][] style array stuff
164 for my $i (0 .. $#bracket_array) {
165 my $d = $bracket_array[$#bracket_array - $i];
168 my $is_surrounding = 0;
170 my $is_conformant = 0;
178 if ($size = shift @size_is) {
179 if ($e->{POINTERS} < 1 and has_property($e, "string")) {
181 delete($e->{PROPERTIES}->{string});
183 } elsif ((scalar(@size_is) == 0) and has_property($e, "string")) {
185 delete($e->{PROPERTIES}->{string});
187 fatal($e, "Must specify size_is() for conformant array!")
190 if (($length = shift @length_is) or $is_string) {
196 if ($e == $e->{PARENT}->{ELEMENTS}[-1]
197 and $e->{PARENT}->{TYPE} ne "FUNCTION") {
202 $is_fixed = 1 if (not $is_conformant and Parse::Pidl::Util::is_constant($size));
203 $is_inline = 1 if (not $is_conformant and not Parse::Pidl::Util::is_constant($size));
205 if ($i == 0 and $is_fixed and has_property($e, "string")) {
209 delete($e->{PROPERTIES}->{string});
212 if (has_property($e, "to_null")) {
219 LENGTH_IS => $length,
220 IS_DEFERRED => $is_deferred,
221 IS_SURROUNDING => $is_surrounding,
222 IS_ZERO_TERMINATED => $is_string,
223 IS_VARYING => $is_varying,
224 IS_CONFORMANT => $is_conformant,
225 IS_FIXED => $is_fixed,
226 IS_INLINE => $is_inline,
227 IS_TO_NULL => $is_to_null
231 # Next, all the pointers
232 foreach my $i (1..$e->{POINTERS}) {
233 my $level = "EMBEDDED";
234 # Top level "ref" pointers do not have a referrent identifier
235 $level = "TOP" if ($i == 1 and $e->{PARENT}->{TYPE} eq "FUNCTION");
239 # Only the first level gets the pointer type from the
240 # pointer property, the others get them from
241 # the pointer_default() interface property
243 # see http://msdn2.microsoft.com/en-us/library/aa378984(VS.85).aspx
244 # (Here they talk about the rightmost pointer, but testing shows
245 # they mean the leftmost pointer.)
249 $pt = pointer_type($e);
251 $is_deferred = 1 if ($pt ne "ref" and $e->{PARENT}->{TYPE} eq "FUNCTION");
252 $pt = $pointer_default;
258 POINTER_INDEX => $pointer_idx,
259 IS_DEFERRED => "$is_deferred",
263 warning($e, "top-level \[out\] pointer `$e->{NAME}' is not a \[ref\] pointer")
264 if ($i == 1 and $pt ne "ref" and
265 $e->{PARENT}->{TYPE} eq "FUNCTION" and
266 not has_property($e, "in"));
270 # everything that follows will be deferred
271 $is_deferred = 1 if ($level ne "TOP");
273 my $array_size = shift @size_is;
280 if ($array_length = shift @length_is) {
283 $array_length = $array_size;
288 if (scalar(@size_is) == 0 and has_property($e, "string") and
289 $i == $e->{POINTERS}) {
291 $is_varying = $is_conformant = has_property($e, "noheader")?0:1;
292 delete($e->{PROPERTIES}->{string});
295 if ($array_size or $is_string) {
298 SIZE_IS => $array_size,
299 LENGTH_IS => $array_length,
300 IS_DEFERRED => $is_deferred,
302 IS_ZERO_TERMINATED => $is_string,
303 IS_VARYING => $is_varying,
304 IS_CONFORMANT => $is_conformant,
317 CONTAINS_DEFERRED => 0,
321 foreach (@$order) { $_->{LEVEL_INDEX} = $i; $i+=1; }
326 if (defined(has_property($e, "subcontext"))) {
327 my $hdr_size = has_property($e, "subcontext");
328 my $subsize = has_property($e, "subcontext_size");
329 if (not defined($subsize)) {
334 TYPE => "SUBCONTEXT",
335 HEADER_SIZE => $hdr_size,
336 SUBCONTEXT_SIZE => $subsize,
337 IS_DEFERRED => $is_deferred,
338 COMPRESSION => has_property($e, "compression"),
342 if (my $switch = has_property($e, "switch_is")) {
345 SWITCH_IS => $switch,
346 IS_DEFERRED => $is_deferred
350 if (scalar(@size_is) > 0) {
351 fatal($e, "size_is() on non-array element");
354 if (scalar(@length_is) > 0) {
355 fatal($e, "length_is() on non-array element");
358 if (has_property($e, "string")) {
359 fatal($e, "string() attribute on non-array element");
364 DATA_TYPE => $e->{TYPE},
365 IS_DEFERRED => $is_deferred,
366 CONTAINS_DEFERRED => can_contain_deferred($e->{TYPE}),
367 IS_SURROUNDING => 0 #FIXME
371 foreach (@$order) { $_->{LEVEL_INDEX} = $i; $i+=1; }
376 sub GetTypedefLevelTable($$$$)
378 my ($e, $data, $pointer_default, $ms_union) = @_;
387 foreach (@$order) { $_->{LEVEL_INDEX} = $i; $i+=1; }
392 #####################################################################
393 # see if a type contains any deferred data
394 sub can_contain_deferred($)
396 sub can_contain_deferred($);
399 return 1 unless (hasType($type)); # assume the worst
401 $type = getType($type);
403 return 0 if (Parse::Pidl::Typelist::is_scalar($type));
405 return can_contain_deferred($type->{DATA}) if ($type->{TYPE} eq "TYPEDEF");
407 return 0 unless defined($type->{ELEMENTS});
409 foreach (@{$type->{ELEMENTS}}) {
410 return 1 if ($_->{POINTERS});
411 return 1 if (can_contain_deferred ($_->{TYPE}));
421 return undef unless $e->{POINTERS};
423 return "ref" if (has_property($e, "ref"));
424 return "full" if (has_property($e, "ptr"));
425 return "sptr" if (has_property($e, "sptr"));
426 return "unique" if (has_property($e, "unique"));
427 return "relative" if (has_property($e, "relative"));
428 return "relative_short" if (has_property($e, "relative_short"));
429 return "ignore" if (has_property($e, "ignore"));
434 #####################################################################
435 # work out the correct alignment for a structure or union
436 sub find_largest_alignment($)
441 for my $e (@{$s->{ELEMENTS}}) {
444 if ($e->{POINTERS}) {
445 # this is a hack for NDR64
446 # the NDR layer translates this into
447 # an alignment of 4 for NDR and 8 for NDR64
449 } elsif (has_property($e, "subcontext")) {
451 } elsif (has_property($e, "transmit_as")) {
452 $a = align_type($e->{PROPERTIES}->{transmit_as});
454 $a = align_type($e->{TYPE});
457 $align = $a if ($align < $a);
463 #####################################################################
470 if (ref($e) eq "HASH" and $e->{TYPE} eq "SCALAR") {
471 return $scalar_alignment->{$e->{NAME}};
474 return 0 if ($e eq "EMPTY");
476 unless (hasType($e)) {
477 # it must be an external type - all we can do is guess
478 # warning($e, "assuming alignment of unknown type '$e' is 4");
482 my $dt = getType($e);
484 if ($dt->{TYPE} eq "TYPEDEF") {
485 return align_type($dt->{DATA});
486 } elsif ($dt->{TYPE} eq "CONFORMANCE") {
487 return $dt->{DATA}->{ALIGN};
488 } elsif ($dt->{TYPE} eq "ENUM") {
489 return align_type(Parse::Pidl::Typelist::enum_type_fn($dt));
490 } elsif ($dt->{TYPE} eq "BITMAP") {
491 return align_type(Parse::Pidl::Typelist::bitmap_type_fn($dt));
492 } elsif (($dt->{TYPE} eq "STRUCT") or ($dt->{TYPE} eq "UNION")) {
493 # Struct/union without body: assume 4
494 return 4 unless (defined($dt->{ELEMENTS}));
495 return find_largest_alignment($dt);
496 } elsif (($dt->{TYPE} eq "PIPE")) {
500 die("Unknown data type type $dt->{TYPE}");
503 sub ParseElement($$$)
505 my ($e, $pointer_default, $ms_union) = @_;
507 $e->{TYPE} = expandAlias($e->{TYPE});
509 if (ref($e->{TYPE}) eq "HASH") {
510 $e->{TYPE} = ParseType($e->{TYPE}, $pointer_default, $ms_union);
516 PROPERTIES => $e->{PROPERTIES},
517 LEVELS => GetElementLevelTable($e, $pointer_default, $ms_union),
518 REPRESENTATION_TYPE => ($e->{PROPERTIES}->{represent_as} or $e->{TYPE}),
519 ALIGN => align_type($e->{TYPE}),
526 my ($struct, $pointer_default, $ms_union) = @_;
528 my $surrounding = undef;
532 NAME => $struct->{NAME},
533 SURROUNDING_ELEMENT => undef,
535 PROPERTIES => $struct->{PROPERTIES},
538 } unless defined($struct->{ELEMENTS});
540 CheckPointerTypes($struct, $pointer_default);
542 foreach my $x (@{$struct->{ELEMENTS}})
544 my $e = ParseElement($x, $pointer_default, $ms_union);
545 if ($x != $struct->{ELEMENTS}[-1] and
546 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
547 fatal($x, "conformant member not at end of struct");
552 my $e = $elements[-1];
553 if (defined($e) and defined($e->{LEVELS}[0]->{IS_SURROUNDING}) and
554 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
558 if (defined $e->{TYPE} && $e->{TYPE} eq "string"
559 && property_matches($e, "flag", ".*LIBNDR_FLAG_STR_CONFORMANT.*")) {
560 $surrounding = $struct->{ELEMENTS}[-1];
564 if ($struct->{NAME}) {
565 $align = align_type($struct->{NAME});
570 NAME => $struct->{NAME},
571 SURROUNDING_ELEMENT => $surrounding,
572 ELEMENTS => \@elements,
573 PROPERTIES => $struct->{PROPERTIES},
581 my ($e, $pointer_default, $ms_union) = @_;
583 my $is_ms_union = $ms_union;
584 $is_ms_union = 1 if has_property($e, "ms_union");
586 my $switch_type = has_property($e, "switch_type");
587 unless (defined($switch_type)) { $switch_type = "uint32"; }
588 if (has_property($e, "nodiscriminant")) { $switch_type = undef; }
593 SWITCH_TYPE => $switch_type,
595 PROPERTIES => $e->{PROPERTIES},
596 HAS_DEFAULT => $hasdefault,
597 IS_MS_UNION => $is_ms_union,
600 } unless defined($e->{ELEMENTS});
602 CheckPointerTypes($e, $pointer_default);
604 foreach my $x (@{$e->{ELEMENTS}})
607 if ($x->{TYPE} eq "EMPTY") {
608 $t = { TYPE => "EMPTY" };
610 $t = ParseElement($x, $pointer_default, $ms_union);
612 if (has_property($x, "default")) {
613 $t->{CASE} = "default";
615 } elsif (defined($x->{PROPERTIES}->{case})) {
616 $t->{CASE} = "case $x->{PROPERTIES}->{case}";
618 die("Union element $x->{NAME} has neither default nor case property");
625 $align = align_type($e->{NAME});
631 SWITCH_TYPE => $switch_type,
632 ELEMENTS => \@elements,
633 PROPERTIES => $e->{PROPERTIES},
634 HAS_DEFAULT => $hasdefault,
635 IS_MS_UNION => $is_ms_union,
643 my ($e, $pointer_default, $ms_union) = @_;
648 BASE_TYPE => Parse::Pidl::Typelist::enum_type_fn($e),
649 ELEMENTS => $e->{ELEMENTS},
650 PROPERTIES => $e->{PROPERTIES},
657 my ($e, $pointer_default, $ms_union) = @_;
662 BASE_TYPE => Parse::Pidl::Typelist::bitmap_type_fn($e),
663 ELEMENTS => $e->{ELEMENTS},
664 PROPERTIES => $e->{PROPERTIES},
671 my ($pipe, $pointer_default, $ms_union) = @_;
673 my $pname = $pipe->{NAME};
674 $pname = $pipe->{PARENT}->{NAME} unless defined $pname;
676 if (not defined($pipe->{PROPERTIES})
677 and defined($pipe->{PARENT}->{PROPERTIES})) {
678 $pipe->{PROPERTIES} = $pipe->{PARENT}->{PROPERTIES};
681 if (ref($pipe->{DATA}) eq "HASH") {
682 if (not defined($pipe->{DATA}->{PROPERTIES})
683 and defined($pipe->{PROPERTIES})) {
684 $pipe->{DATA}->{PROPERTIES} = $pipe->{PROPERTIES};
688 my $struct = ParseStruct($pipe->{DATA}, $pointer_default, $ms_union);
689 $struct->{ALIGN} = 5;
690 $struct->{NAME} = "$pname\_chunk";
692 # 'count' is element [0] and 'array' [1]
693 my $e = $struct->{ELEMENTS}[1];
694 # level [0] is of type "ARRAY"
695 my $l = $e->{LEVELS}[1];
697 # here we check that pipe elements have a fixed size type
698 while (defined($l)) {
700 $l = GetNextLevel($e, $cl);
701 if ($cl->{TYPE} ne "DATA") {
702 fatal($pipe, el_name($pipe) . ": pipe contains non DATA level");
705 # for now we only support scalars
706 next if is_fixed_size_scalar($cl->{DATA_TYPE});
708 fatal($pipe, el_name($pipe) . ": pipe contains non fixed size type[$cl->{DATA_TYPE}]");
713 NAME => $pipe->{NAME},
715 PROPERTIES => $pipe->{PROPERTIES},
722 my ($d, $pointer_default, $ms_union) = @_;
725 STRUCT => \&ParseStruct,
726 UNION => \&ParseUnion,
728 BITMAP => \&ParseBitmap,
729 TYPEDEF => \&ParseTypedef,
731 }->{$d->{TYPE}}->($d, $pointer_default, $ms_union);
738 my ($d, $pointer_default, $ms_union) = @_;
742 if (ref($d->{DATA}) eq "HASH") {
743 if (defined($d->{DATA}->{PROPERTIES})
744 and not defined($d->{PROPERTIES})) {
745 $d->{PROPERTIES} = $d->{DATA}->{PROPERTIES};
748 $data = ParseType($d->{DATA}, $pointer_default, $ms_union);
749 $data->{ALIGN} = align_type($d->{NAME});
751 $data = getType($d->{DATA});
757 PROPERTIES => $d->{PROPERTIES},
758 LEVELS => GetTypedefLevelTable($d, $data, $pointer_default, $ms_union),
771 sub ParseFunction($$$$)
773 my ($ndr,$d,$opnum,$ms_union) = @_;
776 my $thisopnum = undef;
778 CheckPointerTypes($d, "ref");
780 if (not defined($d->{PROPERTIES}{noopnum})) {
781 $thisopnum = ${$opnum};
785 foreach my $x (@{$d->{ELEMENTS}}) {
786 my $e = ParseElement($x, $ndr->{PROPERTIES}->{pointer_default}, $ms_union);
787 push (@{$e->{DIRECTION}}, "in") if (has_property($x, "in"));
788 push (@{$e->{DIRECTION}}, "out") if (has_property($x, "out"));
790 push (@elements, $e);
793 if ($d->{RETURN_TYPE} ne "void") {
794 $rettype = expandAlias($d->{RETURN_TYPE});
801 RETURN_TYPE => $rettype,
802 PROPERTIES => $d->{PROPERTIES},
803 ELEMENTS => \@elements,
808 sub ReturnTypeElement($)
812 return undef unless defined($fn->{RETURN_TYPE});
816 "TYPE" => $fn->{RETURN_TYPE},
817 "PROPERTIES" => undef,
820 "FILE" => $fn->{FILE},
821 "LINE" => $fn->{LINE},
824 return ParseElement($e, 0, 0);
827 sub CheckPointerTypes($$)
829 my ($s,$default) = @_;
831 return unless defined($s->{ELEMENTS});
833 foreach my $e (@{$s->{ELEMENTS}}) {
834 if ($e->{POINTERS} and not defined(pointer_type($e))) {
835 $e->{PROPERTIES}->{$default} = '1';
840 sub FindNestedTypes($$)
842 sub FindNestedTypes($$);
845 return unless defined($t->{ELEMENTS});
846 return if ($t->{TYPE} eq "ENUM");
847 return if ($t->{TYPE} eq "BITMAP");
849 foreach (@{$t->{ELEMENTS}}) {
850 if (ref($_->{TYPE}) eq "HASH") {
851 push (@$l, $_->{TYPE}) if (defined($_->{TYPE}->{NAME}));
852 FindNestedTypes($l, $_->{TYPE});
857 sub ParseInterface($)
867 $ms_union = 1 if has_property($idl, "ms_union");
869 if (not has_property($idl, "pointer_default")) {
870 # MIDL defaults to "ptr" in DCE compatible mode (/osf)
871 # and "unique" in Microsoft Extensions mode (default)
872 $idl->{PROPERTIES}->{pointer_default} = "unique";
875 foreach my $d (@{$idl->{DATA}}) {
876 if ($d->{TYPE} eq "FUNCTION") {
877 push (@functions, ParseFunction($idl, $d, \$opnum, $ms_union));
878 } elsif ($d->{TYPE} eq "CONST") {
879 push (@consts, ParseConst($idl, $d));
881 push (@types, ParseType($d, $idl->{PROPERTIES}->{pointer_default}, $ms_union));
882 FindNestedTypes(\@types, $d);
888 if(defined $idl->{PROPERTIES}->{version}) {
889 my @if_version = split(/\./, $idl->{PROPERTIES}->{version});
890 if ($if_version[0] == $idl->{PROPERTIES}->{version}) {
891 $version = $idl->{PROPERTIES}->{version};
893 $version = $if_version[1] << 16 | $if_version[0];
897 # If no endpoint is set, default to the interface name as a named pipe
898 if (!defined $idl->{PROPERTIES}->{endpoint}) {
899 push @endpoints, "\"ncacn_np:[\\\\pipe\\\\" . $idl->{NAME} . "]\"";
901 @endpoints = split /,/, $idl->{PROPERTIES}->{endpoint};
905 NAME => $idl->{NAME},
906 UUID => lc(has_property($idl, "uuid")),
909 PROPERTIES => $idl->{PROPERTIES},
910 FUNCTIONS => \@functions,
913 ENDPOINTS => \@endpoints,
918 # Convert a IDL tree to a NDR tree
919 # Gives a result tree describing all that's necessary for easily generating
920 # NDR parsers / generators
925 return undef unless (defined($idl));
927 Parse::Pidl::NDR::Validate($idl);
932 ($_->{TYPE} eq "CPP_QUOTE") && push(@ndr, $_);
933 ($_->{TYPE} eq "INTERFACE") && push(@ndr, ParseInterface($_));
934 ($_->{TYPE} eq "IMPORT") && push(@ndr, $_);
947 foreach my $l (@{$e->{LEVELS}}) {
948 return $l if ($seen);
949 ($seen = 1) if ($l == $fl);
960 foreach my $l (@{$e->{LEVELS}}) {
961 (return $prev) if ($l == $fl);
968 sub ContainsString($)
972 if (property_matches($e, "flag", ".*STR_NULLTERM.*")) {
975 if (exists($e->{LEVELS}) and $e->{LEVELS}->[0]->{TYPE} eq "ARRAY" and
976 ($e->{LEVELS}->[0]->{IS_FIXED} or $e->{LEVELS}->[0]->{IS_INLINE}) and
977 has_property($e, "charset"))
982 foreach my $l (@{$e->{LEVELS}}) {
983 return 1 if ($l->{TYPE} eq "ARRAY" and $l->{IS_ZERO_TERMINATED});
985 if (property_matches($e, "charset", ".*DOS.*")) {
992 sub ContainsDeferred($$)
996 return 1 if ($l->{CONTAINS_DEFERRED});
998 while ($l = GetNextLevel($e,$l))
1000 return 1 if ($l->{IS_DEFERRED});
1001 return 1 if ($l->{CONTAINS_DEFERRED});
1007 sub ContainsPipe($$)
1011 return 1 if ($l->{TYPE} eq "PIPE");
1013 while ($l = GetNextLevel($e,$l))
1015 return 1 if ($l->{TYPE} eq "PIPE");
1024 my $name = "<ANONYMOUS>";
1026 $name = $e->{NAME} if defined($e->{NAME});
1028 if (defined($e->{PARENT}) and defined($e->{PARENT}->{NAME})) {
1029 return "$e->{PARENT}->{NAME}.$name";
1032 if (defined($e->{PARENT}) and
1033 defined($e->{PARENT}->{PARENT}) and
1034 defined($e->{PARENT}->{PARENT}->{NAME})) {
1035 return "$e->{PARENT}->{PARENT}->{NAME}.$name";
1041 ###################################
1042 # find a sibling var in a structure
1043 sub find_sibling($$)
1046 my($fn) = $e->{PARENT};
1048 if ($name =~ /\*(.*)/) {
1052 for my $e2 (@{$fn->{ELEMENTS}}) {
1053 return $e2 if ($e2->{NAME} eq $name);
1059 my %property_list = (
1061 "helpstring" => ["INTERFACE", "FUNCTION"],
1062 "version" => ["INTERFACE"],
1063 "uuid" => ["INTERFACE"],
1064 "endpoint" => ["INTERFACE"],
1065 "pointer_default" => ["INTERFACE"],
1066 "helper" => ["INTERFACE"],
1067 "pyhelper" => ["INTERFACE"],
1068 "authservice" => ["INTERFACE"],
1069 "restricted" => ["INTERFACE"],
1070 "no_srv_register" => ["INTERFACE"],
1073 "object" => ["INTERFACE"],
1074 "local" => ["INTERFACE", "FUNCTION"],
1075 "iid_is" => ["ELEMENT"],
1076 "call_as" => ["FUNCTION"],
1077 "idempotent" => ["FUNCTION"],
1080 "noopnum" => ["FUNCTION"],
1081 "in" => ["ELEMENT"],
1082 "out" => ["ELEMENT"],
1085 "ref" => ["ELEMENT", "TYPEDEF"],
1086 "ptr" => ["ELEMENT", "TYPEDEF"],
1087 "unique" => ["ELEMENT", "TYPEDEF"],
1088 "ignore" => ["ELEMENT"],
1089 "relative" => ["ELEMENT", "TYPEDEF"],
1090 "relative_short" => ["ELEMENT", "TYPEDEF"],
1091 "null_is_ffffffff" => ["ELEMENT"],
1092 "relative_base" => ["TYPEDEF", "STRUCT", "UNION"],
1094 "gensize" => ["TYPEDEF", "STRUCT", "UNION"],
1095 "value" => ["ELEMENT"],
1096 "flag" => ["ELEMENT", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "PIPE"],
1099 "public" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "PIPE"],
1100 "nopush" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "PIPE"],
1101 "nopull" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "PIPE"],
1102 "nosize" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
1103 "noprint" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "ELEMENT", "PIPE"],
1104 "nopython" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
1105 "todo" => ["FUNCTION"],
1106 "skip" => ["ELEMENT"],
1109 "switch_is" => ["ELEMENT"],
1110 "switch_type" => ["ELEMENT", "UNION"],
1111 "nodiscriminant" => ["UNION"],
1112 "ms_union" => ["INTERFACE", "UNION"],
1113 "case" => ["ELEMENT"],
1114 "default" => ["ELEMENT"],
1116 "represent_as" => ["ELEMENT"],
1117 "transmit_as" => ["ELEMENT"],
1120 "subcontext" => ["ELEMENT"],
1121 "subcontext_size" => ["ELEMENT"],
1122 "compression" => ["ELEMENT"],
1125 "enum8bit" => ["ENUM"],
1126 "enum16bit" => ["ENUM"],
1127 "v1_enum" => ["ENUM"],
1130 "bitmap8bit" => ["BITMAP"],
1131 "bitmap16bit" => ["BITMAP"],
1132 "bitmap32bit" => ["BITMAP"],
1133 "bitmap64bit" => ["BITMAP"],
1136 "range" => ["ELEMENT", "PIPE"],
1137 "size_is" => ["ELEMENT"],
1138 "string" => ["ELEMENT"],
1139 "noheader" => ["ELEMENT"],
1140 "charset" => ["ELEMENT"],
1141 "length_is" => ["ELEMENT"],
1142 "to_null" => ["ELEMENT"],
1145 #####################################################################
1146 # check for unknown properties
1147 sub ValidProperties($$)
1151 return unless defined $e->{PROPERTIES};
1153 foreach my $key (keys %{$e->{PROPERTIES}}) {
1154 warning($e, el_name($e) . ": unknown property '$key'")
1155 unless defined($property_list{$key});
1157 fatal($e, el_name($e) . ": property '$key' not allowed on '$t'")
1158 unless grep(/^$t$/, @{$property_list{$key}});
1166 return $t->{NAME} if (ref($t) eq "HASH" and $t->{TYPE} eq "SCALAR");
1167 my $ti = getType($t);
1169 if (not defined ($ti)) {
1171 } elsif ($ti->{TYPE} eq "TYPEDEF") {
1172 return mapToScalar($ti->{DATA});
1173 } elsif ($ti->{TYPE} eq "ENUM") {
1174 return Parse::Pidl::Typelist::enum_type_fn($ti);
1175 } elsif ($ti->{TYPE} eq "BITMAP") {
1176 return Parse::Pidl::Typelist::bitmap_type_fn($ti);
1182 #####################################################################
1183 # validate an element
1188 ValidProperties($e,"ELEMENT");
1190 # Check whether switches are used correctly.
1191 if (my $switch = has_property($e, "switch_is")) {
1192 my $e2 = find_sibling($e, $switch);
1193 my $type = getType($e->{TYPE});
1195 if (defined($type) and $type->{DATA}->{TYPE} ne "UNION") {
1196 fatal($e, el_name($e) . ": switch_is() used on non-union type $e->{TYPE} which is a $type->{DATA}->{TYPE}");
1199 if (not has_property($type->{DATA}, "nodiscriminant") and defined($e2)) {
1200 my $discriminator_type = has_property($type->{DATA}, "switch_type");
1201 $discriminator_type = "uint32" unless defined ($discriminator_type);
1203 my $t1 = mapScalarType(mapToScalar($discriminator_type));
1205 if (not defined($t1)) {
1206 fatal($e, el_name($e) . ": unable to map discriminator type '$discriminator_type' to scalar");
1209 my $t2 = mapScalarType(mapToScalar($e2->{TYPE}));
1210 if (not defined($t2)) {
1211 fatal($e, el_name($e) . ": unable to map variable used for switch_is() to scalar");
1215 warning($e, el_name($e) . ": switch_is() is of type $e2->{TYPE} ($t2), while discriminator type for union $type->{NAME} is $discriminator_type ($t1)");
1220 if (has_property($e, "subcontext") and has_property($e, "represent_as")) {
1221 fatal($e, el_name($e) . " : subcontext() and represent_as() can not be used on the same element");
1224 if (has_property($e, "subcontext") and has_property($e, "transmit_as")) {
1225 fatal($e, el_name($e) . " : subcontext() and transmit_as() can not be used on the same element");
1228 if (has_property($e, "represent_as") and has_property($e, "transmit_as")) {
1229 fatal($e, el_name($e) . " : represent_as() and transmit_as() can not be used on the same element");
1232 if (has_property($e, "represent_as") and has_property($e, "value")) {
1233 fatal($e, el_name($e) . " : represent_as() and value() can not be used on the same element");
1236 if (has_property($e, "subcontext")) {
1237 warning($e, "subcontext() is deprecated. Use represent_as() or transmit_as() instead");
1240 if (defined (has_property($e, "subcontext_size")) and not defined(has_property($e, "subcontext"))) {
1241 fatal($e, el_name($e) . " : subcontext_size() on non-subcontext element");
1244 if (defined (has_property($e, "compression")) and not defined(has_property($e, "subcontext"))) {
1245 fatal($e, el_name($e) . " : compression() on non-subcontext element");
1248 if (!$e->{POINTERS} && (
1249 has_property($e, "ptr") or
1250 has_property($e, "unique") or
1251 has_property($e, "relative") or
1252 has_property($e, "relative_short") or
1253 has_property($e, "ref"))) {
1254 fatal($e, el_name($e) . " : pointer properties on non-pointer element\n");
1258 #####################################################################
1264 ValidProperties($enum, "ENUM");
1267 #####################################################################
1273 ValidProperties($bitmap, "BITMAP");
1276 #####################################################################
1280 my($struct) = shift;
1282 ValidProperties($struct, "STRUCT");
1284 return unless defined($struct->{ELEMENTS});
1286 foreach my $e (@{$struct->{ELEMENTS}}) {
1287 $e->{PARENT} = $struct;
1292 #####################################################################
1298 ValidProperties($union,"UNION");
1300 if (has_property($union->{PARENT}, "nodiscriminant") and
1301 has_property($union->{PARENT}, "switch_type")) {
1302 fatal($union->{PARENT}, $union->{PARENT}->{NAME} . ": switch_type(" . $union->{PARENT}->{PROPERTIES}->{switch_type} . ") on union without discriminant");
1305 return unless defined($union->{ELEMENTS});
1307 foreach my $e (@{$union->{ELEMENTS}}) {
1308 $e->{PARENT} = $union;
1310 if (defined($e->{PROPERTIES}->{default}) and
1311 defined($e->{PROPERTIES}->{case})) {
1312 fatal($e, "Union member $e->{NAME} can not have both default and case properties!");
1315 unless (defined ($e->{PROPERTIES}->{default}) or
1316 defined ($e->{PROPERTIES}->{case})) {
1317 fatal($e, "Union member $e->{NAME} must have default or case property");
1320 if (has_property($e, "ref")) {
1321 fatal($e, el_name($e) . ": embedded ref pointers are not supported yet\n");
1329 #####################################################################
1334 my $struct = $pipe->{DATA};
1336 ValidProperties($pipe, "PIPE");
1338 $struct->{PARENT} = $pipe;
1340 $struct->{FILE} = $pipe->{FILE} unless defined($struct->{FILE});
1341 $struct->{LINE} = $pipe->{LINE} unless defined($struct->{LINE});
1346 #####################################################################
1350 my($typedef) = shift;
1351 my $data = $typedef->{DATA};
1353 ValidProperties($typedef, "TYPEDEF");
1355 return unless (ref($data) eq "HASH");
1357 $data->{PARENT} = $typedef;
1359 $data->{FILE} = $typedef->{FILE} unless defined($data->{FILE});
1360 $data->{LINE} = $typedef->{LINE} unless defined($data->{LINE});
1365 #####################################################################
1366 # validate a function
1367 sub ValidFunction($)
1371 ValidProperties($fn,"FUNCTION");
1373 foreach my $e (@{$fn->{ELEMENTS}}) {
1375 if (has_property($e, "ref") && !$e->{POINTERS}) {
1376 fatal($e, "[ref] variables must be pointers ($fn->{NAME}/$e->{NAME})");
1382 #####################################################################
1389 TYPEDEF => \&ValidTypedef,
1390 STRUCT => \&ValidStruct,
1391 UNION => \&ValidUnion,
1392 ENUM => \&ValidEnum,
1393 BITMAP => \&ValidBitmap,
1395 }->{$t->{TYPE}}->($t);
1398 #####################################################################
1399 # parse the interface definitions
1400 sub ValidInterface($)
1402 my($interface) = shift;
1403 my($data) = $interface->{DATA};
1405 if (has_property($interface, "helper")) {
1406 warning($interface, "helper() is pidl-specific and deprecated. Use `include' instead");
1409 ValidProperties($interface,"INTERFACE");
1411 if (has_property($interface, "pointer_default")) {
1412 if (not grep (/$interface->{PROPERTIES}->{pointer_default}/,
1413 ("ref", "unique", "ptr"))) {
1414 fatal($interface, "Unknown default pointer type `$interface->{PROPERTIES}->{pointer_default}'");
1418 if (has_property($interface, "object")) {
1419 if (has_property($interface, "version") &&
1420 $interface->{PROPERTIES}->{version} != 0) {
1421 fatal($interface, "Object interfaces must have version 0.0 ($interface->{NAME})");
1424 if (!defined($interface->{BASE}) &&
1425 not ($interface->{NAME} eq "IUnknown")) {
1426 fatal($interface, "Object interfaces must all derive from IUnknown ($interface->{NAME})");
1430 foreach my $d (@{$data}) {
1431 ($d->{TYPE} eq "FUNCTION") && ValidFunction($d);
1432 ($d->{TYPE} eq "TYPEDEF" or
1433 $d->{TYPE} eq "STRUCT" or
1434 $d->{TYPE} eq "UNION" or
1435 $d->{TYPE} eq "ENUM" or
1436 $d->{TYPE} eq "BITMAP" or
1437 $d->{TYPE} eq "PIPE") && ValidType($d);
1442 #####################################################################
1443 # Validate an IDL structure
1448 foreach my $x (@{$idl}) {
1449 ($x->{TYPE} eq "INTERFACE") &&
1451 ($x->{TYPE} eq "IMPORTLIB") &&
1452 fatal($x, "importlib() not supported");
1456 sub is_charset_array($$)
1460 return 0 if ($l->{TYPE} ne "ARRAY");
1462 my $nl = GetNextLevel($e,$l);
1464 return 0 unless ($nl->{TYPE} eq "DATA");
1466 return has_property($e, "charset");