tools/widl/widltypes.h

   1 /*
   2  * IDL Compiler
   3  *
   4  * Copyright 2002 Ove Kaaven
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WIDL_WIDLTYPES_H
  22 #define __WIDL_WIDLTYPES_H
  23
  24 #include <stdarg.h>
  25 #include <assert.h>
  26 #include "ndrtypes.h"
  27 #include "wine/list.h"
  28
  29 struct uuid
  30 {
  31     unsigned int   Data1;
  32     unsigned short Data2;
  33     unsigned short Data3;
  34     unsigned char  Data4[8];
  35 };
  36
  37 #define TRUE 1
  38 #define FALSE 0
  39
  40 typedef struct _loc_info_t loc_info_t;
  41 typedef struct _attr_t attr_t;
  42 typedef struct _attr_custdata_t attr_custdata_t;
  43 typedef struct _expr_t expr_t;
  44 typedef struct _type_t type_t;
  45 typedef struct _var_t var_t;
  46 typedef struct _decl_spec_t decl_spec_t;
  47 typedef struct _declarator_t declarator_t;
  48 typedef struct _typeref_t typeref_t;
  49 typedef struct _typelib_entry_t typelib_entry_t;
  50 typedef struct _importlib_t importlib_t;
  51 typedef struct _importinfo_t importinfo_t;
  52 typedef struct _typelib_t typelib_t;
  53 typedef struct _user_type_t user_type_t;
  54 typedef struct _user_type_t context_handle_t;
  55 typedef struct _user_type_t generic_handle_t;
  56 typedef struct _statement_t statement_t;
  57 typedef struct _warning_t warning_t;
  58
  59 typedef struct list attr_list_t;
  60 typedef struct list str_list_t;
  61 typedef struct list expr_list_t;
  62 typedef struct list var_list_t;
  63 typedef struct list declarator_list_t;
  64 typedef struct list typeref_list_t;
  65 typedef struct list user_type_list_t;
  66 typedef struct list context_handle_list_t;
  67 typedef struct list generic_handle_list_t;
  68 typedef struct list statement_list_t;
  69 typedef struct list warning_list_t;
  70
  71 enum attr_type
  72 {
  73     ATTR_ACTIVATABLE,
  74     ATTR_AGGREGATABLE,
  75     ATTR_ALLOCATE,
  76     ATTR_ANNOTATION,
  77     ATTR_APPOBJECT,
  78     ATTR_ASYNC,
  79     ATTR_ASYNCUUID,
  80     ATTR_AUTO_HANDLE,
  81     ATTR_BINDABLE,
  82     ATTR_BROADCAST,
  83     ATTR_CALLAS,
  84     ATTR_CALLCONV, /* calling convention pseudo-attribute */
  85     ATTR_CASE,
  86     ATTR_CODE,
  87     ATTR_COMMSTATUS,
  88     ATTR_CONTEXTHANDLE,
  89     ATTR_CONTRACT,
  90     ATTR_CONTRACTVERSION,
  91     ATTR_CONTROL,
  92     ATTR_CUSTOM,
  93     ATTR_DECODE,
  94     ATTR_DEFAULT,
  95     ATTR_DEFAULTBIND,
  96     ATTR_DEFAULTCOLLELEM,
  97     ATTR_DEFAULTVALUE,
  98     ATTR_DEFAULTVTABLE,
  99     ATTR_DISABLECONSISTENCYCHECK,
 100     ATTR_DISPINTERFACE,
 101     ATTR_DISPLAYBIND,
 102     ATTR_DLLNAME,
 103     ATTR_DUAL,
 104     ATTR_ENABLEALLOCATE,
 105     ATTR_ENCODE,
 106     ATTR_ENDPOINT,
 107     ATTR_ENTRY,
 108     ATTR_EVENTADD,
 109     ATTR_EVENTREMOVE,
 110     ATTR_EXCLUSIVETO,
 111     ATTR_EXPLICIT_HANDLE,
 112     ATTR_FAULTSTATUS,
 113     ATTR_FLAGS,
 114     ATTR_FORCEALLOCATE,
 115     ATTR_HANDLE,
 116     ATTR_HELPCONTEXT,
 117     ATTR_HELPFILE,
 118     ATTR_HELPSTRING,
 119     ATTR_HELPSTRINGCONTEXT,
 120     ATTR_HELPSTRINGDLL,
 121     ATTR_HIDDEN,
 122     ATTR_ID,
 123     ATTR_IDEMPOTENT,
 124     ATTR_IGNORE,
 125     ATTR_IIDIS,
 126     ATTR_IMMEDIATEBIND,
 127     ATTR_IMPLICIT_HANDLE,
 128     ATTR_IN,
 129     ATTR_INPUTSYNC,
 130     ATTR_LENGTHIS,
 131     ATTR_LIBLCID,
 132     ATTR_LICENSED,
 133     ATTR_LOCAL,
 134     ATTR_MARSHALING_BEHAVIOR,
 135     ATTR_MAYBE,
 136     ATTR_MESSAGE,
 137     ATTR_NOCODE,
 138     ATTR_NONBROWSABLE,
 139     ATTR_NONCREATABLE,
 140     ATTR_NONEXTENSIBLE,
 141     ATTR_NOTIFY,
 142     ATTR_NOTIFYFLAG,
 143     ATTR_OBJECT,
 144     ATTR_ODL,
 145     ATTR_OLEAUTOMATION,
 146     ATTR_OPTIMIZE,
 147     ATTR_OPTIONAL,
 148     ATTR_OUT,
 149     ATTR_PARAMLCID,
 150     ATTR_PARTIALIGNORE,
 151     ATTR_POINTERDEFAULT,
 152     ATTR_POINTERTYPE,
 153     ATTR_PROGID,
 154     ATTR_PROPGET,
 155     ATTR_PROPPUT,
 156     ATTR_PROPPUTREF,
 157     ATTR_PROXY,
 158     ATTR_PUBLIC,
 159     ATTR_RANGE,
 160     ATTR_READONLY,
 161     ATTR_REPRESENTAS,
 162     ATTR_REQUESTEDIT,
 163     ATTR_RESTRICTED,
 164     ATTR_RETVAL,
 165     ATTR_SIZEIS,
 166     ATTR_SOURCE,
 167     ATTR_STATIC,
 168     ATTR_STRICTCONTEXTHANDLE,
 169     ATTR_STRING,
 170     ATTR_SWITCHIS,
 171     ATTR_SWITCHTYPE,
 172     ATTR_THREADING,
 173     ATTR_TRANSMITAS,
 174     ATTR_UIDEFAULT,
 175     ATTR_USERMARSHAL,
 176     ATTR_USESGETLASTERROR,
 177     ATTR_UUID,
 178     ATTR_V1ENUM,
 179     ATTR_VARARG,
 180     ATTR_VERSION,
 181     ATTR_VIPROGID,
 182     ATTR_WIREMARSHAL
 183 };
 184
 185 enum expr_type
 186 {
 187     EXPR_VOID,
 188     EXPR_NUM,
 189     EXPR_HEXNUM,
 190     EXPR_DOUBLE,
 191     EXPR_IDENTIFIER,
 192     EXPR_NEG,
 193     EXPR_NOT,
 194     EXPR_PPTR,
 195     EXPR_CAST,
 196     EXPR_SIZEOF,
 197     EXPR_SHL,
 198     EXPR_SHR,
 199     EXPR_MUL,
 200     EXPR_DIV,
 201     EXPR_ADD,
 202     EXPR_SUB,
 203     EXPR_AND,
 204     EXPR_OR,
 205     EXPR_COND,
 206     EXPR_TRUEFALSE,
 207     EXPR_ADDRESSOF,
 208     EXPR_MEMBER,
 209     EXPR_ARRAY,
 210     EXPR_MOD,
 211     EXPR_LOGOR,
 212     EXPR_LOGAND,
 213     EXPR_XOR,
 214     EXPR_EQUALITY,
 215     EXPR_INEQUALITY,
 216     EXPR_GTR,
 217     EXPR_LESS,
 218     EXPR_GTREQL,
 219     EXPR_LESSEQL,
 220     EXPR_LOGNOT,
 221     EXPR_POS,
 222     EXPR_STRLIT,
 223     EXPR_WSTRLIT,
 224     EXPR_CHARCONST,
 225 };
 226
 227 enum type_kind
 228 {
 229     TKIND_PRIMITIVE = -1,
 230     TKIND_ENUM,
 231     TKIND_RECORD,
 232     TKIND_MODULE,
 233     TKIND_INTERFACE,
 234     TKIND_DISPATCH,
 235     TKIND_COCLASS,
 236     TKIND_ALIAS,
 237     TKIND_UNION,
 238     TKIND_MAX
 239 };
 240
 241 enum storage_class
 242 {
 243     STG_NONE,
 244     STG_STATIC,
 245     STG_EXTERN,
 246     STG_REGISTER,
 247 };
 248
 249 enum type_qualifier
 250 {
 251     TYPE_QUALIFIER_CONST = 1,
 252 };
 253
 254 enum function_specifier
 255 {
 256     FUNCTION_SPECIFIER_INLINE = 1,
 257 };
 258
 259 enum statement_type
 260 {
 261     STMT_LIBRARY,
 262     STMT_DECLARATION,
 263     STMT_TYPE,
 264     STMT_TYPEREF,
 265     STMT_MODULE,
 266     STMT_TYPEDEF,
 267     STMT_IMPORT,
 268     STMT_IMPORTLIB,
 269     STMT_PRAGMA,
 270     STMT_CPPQUOTE
 271 };
 272
 273 enum threading_type
 274 {
 275     THREADING_APARTMENT = 1,
 276     THREADING_NEUTRAL,
 277     THREADING_SINGLE,
 278     THREADING_FREE,
 279     THREADING_BOTH
 280 };
 281
 282 enum marshaling_type
 283 {
 284     MARSHALING_INVALID = 0,
 285     MARSHALING_NONE,
 286     MARSHALING_AGILE,
 287     MARSHALING_STANDARD,
 288 };
 289
 290 enum type_basic_type
 291 {
 292     TYPE_BASIC_INT8 = 1,
 293     TYPE_BASIC_INT16,
 294     TYPE_BASIC_INT32,
 295     TYPE_BASIC_INT64,
 296     TYPE_BASIC_INT,
 297     TYPE_BASIC_INT3264,
 298     TYPE_BASIC_LONG,
 299     TYPE_BASIC_CHAR,
 300     TYPE_BASIC_HYPER,
 301     TYPE_BASIC_BYTE,
 302     TYPE_BASIC_WCHAR,
 303     TYPE_BASIC_FLOAT,
 304     TYPE_BASIC_DOUBLE,
 305     TYPE_BASIC_ERROR_STATUS_T,
 306     TYPE_BASIC_HANDLE,
 307 };
 308
 309 #define TYPE_BASIC_MAX TYPE_BASIC_HANDLE
 310 #define TYPE_BASIC_INT_MIN TYPE_BASIC_INT8
 311 #define TYPE_BASIC_INT_MAX TYPE_BASIC_HYPER
 312
 313 struct _loc_info_t
 314 {
 315     const char *input_name;
 316     int line_number;
 317     const char *near_text;
 318 };
 319
 320 struct str_list_entry_t
 321 {
 322     char *str;
 323     struct list entry;
 324 };
 325
 326 struct _decl_spec_t
 327 {
 328   type_t *type;
 329   enum storage_class stgclass;
 330   enum type_qualifier qualifier;
 331   enum function_specifier func_specifier;
 332 };
 333
 334 struct _attr_t {
 335   enum attr_type type;
 336   union {
 337     unsigned int ival;
 338     void *pval;
 339   } u;
 340   /* parser-internal */
 341   struct list entry;
 342 };
 343
 344 struct _expr_t {
 345   enum expr_type type;
 346   const expr_t *ref;
 347   union {
 348     int lval;
 349     double dval;
 350     const char *sval;
 351     const expr_t *ext;
 352     decl_spec_t tref;
 353   } u;
 354   const expr_t *ext2;
 355   int is_const;
 356   int cval;
 357   /* parser-internal */
 358   struct list entry;
 359 };
 360
 361 struct _attr_custdata_t {
 362   struct uuid id;
 363   expr_t *pval;
 364 };
 365
 366 struct struct_details
 367 {
 368   var_list_t *fields;
 369 };
 370
 371 struct enumeration_details
 372 {
 373   var_list_t *enums;
 374 };
 375
 376 struct func_details
 377 {
 378   var_list_t *args;
 379   struct _var_t *retval;
 380 };
 381
 382 struct iface_details
 383 {
 384   statement_list_t *stmts;
 385   var_list_t *disp_methods;
 386   var_list_t *disp_props;
 387   struct _type_t *inherit;
 388   struct _type_t *disp_inherit;
 389   struct _type_t *async_iface;
 390   typeref_list_t *requires;
 391 };
 392
 393 struct module_details
 394 {
 395   statement_list_t *stmts;
 396 };
 397
 398 struct array_details
 399 {
 400   expr_t *size_is;
 401   expr_t *length_is;
 402   struct _decl_spec_t elem;
 403   unsigned int dim;
 404   unsigned char declptr; /* if declared as a pointer */
 405   unsigned short ptr_tfsoff;  /* offset of pointer definition for declptr */
 406 };
 407
 408 struct coclass_details
 409 {
 410   typeref_list_t *ifaces;
 411 };
 412
 413 struct basic_details
 414 {
 415   enum type_basic_type type;
 416   int sign;
 417 };
 418
 419 struct pointer_details
 420 {
 421   struct _decl_spec_t ref;
 422 };
 423
 424 struct bitfield_details
 425 {
 426   struct _type_t *field;
 427   const expr_t *bits;
 428 };
 429
 430 struct alias_details
 431 {
 432     struct _decl_spec_t aliasee;
 433 };
 434
 435 struct runtimeclass_details
 436 {
 437     typeref_list_t *ifaces;
 438 };
 439
 440 struct parameterized_details
 441 {
 442     type_t *type;
 443     typeref_list_t *params;
 444 };
 445
 446 struct delegate_details
 447 {
 448     type_t *iface;
 449 };
 450
 451 #define HASHMAX 64
 452
 453 struct namespace {
 454     const char *name;
 455     struct namespace *parent;
 456     struct list entry;
 457     struct list children;
 458     struct rtype *type_hash[HASHMAX];
 459 };
 460
 461 enum type_type
 462 {
 463     TYPE_VOID,
 464     TYPE_BASIC, /* ints, floats and handles */
 465     TYPE_ENUM,
 466     TYPE_STRUCT,
 467     TYPE_ENCAPSULATED_UNION,
 468     TYPE_UNION,
 469     TYPE_ALIAS,
 470     TYPE_MODULE,
 471     TYPE_COCLASS,
 472     TYPE_FUNCTION,
 473     TYPE_INTERFACE,
 474     TYPE_POINTER,
 475     TYPE_ARRAY,
 476     TYPE_BITFIELD,
 477     TYPE_APICONTRACT,
 478     TYPE_RUNTIMECLASS,
 479     TYPE_PARAMETERIZED_TYPE,
 480     TYPE_PARAMETER,
 481     TYPE_DELEGATE,
 482 };
 483
 484 struct _type_t {
 485   const char *name;
 486   struct namespace *namespace;
 487   enum type_type type_type;
 488   attr_list_t *attrs;
 489   union
 490   {
 491     struct struct_details *structure;
 492     struct enumeration_details *enumeration;
 493     struct func_details *function;
 494     struct iface_details *iface;
 495     struct module_details *module;
 496     struct array_details array;
 497     struct coclass_details coclass;
 498     struct basic_details basic;
 499     struct pointer_details pointer;
 500     struct bitfield_details bitfield;
 501     struct alias_details alias;
 502     struct runtimeclass_details runtimeclass;
 503     struct parameterized_details parameterized;
 504     struct delegate_details delegate;
 505   } details;
 506   const char *c_name;
 507   const char *signature;
 508   const char *qualified_name;
 509   const char *impl_name;
 510   const char *short_name;
 511   unsigned int typestring_offset;
 512   unsigned int ptrdesc;           /* used for complex structs */
 513   int typelib_idx;
 514   loc_info_t loc_info;
 515   unsigned int ignore : 1;
 516   unsigned int defined : 1;
 517   unsigned int written : 1;
 518   unsigned int user_types_registered : 1;
 519   unsigned int tfswrite : 1;   /* if the type needs to be written to the TFS */
 520   unsigned int checked : 1;
 521 };
 522
 523 struct _var_t {
 524   char *name;
 525   decl_spec_t declspec;
 526   attr_list_t *attrs;
 527   expr_t *eval;
 528
 529   unsigned int typestring_offset;
 530
 531   /* fields specific to functions */
 532   unsigned int procstring_offset, func_idx;
 533
 534   struct _loc_info_t loc_info;
 535
 536   unsigned int declonly : 1;
 537
 538   /* parser-internal */
 539   struct list entry;
 540 };
 541
 542 struct _declarator_t {
 543   var_t *var;
 544   type_t *type;
 545   enum type_qualifier qualifier;
 546   expr_t *bits;
 547
 548   /* parser-internal */
 549   struct list entry;
 550 };
 551
 552 struct _typeref_t {
 553   type_t *type;
 554   attr_list_t *attrs;
 555
 556   /* parser-internal */
 557   struct list entry;
 558 };
 559
 560 struct _typelib_entry_t {
 561     type_t *type;
 562     struct list entry;
 563 };
 564
 565 struct _importinfo_t {
 566     int offset;
 567     struct uuid guid;
 568     int flags;
 569     int id;
 570
 571     char *name;
 572
 573     importlib_t *importlib;
 574 };
 575
 576 struct _importlib_t {
 577     int offset;
 578     char *name;
 579
 580     int version;
 581     struct uuid guid;
 582
 583     importinfo_t *importinfos;
 584     int ntypeinfos;
 585
 586     int allocated;
 587
 588     struct list entry;
 589 };
 590
 591 struct _typelib_t {
 592     char *name;
 593     const attr_list_t *attrs;
 594     struct list importlibs;
 595     statement_list_t *stmts;
 596
 597     type_t **reg_ifaces;
 598     unsigned int reg_iface_count;
 599 };
 600
 601 struct _user_type_t {
 602     struct list entry;
 603     const char *name;
 604 };
 605
 606 struct _statement_t {
 607     struct list entry;
 608     enum statement_type type;
 609     union
 610     {
 611         type_t *type;
 612         const char *str;
 613         var_t *var;
 614         typelib_t *lib;
 615         typeref_list_t *type_list;
 616     } u;
 617     unsigned int declonly : 1; /* for STMT_TYPE and STMT_TYPEDEF */
 618 };
 619
 620 struct _warning_t {
 621     int num;
 622     struct list entry;
 623 };
 624
 625 typedef enum {
 626     SYS_WIN16,
 627     SYS_WIN32,
 628     SYS_MAC,
 629     SYS_WIN64
 630 } syskind_t;
 631
 632 extern user_type_list_t user_type_list;
 633 extern context_handle_list_t context_handle_list;
 634 extern generic_handle_list_t generic_handle_list;
 635 void check_for_additional_prototype_types(type_t *type);
 636
 637 void init_types(void);
 638 type_t *alloc_type(void);
 639 void set_all_tfswrite(int val);
 640 void clear_all_offsets(void);
 641
 642 #define tsENUM   1
 643 #define tsSTRUCT 2
 644 #define tsUNION  3
 645
 646 var_t *find_const(const char *name, int f);
 647 type_t *find_type(const char *name, struct namespace *namespace, int t);
 648 type_t *make_type(enum type_type type);
 649 type_t *get_type(enum type_type type, char *name, struct namespace *namespace, int t);
 650 type_t *reg_type(type_t *type, const char *name, struct namespace *namespace, int t);
 651
 652 var_t *make_var(char *name);
 653 var_list_t *append_var(var_list_t *list, var_t *var);
 654
 655 void init_loc_info(loc_info_t *);
 656
 657 char *format_namespace(struct namespace *namespace, const char *prefix, const char *separator, const char *suffix,
 658                        const char *abi_prefix);
 659 char *format_parameterized_type_name(type_t *type, typeref_list_t *params);
 660
 661 static inline enum type_type type_get_type_detect_alias(const type_t *type)
 662 {
 663     return type->type_type;
 664 }
 665
 666 #define STATEMENTS_FOR_EACH_FUNC(stmt, stmts) \
 667   if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, statement_t, entry ) \
 668     if (stmt->type == STMT_DECLARATION && stmt->u.var->declspec.stgclass == STG_NONE && \
 669         type_get_type_detect_alias(stmt->u.var->declspec.type) == TYPE_FUNCTION)
 670
 671 static inline int statements_has_func(const statement_list_t *stmts)
 672 {
 673   const statement_t *stmt;
 674   int has_func = 0;
 675   STATEMENTS_FOR_EACH_FUNC(stmt, stmts)
 676   {
 677     has_func = 1;
 678     break;
 679   }
 680   return has_func;
 681 }
 682
 683 static inline int is_global_namespace(const struct namespace *namespace)
 684 {
 685     return !namespace->name;
 686 }
 687
 688 static inline decl_spec_t *init_declspec(decl_spec_t *declspec, type_t *type)
 689 {
 690   declspec->type = type;
 691   declspec->stgclass = STG_NONE;
 692   declspec->qualifier = 0;
 693   declspec->func_specifier = 0;
 694
 695   return declspec;
 696 }
 697
 698 #endif