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);
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 "ignore" if (has_property($e, "ignore"));
359 #####################################################################
360 # work out the correct alignment for a structure or union
361 sub find_largest_alignment($)
366 for my $e (@{$s->{ELEMENTS}}) {
369 if ($e->{POINTERS}) {
370 # this is a hack for NDR64
371 # the NDR layer translates this into
372 # an alignment of 4 for NDR and 8 for NDR64
374 } elsif (has_property($e, "subcontext")) {
376 } elsif (has_property($e, "transmit_as")) {
377 $a = align_type($e->{PROPERTIES}->{transmit_as});
379 $a = align_type($e->{TYPE});
382 $align = $a if ($align < $a);
388 #####################################################################
395 if (ref($e) eq "HASH" and $e->{TYPE} eq "SCALAR") {
396 return $scalar_alignment->{$e->{NAME}};
399 return 0 if ($e eq "EMPTY");
401 unless (hasType($e)) {
402 # it must be an external type - all we can do is guess
403 # warning($e, "assuming alignment of unknown type '$e' is 4");
407 my $dt = getType($e);
409 if ($dt->{TYPE} eq "TYPEDEF") {
410 return align_type($dt->{DATA});
411 } elsif ($dt->{TYPE} eq "CONFORMANCE") {
412 return $dt->{DATA}->{ALIGN};
413 } elsif ($dt->{TYPE} eq "ENUM") {
414 return align_type(Parse::Pidl::Typelist::enum_type_fn($dt));
415 } elsif ($dt->{TYPE} eq "BITMAP") {
416 return align_type(Parse::Pidl::Typelist::bitmap_type_fn($dt));
417 } elsif (($dt->{TYPE} eq "STRUCT") or ($dt->{TYPE} eq "UNION")) {
418 # Struct/union without body: assume 4
419 return 4 unless (defined($dt->{ELEMENTS}));
420 return find_largest_alignment($dt);
423 die("Unknown data type type $dt->{TYPE}");
428 my ($e, $pointer_default) = @_;
430 $e->{TYPE} = expandAlias($e->{TYPE});
432 if (ref($e->{TYPE}) eq "HASH") {
433 $e->{TYPE} = ParseType($e->{TYPE}, $pointer_default);
439 PROPERTIES => $e->{PROPERTIES},
440 LEVELS => GetElementLevelTable($e, $pointer_default),
441 REPRESENTATION_TYPE => ($e->{PROPERTIES}->{represent_as} or $e->{TYPE}),
442 ALIGN => align_type($e->{TYPE}),
449 my ($struct, $pointer_default) = @_;
451 my $surrounding = undef;
455 NAME => $struct->{NAME},
456 SURROUNDING_ELEMENT => undef,
458 PROPERTIES => $struct->{PROPERTIES},
461 } unless defined($struct->{ELEMENTS});
463 CheckPointerTypes($struct, $pointer_default);
465 foreach my $x (@{$struct->{ELEMENTS}})
467 my $e = ParseElement($x, $pointer_default);
468 if ($x != $struct->{ELEMENTS}[-1] and
469 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
470 fatal($x, "conformant member not at end of struct");
475 my $e = $elements[-1];
476 if (defined($e) and defined($e->{LEVELS}[0]->{IS_SURROUNDING}) and
477 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
481 if (defined $e->{TYPE} && $e->{TYPE} eq "string"
482 && property_matches($e, "flag", ".*LIBNDR_FLAG_STR_CONFORMANT.*")) {
483 $surrounding = $struct->{ELEMENTS}[-1];
487 if ($struct->{NAME}) {
488 $align = align_type($struct->{NAME});
493 NAME => $struct->{NAME},
494 SURROUNDING_ELEMENT => $surrounding,
495 ELEMENTS => \@elements,
496 PROPERTIES => $struct->{PROPERTIES},
504 my ($e, $pointer_default) = @_;
507 my $switch_type = has_property($e, "switch_type");
508 unless (defined($switch_type)) { $switch_type = "uint32"; }
509 if (has_property($e, "nodiscriminant")) { $switch_type = undef; }
514 SWITCH_TYPE => $switch_type,
516 PROPERTIES => $e->{PROPERTIES},
517 HAS_DEFAULT => $hasdefault,
520 } unless defined($e->{ELEMENTS});
522 CheckPointerTypes($e, $pointer_default);
524 foreach my $x (@{$e->{ELEMENTS}})
527 if ($x->{TYPE} eq "EMPTY") {
528 $t = { TYPE => "EMPTY" };
530 $t = ParseElement($x, $pointer_default);
532 if (has_property($x, "default")) {
533 $t->{CASE} = "default";
535 } elsif (defined($x->{PROPERTIES}->{case})) {
536 $t->{CASE} = "case $x->{PROPERTIES}->{case}";
538 die("Union element $x->{NAME} has neither default nor case property");
545 $align = align_type($e->{NAME});
551 SWITCH_TYPE => $switch_type,
552 ELEMENTS => \@elements,
553 PROPERTIES => $e->{PROPERTIES},
554 HAS_DEFAULT => $hasdefault,
562 my ($e, $pointer_default) = @_;
567 BASE_TYPE => Parse::Pidl::Typelist::enum_type_fn($e),
568 ELEMENTS => $e->{ELEMENTS},
569 PROPERTIES => $e->{PROPERTIES},
576 my ($e, $pointer_default) = @_;
581 BASE_TYPE => Parse::Pidl::Typelist::bitmap_type_fn($e),
582 ELEMENTS => $e->{ELEMENTS},
583 PROPERTIES => $e->{PROPERTIES},
590 my ($d, $pointer_default) = @_;
593 STRUCT => \&ParseStruct,
594 UNION => \&ParseUnion,
596 BITMAP => \&ParseBitmap,
597 TYPEDEF => \&ParseTypedef,
598 }->{$d->{TYPE}}->($d, $pointer_default);
605 my ($d, $pointer_default) = @_;
607 if (defined($d->{DATA}->{PROPERTIES}) && !defined($d->{PROPERTIES})) {
608 $d->{PROPERTIES} = $d->{DATA}->{PROPERTIES};
611 my $data = ParseType($d->{DATA}, $pointer_default);
612 $data->{ALIGN} = align_type($d->{NAME});
617 PROPERTIES => $d->{PROPERTIES},
618 LEVELS => GetTypedefLevelTable($d, $data, $pointer_default),
631 sub ParseFunction($$$)
633 my ($ndr,$d,$opnum) = @_;
636 my $thisopnum = undef;
638 CheckPointerTypes($d, "ref");
640 if (not defined($d->{PROPERTIES}{noopnum})) {
641 $thisopnum = ${$opnum};
645 foreach my $x (@{$d->{ELEMENTS}}) {
646 my $e = ParseElement($x, $ndr->{PROPERTIES}->{pointer_default});
647 push (@{$e->{DIRECTION}}, "in") if (has_property($x, "in"));
648 push (@{$e->{DIRECTION}}, "out") if (has_property($x, "out"));
650 push (@elements, $e);
653 if ($d->{RETURN_TYPE} ne "void") {
654 $rettype = expandAlias($d->{RETURN_TYPE});
658 if (has_property($d, "async")) { $async = 1; }
665 RETURN_TYPE => $rettype,
666 PROPERTIES => $d->{PROPERTIES},
667 ELEMENTS => \@elements,
672 sub CheckPointerTypes($$)
674 my ($s,$default) = @_;
676 return unless defined($s->{ELEMENTS});
678 foreach my $e (@{$s->{ELEMENTS}}) {
679 if ($e->{POINTERS} and not defined(pointer_type($e))) {
680 $e->{PROPERTIES}->{$default} = '1';
685 sub FindNestedTypes($$)
687 sub FindNestedTypes($$);
690 return unless defined($t->{ELEMENTS});
691 return if ($t->{TYPE} eq "ENUM");
692 return if ($t->{TYPE} eq "BITMAP");
694 foreach (@{$t->{ELEMENTS}}) {
695 if (ref($_->{TYPE}) eq "HASH") {
696 push (@$l, $_->{TYPE}) if (defined($_->{TYPE}->{NAME}));
697 FindNestedTypes($l, $_->{TYPE});
702 sub ParseInterface($)
712 if (not has_property($idl, "pointer_default")) {
713 # MIDL defaults to "ptr" in DCE compatible mode (/osf)
714 # and "unique" in Microsoft Extensions mode (default)
715 $idl->{PROPERTIES}->{pointer_default} = "unique";
718 foreach my $d (@{$idl->{DATA}}) {
719 if ($d->{TYPE} eq "FUNCTION") {
720 push (@functions, ParseFunction($idl, $d, \$opnum));
721 } elsif ($d->{TYPE} eq "CONST") {
722 push (@consts, ParseConst($idl, $d));
724 push (@types, ParseType($d, $idl->{PROPERTIES}->{pointer_default}));
725 FindNestedTypes(\@types, $d);
731 if(defined $idl->{PROPERTIES}->{version}) {
732 my @if_version = split(/\./, $idl->{PROPERTIES}->{version});
733 if ($if_version[0] == $idl->{PROPERTIES}->{version}) {
734 $version = $idl->{PROPERTIES}->{version};
736 $version = $if_version[1] << 16 | $if_version[0];
740 # If no endpoint is set, default to the interface name as a named pipe
741 if (!defined $idl->{PROPERTIES}->{endpoint}) {
742 push @endpoints, "\"ncacn_np:[\\\\pipe\\\\" . $idl->{NAME} . "]\"";
744 @endpoints = split /,/, $idl->{PROPERTIES}->{endpoint};
748 NAME => $idl->{NAME},
749 UUID => lc(has_property($idl, "uuid")),
752 PROPERTIES => $idl->{PROPERTIES},
753 FUNCTIONS => \@functions,
756 ENDPOINTS => \@endpoints
760 # Convert a IDL tree to a NDR tree
761 # Gives a result tree describing all that's necessary for easily generating
762 # NDR parsers / generators
767 return undef unless (defined($idl));
769 Parse::Pidl::NDR::Validate($idl);
774 ($_->{TYPE} eq "CPP_QUOTE") && push(@ndr, $_);
775 ($_->{TYPE} eq "INTERFACE") && push(@ndr, ParseInterface($_));
776 ($_->{TYPE} eq "IMPORT") && push(@ndr, $_);
789 foreach my $l (@{$e->{LEVELS}}) {
790 return $l if ($seen);
791 ($seen = 1) if ($l == $fl);
802 foreach my $l (@{$e->{LEVELS}}) {
803 (return $prev) if ($l == $fl);
810 sub ContainsString($)
814 foreach my $l (@{$e->{LEVELS}}) {
815 return 1 if ($l->{TYPE} eq "ARRAY" and $l->{IS_ZERO_TERMINATED});
821 sub ContainsDeferred($$)
825 return 1 if ($l->{CONTAINS_DEFERRED});
827 while ($l = GetNextLevel($e,$l))
829 return 1 if ($l->{IS_DEFERRED});
830 return 1 if ($l->{CONTAINS_DEFERRED});
839 my $name = "<ANONYMOUS>";
841 $name = $e->{NAME} if defined($e->{NAME});
843 if (defined($e->{PARENT}) and defined($e->{PARENT}->{NAME})) {
844 return "$e->{PARENT}->{NAME}.$name";
847 if (defined($e->{PARENT}) and
848 defined($e->{PARENT}->{PARENT}) and
849 defined($e->{PARENT}->{PARENT}->{NAME})) {
850 return "$e->{PARENT}->{PARENT}->{NAME}.$name";
856 ###################################
857 # find a sibling var in a structure
861 my($fn) = $e->{PARENT};
863 if ($name =~ /\*(.*)/) {
867 for my $e2 (@{$fn->{ELEMENTS}}) {
868 return $e2 if ($e2->{NAME} eq $name);
874 my %property_list = (
876 "helpstring" => ["INTERFACE", "FUNCTION"],
877 "version" => ["INTERFACE"],
878 "uuid" => ["INTERFACE"],
879 "endpoint" => ["INTERFACE"],
880 "pointer_default" => ["INTERFACE"],
881 "helper" => ["INTERFACE"],
882 "pyhelper" => ["INTERFACE"],
883 "authservice" => ["INTERFACE"],
884 "restricted" => ["INTERFACE"],
887 "object" => ["INTERFACE"],
888 "local" => ["INTERFACE", "FUNCTION"],
889 "iid_is" => ["ELEMENT"],
890 "call_as" => ["FUNCTION"],
891 "idempotent" => ["FUNCTION"],
894 "noopnum" => ["FUNCTION"],
896 "out" => ["ELEMENT"],
897 "async" => ["FUNCTION"],
900 "ref" => ["ELEMENT"],
901 "ptr" => ["ELEMENT"],
902 "unique" => ["ELEMENT"],
903 "ignore" => ["ELEMENT"],
904 "relative" => ["ELEMENT"],
905 "null_is_ffffffff" => ["ELEMENT"],
906 "relative_base" => ["TYPEDEF", "STRUCT", "UNION"],
908 "gensize" => ["TYPEDEF", "STRUCT", "UNION"],
909 "value" => ["ELEMENT"],
910 "flag" => ["ELEMENT", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
913 "public" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
914 "nopush" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
915 "nopull" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
916 "nosize" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP"],
917 "noprint" => ["FUNCTION", "TYPEDEF", "STRUCT", "UNION", "ENUM", "BITMAP", "ELEMENT"],
918 "todo" => ["FUNCTION"],
921 "switch_is" => ["ELEMENT"],
922 "switch_type" => ["ELEMENT", "UNION"],
923 "nodiscriminant" => ["UNION"],
924 "case" => ["ELEMENT"],
925 "default" => ["ELEMENT"],
927 "represent_as" => ["ELEMENT"],
928 "transmit_as" => ["ELEMENT"],
931 "subcontext" => ["ELEMENT"],
932 "subcontext_size" => ["ELEMENT"],
933 "compression" => ["ELEMENT"],
936 "enum8bit" => ["ENUM"],
937 "enum16bit" => ["ENUM"],
938 "v1_enum" => ["ENUM"],
941 "bitmap8bit" => ["BITMAP"],
942 "bitmap16bit" => ["BITMAP"],
943 "bitmap32bit" => ["BITMAP"],
944 "bitmap64bit" => ["BITMAP"],
947 "range" => ["ELEMENT", "PIPE"],
948 "size_is" => ["ELEMENT"],
949 "string" => ["ELEMENT"],
950 "noheader" => ["ELEMENT"],
951 "charset" => ["ELEMENT"],
952 "length_is" => ["ELEMENT"],
955 #####################################################################
956 # check for unknown properties
957 sub ValidProperties($$)
961 return unless defined $e->{PROPERTIES};
963 foreach my $key (keys %{$e->{PROPERTIES}}) {
964 warning($e, el_name($e) . ": unknown property '$key'")
965 unless defined($property_list{$key});
967 fatal($e, el_name($e) . ": property '$key' not allowed on '$t'")
968 unless grep(/^$t$/, @{$property_list{$key}});
976 return $t->{NAME} if (ref($t) eq "HASH" and $t->{TYPE} eq "SCALAR");
977 my $ti = getType($t);
979 if (not defined ($ti)) {
981 } elsif ($ti->{TYPE} eq "TYPEDEF") {
982 return mapToScalar($ti->{DATA});
983 } elsif ($ti->{TYPE} eq "ENUM") {
984 return Parse::Pidl::Typelist::enum_type_fn($ti);
985 } elsif ($ti->{TYPE} eq "BITMAP") {
986 return Parse::Pidl::Typelist::bitmap_type_fn($ti);
992 #####################################################################
993 # validate an element
998 ValidProperties($e,"ELEMENT");
1000 # Check whether switches are used correctly.
1001 if (my $switch = has_property($e, "switch_is")) {
1002 my $e2 = find_sibling($e, $switch);
1003 my $type = getType($e->{TYPE});
1005 if (defined($type) and $type->{DATA}->{TYPE} ne "UNION") {
1006 fatal($e, el_name($e) . ": switch_is() used on non-union type $e->{TYPE} which is a $type->{DATA}->{TYPE}");
1009 if (not has_property($type->{DATA}, "nodiscriminant") and defined($e2)) {
1010 my $discriminator_type = has_property($type->{DATA}, "switch_type");
1011 $discriminator_type = "uint32" unless defined ($discriminator_type);
1013 my $t1 = mapToScalar($discriminator_type);
1015 if (not defined($t1)) {
1016 fatal($e, el_name($e) . ": unable to map discriminator type '$discriminator_type' to scalar");
1019 my $t2 = mapToScalar($e2->{TYPE});
1020 if (not defined($t2)) {
1021 fatal($e, el_name($e) . ": unable to map variable used for switch_is() to scalar");
1025 warning($e, el_name($e) . ": switch_is() is of type $e2->{TYPE} ($t2), while discriminator type for union $type->{NAME} is $discriminator_type ($t1)");
1030 if (has_property($e, "subcontext") and has_property($e, "represent_as")) {
1031 fatal($e, el_name($e) . " : subcontext() and represent_as() can not be used on the same element");
1034 if (has_property($e, "subcontext") and has_property($e, "transmit_as")) {
1035 fatal($e, el_name($e) . " : subcontext() and transmit_as() can not be used on the same element");
1038 if (has_property($e, "represent_as") and has_property($e, "transmit_as")) {
1039 fatal($e, el_name($e) . " : represent_as() and transmit_as() can not be used on the same element");
1042 if (has_property($e, "represent_as") and has_property($e, "value")) {
1043 fatal($e, el_name($e) . " : represent_as() and value() can not be used on the same element");
1046 if (has_property($e, "subcontext")) {
1047 warning($e, "subcontext() is deprecated. Use represent_as() or transmit_as() instead");
1050 if (defined (has_property($e, "subcontext_size")) and not defined(has_property($e, "subcontext"))) {
1051 fatal($e, el_name($e) . " : subcontext_size() on non-subcontext element");
1054 if (defined (has_property($e, "compression")) and not defined(has_property($e, "subcontext"))) {
1055 fatal($e, el_name($e) . " : compression() on non-subcontext element");
1058 if (!$e->{POINTERS} && (
1059 has_property($e, "ptr") or
1060 has_property($e, "unique") or
1061 has_property($e, "relative") or
1062 has_property($e, "ref"))) {
1063 fatal($e, el_name($e) . " : pointer properties on non-pointer element\n");
1067 #####################################################################
1073 ValidProperties($enum, "ENUM");
1076 #####################################################################
1082 ValidProperties($bitmap, "BITMAP");
1085 #####################################################################
1089 my($struct) = shift;
1091 ValidProperties($struct, "STRUCT");
1093 return unless defined($struct->{ELEMENTS});
1095 foreach my $e (@{$struct->{ELEMENTS}}) {
1096 $e->{PARENT} = $struct;
1101 #####################################################################
1107 ValidProperties($union,"UNION");
1109 if (has_property($union->{PARENT}, "nodiscriminant") and
1110 has_property($union->{PARENT}, "switch_type")) {
1111 fatal($union->{PARENT}, $union->{PARENT}->{NAME} . ": switch_type(" . $union->{PARENT}->{PROPERTIES}->{switch_type} . ") on union without discriminant");
1114 return unless defined($union->{ELEMENTS});
1116 foreach my $e (@{$union->{ELEMENTS}}) {
1117 $e->{PARENT} = $union;
1119 if (defined($e->{PROPERTIES}->{default}) and
1120 defined($e->{PROPERTIES}->{case})) {
1121 fatal($e, "Union member $e->{NAME} can not have both default and case properties!");
1124 unless (defined ($e->{PROPERTIES}->{default}) or
1125 defined ($e->{PROPERTIES}->{case})) {
1126 fatal($e, "Union member $e->{NAME} must have default or case property");
1129 if (has_property($e, "ref")) {
1130 fatal($e, el_name($e) . ": embedded ref pointers are not supported yet\n");
1138 #####################################################################
1143 my $data = $pipe->{DATA};
1145 ValidProperties($pipe, "PIPE");
1147 fatal($pipe, $pipe->{NAME} . ": 'pipe' is not yet supported by pidl");
1150 #####################################################################
1154 my($typedef) = shift;
1155 my $data = $typedef->{DATA};
1157 ValidProperties($typedef, "TYPEDEF");
1159 $data->{PARENT} = $typedef;
1161 $data->{FILE} = $typedef->{FILE} unless defined($data->{FILE});
1162 $data->{LINE} = $typedef->{LINE} unless defined($data->{LINE});
1164 ValidType($data) if (ref($data) eq "HASH");
1167 #####################################################################
1168 # validate a function
1169 sub ValidFunction($)
1173 ValidProperties($fn,"FUNCTION");
1175 foreach my $e (@{$fn->{ELEMENTS}}) {
1177 if (has_property($e, "ref") && !$e->{POINTERS}) {
1178 fatal($e, "[ref] variables must be pointers ($fn->{NAME}/$e->{NAME})");
1184 #####################################################################
1191 TYPEDEF => \&ValidTypedef,
1192 STRUCT => \&ValidStruct,
1193 UNION => \&ValidUnion,
1194 ENUM => \&ValidEnum,
1195 BITMAP => \&ValidBitmap,
1197 }->{$t->{TYPE}}->($t);
1200 #####################################################################
1201 # parse the interface definitions
1202 sub ValidInterface($)
1204 my($interface) = shift;
1205 my($data) = $interface->{DATA};
1207 if (has_property($interface, "helper")) {
1208 warning($interface, "helper() is pidl-specific and deprecated. Use `include' instead");
1211 ValidProperties($interface,"INTERFACE");
1213 if (has_property($interface, "pointer_default")) {
1214 if (not grep (/$interface->{PROPERTIES}->{pointer_default}/,
1215 ("ref", "unique", "ptr"))) {
1216 fatal($interface, "Unknown default pointer type `$interface->{PROPERTIES}->{pointer_default}'");
1220 if (has_property($interface, "object")) {
1221 if (has_property($interface, "version") &&
1222 $interface->{PROPERTIES}->{version} != 0) {
1223 fatal($interface, "Object interfaces must have version 0.0 ($interface->{NAME})");
1226 if (!defined($interface->{BASE}) &&
1227 not ($interface->{NAME} eq "IUnknown")) {
1228 fatal($interface, "Object interfaces must all derive from IUnknown ($interface->{NAME})");
1232 foreach my $d (@{$data}) {
1233 ($d->{TYPE} eq "FUNCTION") && ValidFunction($d);
1234 ($d->{TYPE} eq "TYPEDEF" or
1235 $d->{TYPE} eq "STRUCT" or
1236 $d->{TYPE} eq "UNION" or
1237 $d->{TYPE} eq "ENUM" or
1238 $d->{TYPE} eq "BITMAP" or
1239 $d->{TYPE} eq "PIPE") && ValidType($d);
1244 #####################################################################
1245 # Validate an IDL structure
1250 foreach my $x (@{$idl}) {
1251 ($x->{TYPE} eq "INTERFACE") &&
1253 ($x->{TYPE} eq "IMPORTLIB") &&
1254 fatal($x, "importlib() not supported");
1258 sub is_charset_array($$)
1262 return 0 if ($l->{TYPE} ne "ARRAY");
1264 my $nl = GetNextLevel($e,$l);
1266 return 0 unless ($nl->{TYPE} eq "DATA");
1268 return has_property($e, "charset");