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