gobject-introspection/gmetadata.h

   1 /* GObject introspection: struct definitions for the binary
   2  * metadata format, validation
   3  *
   4  * Copyright (C) 2005 Matthias Clasen
   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 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
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __G_METADATA_H__
  23 #define __G_METADATA_H__
  24
  25 #include <gmodule.h>
  26 #include "girepository.h"
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_IDL_MAGIC "GOBJ\nMETADATA\r\n\032"
  31
  32 enum
  33 {
  34   BLOB_TYPE_INVALID,
  35   BLOB_TYPE_FUNCTION,
  36   BLOB_TYPE_CALLBACK,
  37   BLOB_TYPE_STRUCT,
  38   BLOB_TYPE_BOXED,
  39   BLOB_TYPE_ENUM,
  40   BLOB_TYPE_FLAGS,
  41   BLOB_TYPE_OBJECT,
  42   BLOB_TYPE_INTERFACE,
  43   BLOB_TYPE_CONSTANT,
  44   BLOB_TYPE_ERROR_DOMAIN,
  45   BLOB_TYPE_UNION
  46 };
  47
  48 typedef struct
  49 {
  50   gchar   magic[16];
  51   guint8  major_version;
  52   guint8  minor_version;
  53   guint16 reserved;
  54   guint16 n_entries;
  55   guint16 n_local_entries;
  56   guint32 directory;
  57   guint32 n_annotations;
  58   guint32 annotations;
  59
  60   guint32 size;
  61   guint32 namespace;
  62   guint32 shared_library;
  63
  64   guint16 entry_blob_size;
  65   guint16 function_blob_size;
  66   guint16 callback_blob_size;
  67   guint16 signal_blob_size;
  68   guint16 vfunc_blob_size;
  69   guint16 arg_blob_size;
  70   guint16 property_blob_size;
  71   guint16 field_blob_size;
  72   guint16 value_blob_size;
  73   guint16 annotation_blob_size;
  74   guint16 constant_blob_size;
  75   guint16 error_domain_blob_size;
  76
  77   guint16 signature_blob_size;
  78   guint16 enum_blob_size;
  79   guint16 struct_blob_size;
  80   guint16 object_blob_size;
  81   guint16 interface_blob_size;
  82   guint16 union_blob_size;
  83
  84   guint16 padding[7];
  85 } Header;
  86
  87 typedef struct
  88 {
  89   guint16 blob_type;
  90
  91   guint   local    : 1;
  92   guint   reserved :15;
  93
  94   guint32 name;
  95   guint32 offset;
  96 } DirEntry;
  97
  98
  99 #define TYPE_POINTER_MASK 1 << 7
 100 #define TYPE_TAG_MASK         63
 101
 102 typedef enum
 103 {
 104   TYPE_TAG_VOID      =  0,
 105   TYPE_TAG_BOOLEAN   =  1,
 106   TYPE_TAG_INT8      =  2,
 107   TYPE_TAG_UINT8     =  3,
 108   TYPE_TAG_INT16     =  4,
 109   TYPE_TAG_UINT16    =  5,
 110   TYPE_TAG_INT32     =  6,
 111   TYPE_TAG_UINT32    =  7,
 112   TYPE_TAG_INT64     =  8,
 113   TYPE_TAG_UINT64    =  9,
 114   TYPE_TAG_INT       = 10,
 115   TYPE_TAG_UINT      = 11,
 116   TYPE_TAG_LONG      = 12,
 117   TYPE_TAG_ULONG     = 13,
 118   TYPE_TAG_SSIZE     = 14,
 119   TYPE_TAG_SIZE      = 15,
 120   TYPE_TAG_FLOAT     = 16,
 121   TYPE_TAG_DOUBLE    = 17,
 122   TYPE_TAG_UTF8      = 18,
 123   TYPE_TAG_FILENAME  = 19,
 124   TYPE_TAG_ARRAY     = 20,
 125   TYPE_TAG_INTERFACE = 21,
 126   TYPE_TAG_LIST      = 22,
 127   TYPE_TAG_SLIST     = 23,
 128   TYPE_TAG_HASH      = 24,
 129   TYPE_TAG_ERROR     = 25
 130 } TypeTag;
 131
 132 typedef union
 133 {
 134   struct
 135   {
 136     guint reserved   : 8;
 137     guint reserved2  :16;
 138     guint pointer    : 1;
 139     guint reserved3  : 2;
 140     guint tag        : 5;
 141   };
 142   guint32    offset;
 143 } SimpleTypeBlob;
 144
 145
 146 typedef struct
 147 {
 148   guint32        name;
 149
 150   guint          in                           : 1;
 151   guint          out                          : 1;
 152   guint          dipper                       : 1;
 153   guint          null_ok                      : 1;
 154   guint          optional                     : 1;
 155   guint          transfer_ownership           : 1;
 156   guint          transfer_container_ownership : 1;
 157   guint          return_value                 : 1;
 158   guint          reserved                     :24;
 159
 160   SimpleTypeBlob arg_type;
 161 } ArgBlob;
 162
 163 typedef struct
 164 {
 165   SimpleTypeBlob return_type;
 166
 167   guint          may_return_null              : 1;
 168   guint          caller_owns_return_value     : 1;
 169   guint          caller_owns_return_container : 1;
 170   guint          reserved                     :13;
 171
 172   guint16        n_arguments;
 173
 174   ArgBlob        arguments[];
 175 } SignatureBlob;
 176
 177 typedef struct
 178 {
 179   guint16 blob_type;  /* 1 */
 180
 181   guint   deprecated     : 1;
 182   guint   reserved       :15;
 183
 184   guint32 name;
 185 } CommonBlob;
 186
 187 typedef struct
 188 {
 189   guint16 blob_type;  /* 1 */
 190
 191   guint   deprecated     : 1;
 192   guint   setter         : 1;
 193   guint   getter         : 1;
 194   guint   constructor    : 1;
 195   guint   wraps_vfunc    : 1;
 196   guint   reserved       : 1;
 197   guint   index          :10;
 198
 199   guint32 name;
 200   guint32 symbol;
 201   guint32 signature;
 202 } FunctionBlob;
 203
 204 typedef struct
 205 {
 206   guint16 blob_type;  /* 2 */
 207
 208   guint   deprecated     : 1;
 209   guint   reserved       :15;
 210
 211   guint32 name;
 212   guint32 signature;
 213 } CallbackBlob;
 214
 215 typedef struct
 216 {
 217   guint pointer    :1;
 218   guint reserved   :2;
 219   guint tag        :5;
 220   guint8     reserved2;
 221   guint16    interface;
 222 } InterfaceTypeBlob;
 223
 224 typedef struct
 225 {
 226   guint pointer    :1;
 227   guint reserved   :2;
 228   guint tag        :5;
 229
 230   guint          zero_terminated :1;
 231   guint          has_length      :1;
 232   guint          reserved2       :6;
 233
 234   guint16        length;
 235
 236   SimpleTypeBlob type;
 237 } ArrayTypeBlob;
 238
 239 typedef struct
 240 {
 241   guint pointer    :1;
 242   guint reserved   :2;
 243   guint tag        :5;
 244
 245   guint8         reserved2;
 246   guint16        n_types;
 247
 248   SimpleTypeBlob type[];
 249 } ParamTypeBlob;
 250
 251 typedef struct
 252 {
 253   guint pointer    :1;
 254   guint reserved   :2;
 255   guint tag        :5;
 256
 257   guint8     reserved2;
 258   guint16    n_domains;
 259
 260   guint16    domains[];
 261 }  ErrorTypeBlob;
 262
 263 typedef struct
 264 {
 265   guint16 blob_type;  /* 10 */
 266
 267   guint   deprecated     : 1;
 268   guint   reserved       :15;
 269
 270   guint32 name;
 271
 272   guint32 get_quark;
 273   guint16 error_codes;
 274   guint16 reserved2;
 275 } ErrorDomainBlob;
 276
 277 typedef struct
 278 {
 279   guint   deprecated : 1;
 280   guint   reserved   :31;
 281   guint32 name;
 282   guint32 value;
 283 } ValueBlob;
 284
 285 typedef struct
 286 {
 287   guint32        name;
 288
 289   guint          readable : 1;
 290   guint          writable : 1;
 291   guint          reserved : 6;
 292   guint8         bits;
 293
 294   guint16        struct_offset;
 295
 296   SimpleTypeBlob type;
 297 } FieldBlob;
 298
 299 typedef struct
 300 {
 301   guint16 blob_type;
 302   guint   deprecated   : 1;
 303   guint   unregistered :15;
 304   guint32 name;
 305
 306   guint32 gtype_name;
 307   guint32 gtype_init;
 308 } RegisteredTypeBlob;
 309
 310 typedef struct
 311 {
 312   guint16   blob_type;
 313
 314   guint     deprecated   : 1;
 315   guint     unregistered : 1;
 316   guint     reserved     :14;
 317
 318   guint32   name;
 319
 320   guint32   gtype_name;
 321   guint32   gtype_init;
 322
 323   guint16   n_fields;
 324   guint16   n_methods;
 325
 326 #if 0
 327   /* variable-length parts of the blob */
 328   FieldBlob    fields[];
 329   FunctionBlob methods[];
 330 #endif
 331 } StructBlob;
 332
 333 typedef struct
 334 {
 335   guint16      blob_type;
 336   guint        deprecated    : 1;
 337   guint        unregistered  : 1;
 338   guint        discriminated : 1;
 339   guint        reserved      :13;
 340   guint32      name;
 341
 342   guint32      gtype_name;
 343   guint32      gtype_init;
 344
 345   guint16      n_fields;
 346   guint16      n_functions;
 347
 348   gint32       discriminator_offset;
 349   SimpleTypeBlob discriminator_type;
 350
 351 #if 0
 352   FieldBlob    fields[];
 353   FunctionBlob functions[];
 354   ConstantBlob discriminator_values[]
 355 #endif
 356 } UnionBlob;
 357
 358 typedef struct
 359 {
 360   guint16   blob_type;
 361
 362   guint     deprecated   : 1;
 363   guint     unregistered : 1;
 364   guint     reserved     :14;
 365
 366   guint32   name;
 367
 368   guint32   gtype_name;
 369   guint32   gtype_init;
 370
 371   guint16   n_values;
 372   guint16   reserved2;
 373
 374   ValueBlob values[];
 375 } EnumBlob;
 376
 377 typedef struct
 378 {
 379   guint32        name;
 380
 381   guint          deprecated     : 1;
 382   guint          readable       : 1;
 383   guint          writable       : 1;
 384   guint          construct      : 1;
 385   guint          construct_only : 1;
 386   guint          reserved       :27;
 387
 388   SimpleTypeBlob type;
 389
 390 } PropertyBlob;
 391
 392 typedef struct
 393 {
 394   guint   deprecated        : 1;
 395   guint   run_first         : 1;
 396   guint   run_last          : 1;
 397   guint   run_cleanup       : 1;
 398   guint   no_recurse        : 1;
 399   guint   detailed          : 1;
 400   guint   action            : 1;
 401   guint   no_hooks          : 1;
 402   guint   has_class_closure : 1;
 403   guint   true_stops_emit   : 1;
 404   guint   reserved          : 6;
 405
 406   guint16 class_closure;
 407
 408   guint32 name;
 409
 410   guint32 signature;
 411 } SignalBlob;
 412
 413 typedef struct
 414 {
 415   guint32 name;
 416
 417   guint   must_chain_up           : 1;
 418   guint   must_be_implemented     : 1;
 419   guint   must_not_be_implemented : 1;
 420   guint   class_closure           : 1;
 421   guint   reserved                :12;
 422   guint16 signal;
 423
 424   guint16 struct_offset;
 425   guint16 reserved2;
 426   guint32 signature;
 427 } VFuncBlob;
 428
 429 typedef struct
 430 {
 431   guint16   blob_type;  /* 7 */
 432   guint     deprecated   : 1;
 433   guint     reserved     :15;
 434   guint32   name;
 435
 436   guint32   gtype_name;
 437   guint32   gtype_init;
 438
 439   guint16   parent;
 440
 441   guint16   n_interfaces;
 442   guint16   n_fields;
 443   guint16   n_properties;
 444   guint16   n_methods;
 445   guint16   n_signals;
 446   guint16   n_vfuncs;
 447   guint16   n_constants;
 448
 449   guint16   interfaces[];
 450
 451 #if 0
 452   /* variable-length parts of the blob */
 453   FieldBlob           fields[];
 454   PropertyBlob        properties[];
 455   FunctionBlob        methods[];
 456   SignalBlob          signals[];
 457   VFuncBlob           vfuncs[];
 458   ConstantBlob        constants[];
 459 #endif
 460 } ObjectBlob;
 461
 462 typedef struct
 463 {
 464   guint16 blob_type;
 465   guint   deprecated   : 1;
 466   guint   reserved     :15;
 467   guint32 name;
 468
 469   guint32 gtype_name;
 470   guint32 gtype_init;
 471
 472   guint16 n_prerequisites;
 473   guint16 n_properties;
 474   guint16 n_methods;
 475   guint16 n_signals;
 476   guint16 n_vfuncs;
 477   guint16 n_constants;
 478
 479   guint16 prerequisites[];
 480
 481 #if 0
 482   /* variable-length parts of the blob */
 483   PropertyBlob        properties[];
 484   FunctionBlob        methods[];
 485   SignalBlob          signals[];
 486   VFuncBlob           vfuncs[];
 487   ConstantBlob        constants[];
 488 #endif
 489 } InterfaceBlob;
 490
 491
 492 typedef struct
 493 {
 494   guint16        blob_type;
 495   guint          deprecated   : 1;
 496   guint          reserved     :15;
 497   guint32        name;
 498
 499   SimpleTypeBlob type;
 500
 501   guint32        size;
 502   guint32        offset;
 503 } ConstantBlob;
 504
 505 typedef struct
 506 {
 507   guint32 offset;
 508   guint32 name;
 509   guint32 value;
 510 } AnnotationBlob;
 511
 512
 513 struct _GMetadata {
 514   guchar *data;
 515   gsize len;
 516   gboolean owns_memory;
 517   GMappedFile *mfile;
 518   GModule *module;
 519 };
 520
 521 DirEntry *g_metadata_get_dir_entry (GMetadata *metadata,
 522                                     guint16            index);
 523
 524 void      g_metadata_check_sanity (void);
 525
 526 #define   g_metadata_get_string(metadata,offset) ((const gchar*)&(metadata->data)[(offset)])
 527
 528
 529 typedef enum
 530 {
 531   G_METADATA_ERROR_INVALID,
 532   G_METADATA_ERROR_INVALID_HEADER,
 533   G_METADATA_ERROR_INVALID_DIRECTORY,
 534   G_METADATA_ERROR_INVALID_ENTRY,
 535   G_METADATA_ERROR_INVALID_BLOB
 536 } GMetadataError;
 537
 538 #define G_METADATA_ERROR (g_metadata_error_quark ())
 539
 540 GQuark g_metadata_error_quark (void);
 541
 542 gboolean g_metadata_validate (GMetadata  *metadata,
 543                               GError    **error);
 544
 545
 546 G_END_DECLS
 547
 548 #endif  /* __G_METADATA_H__ */
 549