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