source/pidl/lib/Parse/Pidl/NDR.pm

   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
   7
   8 =pod
   9
  10 =head1 NAME
  11
  12 Parse::Pidl::NDR - NDR parsing information generator
  13
  14 =head1 DESCRIPTION
  15
  16 Return a table describing the order in which the parts of an element
  17 should be parsed
  18 Possible level types:
  19  - POINTER
  20  - ARRAY
  21  - SUBCONTEXT
  22  - SWITCH
  23  - DATA
  24
  25 =head1 AUTHOR
  26
  27 Jelmer Vernooij <jelmer@samba.org>
  28
  29 =cut
  30
  31 package Parse::Pidl::NDR;
  32
  33 require Exporter;
  34 use vars qw($VERSION);
  35 $VERSION = '0.01';
  36 @ISA = qw(Exporter);
  37 @EXPORT = qw(GetPrevLevel GetNextLevel ContainsDeferred ContainsString);
  38 @EXPORT_OK = qw(GetElementLevelTable ParseElement ValidElement align_type);
  39
  40 use strict;
  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);
  44
  45 # Alignment of the built-in scalar types
  46 my $scalar_alignment = {
  47         'void' => 0,
  48         'char' => 1,
  49         'int8' => 1,
  50         'uint8' => 1,
  51         'int16' => 2,
  52         'uint16' => 2,
  53         'int32' => 4,
  54         'uint32' => 4,
  55         'hyper' => 8,
  56         'pointer' => 8,
  57         'dlong' => 4,
  58         'udlong' => 4,
  59         'udlongr' => 4,
  60         'DATA_BLOB' => 4,
  61         'string' => 4,
  62         'string_array' => 4, #???
  63         'time_t' => 4,
  64         'NTTIME' => 4,
  65         'NTTIME_1sec' => 4,
  66         'NTTIME_hyper' => 8,
  67         'WERROR' => 4,
  68         'NTSTATUS' => 4,
  69         'COMRESULT' => 4,
  70         'nbt_string' => 4,
  71         'wrepl_nbt_name' => 4,
  72         'ipv4address' => 4
  73 };
  74
  75 sub GetElementLevelTable($)
  76 {
  77         my $e = shift;
  78
  79         my $order = [];
  80         my $is_deferred = 0;
  81         my @bracket_array = ();
  82         my @length_is = ();
  83         my @size_is = ();
  84         my $pointer_idx = 0;
  85
  86         if (has_property($e, "size_is")) {
  87                 @size_is = split /,/, has_property($e, "size_is");
  88         }
  89
  90         if (has_property($e, "length_is")) {
  91                 @length_is = split /,/, has_property($e, "length_is");
  92         }
  93
  94         if (defined($e->{ARRAY_LEN})) {
  95                 @bracket_array = @{$e->{ARRAY_LEN}};
  96         }
  97
  98         if (has_property($e, "out")) {
  99                 my $needptrs = 1;
 100
 101                 if (has_property($e, "string")) { $needptrs++; }
 102                 if ($#bracket_array >= 0) { $needptrs = 0; }
 103
 104                 warning($e, "[out] argument `$e->{NAME}' not a pointer") if ($needptrs > $e->{POINTERS});
 105         }
 106
 107         # Parse the [][][][] style array stuff
 108         for my $i (0 .. $#bracket_array) {
 109                 my $d = $bracket_array[$#bracket_array - $i];
 110                 my $size = $d;
 111                 my $length = $d;
 112                 my $is_surrounding = 0;
 113                 my $is_varying = 0;
 114                 my $is_conformant = 0;
 115                 my $is_string = 0;
 116
 117                 if ($d eq "*") {
 118                         $is_conformant = 1;
 119                         if ($size = shift @size_is) {
 120                         } elsif ((scalar(@size_is) == 0) and has_property($e, "string")) {
 121                                 $is_string = 1;
 122                                 delete($e->{PROPERTIES}->{string});
 123                         } else {
 124                                 fatal($e, "Must specify size_is() for conformant array!")
 125                         }
 126
 127                         if (($length = shift @length_is) or $is_string) {
 128                                 $is_varying = 1;
 129                         } else {
 130                                 $length = $size;
 131                         }
 132
 133                         if ($e == $e->{PARENT}->{ELEMENTS}[-1]
 134                                 and $e->{PARENT}->{TYPE} ne "FUNCTION") {
 135                                 $is_surrounding = 1;
 136                         }
 137                 }
 138
 139                 push (@$order, {
 140                         TYPE => "ARRAY",
 141                         SIZE_IS => $size,
 142                         LENGTH_IS => $length,
 143                         IS_DEFERRED => "$is_deferred",
 144                         IS_SURROUNDING => "$is_surrounding",
 145                         IS_ZERO_TERMINATED => "$is_string",
 146                         IS_VARYING => "$is_varying",
 147                         IS_CONFORMANT => "$is_conformant",
 148                         IS_FIXED => (not $is_conformant and Parse::Pidl::Util::is_constant($size)),
 149                         IS_INLINE => (not $is_conformant and not Parse::Pidl::Util::is_constant($size))
 150                 });
 151         }
 152
 153         # Next, all the pointers
 154         foreach my $i (1..$e->{POINTERS}) {
 155                 my $pt = pointer_type($e);
 156
 157                 my $level = "EMBEDDED";
 158                 # Top level "ref" pointers do not have a referrent identifier
 159                 $level = "TOP" if ( defined($pt)
 160                                 and $i == 1
 161                                 and $e->{PARENT}->{TYPE} eq "FUNCTION");
 162
 163                 push (@$order, {
 164                         TYPE => "POINTER",
 165                         # for now, there can only be one pointer type per element
 166                         POINTER_TYPE => pointer_type($e),
 167                         POINTER_INDEX => $pointer_idx,
 168                         IS_DEFERRED => "$is_deferred",
 169                         LEVEL => $level
 170                 });
 171
 172                 warning($e, "top-level \[out\] pointer `$e->{NAME}' is not a \[ref\] pointer")
 173                         if ($i == 1 and pointer_type($e) ne "ref" and
 174                                 $e->{PARENT}->{TYPE} eq "FUNCTION" and
 175                                 not has_property($e, "in"));
 176
 177                 $pointer_idx++;
 178
 179                 # everything that follows will be deferred
 180                 $is_deferred = 1 if ($e->{PARENT}->{TYPE} ne "FUNCTION");
 181
 182                 my $array_size = shift @size_is;
 183                 my $array_length;
 184                 my $is_varying;
 185                 my $is_conformant;
 186                 my $is_string = 0;
 187                 if ($array_size) {
 188                         $is_conformant = 1;
 189                         if ($array_length = shift @length_is) {
 190                                 $is_varying = 1;
 191                         } else {
 192                                 $array_length = $array_size;
 193                                 $is_varying =0;
 194                         }
 195                 }
 196
 197                 if (scalar(@size_is) == 0 and has_property($e, "string") and
 198                     $i == $e->{POINTERS}) {
 199                         $is_string = 1;
 200                         $is_varying = $is_conformant = has_property($e, "noheader")?0:1;
 201                         delete($e->{PROPERTIES}->{string});
 202                 }
 203
 204                 if ($array_size or $is_string) {
 205                         push (@$order, {
 206                                 TYPE => "ARRAY",
 207                                 IS_ZERO_TERMINATED => "$is_string",
 208                                 SIZE_IS => $array_size,
 209                                 LENGTH_IS => $array_length,
 210                                 IS_DEFERRED => "$is_deferred",
 211                                 IS_SURROUNDING => 0,
 212                                 IS_VARYING => "$is_varying",
 213                                 IS_CONFORMANT => "$is_conformant",
 214                                 IS_FIXED => 0,
 215                                 IS_INLINE => 0,
 216                         });
 217
 218                         $is_deferred = 0;
 219                 }
 220         }
 221
 222         if (defined(has_property($e, "subcontext"))) {
 223                 my $hdr_size = has_property($e, "subcontext");
 224                 my $subsize = has_property($e, "subcontext_size");
 225                 if (not defined($subsize)) {
 226                         $subsize = -1;
 227                 }
 228
 229                 push (@$order, {
 230                         TYPE => "SUBCONTEXT",
 231                         HEADER_SIZE => $hdr_size,
 232                         SUBCONTEXT_SIZE => $subsize,
 233                         IS_DEFERRED => $is_deferred,
 234                         COMPRESSION => has_property($e, "compression"),
 235                 });
 236         }
 237
 238         if (my $switch = has_property($e, "switch_is")) {
 239                 push (@$order, {
 240                         TYPE => "SWITCH",
 241                         SWITCH_IS => $switch,
 242                         IS_DEFERRED => $is_deferred
 243                 });
 244         }
 245
 246         if (scalar(@size_is) > 0) {
 247                 warning($e, "size_is() on non-array element");
 248         }
 249
 250         if (scalar(@length_is) > 0) {
 251                 warning($e, "length_is() on non-array element");
 252         }
 253
 254         if (has_property($e, "string")) {
 255                 warning($e, "string() attribute on non-array element");
 256         }
 257
 258         push (@$order, {
 259                 TYPE => "DATA",
 260                 DATA_TYPE => $e->{TYPE},
 261                 IS_DEFERRED => $is_deferred,
 262                 CONTAINS_DEFERRED => can_contain_deferred($e),
 263                 IS_SURROUNDING => 0 #FIXME
 264         });
 265
 266         my $i = 0;
 267         foreach (@$order) { $_->{LEVEL_INDEX} = $i; $i+=1; }
 268
 269         return $order;
 270 }
 271
 272 #####################################################################
 273 # see if a type contains any deferred data
 274 sub can_contain_deferred
 275 {
 276         my $e = shift;
 277
 278         return 0 if (Parse::Pidl::Typelist::is_scalar($e->{TYPE}));
 279         return 1 unless (hasType($e->{TYPE})); # assume the worst
 280
 281         my $type = getType($e->{TYPE});
 282
 283         foreach my $x (@{$type->{DATA}->{ELEMENTS}}) {
 284                 return 1 if ($x->{POINTERS});
 285                 return 1 if (can_contain_deferred ($x));
 286         }
 287
 288         return 0;
 289 }
 290
 291 sub pointer_type($)
 292 {
 293         my $e = shift;
 294
 295         return undef unless $e->{POINTERS};
 296
 297         return "ref" if (has_property($e, "ref"));
 298         return "full" if (has_property($e, "ptr"));
 299         return "sptr" if (has_property($e, "sptr"));
 300         return "unique" if (has_property($e, "unique"));
 301         return "relative" if (has_property($e, "relative"));
 302         return "ignore" if (has_property($e, "ignore"));
 303
 304         return undef;
 305 }
 306
 307 #####################################################################
 308 # work out the correct alignment for a structure or union
 309 sub find_largest_alignment($)
 310 {
 311         my $s = shift;
 312
 313         my $align = 1;
 314         for my $e (@{$s->{ELEMENTS}}) {
 315                 my $a = 1;
 316
 317                 if ($e->{POINTERS}) {
 318                         $a = 4;
 319                 } elsif (has_property($e, "subcontext")) {
 320                         $a = 1;
 321                 } elsif (has_property($e, "transmit_as")) {
 322                         $a = align_type($e->{PROPERTIES}->{transmit_as});
 323                 } else {
 324                         $a = align_type($e->{TYPE});
 325                 }
 326
 327                 $align = $a if ($align < $a);
 328         }
 329
 330         return $align;
 331 }
 332
 333 #####################################################################
 334 # align a type
 335 sub align_type($)
 336 {
 337         sub align_type($);
 338         my ($e) = @_;
 339
 340         if (ref($e) eq "HASH" and $e->{TYPE} eq "SCALAR") {
 341                 return $scalar_alignment->{$e->{NAME}};
 342         }
 343
 344         unless (hasType($e)) {
 345             # it must be an external type - all we can do is guess
 346                 # print "Warning: assuming alignment of unknown type '$e' is 4\n";
 347             return 4;
 348         }
 349
 350         my $dt = getType($e);
 351
 352         if ($dt->{TYPE} eq "TYPEDEF") {
 353                 return align_type($dt->{DATA});
 354         } elsif ($dt->{TYPE} eq "ENUM") {
 355                 return align_type(Parse::Pidl::Typelist::enum_type_fn($dt));
 356         } elsif ($dt->{TYPE} eq "BITMAP") {
 357                 return align_type(Parse::Pidl::Typelist::bitmap_type_fn($dt));
 358         } elsif (($dt->{TYPE} eq "STRUCT") or ($dt->{TYPE} eq "UNION")) {
 359                 return find_largest_alignment($dt);
 360         }
 361
 362         die("Unknown data type type $dt->{TYPE}");
 363 }
 364
 365 sub ParseElement($$)
 366 {
 367         my ($e, $pointer_default) = @_;
 368
 369         $e->{TYPE} = expandAlias($e->{TYPE});
 370
 371         if (ref($e->{TYPE}) eq "HASH") {
 372                 $e->{TYPE} = ParseType($e->{TYPE}, $pointer_default);
 373         }
 374
 375         return {
 376                 NAME => $e->{NAME},
 377                 TYPE => $e->{TYPE},
 378                 PROPERTIES => $e->{PROPERTIES},
 379                 LEVELS => GetElementLevelTable($e),
 380                 REPRESENTATION_TYPE => ($e->{PROPERTIES}->{represent_as} or $e->{TYPE}),
 381                 ALIGN => align_type($e->{TYPE}),
 382                 ORIGINAL => $e
 383         };
 384 }
 385
 386 sub ParseStruct($$)
 387 {
 388         my ($struct, $pointer_default) = @_;
 389         my @elements = ();
 390         my $surrounding = undef;
 391
 392         foreach my $x (@{$struct->{ELEMENTS}})
 393         {
 394                 my $e = ParseElement($x, $pointer_default);
 395                 if ($x != $struct->{ELEMENTS}[-1] and
 396                         $e->{LEVELS}[0]->{IS_SURROUNDING}) {
 397                         fatal($x, "conformant member not at end of struct");
 398                 }
 399                 push @elements, $e;
 400         }
 401
 402         my $e = $elements[-1];
 403         if (defined($e) and defined($e->{LEVELS}[0]->{IS_SURROUNDING}) and
 404                 $e->{LEVELS}[0]->{IS_SURROUNDING}) {
 405                 $surrounding = $e;
 406         }
 407
 408         if (defined $e->{TYPE} && $e->{TYPE} eq "string"
 409             &&  property_matches($e, "flag", ".*LIBNDR_FLAG_STR_CONFORMANT.*")) {
 410                 $surrounding = $struct->{ELEMENTS}[-1];
 411         }
 412
 413         my $align = undef;
 414         if ($struct->{NAME}) {
 415                 $align = align_type($struct->{NAME});
 416         }
 417
 418         return {
 419                 TYPE => "STRUCT",
 420                 NAME => $struct->{NAME},
 421                 SURROUNDING_ELEMENT => $surrounding,
 422                 ELEMENTS => \@elements,
 423                 PROPERTIES => $struct->{PROPERTIES},
 424                 ORIGINAL => $struct,
 425                 ALIGN => $align
 426         };
 427 }
 428
 429 sub ParseUnion($$)
 430 {
 431         my ($e, $pointer_default) = @_;
 432         my @elements = ();
 433         my $switch_type = has_property($e, "switch_type");
 434         unless (defined($switch_type)) { $switch_type = "uint32"; }
 435
 436         if (has_property($e, "nodiscriminant")) { $switch_type = undef; }
 437
 438         my $hasdefault = 0;
 439         foreach my $x (@{$e->{ELEMENTS}})
 440         {
 441                 my $t;
 442                 if ($x->{TYPE} eq "EMPTY") {
 443                         $t = { TYPE => "EMPTY" };
 444                 } else {
 445                         $t = ParseElement($x, $pointer_default);
 446                 }
 447                 if (has_property($x, "default")) {
 448                         $t->{CASE} = "default";
 449                         $hasdefault = 1;
 450                 } elsif (defined($x->{PROPERTIES}->{case})) {
 451                         $t->{CASE} = "case $x->{PROPERTIES}->{case}";
 452                 } else {
 453                         die("Union element $x->{NAME} has neither default nor case property");
 454                 }
 455                 push @elements, $t;
 456         }
 457
 458         return {
 459                 TYPE => "UNION",
 460                 NAME => $e->{NAME},
 461                 SWITCH_TYPE => $switch_type,
 462                 ELEMENTS => \@elements,
 463                 PROPERTIES => $e->{PROPERTIES},
 464                 HAS_DEFAULT => $hasdefault,
 465                 ORIGINAL => $e
 466         };
 467 }
 468
 469 sub ParseEnum($$)
 470 {
 471         my ($e, $pointer_default) = @_;
 472
 473         return {
 474                 TYPE => "ENUM",
 475                 NAME => $e->{NAME},
 476                 BASE_TYPE => Parse::Pidl::Typelist::enum_type_fn($e),
 477                 ELEMENTS => $e->{ELEMENTS},
 478                 PROPERTIES => $e->{PROPERTIES},
 479                 ORIGINAL => $e
 480         };
 481 }
 482
 483 sub ParseBitmap($$)
 484 {
 485         my ($e, $pointer_default) = @_;
 486
 487         return {
 488                 TYPE => "BITMAP",
 489                 NAME => $e->{NAME},
 490                 BASE_TYPE => Parse::Pidl::Typelist::bitmap_type_fn($e),
 491                 ELEMENTS => $e->{ELEMENTS},
 492                 PROPERTIES => $e->{PROPERTIES},
 493                 ORIGINAL => $e
 494         };
 495 }
 496
 497 sub ParseType($$)
 498 {
 499         my ($d, $pointer_default) = @_;
 500
 501         if ($d->{TYPE} eq "STRUCT" or $d->{TYPE} eq "UNION") {
 502                 CheckPointerTypes($d, $pointer_default);
 503         }
 504
 505         my $data = {
 506                 STRUCT => \&ParseStruct,
 507                 UNION => \&ParseUnion,
 508                 ENUM => \&ParseEnum,
 509                 BITMAP => \&ParseBitmap,
 510                 TYPEDEF => \&ParseTypedef,
 511         }->{$d->{TYPE}}->($d, $pointer_default);
 512
 513         return $data;
 514 }
 515
 516 sub ParseTypedef($$)
 517 {
 518         my ($d, $pointer_default) = @_;
 519
 520         if (defined($d->{DATA}->{PROPERTIES}) && !defined($d->{PROPERTIES})) {
 521                 $d->{PROPERTIES} = $d->{DATA}->{PROPERTIES};
 522         }
 523
 524         my $data = ParseType($d->{DATA}, $pointer_default);
 525         $data->{ALIGN} = align_type($d->{NAME});
 526
 527         return {
 528                 NAME => $d->{NAME},
 529                 TYPE => $d->{TYPE},
 530                 PROPERTIES => $d->{PROPERTIES},
 531                 DATA => $data,
 532                 ORIGINAL => $d
 533         };
 534 }
 535
 536 sub ParseConst($$)
 537 {
 538         my ($ndr,$d) = @_;
 539
 540         return $d;
 541 }
 542
 543 sub ParseFunction($$$)
 544 {
 545         my ($ndr,$d,$opnum) = @_;
 546         my @elements = ();
 547         my $rettype = undef;
 548         my $thisopnum = undef;
 549
 550         CheckPointerTypes($d, $ndr->{PROPERTIES}->{pointer_default_top});
 551
 552         if (not defined($d->{PROPERTIES}{noopnum})) {
 553                 $thisopnum = ${$opnum};
 554                 ${$opnum}++;
 555         }
 556
 557         foreach my $x (@{$d->{ELEMENTS}}) {
 558                 my $e = ParseElement($x, $ndr->{PROPERTIES}->{pointer_default});
 559                 push (@{$e->{DIRECTION}}, "in") if (has_property($x, "in"));
 560                 push (@{$e->{DIRECTION}}, "out") if (has_property($x, "out"));
 561
 562                 push (@elements, $e);
 563         }
 564
 565         if ($d->{RETURN_TYPE} ne "void") {
 566                 $rettype = expandAlias($d->{RETURN_TYPE});
 567         }
 568
 569         my $async = 0;
 570         if (has_property($d, "async")) { $async = 1; }
 571
 572         return {
 573                         NAME => $d->{NAME},
 574                         TYPE => "FUNCTION",
 575                         OPNUM => $thisopnum,
 576                         ASYNC => $async,
 577                         RETURN_TYPE => $rettype,
 578                         PROPERTIES => $d->{PROPERTIES},
 579                         ELEMENTS => \@elements,
 580                         ORIGINAL => $d
 581                 };
 582 }
 583
 584 sub CheckPointerTypes($$)
 585 {
 586         my ($s,$default) = @_;
 587
 588         foreach my $e (@{$s->{ELEMENTS}}) {
 589                 if ($e->{POINTERS} and not defined(pointer_type($e))) {
 590                         $e->{PROPERTIES}->{$default} = 1;
 591                 }
 592         }
 593 }
 594
 595 sub FindNestedTypes($$)
 596 {
 597         sub FindNestedTypes($$);
 598         my ($l, $t) = @_;
 599
 600         return if not defined($t->{ELEMENTS});
 601
 602         foreach (@{$t->{ELEMENTS}}) {
 603                 if (ref($_->{TYPE}) eq "HASH") {
 604                         push (@$l, $_->{TYPE}) if (defined($_->{TYPE}->{NAME}));
 605                         FindNestedTypes($l, $_->{TYPE});
 606                 }
 607         }
 608 }
 609
 610 sub ParseInterface($)
 611 {
 612         my $idl = shift;
 613         my @types = ();
 614         my @consts = ();
 615         my @functions = ();
 616         my @endpoints;
 617         my @declares = ();
 618         my $opnum = 0;
 619         my $version;
 620
 621         if (not has_property($idl, "pointer_default")) {
 622                 # MIDL defaults to "ptr" in DCE compatible mode (/osf)
 623                 # and "unique" in Microsoft Extensions mode (default)
 624                 $idl->{PROPERTIES}->{pointer_default} = "unique";
 625         }
 626
 627         if (not has_property($idl, "pointer_default_top")) {
 628                 $idl->{PROPERTIES}->{pointer_default_top} = "ref";
 629         } else {
 630                 warning($idl, "pointer_default_top() is a pidl extension and should not be used");
 631         }
 632
 633         foreach my $d (@{$idl->{DATA}}) {
 634                 if ($d->{TYPE} eq "DECLARE") {
 635                         push (@declares, $d);
 636                 } elsif ($d->{TYPE} eq "FUNCTION") {
 637                         push (@functions, ParseFunction($idl, $d, \$opnum));
 638                 } elsif ($d->{TYPE} eq "CONST") {
 639                         push (@consts, ParseConst($idl, $d));
 640                 } else {
 641                         push (@types, ParseType($d, $idl->{PROPERTIES}->{pointer_default}));
 642                         FindNestedTypes(\@types, $d);
 643                 }
 644         }
 645
 646         $version = "0.0";
 647
 648         if(defined $idl->{PROPERTIES}->{version}) {
 649                 $version = $idl->{PROPERTIES}->{version};
 650         }
 651
 652         # If no endpoint is set, default to the interface name as a named pipe
 653         if (!defined $idl->{PROPERTIES}->{endpoint}) {
 654                 push @endpoints, "\"ncacn_np:[\\\\pipe\\\\" . $idl->{NAME} . "]\"";
 655         } else {
 656                 @endpoints = split / /, $idl->{PROPERTIES}->{endpoint};
 657         }
 658
 659         return {
 660                 NAME => $idl->{NAME},
 661                 UUID => lc(has_property($idl, "uuid")),
 662                 VERSION => $version,
 663                 TYPE => "INTERFACE",
 664                 PROPERTIES => $idl->{PROPERTIES},
 665                 FUNCTIONS => \@functions,
 666                 CONSTS => \@consts,
 667                 TYPES => \@types,
 668                 DECLARES => \@declares,
 669                 ENDPOINTS => \@endpoints
 670         };
 671 }
 672
 673 # Convert a IDL tree to a NDR tree
 674 # Gives a result tree describing all that's necessary for easily generating
 675 # NDR parsers / generators
 676 sub Parse($)
 677 {
 678         my $idl = shift;
 679
 680         return undef unless (defined($idl));
 681
 682         Parse::Pidl::NDR::Validate($idl);
 683
 684         my @ndr = ();
 685
 686         foreach (@{$idl}) {
 687                 ($_->{TYPE} eq "INTERFACE") && push(@ndr, ParseInterface($_));
 688                 ($_->{TYPE} eq "IMPORT") && push(@ndr, $_);
 689         }
 690
 691         return \@ndr;
 692 }
 693
 694 sub GetNextLevel($$)
 695 {
 696         my $e = shift;
 697         my $fl = shift;
 698
 699         my $seen = 0;
 700
 701         foreach my $l (@{$e->{LEVELS}}) {
 702                 return $l if ($seen);
 703                 ($seen = 1) if ($l == $fl);
 704         }
 705
 706         return undef;
 707 }
 708
 709 sub GetPrevLevel($$)
 710 {
 711         my ($e,$fl) = @_;
 712         my $prev = undef;
 713
 714         foreach my $l (@{$e->{LEVELS}}) {
 715                 (return $prev) if ($l == $fl);
 716                 $prev = $l;
 717         }
 718
 719         return undef;
 720 }
 721
 722 sub ContainsString($)
 723 {
 724         my ($e) = @_;
 725
 726         foreach my $l (@{$e->{LEVELS}}) {
 727                 return 1 if ($l->{TYPE} eq "ARRAY" and $l->{IS_ZERO_TERMINATED});
 728         }
 729
 730         return 0;
 731 }
 732
 733 sub ContainsDeferred($$)
 734 {
 735         my ($e,$l) = @_;
 736
 737         return 1 if ($l->{CONTAINS_DEFERRED});
 738
 739         while ($l = GetNextLevel($e,$l))
 740         {
 741                 return 1 if ($l->{IS_DEFERRED});
 742                 return 1 if ($l->{CONTAINS_DEFERRED});
 743         }
 744
 745         return 0;
 746 }
 747
 748 sub el_name($)
 749 {
 750         my $e = shift;
 751
 752         if ($e->{PARENT} && $e->{PARENT}->{NAME}) {
 753                 return "$e->{PARENT}->{NAME}.$e->{NAME}";
 754         }
 755
 756         if ($e->{PARENT} && $e->{PARENT}->{PARENT}->{NAME}) {
 757                 return "$e->{PARENT}->{PARENT}->{NAME}.$e->{NAME}";
 758         }
 759
 760         if ($e->{PARENT}) {
 761                 return "$e->{PARENT}->{NAME}.$e->{NAME}";
 762         }
 763
 764         return $e->{NAME};
 765 }
 766
 767 ###################################
 768 # find a sibling var in a structure
 769 sub find_sibling($$)
 770 {
 771         my($e,$name) = @_;
 772         my($fn) = $e->{PARENT};
 773
 774         if ($name =~ /\*(.*)/) {
 775                 $name = $1;
 776         }
 777
 778         for my $e2 (@{$fn->{ELEMENTS}}) {
 779                 return $e2 if ($e2->{NAME} eq $name);
 780         }
 781
 782         return undef;
 783 }
 784
 785 my %property_list = (
 786         # interface
 787         "helpstring"            => ["INTERFACE", "FUNCTION"],
 788         "version"               => ["INTERFACE"],
 789         "uuid"                  => ["INTERFACE"],
 790         "endpoint"              => ["INTERFACE"],
 791         "pointer_default"       => ["INTERFACE"],
 792         "pointer_default_top"   => ["INTERFACE"],
 793         "helper"                => ["INTERFACE"],
 794         "authservice"           => ["INTERFACE"],
 795
 796         # dcom
 797         "object"                => ["INTERFACE"],
 798         "local"                 => ["INTERFACE", "FUNCTION"],
 799         "iid_is"                => ["ELEMENT"],
 800         "call_as"               => ["FUNCTION"],
 801         "idempotent"            => ["FUNCTION"],
 802
 803         # function
 804         "noopnum"               => ["FUNCTION"],
 805         "in"                    => ["ELEMENT"],
 806         "out"                   => ["ELEMENT"],
 807         "async"                 => ["FUNCTION"],
 808
 809         # pointer
 810         "ref"                   => ["ELEMENT"],
 811         "ptr"                   => ["ELEMENT"],
 812         "unique"                => ["ELEMENT"],
 813         "ignore"                => ["ELEMENT"],
 814         "relative"              => ["ELEMENT"],
 815         "relative_base"         => ["TYPEDEF"],
 816
 817         "gensize"               => ["TYPEDEF"],
 818         "value"                 => ["ELEMENT"],
 819         "flag"                  => ["ELEMENT", "TYPEDEF"],
 820
 821         # generic
 822         "public"                => ["FUNCTION", "TYPEDEF"],
 823         "nopush"                => ["FUNCTION", "TYPEDEF"],
 824         "nopull"                => ["FUNCTION", "TYPEDEF"],
 825         "nosize"                => ["FUNCTION", "TYPEDEF"],
 826         "noprint"               => ["FUNCTION", "TYPEDEF"],
 827         "noejs"                 => ["FUNCTION", "TYPEDEF"],
 828
 829         # union
 830         "switch_is"             => ["ELEMENT"],
 831         "switch_type"           => ["ELEMENT", "TYPEDEF"],
 832         "nodiscriminant"        => ["TYPEDEF"],
 833         "case"                  => ["ELEMENT"],
 834         "default"               => ["ELEMENT"],
 835
 836         "represent_as"          => ["ELEMENT"],
 837         "transmit_as"           => ["ELEMENT"],
 838
 839         # subcontext
 840         "subcontext"            => ["ELEMENT"],
 841         "subcontext_size"       => ["ELEMENT"],
 842         "compression"           => ["ELEMENT"],
 843
 844         # enum
 845         "enum8bit"              => ["TYPEDEF"],
 846         "enum16bit"             => ["TYPEDEF"],
 847         "v1_enum"               => ["TYPEDEF"],
 848
 849         # bitmap
 850         "bitmap8bit"            => ["TYPEDEF"],
 851         "bitmap16bit"           => ["TYPEDEF"],
 852         "bitmap32bit"           => ["TYPEDEF"],
 853         "bitmap64bit"           => ["TYPEDEF"],
 854
 855         # array
 856         "range"                 => ["ELEMENT"],
 857         "size_is"               => ["ELEMENT"],
 858         "string"                => ["ELEMENT"],
 859         "noheader"              => ["ELEMENT"],
 860         "charset"               => ["ELEMENT"],
 861         "length_is"             => ["ELEMENT"],
 862 );
 863
 864 #####################################################################
 865 # check for unknown properties
 866 sub ValidProperties($$)
 867 {
 868         my ($e,$t) = @_;
 869
 870         return unless defined $e->{PROPERTIES};
 871
 872         foreach my $key (keys %{$e->{PROPERTIES}}) {
 873                 warning($e, el_name($e) . ": unknown property '$key'")
 874                         unless defined($property_list{$key});
 875
 876                 fatal($e, el_name($e) . ": property '$key' not allowed on '$t'")
 877                         unless grep($t, @{$property_list{$key}});
 878         }
 879 }
 880
 881 sub mapToScalar($)
 882 {
 883         my $t = shift;
 884         my $ti = getType($t);
 885
 886         if (not defined ($ti)) {
 887                 return undef;
 888         } elsif ($ti->{DATA}->{TYPE} eq "ENUM") {
 889                 return Parse::Pidl::Typelist::enum_type_fn($ti->{DATA});
 890         } elsif ($ti->{DATA}->{TYPE} eq "BITMAP") {
 891                 return Parse::Pidl::Typelist::enum_type_fn($ti->{DATA});
 892         } elsif ($ti->{DATA}->{TYPE} eq "SCALAR") {
 893                 return $t;
 894         }
 895
 896         return undef;
 897 }
 898
 899 #####################################################################
 900 # validate an element
 901 sub ValidElement($)
 902 {
 903         my $e = shift;
 904
 905         ValidProperties($e,"ELEMENT");
 906
 907         # Check whether switches are used correctly.
 908         if (my $switch = has_property($e, "switch_is")) {
 909                 my $e2 = find_sibling($e, $switch);
 910                 my $type = getType($e->{TYPE});
 911
 912                 if (defined($type) and $type->{DATA}->{TYPE} ne "UNION") {
 913                         fatal($e, el_name($e) . ": switch_is() used on non-union type $e->{TYPE} which is a $type->{DATA}->{TYPE}");
 914                 }
 915
 916                 if (not has_property($type->{DATA}, "nodiscriminant") and defined($e2)) {
 917                         my $discriminator_type = has_property($type->{DATA}, "switch_type");
 918                         $discriminator_type = "uint32" unless defined ($discriminator_type);
 919
 920                         my $t1 = mapToScalar($discriminator_type);
 921
 922                         if (not defined($t1)) {
 923                                 fatal($e, el_name($e) . ": unable to map discriminator type '$discriminator_type' to scalar");
 924                         }
 925
 926                         my $t2 = mapToScalar($e2->{TYPE});
 927                         if (not defined($t2)) {
 928                                 fatal($e, el_name($e) . ": unable to map variable used for switch_is() to scalar");
 929                         }
 930
 931                         if ($t1 ne $t2) {
 932                                 warning($e, el_name($e) . ": switch_is() is of type $e2->{TYPE} ($t2), while discriminator type for union $type->{NAME} is $discriminator_type ($t1)");
 933                         }
 934                 }
 935         }
 936
 937         if (has_property($e, "subcontext") and has_property($e, "represent_as")) {
 938                 fatal($e, el_name($e) . " : subcontext() and represent_as() can not be used on the same element");
 939         }
 940
 941         if (has_property($e, "subcontext") and has_property($e, "transmit_as")) {
 942                 fatal($e, el_name($e) . " : subcontext() and transmit_as() can not be used on the same element");
 943         }
 944
 945         if (has_property($e, "represent_as") and has_property($e, "transmit_as")) {
 946                 fatal($e, el_name($e) . " : represent_as() and transmit_as() can not be used on the same element");
 947         }
 948
 949         if (has_property($e, "represent_as") and has_property($e, "value")) {
 950                 fatal($e, el_name($e) . " : represent_as() and value() can not be used on the same element");
 951         }
 952
 953         if (has_property($e, "subcontext")) {
 954                 warning($e, "subcontext() is deprecated. Use represent_as() or transmit_as() instead");
 955         }
 956
 957         if (defined (has_property($e, "subcontext_size")) and not defined(has_property($e, "subcontext"))) {
 958                 fatal($e, el_name($e) . " : subcontext_size() on non-subcontext element");
 959         }
 960
 961         if (defined (has_property($e, "compression")) and not defined(has_property($e, "subcontext"))) {
 962                 fatal($e, el_name($e) . " : compression() on non-subcontext element");
 963         }
 964
 965         if (!$e->{POINTERS} && (
 966                 has_property($e, "ptr") or
 967                 has_property($e, "unique") or
 968                 has_property($e, "relative") or
 969                 has_property($e, "ref"))) {
 970                 fatal($e, el_name($e) . " : pointer properties on non-pointer element\n");
 971         }
 972 }
 973
 974 #####################################################################
 975 # validate an enum
 976 sub ValidEnum($)
 977 {
 978         my ($enum) = @_;
 979
 980         ValidProperties($enum, "ENUM");
 981 }
 982
 983 #####################################################################
 984 # validate a bitmap
 985 sub ValidBitmap($)
 986 {
 987         my ($bitmap) = @_;
 988
 989         ValidProperties($bitmap, "BITMAP");
 990 }
 991
 992 #####################################################################
 993 # validate a struct
 994 sub ValidStruct($)
 995 {
 996         my($struct) = shift;
 997
 998         ValidProperties($struct, "STRUCT");
 999
1000         foreach my $e (@{$struct->{ELEMENTS}}) {
1001                 $e->{PARENT} = $struct;
1002                 ValidElement($e);
1003         }
1004 }
1005
1006 #####################################################################
1007 # parse a union
1008 sub ValidUnion($)
1009 {
1010         my($union) = shift;
1011
1012         ValidProperties($union,"UNION");
1013
1014         if (has_property($union->{PARENT}, "nodiscriminant") and has_property($union->{PARENT}, "switch_type")) {
1015                 fatal($union->{PARENT}, $union->{PARENT}->{NAME} . ": switch_type() on union without discriminant");
1016         }
1017
1018         foreach my $e (@{$union->{ELEMENTS}}) {
1019                 $e->{PARENT} = $union;
1020
1021                 if (defined($e->{PROPERTIES}->{default}) and
1022                         defined($e->{PROPERTIES}->{case})) {
1023                         fatal($e, "Union member $e->{NAME} can not have both default and case properties!");
1024                 }
1025
1026                 unless (defined ($e->{PROPERTIES}->{default}) or
1027                                 defined ($e->{PROPERTIES}->{case})) {
1028                         fatal($e, "Union member $e->{NAME} must have default or case property");
1029                 }
1030
1031                 if (has_property($e, "ref")) {
1032                         fatal($e, el_name($e) . " : embedded ref pointers are not supported yet\n");
1033                 }
1034
1035
1036                 ValidElement($e);
1037         }
1038 }
1039
1040 #####################################################################
1041 # parse a typedef
1042 sub ValidTypedef($)
1043 {
1044         my($typedef) = shift;
1045         my $data = $typedef->{DATA};
1046
1047         ValidProperties($typedef, "TYPEDEF");
1048
1049         $data->{PARENT} = $typedef;
1050
1051         ValidType($data) if (ref($data) eq "HASH");
1052 }
1053
1054 #####################################################################
1055 # validate a function
1056 sub ValidFunction($)
1057 {
1058         my($fn) = shift;
1059
1060         ValidProperties($fn,"FUNCTION");
1061
1062         foreach my $e (@{$fn->{ELEMENTS}}) {
1063                 $e->{PARENT} = $fn;
1064                 if (has_property($e, "ref") && !$e->{POINTERS}) {
1065                         fatal($e, "[ref] variables must be pointers ($fn->{NAME}/$e->{NAME})");
1066                 }
1067                 ValidElement($e);
1068         }
1069 }
1070
1071 #####################################################################
1072 # validate a type
1073 sub ValidType($)
1074 {
1075         my ($t) = @_;
1076
1077         {
1078                 TYPEDEF => \&ValidTypedef,
1079                 STRUCT => \&ValidStruct,
1080                 UNION => \&ValidUnion,
1081                 ENUM => \&ValidEnum,
1082                 BITMAP => \&ValidBitmap
1083         }->{$t->{TYPE}}->($t);
1084 }
1085
1086 #####################################################################
1087 # parse the interface definitions
1088 sub ValidInterface($)
1089 {
1090         my($interface) = shift;
1091         my($data) = $interface->{DATA};
1092
1093         if (has_property($interface, "helper")) {
1094                 warning($interface, "helper() is pidl-specific and deprecated. Use `include' instead");
1095         }
1096
1097         ValidProperties($interface,"INTERFACE");
1098
1099         if (has_property($interface, "pointer_default")) {
1100                 if (not grep (/$interface->{PROPERTIES}->{pointer_default}/,
1101                                         ("ref", "unique", "ptr"))) {
1102                         fatal($interface, "Unknown default pointer type `$interface->{PROPERTIES}->{pointer_default}'");
1103                 }
1104         }
1105
1106         if (has_property($interface, "object")) {
1107                 if (has_property($interface, "version") &&
1108                         $interface->{PROPERTIES}->{version} != 0) {
1109                         fatal($interface, "Object interfaces must have version 0.0 ($interface->{NAME})");
1110                 }
1111
1112                 if (!defined($interface->{BASE}) &&
1113                         not ($interface->{NAME} eq "IUnknown")) {
1114                         fatal($interface, "Object interfaces must all derive from IUnknown ($interface->{NAME})");
1115                 }
1116         }
1117
1118         foreach my $d (@{$data}) {
1119                 ($d->{TYPE} eq "FUNCTION") && ValidFunction($d);
1120                 ($d->{TYPE} eq "TYPEDEF" or
1121                  $d->{TYPE} eq "STRUCT" or
1122                  $d->{TYPE} eq "UNION" or
1123                  $d->{TYPE} eq "ENUM" or
1124              $d->{TYPE} eq "BITMAP") && ValidType($d);
1125         }
1126
1127 }
1128
1129 #####################################################################
1130 # Validate an IDL structure
1131 sub Validate($)
1132 {
1133         my($idl) = shift;
1134
1135         foreach my $x (@{$idl}) {
1136                 ($x->{TYPE} eq "INTERFACE") &&
1137                     ValidInterface($x);
1138                 ($x->{TYPE} eq "IMPORTLIB") &&
1139                         warning($x, "importlib() not supported");
1140         }
1141 }
1142
1143 1;