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