tools/widl/typetree.h

   1 /*
   2  * IDL Type Tree
   3  *
   4  * Copyright 2008 Robert Shearman
   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 #include "widltypes.h"
  22 #include <assert.h>
  23 #include <stdio.h>
  24
  25 #include "utils.h"
  26
  27 #ifndef WIDL_TYPE_TREE_H
  28 #define WIDL_TYPE_TREE_H
  29
  30 enum name_type {
  31     NAME_DEFAULT,
  32     NAME_C
  33 };
  34
  35 type_t *find_parameterized_type(type_t *type, typeref_list_t *params);
  36
  37 type_t *type_new_function(var_list_t *args);
  38 type_t *type_new_pointer(type_t *ref);
  39 type_t *type_new_alias(const decl_spec_t *t, const char *name);
  40 type_t *type_module_declare(char *name);
  41 type_t *type_new_array(const char *name, const decl_spec_t *element, int declptr,
  42                        unsigned int dim, expr_t *size_is, expr_t *length_is);
  43 type_t *type_new_basic(enum type_basic_type basic_type);
  44 type_t *type_new_int(enum type_basic_type basic_type, int sign);
  45 type_t *type_new_void(void);
  46 type_t *type_coclass_declare(char *name);
  47 type_t *type_new_enum(const char *name, struct namespace *namespace, int defined, var_list_t *enums);
  48 type_t *type_new_struct(char *name, struct namespace *namespace, int defined, var_list_t *fields);
  49 type_t *type_new_nonencapsulated_union(const char *name, struct namespace *namespace, int defined, var_list_t *fields);
  50 type_t *type_new_encapsulated_union(char *name, var_t *switch_field, var_t *union_field, var_list_t *cases);
  51 type_t *type_new_bitfield(type_t *field_type, const expr_t *bits);
  52 type_t *type_runtimeclass_declare(char *name, struct namespace *namespace);
  53 type_t *type_interface_declare(char *name, struct namespace *namespace);
  54 type_t *type_interface_define(type_t *iface, attr_list_t *attrs, type_t *inherit, statement_list_t *stmts, typeref_list_t *requires);
  55 type_t *type_dispinterface_declare(char *name);
  56 type_t *type_dispinterface_define(type_t *iface, attr_list_t *attrs, var_list_t *props, var_list_t *methods);
  57 type_t *type_dispinterface_define_from_iface(type_t *dispiface, attr_list_t *attrs, type_t *iface);
  58 type_t *type_module_define(type_t* module, attr_list_t *attrs, statement_list_t *stmts);
  59 type_t *type_coclass_define(type_t *coclass, attr_list_t *attrs, typeref_list_t *ifaces);
  60 type_t *type_runtimeclass_define(type_t *runtimeclass, attr_list_t *attrs, typeref_list_t *ifaces);
  61 type_t *type_apicontract_declare(char *name, struct namespace *namespace);
  62 type_t *type_apicontract_define(type_t *apicontract, attr_list_t *attrs);
  63 type_t *type_delegate_declare(char *name, struct namespace *namespace);
  64 type_t *type_delegate_define(type_t *delegate, attr_list_t *attrs, statement_list_t *stmts);
  65 type_t *type_parameterized_interface_declare(char *name, struct namespace *namespace, typeref_list_t *params);
  66 type_t *type_parameterized_interface_define(type_t *type, attr_list_t *attrs, type_t *inherit, statement_list_t *stmts, typeref_list_t *requires);
  67 type_t *type_parameterized_delegate_declare(char *name, struct namespace *namespace, typeref_list_t *params);
  68 type_t *type_parameterized_delegate_define(type_t *type, attr_list_t *attrs, statement_list_t *stmts);
  69 type_t *type_parameterized_type_specialize_partial(type_t *type, typeref_list_t *params);
  70 type_t *type_parameterized_type_specialize_declare(type_t *type, typeref_list_t *params);
  71 type_t *type_parameterized_type_specialize_define(type_t *type);
  72 int type_is_equal(const type_t *type1, const type_t *type2);
  73 const char *type_get_decl_name(const type_t *type, enum name_type name_type);
  74 const char *type_get_name(const type_t *type, enum name_type name_type);
  75 char *gen_name(void);
  76
  77 typeref_t *make_typeref(type_t *type);
  78 typeref_list_t *append_typeref(typeref_list_t *list, typeref_t *ref);
  79
  80 /* FIXME: shouldn't need to export this */
  81 type_t *duptype(type_t *t, int dupname);
  82
  83 /* un-alias the type until finding the non-alias type */
  84 static inline type_t *type_get_real_type(const type_t *type)
  85 {
  86     if (type->type_type == TYPE_ALIAS)
  87         return type_get_real_type(type->details.alias.aliasee.type);
  88     else
  89         return (type_t *)type;
  90 }
  91
  92 static inline type_t *type_parameterized_type_get_real_type(const type_t *type)
  93 {
  94     if (type->type_type == TYPE_PARAMETERIZED_TYPE)
  95         return type_parameterized_type_get_real_type(type->details.parameterized.type);
  96     else
  97         return (type_t *)type;
  98 }
  99
 100 static inline enum type_type type_get_type(const type_t *type)
 101 {
 102     return type_get_type_detect_alias(type_get_real_type(type));
 103 }
 104
 105 static inline enum type_basic_type type_basic_get_type(const type_t *type)
 106 {
 107     type = type_get_real_type(type);
 108     assert(type_get_type(type) == TYPE_BASIC);
 109     return type->details.basic.type;
 110 }
 111
 112 static inline int type_basic_get_sign(const type_t *type)
 113 {
 114     type = type_get_real_type(type);
 115     assert(type_get_type(type) == TYPE_BASIC);
 116     return type->details.basic.sign;
 117 }
 118
 119 static inline var_list_t *type_struct_get_fields(const type_t *type)
 120 {
 121     type = type_get_real_type(type);
 122     assert(type_get_type(type) == TYPE_STRUCT);
 123     return type->details.structure->fields;
 124 }
 125
 126 static inline var_list_t *type_function_get_args(const type_t *type)
 127 {
 128     type = type_get_real_type(type);
 129     assert(type_get_type(type) == TYPE_FUNCTION);
 130     return type->details.function->args;
 131 }
 132
 133 static inline var_t *type_function_get_retval(const type_t *type)
 134 {
 135     type = type_get_real_type(type);
 136     assert(type_get_type(type) == TYPE_FUNCTION);
 137     return type->details.function->retval;
 138 }
 139
 140 static inline const decl_spec_t *type_function_get_ret(const type_t *type)
 141 {
 142     return &type_function_get_retval(type)->declspec;
 143 }
 144
 145 static inline type_t *type_function_get_rettype(const type_t *type)
 146 {
 147     return type_function_get_retval(type)->declspec.type;
 148 }
 149
 150 static inline var_list_t *type_enum_get_values(const type_t *type)
 151 {
 152     type = type_get_real_type(type);
 153     assert(type_get_type(type) == TYPE_ENUM);
 154     return type->details.enumeration->enums;
 155 }
 156
 157 static inline var_t *type_union_get_switch_value(const type_t *type)
 158 {
 159     type = type_get_real_type(type);
 160     assert(type_get_type(type) == TYPE_ENCAPSULATED_UNION);
 161     return LIST_ENTRY(list_head(type->details.structure->fields), var_t, entry);
 162 }
 163
 164 static inline var_list_t *type_encapsulated_union_get_fields(const type_t *type)
 165 {
 166     type = type_get_real_type(type);
 167     assert(type_get_type(type) == TYPE_ENCAPSULATED_UNION);
 168     return type->details.structure->fields;
 169 }
 170
 171 static inline var_list_t *type_union_get_cases(const type_t *type)
 172 {
 173     enum type_type type_type;
 174
 175     type = type_get_real_type(type);
 176     type_type = type_get_type(type);
 177
 178     assert(type_type == TYPE_UNION || type_type == TYPE_ENCAPSULATED_UNION);
 179     if (type_type == TYPE_ENCAPSULATED_UNION)
 180     {
 181         const var_t *uv = LIST_ENTRY(list_tail(type->details.structure->fields), const var_t, entry);
 182         return uv->declspec.type->details.structure->fields;
 183     }
 184     else
 185         return type->details.structure->fields;
 186 }
 187
 188 static inline statement_list_t *type_iface_get_stmts(const type_t *type)
 189 {
 190     type = type_get_real_type(type);
 191     assert(type_get_type(type) == TYPE_INTERFACE);
 192     return type->details.iface->stmts;
 193 }
 194
 195 static inline type_t *type_iface_get_inherit(const type_t *type)
 196 {
 197     type = type_get_real_type(type);
 198     assert(type_get_type(type) == TYPE_INTERFACE);
 199     return type->details.iface->inherit;
 200 }
 201
 202 static inline typeref_list_t *type_iface_get_requires(const type_t *type)
 203 {
 204     type = type_get_real_type(type);
 205     assert(type_get_type(type) == TYPE_INTERFACE);
 206     return type->details.iface->requires;
 207 }
 208
 209 static inline type_t *type_iface_get_async_iface(const type_t *type)
 210 {
 211     type = type_get_real_type(type);
 212     assert(type_get_type(type) == TYPE_INTERFACE);
 213     return type->details.iface->async_iface;
 214 }
 215
 216 static inline var_list_t *type_dispiface_get_props(const type_t *type)
 217 {
 218     type = type_get_real_type(type);
 219     assert(type_get_type(type) == TYPE_INTERFACE);
 220     return type->details.iface->disp_props;
 221 }
 222
 223 static inline var_list_t *type_dispiface_get_methods(const type_t *type)
 224 {
 225     type = type_get_real_type(type);
 226     assert(type_get_type(type) == TYPE_INTERFACE);
 227     return type->details.iface->disp_methods;
 228 }
 229
 230 static inline type_t *type_dispiface_get_inherit(const type_t *type)
 231 {
 232     type = type_get_real_type(type);
 233     assert(type_get_type(type) == TYPE_INTERFACE);
 234     return type->details.iface->disp_inherit;
 235 }
 236
 237 static inline int type_is_defined(const type_t *type)
 238 {
 239     return type->defined;
 240 }
 241
 242 static inline int type_is_complete(const type_t *type)
 243 {
 244     switch (type_get_type_detect_alias(type))
 245     {
 246     case TYPE_FUNCTION:
 247         return (type->details.function != NULL);
 248     case TYPE_INTERFACE:
 249         return (type->details.iface != NULL);
 250     case TYPE_ENUM:
 251         return (type->details.enumeration != NULL);
 252     case TYPE_UNION:
 253     case TYPE_ENCAPSULATED_UNION:
 254     case TYPE_STRUCT:
 255         return (type->details.structure != NULL);
 256     case TYPE_VOID:
 257     case TYPE_BASIC:
 258     case TYPE_ALIAS:
 259     case TYPE_MODULE:
 260     case TYPE_COCLASS:
 261     case TYPE_POINTER:
 262     case TYPE_ARRAY:
 263     case TYPE_BITFIELD:
 264     case TYPE_RUNTIMECLASS:
 265     case TYPE_DELEGATE:
 266         return TRUE;
 267     case TYPE_APICONTRACT:
 268     case TYPE_PARAMETERIZED_TYPE:
 269     case TYPE_PARAMETER:
 270         assert(0);
 271         break;
 272     }
 273     return FALSE;
 274 }
 275
 276 static inline int type_array_has_conformance(const type_t *type)
 277 {
 278     type = type_get_real_type(type);
 279     assert(type_get_type(type) == TYPE_ARRAY);
 280     return (type->details.array.size_is != NULL);
 281 }
 282
 283 static inline int type_array_has_variance(const type_t *type)
 284 {
 285     type = type_get_real_type(type);
 286     assert(type_get_type(type) == TYPE_ARRAY);
 287     return (type->details.array.length_is != NULL);
 288 }
 289
 290 static inline unsigned int type_array_get_dim(const type_t *type)
 291 {
 292     type = type_get_real_type(type);
 293     assert(type_get_type(type) == TYPE_ARRAY);
 294     return type->details.array.dim;
 295 }
 296
 297 static inline expr_t *type_array_get_conformance(const type_t *type)
 298 {
 299     type = type_get_real_type(type);
 300     assert(type_get_type(type) == TYPE_ARRAY);
 301     return type->details.array.size_is;
 302 }
 303
 304 static inline expr_t *type_array_get_variance(const type_t *type)
 305 {
 306     type = type_get_real_type(type);
 307     assert(type_get_type(type) == TYPE_ARRAY);
 308     return type->details.array.length_is;
 309 }
 310
 311 static inline unsigned short type_array_get_ptr_tfsoff(const type_t *type)
 312 {
 313     type = type_get_real_type(type);
 314     assert(type_get_type(type) == TYPE_ARRAY);
 315     return type->details.array.ptr_tfsoff;
 316 }
 317
 318 static inline void type_array_set_ptr_tfsoff(type_t *type, unsigned short ptr_tfsoff)
 319 {
 320     type = type_get_real_type(type);
 321     assert(type_get_type(type) == TYPE_ARRAY);
 322     type->details.array.ptr_tfsoff = ptr_tfsoff;
 323 }
 324
 325 static inline const decl_spec_t *type_array_get_element(const type_t *type)
 326 {
 327     type = type_get_real_type(type);
 328     assert(type_get_type(type) == TYPE_ARRAY);
 329     return &type->details.array.elem;
 330 }
 331
 332 static inline type_t *type_array_get_element_type(const type_t *type)
 333 {
 334     return type_array_get_element(type)->type;
 335 }
 336
 337 static inline int type_array_is_decl_as_ptr(const type_t *type)
 338 {
 339     type = type_get_real_type(type);
 340     assert(type_get_type(type) == TYPE_ARRAY);
 341     return type->details.array.declptr;
 342 }
 343
 344 static inline int type_is_alias(const type_t *type)
 345 {
 346     return type->type_type == TYPE_ALIAS;
 347 }
 348
 349 static inline int type_is_ptr( const type_t *type )
 350 {
 351     return type->type_type == TYPE_POINTER;
 352 }
 353
 354 static inline const decl_spec_t *type_alias_get_aliasee(const type_t *type)
 355 {
 356     assert(type_is_alias(type));
 357     return &type->details.alias.aliasee;
 358 }
 359
 360 static inline type_t *type_alias_get_aliasee_type(const type_t *type)
 361 {
 362     assert(type_is_alias(type));
 363     return type->details.alias.aliasee.type;
 364 }
 365
 366 static inline typeref_list_t *type_coclass_get_ifaces(const type_t *type)
 367 {
 368     type = type_get_real_type(type);
 369     assert(type_get_type(type) == TYPE_COCLASS);
 370     return type->details.coclass.ifaces;
 371 }
 372
 373 static inline typeref_list_t *type_runtimeclass_get_ifaces(const type_t *type)
 374 {
 375     type = type_get_real_type(type);
 376     assert(type_get_type(type) == TYPE_RUNTIMECLASS);
 377     return type->details.runtimeclass.ifaces;
 378 }
 379
 380 static inline type_t *type_runtimeclass_get_default_iface(const type_t *type, int check)
 381 {
 382     typeref_list_t *ifaces = type_runtimeclass_get_ifaces(type);
 383     typeref_t *ref;
 384
 385     if (ifaces) LIST_FOR_EACH_ENTRY(ref, ifaces, typeref_t, entry)
 386         if (is_attr(ref->attrs, ATTR_DEFAULT))
 387             return ref->type;
 388
 389     if (!check) return NULL;
 390     error_at( &type->where, "runtimeclass %s needs a default interface\n", type->name );
 391 }
 392
 393 static inline type_t *type_delegate_get_iface(const type_t *type)
 394 {
 395     type = type_get_real_type(type);
 396     assert(type_get_type(type) == TYPE_DELEGATE);
 397     return type->details.delegate.iface;
 398 }
 399
 400 static inline const decl_spec_t *type_pointer_get_ref(const type_t *type)
 401 {
 402     type = type_get_real_type(type);
 403     assert(type_get_type(type) == TYPE_POINTER);
 404     return &type->details.pointer.ref;
 405 }
 406
 407 static inline type_t *type_pointer_get_ref_type(const type_t *type)
 408 {
 409     return type_pointer_get_ref(type)->type;
 410 }
 411
 412 static inline type_t *type_pointer_get_root_type(type_t *type)
 413 {
 414     for (; type && type->type_type == TYPE_POINTER; type = type_pointer_get_ref_type(type)) {}
 415     return type;
 416 }
 417
 418 static inline type_t *type_bitfield_get_field(const type_t *type)
 419 {
 420     type = type_get_real_type(type);
 421     assert(type_get_type(type) == TYPE_BITFIELD);
 422     return type->details.bitfield.field;
 423 }
 424
 425 static inline const expr_t *type_bitfield_get_bits(const type_t *type)
 426 {
 427     type = type_get_real_type(type);
 428     assert(type_get_type(type) == TYPE_BITFIELD);
 429     return type->details.bitfield.bits;
 430 }
 431
 432 #endif /* WIDL_TYPE_TREE_H */