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 ContainsString);
38 @EXPORT_OK = qw(GetElementLevelTable ParseElement 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 expandAlias mapScalarType);
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, #???
76 'wrepl_nbt_name' => 4,
80 sub GetElementLevelTable($$)
82 my ($e, $pointer_default) = @_;
86 my @bracket_array = ();
91 if (has_property($e, "size_is")) {
92 @size_is = split /,/, has_property($e, "size_is");
95 if (has_property($e, "length_is")) {
96 @length_is = split /,/, has_property($e, "length_is");
99 if (defined($e->{ARRAY_LEN})) {
100 @bracket_array = @{$e->{ARRAY_LEN}};
103 if (has_property($e, "out")) {
106 if (has_property($e, "string")) { $needptrs++; }
107 if ($#bracket_array >= 0) { $needptrs = 0; }
109 warning($e, "[out] argument `$e->{NAME}' not a pointer") if ($needptrs > $e->{POINTERS});
112 # Parse the [][][][] style array stuff
113 for my $i (0 .. $#bracket_array) {
114 my $d = $bracket_array[$#bracket_array - $i];
117 my $is_surrounding = 0;
119 my $is_conformant = 0;
126 if ($size = shift @size_is) {
127 } elsif ((scalar(@size_is) == 0) and has_property($e, "string")) {
129 delete($e->{PROPERTIES}->{string});
131 fatal($e, "Must specify size_is() for conformant array!")
134 if (($length = shift @length_is) or $is_string) {
140 if ($e == $e->{PARENT}->{ELEMENTS}[-1]
141 and $e->{PARENT}->{TYPE} ne "FUNCTION") {
146 $is_fixed = 1 if (not $is_conformant and Parse::Pidl::Util::is_constant($size));
147 $is_inline = 1 if (not $is_conformant and not Parse::Pidl::Util::is_constant($size));
149 if ($i == 0 and $is_fixed and has_property($e, "string")) {
153 delete($e->{PROPERTIES}->{string});
159 LENGTH_IS => $length,
160 IS_DEFERRED => $is_deferred,
161 IS_SURROUNDING => $is_surrounding,
162 IS_ZERO_TERMINATED => $is_string,
163 IS_VARYING => $is_varying,
164 IS_CONFORMANT => $is_conformant,
165 IS_FIXED => $is_fixed,
166 IS_INLINE => $is_inline
170 # Next, all the pointers
171 foreach my $i (1..$e->{POINTERS}) {
172 my $level = "EMBEDDED";
173 # Top level "ref" pointers do not have a referrent identifier
174 $level = "TOP" if ($i == 1 and $e->{PARENT}->{TYPE} eq "FUNCTION");
178 # Only the first level gets the pointer type from the
179 # pointer property, the others get them from
180 # the pointer_default() interface property
182 # see http://msdn2.microsoft.com/en-us/library/aa378984(VS.85).aspx
183 # (Here they talk about the rightmost pointer, but testing shows
184 # they mean the leftmost pointer.)
188 $pt = pointer_type($e);
190 $is_deferred = 1 if ($pt ne "ref" and $e->{PARENT}->{TYPE} eq "FUNCTION");
191 $pt = $pointer_default;
197 POINTER_INDEX => $pointer_idx,
198 IS_DEFERRED => "$is_deferred",
202 warning($e, "top-level \[out\] pointer `$e->{NAME}' is not a \[ref\] pointer")
203 if ($i == 1 and $pt ne "ref" and
204 $e->{PARENT}->{TYPE} eq "FUNCTION" and
205 not has_property($e, "in"));
209 # everything that follows will be deferred
210 $is_deferred = 1 if ($level ne "TOP");
212 my $array_size = shift @size_is;
219 if ($array_length = shift @length_is) {
222 $array_length = $array_size;
227 if (scalar(@size_is) == 0 and has_property($e, "string") and
228 $i == $e->{POINTERS}) {
230 $is_varying = $is_conformant = has_property($e, "noheader")?0:1;
231 delete($e->{PROPERTIES}->{string});
234 if ($array_size or $is_string) {
237 SIZE_IS => $array_size,
238 LENGTH_IS => $array_length,
239 IS_DEFERRED => $is_deferred,
241 IS_ZERO_TERMINATED => $is_string,
242 IS_VARYING => $is_varying,
243 IS_CONFORMANT => $is_conformant,
252 if (defined(has_property($e, "subcontext"))) {
253 my $hdr_size = has_property($e, "subcontext");
254 my $subsize = has_property($e, "subcontext_size");
255 if (not defined($subsize)) {
260 TYPE => "SUBCONTEXT",
261 HEADER_SIZE => $hdr_size,
262 SUBCONTEXT_SIZE => $subsize,
263 IS_DEFERRED => $is_deferred,
264 COMPRESSION => has_property($e, "compression"),
268 if (my $switch = has_property($e, "switch_is")) {
271 SWITCH_IS => $switch,
272 IS_DEFERRED => $is_deferred
276 if (scalar(@size_is) > 0) {
277 fatal($e, "size_is() on non-array element");
280 if (scalar(@length_is) > 0) {
281 fatal($e, "length_is() on non-array element");
284 if (has_property($e, "string")) {
285 fatal($e, "string() attribute on non-array element");
290 DATA_TYPE => $e->{TYPE},
291 IS_DEFERRED => $is_deferred,
292 CONTAINS_DEFERRED => can_contain_deferred($e->{TYPE}),
293 IS_SURROUNDING => 0 #FIXME
297 foreach (@$order) { $_->{LEVEL_INDEX} = $i; $i+=1; }
302 sub GetTypedefLevelTable($$$)
304 my ($e, $data, $pointer_default) = @_;
313 foreach (@$order) { $_->{LEVEL_INDEX} = $i; $i+=1; }
318 #####################################################################
319 # see if a type contains any deferred data
320 sub can_contain_deferred($)
322 sub can_contain_deferred($);
325 return 1 unless (hasType($type)); # assume the worst
327 $type = getType($type);
329 return 0 if (Parse::Pidl::Typelist::is_scalar($type));
331 return can_contain_deferred($type->{DATA}) if ($type->{TYPE} eq "TYPEDEF");
333 return 0 unless defined($type->{ELEMENTS});
335 foreach (@{$type->{ELEMENTS}}) {
336 return 1 if ($_->{POINTERS});
337 return 1 if (can_contain_deferred ($_->{TYPE}));
347 return undef unless $e->{POINTERS};
349 return "ref" if (has_property($e, "ref"));
350 return "full" if (has_property($e, "ptr"));
351 return "sptr" if (has_property($e, "sptr"));
352 return "unique" if (has_property($e, "unique"));
353 return "relative" if (has_property($e, "relative"));
354 return "relative_short" if (has_property($e, "relative_short"));
355 return "ignore" if (has_property($e, "ignore"));
360 #####################################################################
361 # work out the correct alignment for a structure or union
362 sub find_largest_alignment($)
367 for my $e (@{$s->{ELEMENTS}}) {
370 if ($e->{POINTERS}) {
371 # this is a hack for NDR64
372 # the NDR layer translates this into
373 # an alignment of 4 for NDR and 8 for NDR64
375 } elsif (has_property($e, "subcontext")) {
377 } elsif (has_property($e, "transmit_as")) {
378 $a = align_type($e->{PROPERTIES}->{transmit_as});
380 $a = align_type($e->{TYPE});
383 $align = $a if ($align < $a);
389 #####################################################################
396 if (ref($e) eq "HASH" and $e->{TYPE} eq "SCALAR") {
397 return $scalar_alignment->{$e->{NAME}};
400 return 0 if ($e eq "EMPTY");
402 unless (hasType($e)) {
403 # it must be an external type - all we can do is guess
404 # warning($e, "assuming alignment of unknown type '$e' is 4");
408 my $dt = getType($e);
410 if ($dt->{TYPE} eq "TYPEDEF") {
411 return align_type($dt->{DATA});
412 } elsif ($dt->{TYPE} eq "CONFORMANCE") {
413 return $dt->{DATA}->{ALIGN};
414 } elsif ($dt->{TYPE} eq "ENUM") {
415 return align_type(Parse::Pidl::Typelist::enum_type_fn($dt));
416 } elsif ($dt->{TYPE} eq "BITMAP") {
417 return align_type(Parse::Pidl::Typelist::bitmap_type_fn($dt));
418 } elsif (($dt->{TYPE} eq "STRUCT") or ($dt->{TYPE} eq "UNION")) {
419 # Struct/union without body: assume 4
420 return 4 unless (defined($dt->{ELEMENTS}));
421 return find_largest_alignment($dt);
424 die("Unknown data type type $dt->{TYPE}");
429 my ($e, $pointer_default) = @_;
431 $e->{TYPE} = expandAlias($e->{TYPE});
433 if (ref($e->{TYPE}) eq "HASH") {
434 $e->{TYPE} = ParseType($e->{TYPE}, $pointer_default);
440 PROPERTIES => $e->{PROPERTIES},
441 LEVELS => GetElementLevelTable($e, $pointer_default),
442 REPRESENTATION_TYPE => ($e->{PROPERTIES}->{represent_as} or $e->{TYPE}),
443 ALIGN => align_type($e->{TYPE}),
450 my ($struct, $pointer_default) = @_;
452 my $surrounding = undef;
456 NAME => $struct->{NAME},
457 SURROUNDING_ELEMENT => undef,
459 PROPERTIES => $struct->{PROPERTIES},
462 } unless defined($struct->{ELEMENTS});
464 CheckPointerTypes($struct, $pointer_default);
466 foreach my $x (@{$struct->{ELEMENTS}})
468 my $e = ParseElement($x, $pointer_default);
469 if ($x != $struct->{ELEMENTS}[-1] and
470 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
471 fatal($x, "conformant member not at end of struct");
476 my $e = $elements[-1];
477 if (defined($e) and defined($e->{LEVELS}[0]->{IS_SURROUNDING}) and
478 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
482 if (defined $e->{TYPE} && $e->{TYPE} eq "string"
483 && property_matches($e, "flag", ".*LIBNDR_FLAG_STR_CONFORMANT.*")) {
484 $surrounding = $struct->{ELEMENTS}[-1];
488 if ($struct->{NAME}) {
489 $align = align_type($struct->{NAME});
494 NAME => $struct->{NAME},
495 SURROUNDING_ELEMENT => $surrounding,
496 ELEMENTS => \@elements,
497 PROPERTIES => $struct->{PROPERTIES},
505 my ($e, $pointer_default) = @_;
508 my $switch_type = has_property($e, "switch_type");
509 unless (defined($switch_type)) { $switch_type = "uint32"; }
510 if (has_property($e, "nodiscriminant")) { $switch_type = undef; }
515 SWITCH_TYPE => $switch_type,
517 PROPERTIES => $e->{PROPERTIES},
518 HAS_DEFAULT => $hasdefault,
521 } unless defined($e->{ELEMENTS});
523 CheckPointerTypes($e, $pointer_default);
525 foreach my $x (@{$e->{ELEMENTS}})
528 if ($x->{TYPE} eq "EMPTY") {
529 $t = { TYPE => "EMPTY" };
531 $t = ParseElement($x, $pointer_default);
533 if (has_property($x, "default")) {
534 $t->{CASE} = "default";
536 } elsif (defined($x->{PROPERTIES}->{case})) {
537 $t->{CASE} = "case $x->{PROPERTIES}->{case}";
539 die("Union element $x->{NAME} has neither default nor case property");
546 $align = align_type($e->{NAME});
552 SWITCH_TYPE => $switch_type,
553 ELEMENTS => \@elements,
554 PROPERTIES => $e->{PROPERTIES},
555 HAS_DEFAULT => $hasdefault,
563 my ($e, $pointer_default) = @_;
568 BASE_TYPE => Parse::Pidl::Typelist::enum_type_fn($e),
569 ELEMENTS => $e->{ELEMENTS},
570 PROPERTIES => $e->{PROPERTIES},
577 my ($e, $pointer_default) = @_;
582 BASE_TYPE => Parse::Pidl::Typelist::bitmap_type_fn($e),
583 ELEMENTS => $e->{ELEMENTS},
584 PROPERTIES => $e->{PROPERTIES},
591 my ($d, $pointer_default) = @_;
594 STRUCT => \&ParseStruct,
595 UNION => \&ParseUnion,
597 BITMAP => \&ParseBitmap,
598 TYPEDEF => \&ParseTypedef,
599 }->{$d->{TYPE}}->($d, $pointer_default);
606 my ($d, $pointer_default) = @_;
608 if (defined($d->{DATA}->{PROPERTIES}) && !defined($d->{PROPERTIES})) {
609 $d->{PROPERTIES} = $d->{DATA}->{PROPERTIES};
612 my $data = ParseType($d->{DATA}, $pointer_default);
613 $data->{ALIGN} = align_type($d->{NAME});
618 PROPERTIES => $d->{PROPERTIES},
619 LEVELS => GetTypedefLevelTable($d, $data, $pointer_default),
632 sub ParseFunction($$$)
634 my ($ndr,$d,$opnum) = @_;
637 my $thisopnum = undef;
639 CheckPointerTypes($d, "ref");
641 if (not defined($d->{PROPERTIES}{noopnum})) {
642 $thisopnum = ${$opnum};
646 foreach my $x (@{$d->{ELEMENTS}}) {
647 my $e = ParseElement($x, $ndr->{PROPERTIES}->{pointer_default});
648 push (@{$e->{DIRECTION}}, "in") if (has_property($x, "in"));
649 push (@{$e->{DIRECTION}}, "out") if (has_property($x, "out"));
651 push (@elements, $e);
654 if ($d->{RETURN_TYPE} ne "void") {
655 $rettype = expandAlias($d->{RETURN_TYPE});
659 if (has_property($d, "async")) { $async = 1; }
666 RETURN_TYPE => $rettype,
667 PROPERTIES => $d->{PROPERTIES},
668 ELEMENTS => \@elements,
673 sub CheckPointerTypes($$)
675 my ($s,$default) = @_;
677 return unless defined($s->{ELEMENTS});
679 foreach my $e (@{$s->{ELEMENTS}}) {
680 if ($e->{POINTERS} and not defined(pointer_type($e))) {
681 $e->{PROPERTIES}->{$default} = '1';
686 sub FindNestedTypes($$)
688 sub FindNestedTypes($$);
691 return unless defined($t->{ELEMENTS});
692 return if ($t->{TYPE} eq "ENUM");
693 return if ($t->{TYPE} eq "BITMAP");
695 foreach (@{$t->{ELEMENTS}}) {
696 if (ref($_->{TYPE}) eq "HASH") {
697 push (@$l, $_->{TYPE}) if (defined($_->{TYPE}->{NAME}));
698 FindNestedTypes($l, $_->{TYPE});
703 sub ParseInterface($)
713 if (not has_property($idl, "pointer_default")) {
714 # MIDL defaults to "ptr" in DCE compatible mode (/osf)
715 # and "unique" in Microsoft Extensions mode (default)
716 $idl->{PROPERTIES}->{pointer_default} = "unique";
719 foreach my $d (@{$idl->{DATA}}) {
720 if ($d->{TYPE} eq "FUNCTION") {
721 push (@functions, ParseFunction($idl, $d, \$opnum));
722 } elsif ($d->{TYPE} eq "CONST") {
723 push (@consts, ParseConst($idl, $d));
725 push (@types, ParseType($d, $idl->{PROPERTIES}->{pointer_default}));
726 FindNestedTypes(\@types, $d);
732 if(defined $idl->{PROPERTIES}->{version}) {
733 my @if_version = split(/\./, $idl->{PROPERTIES}->{version});
734 if ($if_version[0] == $idl->{PROPERTIES}->{version}) {
735 $version = $idl->{PROPERTIES}->{version};
737 $version = $if_version[1] << 16 | $if_version[0];
741 # If no endpoint is set, default to the interface name as a named pipe
742 if (!defined $idl->{PROPERTIES}->{endpoint}) {
743 push @endpoints, "\"ncacn_np:[\\\\pipe\\\\" . $idl->{NAME} . "]\"";
745 @endpoints = split /,/, $idl->{PROPERTIES}->{endpoint};
749 NAME => $idl->{NAME},
750 UUID => lc(has_property($idl, "uuid")),
753 PROPERTIES => $idl->{PROPERTIES},
754 FUNCTIONS => \@functions,
757 ENDPOINTS => \@endpoints
761 # Convert a IDL tree to a NDR tree
762 # Gives a result tree describing all that's necessary for easily generating
763 # NDR parsers / generators
768 return undef unless (defined($idl));
770 Parse::Pidl::NDR::Validate($idl);
775 ($_->{TYPE} eq "CPP_QUOTE") && push(@ndr, $_);
776 ($_->{TYPE} eq "INTERFACE") && push(@ndr, ParseInterface($_));
777 ($_->{TYPE} eq "IMPORT") && push(@ndr, $_);
790 foreach my $l (@{$e->{LEVELS}}) {
791 return $l if ($seen);
792 ($seen = 1) if ($l == $fl);
803 foreach my $l (@{$e->{LEVELS}}) {
804 (return $prev) if ($l == $fl);
811 sub ContainsString($)
815 foreach my $l (@{$e->{LEVELS}}) {
816 return 1 if ($l->{TYPE} eq "ARRAY" and $l->{IS_ZERO_TERMINATED});
822 sub ContainsDeferred($$)
826 return 1 if ($l->{CONTAINS_DEFERRED});
828 while ($l = GetNextLevel($e,$l))
830 return 1 if ($l->{IS_DEFERRED});
831 return 1 if ($l->{CONTAINS_DEFERRED});
840 my $name = "<ANONYMOUS>";
842 $name = $e->{NAME} if defined($e->{NAME});
844 if (defined($e->{PARENT}) and defined($e->{PARENT}->{NAME})) {
845 return "$e->{PARENT}->{NAME}.$name";
848 if (defined($e->{PARENT}) and
849 defined($e->{PARENT}->{PARENT}) and
850 defined($e->{PARENT}->{PARENT}->{NAME})) {
851 return "$e->{PARENT}->{PARENT}->{NAME}.$name";
857 ###################################
858 # find a sibling var in a structure
862 my($fn) = $e->{PARENT};
864 if ($name =~ /\*(.*)/) {
868 for my $e2 (@{$fn->{ELEMENTS}}) {
869 return $e2 if ($e2->{NAME} eq $name);
875 my %property_list = (
877 "helpstring" => ["INTERFACE", "FUNCTION"],
878 "version" => ["INTERFACE"],
879 "uuid" => ["INTERFACE"],
880 "endpoint" => ["INTERFACE"],
881 "pointer_default" => ["INTERFACE"],
882 "helper" => ["INTERFACE"],
883 "pyhelper" => ["INTERFACE"],
884 "authservice" => ["INTERFACE"],
885 "restricted" => ["INTERFACE"],
888 "object" => ["INTERFACE"],
889 "local" => ["INTERFACE", "FUNCTION"],
890 "iid_is" => ["ELEMENT"],
891 "call_as" => ["FUNCTION"],
892 "idempotent" => ["FUNCTION"],
895 "noopnum" => ["FUNCTION"],
897 "out" => ["ELEMENT"],
898 "async" => ["FUNCTION"],
901 "ref" => ["ELEMENT"],
902 "ptr" => ["ELEMENT"],
903 "unique" => ["ELEMENT"],
904 "ignore" => ["ELEMENT"],
905 "relative" => ["ELEMENT"],
906 "relative_short" => ["ELEMENT"],
907 "null_is_ffffffff" => ["ELEMENT"],
908 "relative_base" => ["TYPEDEF", "STRUCT", "UNION"],
910 "gensize" => ["TYPEDEF", "STRUCT", "UNION"],
911 "value" => ["ELEMENT"],
912 "flag" => ["ELEMENT", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
915 "public" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
916 "nopush" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
917 "nopull" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
918 "nosize" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
919 "noprint" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "ELEMENT"],
920 "nopython" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
921 "todo" => ["FUNCTION"],
924 "switch_is" => ["ELEMENT"],
925 "switch_type" => ["ELEMENT", "UNION"],
926 "nodiscriminant" => ["UNION"],
927 "case" => ["ELEMENT"],
928 "default" => ["ELEMENT"],
930 "represent_as" => ["ELEMENT"],
931 "transmit_as" => ["ELEMENT"],
934 "subcontext" => ["ELEMENT"],
935 "subcontext_size" => ["ELEMENT"],
936 "compression" => ["ELEMENT"],
939 "enum8bit" => ["ENUM"],
940 "enum16bit" => ["ENUM"],
941 "v1_enum" => ["ENUM"],
944 "bitmap8bit" => ["BITMAP"],
945 "bitmap16bit" => ["BITMAP"],
946 "bitmap32bit" => ["BITMAP"],
947 "bitmap64bit" => ["BITMAP"],
950 "range" => ["ELEMENT", "PIPE"],
951 "size_is" => ["ELEMENT"],
952 "string" => ["ELEMENT"],
953 "noheader" => ["ELEMENT"],
954 "charset" => ["ELEMENT"],
955 "length_is" => ["ELEMENT"],
958 #####################################################################
959 # check for unknown properties
960 sub ValidProperties($$)
964 return unless defined $e->{PROPERTIES};
966 foreach my $key (keys %{$e->{PROPERTIES}}) {
967 warning($e, el_name($e) . ": unknown property '$key'")
968 unless defined($property_list{$key});
970 fatal($e, el_name($e) . ": property '$key' not allowed on '$t'")
971 unless grep(/^$t$/, @{$property_list{$key}});
979 return $t->{NAME} if (ref($t) eq "HASH" and $t->{TYPE} eq "SCALAR");
980 my $ti = getType($t);
982 if (not defined ($ti)) {
984 } elsif ($ti->{TYPE} eq "TYPEDEF") {
985 return mapToScalar($ti->{DATA});
986 } elsif ($ti->{TYPE} eq "ENUM") {
987 return Parse::Pidl::Typelist::enum_type_fn($ti);
988 } elsif ($ti->{TYPE} eq "BITMAP") {
989 return Parse::Pidl::Typelist::bitmap_type_fn($ti);
995 #####################################################################
996 # validate an element
1001 ValidProperties($e,"ELEMENT");
1003 # Check whether switches are used correctly.
1004 if (my $switch = has_property($e, "switch_is")) {
1005 my $e2 = find_sibling($e, $switch);
1006 my $type = getType($e->{TYPE});
1008 if (defined($type) and $type->{DATA}->{TYPE} ne "UNION") {
1009 fatal($e, el_name($e) . ": switch_is() used on non-union type $e->{TYPE} which is a $type->{DATA}->{TYPE}");
1012 if (not has_property($type->{DATA}, "nodiscriminant") and defined($e2)) {
1013 my $discriminator_type = has_property($type->{DATA}, "switch_type");
1014 $discriminator_type = "uint32" unless defined ($discriminator_type);
1016 my $t1 = mapScalarType(mapToScalar($discriminator_type));
1018 if (not defined($t1)) {
1019 fatal($e, el_name($e) . ": unable to map discriminator type '$discriminator_type' to scalar");
1022 my $t2 = mapScalarType(mapToScalar($e2->{TYPE}));
1023 if (not defined($t2)) {
1024 fatal($e, el_name($e) . ": unable to map variable used for switch_is() to scalar");
1028 warning($e, el_name($e) . ": switch_is() is of type $e2->{TYPE} ($t2), while discriminator type for union $type->{NAME} is $discriminator_type ($t1)");
1033 if (has_property($e, "subcontext") and has_property($e, "represent_as")) {
1034 fatal($e, el_name($e) . " : subcontext() and represent_as() can not be used on the same element");
1037 if (has_property($e, "subcontext") and has_property($e, "transmit_as")) {
1038 fatal($e, el_name($e) . " : subcontext() and transmit_as() can not be used on the same element");
1041 if (has_property($e, "represent_as") and has_property($e, "transmit_as")) {
1042 fatal($e, el_name($e) . " : represent_as() and transmit_as() can not be used on the same element");
1045 if (has_property($e, "represent_as") and has_property($e, "value")) {
1046 fatal($e, el_name($e) . " : represent_as() and value() can not be used on the same element");
1049 if (has_property($e, "subcontext")) {
1050 warning($e, "subcontext() is deprecated. Use represent_as() or transmit_as() instead");
1053 if (defined (has_property($e, "subcontext_size")) and not defined(has_property($e, "subcontext"))) {
1054 fatal($e, el_name($e) . " : subcontext_size() on non-subcontext element");
1057 if (defined (has_property($e, "compression")) and not defined(has_property($e, "subcontext"))) {
1058 fatal($e, el_name($e) . " : compression() on non-subcontext element");
1061 if (!$e->{POINTERS} && (
1062 has_property($e, "ptr") or
1063 has_property($e, "unique") or
1064 has_property($e, "relative") or
1065 has_property($e, "relative_short") or
1066 has_property($e, "ref"))) {
1067 fatal($e, el_name($e) . " : pointer properties on non-pointer element\n");
1071 #####################################################################
1077 ValidProperties($enum, "ENUM");
1080 #####################################################################
1086 ValidProperties($bitmap, "BITMAP");
1089 #####################################################################
1093 my($struct) = shift;
1095 ValidProperties($struct, "STRUCT");
1097 return unless defined($struct->{ELEMENTS});
1099 foreach my $e (@{$struct->{ELEMENTS}}) {
1100 $e->{PARENT} = $struct;
1105 #####################################################################
1111 ValidProperties($union,"UNION");
1113 if (has_property($union->{PARENT}, "nodiscriminant") and
1114 has_property($union->{PARENT}, "switch_type")) {
1115 fatal($union->{PARENT}, $union->{PARENT}->{NAME} . ": switch_type(" . $union->{PARENT}->{PROPERTIES}->{switch_type} . ") on union without discriminant");
1118 return unless defined($union->{ELEMENTS});
1120 foreach my $e (@{$union->{ELEMENTS}}) {
1121 $e->{PARENT} = $union;
1123 if (defined($e->{PROPERTIES}->{default}) and
1124 defined($e->{PROPERTIES}->{case})) {
1125 fatal($e, "Union member $e->{NAME} can not have both default and case properties!");
1128 unless (defined ($e->{PROPERTIES}->{default}) or
1129 defined ($e->{PROPERTIES}->{case})) {
1130 fatal($e, "Union member $e->{NAME} must have default or case property");
1133 if (has_property($e, "ref")) {
1134 fatal($e, el_name($e) . ": embedded ref pointers are not supported yet\n");
1142 #####################################################################
1147 my $data = $pipe->{DATA};
1149 ValidProperties($pipe, "PIPE");
1151 fatal($pipe, $pipe->{NAME} . ": 'pipe' is not yet supported by pidl");
1154 #####################################################################
1158 my($typedef) = shift;
1159 my $data = $typedef->{DATA};
1161 ValidProperties($typedef, "TYPEDEF");
1163 $data->{PARENT} = $typedef;
1165 $data->{FILE} = $typedef->{FILE} unless defined($data->{FILE});
1166 $data->{LINE} = $typedef->{LINE} unless defined($data->{LINE});
1168 ValidType($data) if (ref($data) eq "HASH");
1171 #####################################################################
1172 # validate a function
1173 sub ValidFunction($)
1177 ValidProperties($fn,"FUNCTION");
1179 foreach my $e (@{$fn->{ELEMENTS}}) {
1181 if (has_property($e, "ref") && !$e->{POINTERS}) {
1182 fatal($e, "[ref] variables must be pointers ($fn->{NAME}/$e->{NAME})");
1188 #####################################################################
1195 TYPEDEF => \&ValidTypedef,
1196 STRUCT => \&ValidStruct,
1197 UNION => \&ValidUnion,
1198 ENUM => \&ValidEnum,
1199 BITMAP => \&ValidBitmap,
1201 }->{$t->{TYPE}}->($t);
1204 #####################################################################
1205 # parse the interface definitions
1206 sub ValidInterface($)
1208 my($interface) = shift;
1209 my($data) = $interface->{DATA};
1211 if (has_property($interface, "helper")) {
1212 warning($interface, "helper() is pidl-specific and deprecated. Use `include' instead");
1215 ValidProperties($interface,"INTERFACE");
1217 if (has_property($interface, "pointer_default")) {
1218 if (not grep (/$interface->{PROPERTIES}->{pointer_default}/,
1219 ("ref", "unique", "ptr"))) {
1220 fatal($interface, "Unknown default pointer type `$interface->{PROPERTIES}->{pointer_default}'");
1224 if (has_property($interface, "object")) {
1225 if (has_property($interface, "version") &&
1226 $interface->{PROPERTIES}->{version} != 0) {
1227 fatal($interface, "Object interfaces must have version 0.0 ($interface->{NAME})");
1230 if (!defined($interface->{BASE}) &&
1231 not ($interface->{NAME} eq "IUnknown")) {
1232 fatal($interface, "Object interfaces must all derive from IUnknown ($interface->{NAME})");
1236 foreach my $d (@{$data}) {
1237 ($d->{TYPE} eq "FUNCTION") && ValidFunction($d);
1238 ($d->{TYPE} eq "TYPEDEF" or
1239 $d->{TYPE} eq "STRUCT" or
1240 $d->{TYPE} eq "UNION" or
1241 $d->{TYPE} eq "ENUM" or
1242 $d->{TYPE} eq "BITMAP" or
1243 $d->{TYPE} eq "PIPE") && ValidType($d);
1248 #####################################################################
1249 # Validate an IDL structure
1254 foreach my $x (@{$idl}) {
1255 ($x->{TYPE} eq "INTERFACE") &&
1257 ($x->{TYPE} eq "IMPORTLIB") &&
1258 fatal($x, "importlib() not supported");
1262 sub is_charset_array($$)
1266 return 0 if ($l->{TYPE} ne "ARRAY");
1268 my $nl = GetNextLevel($e,$l);
1270 return 0 unless ($nl->{TYPE} eq "DATA");
1272 return has_property($e, "charset");