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