gobject/gtype.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General
  15  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17 #ifndef __G_TYPE_H__
  18 #define __G_TYPE_H__
  19
  20 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  21 #error "Only <glib-object.h> can be included directly."
  22 #endif
  23
  24 #include        <glib.h>
  25
  26 G_BEGIN_DECLS
  27
  28 /* Basic Type Macros
  29  */
  30 /**
  31  * G_TYPE_FUNDAMENTAL:
  32  * @type: A #GType value.
  33  *
  34  * The fundamental type which is the ancestor of @type.
  35  * Fundamental types are types that serve as ultimate bases for the derived types,
  36  * thus they are the roots of distinct inheritance hierarchies.
  37  */
  38 #define G_TYPE_FUNDAMENTAL(type)        (g_type_fundamental (type))
  39 /**
  40  * G_TYPE_FUNDAMENTAL_MAX:
  41  *
  42  * An integer constant that represents the number of identifiers reserved
  43  * for types that are assigned at compile-time.
  44  */
  45 #define G_TYPE_FUNDAMENTAL_MAX          (255 << G_TYPE_FUNDAMENTAL_SHIFT)
  46
  47 /* Constant fundamental types,
  48  */
  49 /**
  50  * G_TYPE_INVALID:
  51  *
  52  * An invalid #GType used as error return value in some functions which return
  53  * a #GType.
  54  */
  55 #define G_TYPE_INVALID                  G_TYPE_MAKE_FUNDAMENTAL (0)
  56 /**
  57  * G_TYPE_NONE:
  58  *
  59  * A fundamental type which is used as a replacement for the C
  60  * void return type.
  61  */
  62 #define G_TYPE_NONE                     G_TYPE_MAKE_FUNDAMENTAL (1)
  63 /**
  64  * G_TYPE_INTERFACE:
  65  *
  66  * The fundamental type from which all interfaces are derived.
  67  */
  68 #define G_TYPE_INTERFACE                G_TYPE_MAKE_FUNDAMENTAL (2)
  69 /**
  70  * G_TYPE_CHAR:
  71  *
  72  * The fundamental type corresponding to #gchar.
  73  * The type designated by G_TYPE_CHAR is unconditionally an 8-bit signed integer.
  74  * This may or may not be the same type a the C type "gchar".
  75  */
  76 #define G_TYPE_CHAR                     G_TYPE_MAKE_FUNDAMENTAL (3)
  77 /**
  78  * G_TYPE_UCHAR:
  79  *
  80  * The fundamental type corresponding to #guchar.
  81  */
  82 #define G_TYPE_UCHAR                    G_TYPE_MAKE_FUNDAMENTAL (4)
  83 /**
  84  * G_TYPE_BOOLEAN:
  85  *
  86  * The fundamental type corresponding to #gboolean.
  87  */
  88 #define G_TYPE_BOOLEAN                  G_TYPE_MAKE_FUNDAMENTAL (5)
  89 /**
  90  * G_TYPE_INT:
  91  *
  92  * The fundamental type corresponding to #gint.
  93  */
  94 #define G_TYPE_INT                      G_TYPE_MAKE_FUNDAMENTAL (6)
  95 /**
  96  * G_TYPE_UINT:
  97  *
  98  * The fundamental type corresponding to #guint.
  99  */
 100 #define G_TYPE_UINT                     G_TYPE_MAKE_FUNDAMENTAL (7)
 101 /**
 102  * G_TYPE_LONG:
 103  *
 104  * The fundamental type corresponding to #glong.
 105  */
 106 #define G_TYPE_LONG                     G_TYPE_MAKE_FUNDAMENTAL (8)
 107 /**
 108  * G_TYPE_ULONG:
 109  *
 110  * The fundamental type corresponding to #gulong.
 111  */
 112 #define G_TYPE_ULONG                    G_TYPE_MAKE_FUNDAMENTAL (9)
 113 /**
 114  * G_TYPE_INT64:
 115  *
 116  * The fundamental type corresponding to #gint64.
 117  */
 118 #define G_TYPE_INT64                    G_TYPE_MAKE_FUNDAMENTAL (10)
 119 /**
 120  * G_TYPE_UINT64:
 121  *
 122  * The fundamental type corresponding to #guint64.
 123  */
 124 #define G_TYPE_UINT64                   G_TYPE_MAKE_FUNDAMENTAL (11)
 125 /**
 126  * G_TYPE_ENUM:
 127  *
 128  * The fundamental type from which all enumeration types are derived.
 129  */
 130 #define G_TYPE_ENUM                     G_TYPE_MAKE_FUNDAMENTAL (12)
 131 /**
 132  * G_TYPE_FLAGS:
 133  *
 134  * The fundamental type from which all flags types are derived.
 135  */
 136 #define G_TYPE_FLAGS                    G_TYPE_MAKE_FUNDAMENTAL (13)
 137 /**
 138  * G_TYPE_FLOAT:
 139  *
 140  * The fundamental type corresponding to #gfloat.
 141  */
 142 #define G_TYPE_FLOAT                    G_TYPE_MAKE_FUNDAMENTAL (14)
 143 /**
 144  * G_TYPE_DOUBLE:
 145  *
 146  * The fundamental type corresponding to #gdouble.
 147  */
 148 #define G_TYPE_DOUBLE                   G_TYPE_MAKE_FUNDAMENTAL (15)
 149 /**
 150  * G_TYPE_STRING:
 151  *
 152  * The fundamental type corresponding to nul-terminated C strings.
 153  */
 154 #define G_TYPE_STRING                   G_TYPE_MAKE_FUNDAMENTAL (16)
 155 /**
 156  * G_TYPE_POINTER:
 157  *
 158  * The fundamental type corresponding to #gpointer.
 159  */
 160 #define G_TYPE_POINTER                  G_TYPE_MAKE_FUNDAMENTAL (17)
 161 /**
 162  * G_TYPE_BOXED:
 163  *
 164  * The fundamental type from which all boxed types are derived.
 165  */
 166 #define G_TYPE_BOXED                    G_TYPE_MAKE_FUNDAMENTAL (18)
 167 /**
 168  * G_TYPE_PARAM:
 169  *
 170  * The fundamental type from which all #GParamSpec types are derived.
 171  */
 172 #define G_TYPE_PARAM                    G_TYPE_MAKE_FUNDAMENTAL (19)
 173 /**
 174  * G_TYPE_OBJECT:
 175  *
 176  * The fundamental type for #GObject.
 177  */
 178 #define G_TYPE_OBJECT                   G_TYPE_MAKE_FUNDAMENTAL (20)
 179 /**
 180  * G_TYPE_VARIANT:
 181  *
 182  * The fundamental type corresponding to #GVariant.
 183  *
 184  * All floating #GVariant instances passed through the #GType system are
 185  * consumed.
 186  *
 187  * Note that callbacks in closures, and signal handlers
 188  * for signals of return type %G_TYPE_VARIANT, must never return floating
 189  * variants.
 190  *
 191  * Note: GLib 2.24 did include a boxed type with this name. It was replaced
 192  * with this fundamental type in 2.26.
 193  *
 194  * Since: 2.26
 195  */
 196 #define G_TYPE_VARIANT                  G_TYPE_MAKE_FUNDAMENTAL (21)
 197
 198
 199 /* Reserved fundamental type numbers to create new fundamental
 200  * type IDs with G_TYPE_MAKE_FUNDAMENTAL().
 201  * Send email to gtk-devel-list@gnome.org for reservations.
 202  */
 203 /**
 204  * G_TYPE_FUNDAMENTAL_SHIFT:
 205  *
 206  * Shift value used in converting numbers to type IDs.
 207  */
 208 #define G_TYPE_FUNDAMENTAL_SHIFT        (2)
 209 /**
 210  * G_TYPE_MAKE_FUNDAMENTAL:
 211  * @x: the fundamental type number.
 212  *
 213  * Get the type ID for the fundamental type number @x.
 214  * Use g_type_fundamental_next() instead of this macro to create new fundamental
 215  * types.
 216  *
 217  * Returns: the GType
 218  */
 219 #define G_TYPE_MAKE_FUNDAMENTAL(x)      ((GType) ((x) << G_TYPE_FUNDAMENTAL_SHIFT))
 220 /**
 221  * G_TYPE_RESERVED_GLIB_FIRST:
 222  *
 223  * First fundamental type number to create a new fundamental type id with
 224  * G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib.
 225  */
 226 #define G_TYPE_RESERVED_GLIB_FIRST      (22)
 227 /**
 228  * G_TYPE_RESERVED_GLIB_LAST:
 229  *
 230  * Last fundamental type number reserved for GLib.
 231  */
 232 #define G_TYPE_RESERVED_GLIB_LAST       (31)
 233 /**
 234  * G_TYPE_RESERVED_BSE_FIRST:
 235  *
 236  * First fundamental type number to create a new fundamental type id with
 237  * G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE.
 238  */
 239 #define G_TYPE_RESERVED_BSE_FIRST       (32)
 240 /**
 241  * G_TYPE_RESERVED_BSE_LAST:
 242  *
 243  * Last fundamental type number reserved for BSE.
 244  */
 245 #define G_TYPE_RESERVED_BSE_LAST        (48)
 246 /**
 247  * G_TYPE_RESERVED_USER_FIRST:
 248  *
 249  * First available fundamental type number to create new fundamental
 250  * type id with G_TYPE_MAKE_FUNDAMENTAL().
 251  */
 252 #define G_TYPE_RESERVED_USER_FIRST      (49)
 253
 254
 255 /* Type Checking Macros
 256  */
 257 /**
 258  * G_TYPE_IS_FUNDAMENTAL:
 259  * @type: A #GType value.
 260  *
 261  * Checks if @type is a fundamental type.
 262  *
 263  * Returns: %TRUE on success.
 264  */
 265 #define G_TYPE_IS_FUNDAMENTAL(type)             ((type) <= G_TYPE_FUNDAMENTAL_MAX)
 266 /**
 267  * G_TYPE_IS_DERIVED:
 268  * @type: A #GType value.
 269  *
 270  * Checks if @type is derived (or in object-oriented terminology:
 271  * inherited) from another type (this holds true for all non-fundamental
 272  * types).
 273  *
 274  * Returns: %TRUE on success.
 275  */
 276 #define G_TYPE_IS_DERIVED(type)                 ((type) > G_TYPE_FUNDAMENTAL_MAX)
 277 /**
 278  * G_TYPE_IS_INTERFACE:
 279  * @type: A #GType value.
 280  *
 281  * Checks if @type is an interface type.
 282  * An interface type provides a pure API, the implementation
 283  * of which is provided by another type (which is then said to conform
 284  * to the interface).  GLib interfaces are somewhat analogous to Java
 285  * interfaces and C++ classes containing only pure virtual functions,
 286  * with the difference that GType interfaces are not derivable (but see
 287  * g_type_interface_add_prerequisite() for an alternative).
 288  *
 289  * Returns: %TRUE on success.
 290  */
 291 #define G_TYPE_IS_INTERFACE(type)               (G_TYPE_FUNDAMENTAL (type) == G_TYPE_INTERFACE)
 292 /**
 293  * G_TYPE_IS_CLASSED:
 294  * @type: A #GType value.
 295  *
 296  * Checks if @type is a classed type.
 297  *
 298  * Returns: %TRUE on success.
 299  */
 300 #define G_TYPE_IS_CLASSED(type)                 (g_type_test_flags ((type), G_TYPE_FLAG_CLASSED))
 301 /**
 302  * G_TYPE_IS_INSTANTIATABLE:
 303  * @type: A #GType value.
 304  *
 305  * Checks if @type can be instantiated.  Instantiation is the
 306  * process of creating an instance (object) of this type.
 307  *
 308  * Returns: %TRUE on success.
 309  */
 310 #define G_TYPE_IS_INSTANTIATABLE(type)          (g_type_test_flags ((type), G_TYPE_FLAG_INSTANTIATABLE))
 311 /**
 312  * G_TYPE_IS_DERIVABLE:
 313  * @type: A #GType value.
 314  *
 315  * Checks if @type is a derivable type.  A derivable type can
 316  * be used as the base class of a flat (single-level) class hierarchy.
 317  *
 318  * Returns: %TRUE on success.
 319  */
 320 #define G_TYPE_IS_DERIVABLE(type)               (g_type_test_flags ((type), G_TYPE_FLAG_DERIVABLE))
 321 /**
 322  * G_TYPE_IS_DEEP_DERIVABLE:
 323  * @type: A #GType value.
 324  *
 325  * Checks if @type is a deep derivable type.  A deep derivable type
 326  * can be used as the base class of a deep (multi-level) class hierarchy.
 327  *
 328  * Returns: %TRUE on success.
 329  */
 330 #define G_TYPE_IS_DEEP_DERIVABLE(type)          (g_type_test_flags ((type), G_TYPE_FLAG_DEEP_DERIVABLE))
 331 /**
 332  * G_TYPE_IS_ABSTRACT:
 333  * @type: A #GType value.
 334  *
 335  * Checks if @type is an abstract type.  An abstract type cannot be
 336  * instantiated and is normally used as an abstract base class for
 337  * derived classes.
 338  *
 339  * Returns: %TRUE on success.
 340  */
 341 #define G_TYPE_IS_ABSTRACT(type)                (g_type_test_flags ((type), G_TYPE_FLAG_ABSTRACT))
 342 /**
 343  * G_TYPE_IS_VALUE_ABSTRACT:
 344  * @type: A #GType value.
 345  *
 346  * Checks if @type is an abstract value type.  An abstract value type introduces
 347  * a value table, but can't be used for g_value_init() and is normally used as
 348  * an abstract base type for derived value types.
 349  *
 350  * Returns: %TRUE on success.
 351  */
 352 #define G_TYPE_IS_VALUE_ABSTRACT(type)          (g_type_test_flags ((type), G_TYPE_FLAG_VALUE_ABSTRACT))
 353 /**
 354  * G_TYPE_IS_VALUE_TYPE:
 355  * @type: A #GType value.
 356  *
 357  * Checks if @type is a value type and can be used with g_value_init().
 358  *
 359  * Returns: %TRUE on success.
 360  */
 361 #define G_TYPE_IS_VALUE_TYPE(type)              (g_type_check_is_value_type (type))
 362 /**
 363  * G_TYPE_HAS_VALUE_TABLE:
 364  * @type: A #GType value.
 365  *
 366  * Checks if @type has a #GTypeValueTable.
 367  *
 368  * Returns: %TRUE on success.
 369  */
 370 #define G_TYPE_HAS_VALUE_TABLE(type)            (g_type_value_table_peek (type) != NULL)
 371
 372
 373 /* Typedefs
 374  */
 375 /**
 376  * GType:
 377  *
 378  * A numerical value which represents the unique identifier of a registered
 379  * type.
 380  */
 381 #if     GLIB_SIZEOF_SIZE_T != GLIB_SIZEOF_LONG || !defined __cplusplus
 382 typedef gsize                           GType;
 383 #else   /* for historic reasons, C++ links against gulong GTypes */
 384 typedef gulong                          GType;
 385 #endif
 386 typedef struct _GValue                  GValue;
 387 typedef union  _GTypeCValue             GTypeCValue;
 388 typedef struct _GTypePlugin             GTypePlugin;
 389 typedef struct _GTypeClass              GTypeClass;
 390 typedef struct _GTypeInterface          GTypeInterface;
 391 typedef struct _GTypeInstance           GTypeInstance;
 392 typedef struct _GTypeInfo               GTypeInfo;
 393 typedef struct _GTypeFundamentalInfo    GTypeFundamentalInfo;
 394 typedef struct _GInterfaceInfo          GInterfaceInfo;
 395 typedef struct _GTypeValueTable         GTypeValueTable;
 396 typedef struct _GTypeQuery              GTypeQuery;
 397
 398
 399 /* Basic Type Structures
 400  */
 401 /**
 402  * GTypeClass:
 403  *
 404  * An opaque structure used as the base of all classes.
 405  */
 406 struct _GTypeClass
 407 {
 408   /*< private >*/
 409   GType g_type;
 410 };
 411 /**
 412  * GTypeInstance:
 413  *
 414  * An opaque structure used as the base of all type instances.
 415  */
 416 struct _GTypeInstance
 417 {
 418   /*< private >*/
 419   GTypeClass *g_class;
 420 };
 421 /**
 422  * GTypeInterface:
 423  *
 424  * An opaque structure used as the base of all interface types.
 425  */
 426 struct _GTypeInterface
 427 {
 428   /*< private >*/
 429   GType g_type;         /* iface type */
 430   GType g_instance_type;
 431 };
 432 /**
 433  * GTypeQuery:
 434  * @type: the #GType value of the type.
 435  * @type_name: the name of the type.
 436  * @class_size: the size of the class structure.
 437  * @instance_size: the size of the instance structure.
 438  *
 439  * A structure holding information for a specific type. It is
 440  * filled in by the g_type_query() function.
 441  */
 442 struct _GTypeQuery
 443 {
 444   GType         type;
 445   const gchar  *type_name;
 446   guint         class_size;
 447   guint         instance_size;
 448 };
 449
 450
 451 /* Casts, checks and accessors for structured types
 452  * usage of these macros is reserved to type implementations only
 453  */
 454 /*< protected >*/
 455 /**
 456  * G_TYPE_CHECK_INSTANCE:
 457  * @instance: Location of a #GTypeInstance structure.
 458  *
 459  * Checks if @instance is a valid #GTypeInstance structure,
 460  * otherwise issues a warning and returns %FALSE.
 461  *
 462  * This macro should only be used in type implementations.
 463  *
 464  * Returns: %TRUE on success.
 465  */
 466 #define G_TYPE_CHECK_INSTANCE(instance)                         (_G_TYPE_CHI ((GTypeInstance*) (instance)))
 467 /**
 468  * G_TYPE_CHECK_INSTANCE_CAST:
 469  * @instance: Location of a #GTypeInstance structure.
 470  * @g_type: The type to be returned.
 471  * @c_type: The corresponding C type of @g_type.
 472  *
 473  * Checks that @instance is an instance of the type identified by @g_type
 474  * and issues a warning if this is not the case. Returns @instance casted
 475  * to a pointer to @c_type.
 476  *
 477  * This macro should only be used in type implementations.
 478  */
 479 #define G_TYPE_CHECK_INSTANCE_CAST(instance, g_type, c_type)    (_G_TYPE_CIC ((instance), (g_type), c_type))
 480 /**
 481  * G_TYPE_CHECK_INSTANCE_TYPE:
 482  * @instance: Location of a #GTypeInstance structure.
 483  * @g_type: The type to be checked
 484  *
 485  * Checks if @instance is an instance of the type identified by @g_type.
 486  *
 487  * This macro should only be used in type implementations.
 488  *
 489  * Returns: %TRUE on success.
 490  */
 491 #define G_TYPE_CHECK_INSTANCE_TYPE(instance, g_type)            (_G_TYPE_CIT ((instance), (g_type)))
 492 /**
 493  * G_TYPE_INSTANCE_GET_CLASS:
 494  * @instance: Location of the #GTypeInstance structure.
 495  * @g_type: The #GType of the class to be returned.
 496  * @c_type: The C type of the class structure.
 497  *
 498  * Get the class structure of a given @instance, casted
 499  * to a specified ancestor type @g_type of the instance.
 500  *
 501  * Note that while calling a GInstanceInitFunc(), the class pointer gets
 502  * modified, so it might not always return the expected pointer.
 503  *
 504  * This macro should only be used in type implementations.
 505  *
 506  * Returns: a pointer to the class structure
 507  */
 508 #define G_TYPE_INSTANCE_GET_CLASS(instance, g_type, c_type)     (_G_TYPE_IGC ((instance), (g_type), c_type))
 509 /**
 510  * G_TYPE_INSTANCE_GET_INTERFACE:
 511  * @instance: Location of the #GTypeInstance structure.
 512  * @g_type: The #GType of the interface to be returned.
 513  * @c_type: The C type of the interface structure.
 514  *
 515  * Get the interface structure for interface @g_type of a given @instance.
 516  *
 517  * This macro should only be used in type implementations.
 518  *
 519  * Returns: a pointer to the interface structure
 520  */
 521 #define G_TYPE_INSTANCE_GET_INTERFACE(instance, g_type, c_type) (_G_TYPE_IGI ((instance), (g_type), c_type))
 522 /**
 523  * G_TYPE_CHECK_CLASS_CAST:
 524  * @g_class: Location of a #GTypeClass structure.
 525  * @g_type: The type to be returned.
 526  * @c_type: The corresponding C type of class structure of @g_type.
 527  *
 528  * Checks that @g_class is a class structure of the type identified by @g_type
 529  * and issues a warning if this is not the case. Returns @g_class casted
 530  * to a pointer to @c_type.
 531  *
 532  * This macro should only be used in type implementations.
 533  */
 534 #define G_TYPE_CHECK_CLASS_CAST(g_class, g_type, c_type)        (_G_TYPE_CCC ((g_class), (g_type), c_type))
 535 /**
 536  * G_TYPE_CHECK_CLASS_TYPE:
 537  * @g_class: Location of a #GTypeClass structure.
 538  * @g_type: The type to be checked.
 539  *
 540  * Checks if @g_class is a class structure of the type identified by
 541  * @g_type.
 542  *
 543  * This macro should only be used in type implementations.
 544  *
 545  * Returns: %TRUE on success.
 546  */
 547 #define G_TYPE_CHECK_CLASS_TYPE(g_class, g_type)                (_G_TYPE_CCT ((g_class), (g_type)))
 548 /**
 549  * G_TYPE_CHECK_VALUE:
 550  * @value: a #GValue
 551  *
 552  * Checks if @value has been initialized to hold values
 553  * of a value type.
 554  *
 555  * This macro should only be used in type implementations.
 556  *
 557  * Returns: %TRUE on success.
 558  */
 559 #define G_TYPE_CHECK_VALUE(value)                               (_G_TYPE_CHV ((value)))
 560 /**
 561  * G_TYPE_CHECK_VALUE_TYPE:
 562  * @value: a #GValue
 563  * @g_type: The type to be checked.
 564  *
 565  * Checks if @value has been initialized to hold values
 566  * of type @g_type.
 567  *
 568  * This macro should only be used in type implementations.
 569  *
 570  * Returns: %TRUE on success.
 571  */
 572 #define G_TYPE_CHECK_VALUE_TYPE(value, g_type)                  (_G_TYPE_CVH ((value), (g_type)))
 573 /**
 574  * G_TYPE_FROM_INSTANCE:
 575  * @instance: Location of a valid #GTypeInstance structure.
 576  *
 577  * Get the type identifier from a given @instance structure.
 578  *
 579  * This macro should only be used in type implementations.
 580  *
 581  * Returns: the #GType
 582  */
 583 #define G_TYPE_FROM_INSTANCE(instance)                          (G_TYPE_FROM_CLASS (((GTypeInstance*) (instance))->g_class))
 584 /**
 585  * G_TYPE_FROM_CLASS:
 586  * @g_class: Location of a valid #GTypeClass structure.
 587  *
 588  * Get the type identifier from a given @class structure.
 589  *
 590  * This macro should only be used in type implementations.
 591  *
 592  * Returns: the #GType
 593  */
 594 #define G_TYPE_FROM_CLASS(g_class)                              (((GTypeClass*) (g_class))->g_type)
 595 /**
 596  * G_TYPE_FROM_INTERFACE:
 597  * @g_iface: Location of a valid #GTypeInterface structure.
 598  *
 599  * Get the type identifier from a given @interface structure.
 600  *
 601  * This macro should only be used in type implementations.
 602  *
 603  * Returns: the #GType
 604  */
 605 #define G_TYPE_FROM_INTERFACE(g_iface)                          (((GTypeInterface*) (g_iface))->g_type)
 606
 607 /**
 608  * G_TYPE_INSTANCE_GET_PRIVATE:
 609  * @instance: the instance of a type deriving from @private_type.
 610  * @g_type: the type identifying which private data to retrieve.
 611  * @c_type: The C type for the private structure.
 612  *
 613  * Gets the private structure for a particular type.
 614  * The private structure must have been registered in the
 615  * class_init function with g_type_class_add_private().
 616  *
 617  * This macro should only be used in type implementations.
 618  *
 619  * Since: 2.4
 620  * Returns: a pointer to the private data structure.
 621  */
 622 #define G_TYPE_INSTANCE_GET_PRIVATE(instance, g_type, c_type)   ((c_type*) g_type_instance_get_private ((GTypeInstance*) (instance), (g_type)))
 623
 624 /**
 625  * G_TYPE_CLASS_GET_PRIVATE:
 626  * @klass: the class of a type deriving from @private_type.
 627  * @g_type: the type identifying which private data to retrieve.
 628  * @c_type: The C type for the private structure.
 629  *
 630  * Gets the private class structure for a particular type.
 631  * The private structure must have been registered in the
 632  * get_type() function with g_type_add_class_private().
 633  *
 634  * This macro should only be used in type implementations.
 635  *
 636  * Since: 2.24
 637  * Returns: a pointer to the private data structure.
 638  */
 639 #define G_TYPE_CLASS_GET_PRIVATE(klass, g_type, c_type)   ((c_type*) g_type_class_get_private ((GTypeClass*) (klass), (g_type)))
 640
 641 /**
 642  * GTypeDebugFlags:
 643  * @G_TYPE_DEBUG_NONE: Print no messages.
 644  * @G_TYPE_DEBUG_OBJECTS: Print messages about object bookkeeping.
 645  * @G_TYPE_DEBUG_SIGNALS: Print messages about signal emissions.
 646  * @G_TYPE_DEBUG_MASK: Mask covering all debug flags.
 647  *
 648  * These flags used to be passed to g_type_init_with_debug_flags() which
 649  * is now deprecated.
 650  *
 651  * If you need to enable debugging features, use the GOBJECT_DEBUG
 652  * environment variable.
 653  *
 654  * Deprecated: 2.36: g_type_init() is now done automatically
 655  */
 656 typedef enum    /*< skip >*/
 657 {
 658   G_TYPE_DEBUG_NONE     = 0,
 659   G_TYPE_DEBUG_OBJECTS  = 1 << 0,
 660   G_TYPE_DEBUG_SIGNALS  = 1 << 1,
 661   G_TYPE_DEBUG_MASK     = 0x03
 662 } GTypeDebugFlags;
 663
 664
 665 /* --- prototypes --- */
 666 GLIB_DEPRECATED_IN_2_36
 667 void                  g_type_init                    (void);
 668 GLIB_DEPRECATED_IN_2_36
 669 void                  g_type_init_with_debug_flags   (GTypeDebugFlags  debug_flags);
 670 GLIB_AVAILABLE_IN_ALL
 671 const gchar *         g_type_name                    (GType            type);
 672 GLIB_AVAILABLE_IN_ALL
 673 GQuark                g_type_qname                   (GType            type);
 674 GLIB_AVAILABLE_IN_ALL
 675 GType                 g_type_from_name               (const gchar     *name);
 676 GLIB_AVAILABLE_IN_ALL
 677 GType                 g_type_parent                  (GType            type);
 678 GLIB_AVAILABLE_IN_ALL
 679 guint                 g_type_depth                   (GType            type);
 680 GLIB_AVAILABLE_IN_ALL
 681 GType                 g_type_next_base               (GType            leaf_type,
 682                                                       GType            root_type);
 683 GLIB_AVAILABLE_IN_ALL
 684 gboolean              g_type_is_a                    (GType            type,
 685                                                       GType            is_a_type);
 686 GLIB_AVAILABLE_IN_ALL
 687 gpointer              g_type_class_ref               (GType            type);
 688 GLIB_AVAILABLE_IN_ALL
 689 gpointer              g_type_class_peek              (GType            type);
 690 GLIB_AVAILABLE_IN_ALL
 691 gpointer              g_type_class_peek_static       (GType            type);
 692 GLIB_AVAILABLE_IN_ALL
 693 void                  g_type_class_unref             (gpointer         g_class);
 694 GLIB_AVAILABLE_IN_ALL
 695 gpointer              g_type_class_peek_parent       (gpointer         g_class);
 696 GLIB_AVAILABLE_IN_ALL
 697 gpointer              g_type_interface_peek          (gpointer         instance_class,
 698                                                       GType            iface_type);
 699 GLIB_AVAILABLE_IN_ALL
 700 gpointer              g_type_interface_peek_parent   (gpointer         g_iface);
 701
 702 GLIB_AVAILABLE_IN_ALL
 703 gpointer              g_type_default_interface_ref   (GType            g_type);
 704 GLIB_AVAILABLE_IN_ALL
 705 gpointer              g_type_default_interface_peek  (GType            g_type);
 706 GLIB_AVAILABLE_IN_ALL
 707 void                  g_type_default_interface_unref (gpointer         g_iface);
 708
 709 /* g_free() the returned arrays */
 710 GLIB_AVAILABLE_IN_ALL
 711 GType*                g_type_children                (GType            type,
 712                                                       guint           *n_children);
 713 GLIB_AVAILABLE_IN_ALL
 714 GType*                g_type_interfaces              (GType            type,
 715                                                       guint           *n_interfaces);
 716
 717 /* per-type _static_ data */
 718 GLIB_AVAILABLE_IN_ALL
 719 void                  g_type_set_qdata               (GType            type,
 720                                                       GQuark           quark,
 721                                                       gpointer         data);
 722 GLIB_AVAILABLE_IN_ALL
 723 gpointer              g_type_get_qdata               (GType            type,
 724                                                       GQuark           quark);
 725 GLIB_AVAILABLE_IN_ALL
 726 void                  g_type_query                   (GType            type,
 727                                                       GTypeQuery      *query);
 728
 729
 730 /* --- type registration --- */
 731 /**
 732  * GBaseInitFunc:
 733  * @g_class: The #GTypeClass structure to initialize.
 734  *
 735  * A callback function used by the type system to do base initialization
 736  * of the class structures of derived types. It is called as part of the
 737  * initialization process of all derived classes and should reallocate
 738  * or reset all dynamic class members copied over from the parent class.
 739  * For example, class members (such as strings) that are not sufficiently
 740  * handled by a plain memory copy of the parent class into the derived class
 741  * have to be altered. See GClassInitFunc() for a discussion of the class
 742  * intialization process.
 743  */
 744 typedef void   (*GBaseInitFunc)              (gpointer         g_class);
 745 /**
 746  * GBaseFinalizeFunc:
 747  * @g_class: The #GTypeClass structure to finalize.
 748  *
 749  * A callback function used by the type system to finalize those portions
 750  * of a derived types class structure that were setup from the corresponding
 751  * GBaseInitFunc() function. Class finalization basically works the inverse
 752  * way in which class intialization is performed.
 753  * See GClassInitFunc() for a discussion of the class intialization process.
 754  */
 755 typedef void   (*GBaseFinalizeFunc)          (gpointer         g_class);
 756 /**
 757  * GClassInitFunc:
 758  * @g_class: The #GTypeClass structure to initialize.
 759  * @class_data: The @class_data member supplied via the #GTypeInfo structure.
 760  *
 761  * A callback function used by the type system to initialize the class
 762  * of a specific type. This function should initialize all static class
 763  * members.
 764  * The initialization process of a class involves:
 765  * <itemizedlist>
 766  * <listitem><para>
 767  *      1 - Copying common members from the parent class over to the
 768  *      derived class structure.
 769  * </para></listitem>
 770  * <listitem><para>
 771  *      2 -  Zero initialization of the remaining members not copied
 772  *      over from the parent class.
 773  * </para></listitem>
 774  * <listitem><para>
 775  *      3 - Invocation of the GBaseInitFunc() initializers of all parent
 776  *      types and the class' type.
 777  * </para></listitem>
 778  * <listitem><para>
 779  *      4 - Invocation of the class' GClassInitFunc() initializer.
 780  * </para></listitem>
 781  * </itemizedlist>
 782  * Since derived classes are partially initialized through a memory copy
 783  * of the parent class, the general rule is that GBaseInitFunc() and
 784  * GBaseFinalizeFunc() should take care of necessary reinitialization
 785  * and release of those class members that were introduced by the type
 786  * that specified these GBaseInitFunc()/GBaseFinalizeFunc().
 787  * GClassInitFunc() should only care about initializing static
 788  * class members, while dynamic class members (such as allocated strings
 789  * or reference counted resources) are better handled by a GBaseInitFunc()
 790  * for this type, so proper initialization of the dynamic class members
 791  * is performed for class initialization of derived types as well.
 792  * An example may help to correspond the intend of the different class
 793  * initializers:
 794  *
 795  * |[
 796  * typedef struct {
 797  *   GObjectClass parent_class;
 798  *   gint         static_integer;
 799  *   gchar       *dynamic_string;
 800  * } TypeAClass;
 801  * static void
 802  * type_a_base_class_init (TypeAClass *class)
 803  * {
 804  *   class->dynamic_string = g_strdup ("some string");
 805  * }
 806  * static void
 807  * type_a_base_class_finalize (TypeAClass *class)
 808  * {
 809  *   g_free (class->dynamic_string);
 810  * }
 811  * static void
 812  * type_a_class_init (TypeAClass *class)
 813  * {
 814  *   class->static_integer = 42;
 815  * }
 816  *
 817  * typedef struct {
 818  *   TypeAClass   parent_class;
 819  *   gfloat       static_float;
 820  *   GString     *dynamic_gstring;
 821  * } TypeBClass;
 822  * static void
 823  * type_b_base_class_init (TypeBClass *class)
 824  * {
 825  *   class->dynamic_gstring = g_string_new ("some other string");
 826  * }
 827  * static void
 828  * type_b_base_class_finalize (TypeBClass *class)
 829  * {
 830  *   g_string_free (class->dynamic_gstring);
 831  * }
 832  * static void
 833  * type_b_class_init (TypeBClass *class)
 834  * {
 835  *   class->static_float = 3.14159265358979323846;
 836  * }
 837  * ]|
 838  * Initialization of TypeBClass will first cause initialization of
 839  * TypeAClass (derived classes reference their parent classes, see
 840  * g_type_class_ref() on this).
 841  * Initialization of TypeAClass roughly involves zero-initializing its fields,
 842  * then calling its GBaseInitFunc() type_a_base_class_init() to allocate
 843  * its dynamic members (dynamic_string), and finally calling its GClassInitFunc()
 844  * type_a_class_init() to initialize its static members (static_integer).
 845  * The first step in the initialization process of TypeBClass is then
 846  * a plain memory copy of the contents of TypeAClass into TypeBClass and
 847  * zero-initialization of the remaining fields in TypeBClass.
 848  * The dynamic members of TypeAClass within TypeBClass now need
 849  * reinitialization which is performed by calling type_a_base_class_init()
 850  * with an argument of TypeBClass.
 851  * After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init()
 852  * is called to allocate the dynamic members of TypeBClass (dynamic_gstring),
 853  * and finally the GClassInitFunc() of TypeBClass, type_b_class_init(),
 854  * is called to complete the initialization process with the static members
 855  * (static_float).
 856  * Corresponding finalization counter parts to the GBaseInitFunc() functions
 857  * have to be provided to release allocated resources at class finalization
 858  * time.
 859  */
 860 typedef void   (*GClassInitFunc)             (gpointer         g_class,
 861                                               gpointer         class_data);
 862 /**
 863  * GClassFinalizeFunc:
 864  * @g_class: The #GTypeClass structure to finalize.
 865  * @class_data: The @class_data member supplied via the #GTypeInfo structure.
 866  *
 867  * A callback function used by the type system to finalize a class.
 868  * This function is rarely needed, as dynamically allocated class resources
 869  * should be handled by GBaseInitFunc() and GBaseFinalizeFunc().
 870  * Also, specification of a GClassFinalizeFunc() in the #GTypeInfo
 871  * structure of a static type is invalid, because classes of static types
 872  * will never be finalized (they are artificially kept alive when their
 873  * reference count drops to zero).
 874  */
 875 typedef void   (*GClassFinalizeFunc)         (gpointer         g_class,
 876                                               gpointer         class_data);
 877 /**
 878  * GInstanceInitFunc:
 879  * @instance: The instance to initialize.
 880  * @g_class: The class of the type the instance is created for.
 881  *
 882  * A callback function used by the type system to initialize a new
 883  * instance of a type. This function initializes all instance members and
 884  * allocates any resources required by it.
 885  *
 886  * Initialization of a derived instance involves calling all its parent
 887  * types instance initializers, so the class member of the instance
 888  * is altered during its initialization to always point to the class that
 889  * belongs to the type the current initializer was introduced for.
 890  *
 891  * The extended members of @instance are guaranteed to have been filled with
 892  * zeros before this function is called.
 893  */
 894 typedef void   (*GInstanceInitFunc)          (GTypeInstance   *instance,
 895                                               gpointer         g_class);
 896 /**
 897  * GInterfaceInitFunc:
 898  * @g_iface: The interface structure to initialize.
 899  * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure.
 900  *
 901  * A callback function used by the type system to initialize a new
 902  * interface.  This function should initialize all internal data and
 903  * allocate any resources required by the interface.
 904  *
 905  * The members of @iface_data are guaranteed to have been filled with
 906  * zeros before this function is called.
 907  */
 908 typedef void   (*GInterfaceInitFunc)         (gpointer         g_iface,
 909                                               gpointer         iface_data);
 910 /**
 911  * GInterfaceFinalizeFunc:
 912  * @g_iface: The interface structure to finalize.
 913  * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure.
 914  *
 915  * A callback function used by the type system to finalize an interface.
 916  * This function should destroy any internal data and release any resources
 917  * allocated by the corresponding GInterfaceInitFunc() function.
 918  */
 919 typedef void   (*GInterfaceFinalizeFunc)     (gpointer         g_iface,
 920                                               gpointer         iface_data);
 921 /**
 922  * GTypeClassCacheFunc:
 923  * @cache_data: data that was given to the g_type_add_class_cache_func() call
 924  * @g_class: The #GTypeClass structure which is unreferenced
 925  *
 926  * A callback function which is called when the reference count of a class
 927  * drops to zero. It may use g_type_class_ref() to prevent the class from
 928  * being freed. You should not call g_type_class_unref() from a
 929  * #GTypeClassCacheFunc function to prevent infinite recursion, use
 930  * g_type_class_unref_uncached() instead.
 931  *
 932  * The functions have to check the class id passed in to figure
 933  * whether they actually want to cache the class of this type, since all
 934  * classes are routed through the same #GTypeClassCacheFunc chain.
 935  *
 936  * Returns: %TRUE to stop further #GTypeClassCacheFuncs from being
 937  *  called, %FALSE to continue.
 938  */
 939 typedef gboolean (*GTypeClassCacheFunc)      (gpointer         cache_data,
 940                                               GTypeClass      *g_class);
 941 /**
 942  * GTypeInterfaceCheckFunc:
 943  * @check_data: data passed to g_type_add_interface_check().
 944  * @g_iface: the interface that has been initialized
 945  *
 946  * A callback called after an interface vtable is initialized.
 947  * See g_type_add_interface_check().
 948  *
 949  * Since: 2.4
 950  */
 951 typedef void     (*GTypeInterfaceCheckFunc)  (gpointer         check_data,
 952                                               gpointer         g_iface);
 953 /**
 954  * GTypeFundamentalFlags:
 955  * @G_TYPE_FLAG_CLASSED: Indicates a classed type.
 956  * @G_TYPE_FLAG_INSTANTIATABLE: Indicates an instantiable type (implies classed).
 957  * @G_TYPE_FLAG_DERIVABLE: Indicates a flat derivable type.
 958  * @G_TYPE_FLAG_DEEP_DERIVABLE: Indicates a deep derivable type (implies derivable).
 959  *
 960  * Bit masks used to check or determine specific characteristics of a
 961  * fundamental type.
 962  */
 963 typedef enum    /*< skip >*/
 964 {
 965   G_TYPE_FLAG_CLASSED           = (1 << 0),
 966   G_TYPE_FLAG_INSTANTIATABLE    = (1 << 1),
 967   G_TYPE_FLAG_DERIVABLE         = (1 << 2),
 968   G_TYPE_FLAG_DEEP_DERIVABLE    = (1 << 3)
 969 } GTypeFundamentalFlags;
 970 /**
 971  * GTypeFlags:
 972  * @G_TYPE_FLAG_ABSTRACT: Indicates an abstract type. No instances can be
 973  *  created for an abstract type.
 974  * @G_TYPE_FLAG_VALUE_ABSTRACT: Indicates an abstract value type, i.e. a type
 975  *  that introduces a value table, but can't be used for
 976  *  g_value_init().
 977  *
 978  * Bit masks used to check or determine characteristics of a type.
 979  */
 980 typedef enum    /*< skip >*/
 981 {
 982   G_TYPE_FLAG_ABSTRACT          = (1 << 4),
 983   G_TYPE_FLAG_VALUE_ABSTRACT    = (1 << 5)
 984 } GTypeFlags;
 985 /**
 986  * GTypeInfo:
 987  * @class_size: Size of the class structure (required for interface, classed and instantiatable types).
 988  * @base_init: Location of the base initialization function (optional).
 989  * @base_finalize: Location of the base finalization function (optional).
 990  * @class_init: Location of the class initialization function for
 991  *  classed and instantiatable types. Location of the default vtable
 992  *  inititalization function for interface types. (optional) This function
 993  *  is used both to fill in virtual functions in the class or default vtable,
 994  *  and to do type-specific setup such as registering signals and object
 995  *  properties.
 996  * @class_finalize: Location of the class finalization function for
 997  *  classed and instantiatable types. Location of the default vtable
 998  *  finalization function for interface types. (optional)
 999  * @class_data: User-supplied data passed to the class init/finalize functions.
1000  * @instance_size: Size of the instance (object) structure (required for instantiatable types only).
1001  * @n_preallocs: Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now.
1002  * @instance_init: Location of the instance initialization function (optional, for instantiatable types only).
1003  * @value_table: A #GTypeValueTable function table for generic handling of GValues of this type (usually only
1004  *  useful for fundamental types).
1005  *
1006  * This structure is used to provide the type system with the information
1007  * required to initialize and destruct (finalize) a type's class and
1008  * its instances.
1009  * The initialized structure is passed to the g_type_register_static() function
1010  * (or is copied into the provided #GTypeInfo structure in the
1011  * g_type_plugin_complete_type_info()). The type system will perform a deep
1012  * copy of this structure, so its memory does not need to be persistent
1013  * across invocation of g_type_register_static().
1014  */
1015 struct _GTypeInfo
1016 {
1017   /* interface types, classed types, instantiated types */
1018   guint16                class_size;
1019
1020   GBaseInitFunc          base_init;
1021   GBaseFinalizeFunc      base_finalize;
1022
1023   /* interface types, classed types, instantiated types */
1024   GClassInitFunc         class_init;
1025   GClassFinalizeFunc     class_finalize;
1026   gconstpointer          class_data;
1027
1028   /* instantiated types */
1029   guint16                instance_size;
1030   guint16                n_preallocs;
1031   GInstanceInitFunc      instance_init;
1032
1033   /* value handling */
1034   const GTypeValueTable *value_table;
1035 };
1036 /**
1037  * GTypeFundamentalInfo:
1038  * @type_flags: #GTypeFundamentalFlags describing the characteristics of the fundamental type
1039  *
1040  * A structure that provides information to the type system which is
1041  * used specifically for managing fundamental types.
1042  */
1043 struct _GTypeFundamentalInfo
1044 {
1045   GTypeFundamentalFlags  type_flags;
1046 };
1047 /**
1048  * GInterfaceInfo:
1049  * @interface_init: location of the interface initialization function
1050  * @interface_finalize: location of the interface finalization function
1051  * @interface_data: user-supplied data passed to the interface init/finalize functions
1052  *
1053  * A structure that provides information to the type system which is
1054  * used specifically for managing interface types.
1055  */
1056 struct _GInterfaceInfo
1057 {
1058   GInterfaceInitFunc     interface_init;
1059   GInterfaceFinalizeFunc interface_finalize;
1060   gpointer               interface_data;
1061 };
1062 /**
1063  * GTypeValueTable:
1064  * @value_init: Default initialize @values contents by poking values
1065  *  directly into the value->data array. The data array of
1066  *  the #GValue passed into this function was zero-filled
1067  *  with <function>memset()</function>, so no care has to
1068  *  be taken to free any
1069  *  old contents. E.g. for the implementation of a string
1070  *  value that may never be %NULL, the implementation might
1071  *  look like:
1072  *  |[
1073  *  value->data[0].v_pointer = g_strdup ("");
1074  *  ]|
1075  * @value_free: Free any old contents that might be left in the
1076  *  data array of the passed in @value. No resources may
1077  *  remain allocated through the #GValue contents after
1078  *  this function returns. E.g. for our above string type:
1079  *  |[
1080  *  // only free strings without a specific flag for static storage
1081  *  if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
1082  *    g_free (value->data[0].v_pointer);
1083  *  ]|
1084  * @value_copy: @dest_value is a #GValue with zero-filled data section
1085  *  and @src_value is a properly setup #GValue of same or
1086  *  derived type.
1087  *  The purpose of this function is to copy the contents of
1088  *  @src_value into @dest_value in a way, that even after
1089  *  @src_value has been freed, the contents of @dest_value
1090  *  remain valid. String type example:
1091  *  |[
1092  *  dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer);
1093  *  ]|
1094  * @value_peek_pointer: If the value contents fit into a pointer, such as objects
1095  *  or strings, return this pointer, so the caller can peek at
1096  *  the current contents. To extend on our above string example:
1097  *  |[
1098  *  return value->data[0].v_pointer;
1099  *  ]|
1100  * @collect_format: A string format describing how to collect the contents of
1101  *  this value bit-by-bit. Each character in the format represents
1102  *  an argument to be collected, and the characters themselves indicate
1103  *  the type of the argument. Currently supported arguments are:
1104  *  <variablelist>
1105  *  <varlistentry><term /><listitem><para>
1106  *  'i' - Integers. passed as collect_values[].v_int.
1107  *  </para></listitem></varlistentry>
1108  *  <varlistentry><term /><listitem><para>
1109  *  'l' - Longs. passed as collect_values[].v_long.
1110  *  </para></listitem></varlistentry>
1111  *  <varlistentry><term /><listitem><para>
1112  *  'd' - Doubles. passed as collect_values[].v_double.
1113  *  </para></listitem></varlistentry>
1114  *  <varlistentry><term /><listitem><para>
1115  *  'p' - Pointers. passed as collect_values[].v_pointer.
1116  *  </para></listitem></varlistentry>
1117  *  </variablelist>
1118  *  It should be noted that for variable argument list construction,
1119  *  ANSI C promotes every type smaller than an integer to an int, and
1120  *  floats to doubles. So for collection of short int or char, 'i'
1121  *  needs to be used, and for collection of floats 'd'.
1122  * @collect_value: The collect_value() function is responsible for converting the
1123  *  values collected from a variable argument list into contents
1124  *  suitable for storage in a GValue. This function should setup
1125  *  @value similar to value_init(); e.g. for a string value that
1126  *  does not allow %NULL pointers, it needs to either spew an error,
1127  *  or do an implicit conversion by storing an empty string.
1128  *  The @value passed in to this function has a zero-filled data
1129  *  array, so just like for value_init() it is guaranteed to not
1130  *  contain any old contents that might need freeing.
1131  *  @n_collect_values is exactly the string length of @collect_format,
1132  *  and @collect_values is an array of unions #GTypeCValue with
1133  *  length @n_collect_values, containing the collected values
1134  *  according to @collect_format.
1135  *  @collect_flags is an argument provided as a hint by the caller.
1136  *  It may contain the flag %G_VALUE_NOCOPY_CONTENTS indicating,
1137  *  that the collected value contents may be considered "static"
1138  *  for the duration of the @value lifetime.
1139  *  Thus an extra copy of the contents stored in @collect_values is
1140  *  not required for assignment to @value.
1141  *  For our above string example, we continue with:
1142  *  |[
1143  *  if (!collect_values[0].v_pointer)
1144  *    value->data[0].v_pointer = g_strdup ("");
1145  *  else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
1146  *  {
1147  *    value->data[0].v_pointer = collect_values[0].v_pointer;
1148  *    // keep a flag for the value_free() implementation to not free this string
1149  *    value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
1150  *  }
1151  *  else
1152  *    value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer);
1153  *  return NULL;
1154  *  ]|
1155  *  It should be noted, that it is generally a bad idea to follow the
1156  *  #G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to
1157  *  reentrancy requirements and reference count assertions performed
1158  *  by the signal emission code, reference counts should always be
1159  *  incremented for reference counted contents stored in the value->data
1160  *  array.  To deviate from our string example for a moment, and taking
1161  *  a look at an exemplary implementation for collect_value() of
1162  *  #GObject:
1163  *  |[
1164  *  if (collect_values[0].v_pointer)
1165  *  {
1166  *    GObject *object = G_OBJECT (collect_values[0].v_pointer);
1167  *    // never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types
1168  *    value->data[0].v_pointer = g_object_ref (object);
1169  *    return NULL;
1170  *  }
1171  *  else
1172  *    return g_strdup_printf ("Object passed as invalid NULL pointer");
1173  *  }
1174  *  ]|
1175  *  The reference count for valid objects is always incremented,
1176  *  regardless of @collect_flags. For invalid objects, the example
1177  *  returns a newly allocated string without altering @value.
1178  *  Upon success, collect_value() needs to return %NULL. If, however,
1179  *  an error condition occurred, collect_value() may spew an
1180  *  error by returning a newly allocated non-%NULL string, giving
1181  *  a suitable description of the error condition.
1182  *  The calling code makes no assumptions about the @value
1183  *  contents being valid upon error returns, @value
1184  *  is simply thrown away without further freeing. As such, it is
1185  *  a good idea to not allocate #GValue contents, prior to returning
1186  *  an error, however, collect_values() is not obliged to return
1187  *  a correctly setup @value for error returns, simply because
1188  *  any non-%NULL return is considered a fatal condition so further
1189  *  program behaviour is undefined.
1190  * @lcopy_format: Format description of the arguments to collect for @lcopy_value,
1191  *  analogous to @collect_format. Usually, @lcopy_format string consists
1192  *  only of 'p's to provide lcopy_value() with pointers to storage locations.
1193  * @lcopy_value: This function is responsible for storing the @value contents into
1194  *  arguments passed through a variable argument list which got
1195  *  collected into @collect_values according to @lcopy_format.
1196  *  @n_collect_values equals the string length of @lcopy_format,
1197  *  and @collect_flags may contain %G_VALUE_NOCOPY_CONTENTS.
1198  *  In contrast to collect_value(), lcopy_value() is obliged to
1199  *  always properly support %G_VALUE_NOCOPY_CONTENTS.
1200  *  Similar to collect_value() the function may prematurely abort
1201  *  by returning a newly allocated string describing an error condition.
1202  *  To complete the string example:
1203  *  |[
1204  *  gchar **string_p = collect_values[0].v_pointer;
1205  *  if (!string_p)
1206  *    return g_strdup_printf ("string location passed as NULL");
1207  *  if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
1208  *    *string_p = value->data[0].v_pointer;
1209  *  else
1210  *    *string_p = g_strdup (value->data[0].v_pointer);
1211  *  ]|
1212  *  And an illustrative version of lcopy_value() for
1213  *  reference-counted types:
1214  *  |[
1215  *  GObject **object_p = collect_values[0].v_pointer;
1216  *  if (!object_p)
1217  *    return g_strdup_printf ("object location passed as NULL");
1218  *  if (!value->data[0].v_pointer)
1219  *    *object_p = NULL;
1220  *  else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) /&ast; always honour &ast;/
1221  *    *object_p = value->data[0].v_pointer;
1222  *  else
1223  *    *object_p = g_object_ref (value->data[0].v_pointer);
1224  *  return NULL;
1225  *  ]|
1226  *
1227  * The #GTypeValueTable provides the functions required by the #GValue implementation,
1228  * to serve as a container for values of a type.
1229  */
1230
1231 struct _GTypeValueTable
1232 {
1233   void     (*value_init)         (GValue       *value);
1234   void     (*value_free)         (GValue       *value);
1235   void     (*value_copy)         (const GValue *src_value,
1236                                   GValue       *dest_value);
1237   /* varargs functionality (optional) */
1238   gpointer (*value_peek_pointer) (const GValue *value);
1239   const gchar *collect_format;
1240   gchar*   (*collect_value)      (GValue       *value,
1241                                   guint         n_collect_values,
1242                                   GTypeCValue  *collect_values,
1243                                   guint         collect_flags);
1244   const gchar *lcopy_format;
1245   gchar*   (*lcopy_value)        (const GValue *value,
1246                                   guint         n_collect_values,
1247                                   GTypeCValue  *collect_values,
1248                                   guint         collect_flags);
1249 };
1250 GLIB_AVAILABLE_IN_ALL
1251 GType g_type_register_static            (GType                       parent_type,
1252                                          const gchar                *type_name,
1253                                          const GTypeInfo            *info,
1254                                          GTypeFlags                  flags);
1255 GLIB_AVAILABLE_IN_ALL
1256 GType g_type_register_static_simple     (GType                       parent_type,
1257                                          const gchar                *type_name,
1258                                          guint                       class_size,
1259                                          GClassInitFunc              class_init,
1260                                          guint                       instance_size,
1261                                          GInstanceInitFunc           instance_init,
1262                                          GTypeFlags                  flags);
1263
1264 GLIB_AVAILABLE_IN_ALL
1265 GType g_type_register_dynamic           (GType                       parent_type,
1266                                          const gchar                *type_name,
1267                                          GTypePlugin                *plugin,
1268                                          GTypeFlags                  flags);
1269 GLIB_AVAILABLE_IN_ALL
1270 GType g_type_register_fundamental       (GType                       type_id,
1271                                          const gchar                *type_name,
1272                                          const GTypeInfo            *info,
1273                                          const GTypeFundamentalInfo *finfo,
1274                                          GTypeFlags                  flags);
1275 GLIB_AVAILABLE_IN_ALL
1276 void  g_type_add_interface_static       (GType                       instance_type,
1277                                          GType                       interface_type,
1278                                          const GInterfaceInfo       *info);
1279 GLIB_AVAILABLE_IN_ALL
1280 void  g_type_add_interface_dynamic      (GType                       instance_type,
1281                                          GType                       interface_type,
1282                                          GTypePlugin                *plugin);
1283 GLIB_AVAILABLE_IN_ALL
1284 void  g_type_interface_add_prerequisite (GType                       interface_type,
1285                                          GType                       prerequisite_type);
1286 GLIB_AVAILABLE_IN_ALL
1287 GType*g_type_interface_prerequisites    (GType                       interface_type,
1288                                          guint                      *n_prerequisites);
1289 GLIB_AVAILABLE_IN_ALL
1290 void     g_type_class_add_private       (gpointer                    g_class,
1291                                          gsize                       private_size);
1292 GLIB_AVAILABLE_IN_2_38
1293 gint     g_type_add_instance_private    (GType                       class_type,
1294                                          gsize                       private_size);
1295 GLIB_AVAILABLE_IN_ALL
1296 gpointer g_type_instance_get_private    (GTypeInstance              *instance,
1297                                          GType                       private_type);
1298 GLIB_AVAILABLE_IN_2_38
1299 void     g_type_class_adjust_private_offset (gpointer                g_class,
1300                                              gint                   *private_size_or_offset);
1301
1302 GLIB_AVAILABLE_IN_ALL
1303 void      g_type_add_class_private      (GType                       class_type,
1304                                          gsize                       private_size);
1305 GLIB_AVAILABLE_IN_ALL
1306 gpointer  g_type_class_get_private      (GTypeClass                 *klass,
1307                                          GType                       private_type);
1308 GLIB_AVAILABLE_IN_2_38
1309 gint      g_type_class_get_instance_private_offset (gpointer         g_class);
1310
1311 GLIB_AVAILABLE_IN_2_34
1312 void      g_type_ensure                 (GType                       type);
1313 GLIB_AVAILABLE_IN_2_36
1314 guint     g_type_get_type_registration_serial (void);
1315
1316
1317 /* --- GType boilerplate --- */
1318 /**
1319  * G_DEFINE_TYPE:
1320  * @TN: The name of the new type, in Camel case.
1321  * @t_n: The name of the new type, in lowercase, with words
1322  *  separated by '_'.
1323  * @T_P: The #GType of the parent type.
1324  *
1325  * A convenience macro for type implementations, which declares a
1326  * class initialization function, an instance initialization function (see #GTypeInfo for information about
1327  * these) and a static variable named @t_n<!-- -->_parent_class pointing to the parent class. Furthermore, it defines
1328  * a *_get_type() function. See G_DEFINE_TYPE_EXTENDED() for an example.
1329  *
1330  * Since: 2.4
1331  */
1332 #define G_DEFINE_TYPE(TN, t_n, T_P)                         G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
1333 /**
1334  * G_DEFINE_TYPE_WITH_CODE:
1335  * @TN: The name of the new type, in Camel case.
1336  * @t_n: The name of the new type in lowercase, with words separated by '_'.
1337  * @T_P: The #GType of the parent type.
1338  * @_C_: Custom code that gets inserted in the *_get_type() function.
1339  *
1340  * A convenience macro for type implementations.
1341  * Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the
1342  * *_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().
1343  * See G_DEFINE_TYPE_EXTENDED() for an example.
1344  *
1345  * Since: 2.4
1346  */
1347 #define G_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_)          _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, 0) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1348 /**
1349  * G_DEFINE_TYPE_WITH_PRIVATE:
1350  * @TN: The name of the new type, in Camel case.
1351  * @t_n: The name of the new type, in lowercase, with words
1352  *  separated by '_'.
1353  * @T_P: The #GType of the parent type.
1354  *
1355  * A convenience macro for type implementations, which declares a
1356  * class initialization function, an instance initialization function (see #GTypeInfo for information about
1357  * these), a static variable named @t_n<!-- -->_parent_class pointing to the parent class, and adds private
1358  * instance data to the type. Furthermore, it defines a *_get_type() function. See G_DEFINE_TYPE_EXTENDED()
1359  * for an example.
1360  *
1361  * Note that private structs added with this macros must have a struct
1362  * name of the form <replaceable>@TN</replaceable>Private.
1363  *
1364  * Since: 2.38
1365  */
1366 #define G_DEFINE_TYPE_WITH_PRIVATE(TN, t_n, T_P)            G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, G_ADD_PRIVATE (TN))
1367 /**
1368  * G_DEFINE_ABSTRACT_TYPE:
1369  * @TN: The name of the new type, in Camel case.
1370  * @t_n: The name of the new type, in lowercase, with words
1371  *  separated by '_'.
1372  * @T_P: The #GType of the parent type.
1373  *
1374  * A convenience macro for type implementations.
1375  * Similar to G_DEFINE_TYPE(), but defines an abstract type.
1376  * See G_DEFINE_TYPE_EXTENDED() for an example.
1377  *
1378  * Since: 2.4
1379  */
1380 #define G_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P)                G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
1381 /**
1382  * G_DEFINE_ABSTRACT_TYPE_WITH_CODE:
1383  * @TN: The name of the new type, in Camel case.
1384  * @t_n: The name of the new type, in lowercase, with words
1385  *  separated by '_'.
1386  * @T_P: The #GType of the parent type.
1387  * @_C_: Custom code that gets inserted in the @type_name_get_type() function.
1388  *
1389  * A convenience macro for type implementations.
1390  * Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and allows you to
1391  * insert custom code into the *_get_type() function, e.g. interface implementations
1392  * via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example.
1393  *
1394  * Since: 2.4
1395  */
1396 #define G_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1397 /**
1398  * G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE:
1399  * @TN: The name of the new type, in Camel case.
1400  * @t_n: The name of the new type, in lowercase, with words
1401  *  separated by '_'.
1402  * @T_P: The #GType of the parent type.
1403  *
1404  * Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type.
1405  * See G_DEFINE_TYPE_EXTENDED() for an example.
1406  *
1407  * Since: 2.38
1408  */
1409 #define G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(TN, t_n, T_P)   G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, G_ADD_PRIVATE (TN))
1410 /**
1411  * G_DEFINE_TYPE_EXTENDED:
1412  * @TN: The name of the new type, in Camel case.
1413  * @t_n: The name of the new type, in lowercase, with words
1414  *    separated by '_'.
1415  * @T_P: The #GType of the parent type.
1416  * @_f_: #GTypeFlags to pass to g_type_register_static()
1417  * @_C_: Custom code that gets inserted in the *_get_type() function.
1418  *
1419  * The most general convenience macro for type implementations, on which
1420  * G_DEFINE_TYPE(), etc are based.
1421  *
1422  * |[
1423  * G_DEFINE_TYPE_EXTENDED (GtkGadget,
1424  *                         gtk_gadget,
1425  *                         GTK_TYPE_WIDGET,
1426  *                         0,
1427  *                         G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
1428  *                                                gtk_gadget_gizmo_init));
1429  * ]|
1430  * expands to
1431  * |[
1432  * static void     gtk_gadget_init       (GtkGadget      *self);
1433  * static void     gtk_gadget_class_init (GtkGadgetClass *klass);
1434  * static gpointer gtk_gadget_parent_class = NULL;
1435  * static void     gtk_gadget_class_intern_init (gpointer klass)
1436  * {
1437  *   gtk_gadget_parent_class = g_type_class_peek_parent (klass);
1438  *   gtk_gadget_class_init ((GtkGadgetClass*) klass);
1439  * }
1440  *
1441  * GType
1442  * gtk_gadget_get_type (void)
1443  * {
1444  *   static volatile gsize g_define_type_id__volatile = 0;
1445  *   if (g_once_init_enter (&g_define_type_id__volatile))
1446  *     {
1447  *       GType g_define_type_id =
1448  *         g_type_register_static_simple (GTK_TYPE_WIDGET,
1449  *                                        g_intern_static_string ("GtkGadget"),
1450  *                                        sizeof (GtkGadgetClass),
1451  *                                        (GClassInitFunc) gtk_gadget_class_intern_init,
1452  *                                        sizeof (GtkGadget),
1453  *                                        (GInstanceInitFunc) gtk_gadget_init,
1454  *                                        0);
1455  *       {
1456  *         const GInterfaceInfo g_implement_interface_info = {
1457  *           (GInterfaceInitFunc) gtk_gadget_gizmo_init
1458  *         };
1459  *         g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
1460  *       }
1461  *       g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
1462  *     }
1463  *   return g_define_type_id__volatile;
1464  * }
1465  * ]|
1466  * The only pieces which have to be manually provided are the definitions of
1467  * the instance and class structure and the definitions of the instance and
1468  * class init functions.
1469  *
1470  * Since: 2.4
1471  */
1472 #define G_DEFINE_TYPE_EXTENDED(TN, t_n, T_P, _f_, _C_)      _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, _f_) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1473
1474 /**
1475  * G_DEFINE_INTERFACE:
1476  * @TN: The name of the new type, in Camel case.
1477  * @t_n: The name of the new type, in lowercase, with words separated by '_'.
1478  * @T_P: The #GType of the prerequisite type for the interface, or 0
1479  * (%G_TYPE_INVALID) for no prerequisite type.
1480  *
1481  * A convenience macro for #GTypeInterface definitions, which declares
1482  * a default vtable initialization function and defines a *_get_type()
1483  * function.
1484  *
1485  * The macro expects the interface initialization function to have the
1486  * name `t_n ## _default_init`, and the interface structure to have the
1487  * name `TN ## Interface`.
1488  *
1489  * Since: 2.24
1490  */
1491 #define G_DEFINE_INTERFACE(TN, t_n, T_P)                    G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, ;)
1492
1493 /**
1494  * G_DEFINE_INTERFACE_WITH_CODE:
1495  * @TN: The name of the new type, in Camel case.
1496  * @t_n: The name of the new type, in lowercase, with words separated by '_'.
1497  * @T_P: The #GType of the prerequisite type for the interface, or 0
1498  * (%G_TYPE_INVALID) for no prerequisite type.
1499  * @_C_: Custom code that gets inserted in the *_get_type() function.
1500  *
1501  * A convenience macro for #GTypeInterface definitions. Similar to
1502  * G_DEFINE_INTERFACE(), but allows you to insert custom code into the
1503  * *_get_type() function, e.g. additional interface implementations
1504  * via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. See
1505  * G_DEFINE_TYPE_EXTENDED() for a similar example using
1506  * G_DEFINE_TYPE_WITH_CODE().
1507  *
1508  * Since: 2.24
1509  */
1510 #define G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, _C_)     _G_DEFINE_INTERFACE_EXTENDED_BEGIN(TN, t_n, T_P) {_C_;} _G_DEFINE_INTERFACE_EXTENDED_END()
1511
1512 /**
1513  * G_IMPLEMENT_INTERFACE:
1514  * @TYPE_IFACE: The #GType of the interface to add
1515  * @iface_init: The interface init function
1516  *
1517  * A convenience macro to ease interface addition in the @_C_ section
1518  * of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
1519  * See G_DEFINE_TYPE_EXTENDED() for an example.
1520  *
1521  * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1522  * macros, since it depends on variable names from those macros.
1523  *
1524  * Since: 2.4
1525  */
1526 #define G_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init)       { \
1527   const GInterfaceInfo g_implement_interface_info = { \
1528     (GInterfaceInitFunc) iface_init, NULL, NULL \
1529   }; \
1530   g_type_add_interface_static (g_define_type_id, TYPE_IFACE, &g_implement_interface_info); \
1531 }
1532
1533 /**
1534  * G_ADD_PRIVATE:
1535  * @TypeName: the name of the type in CamelCase
1536  *
1537  * A convenience macro to ease adding private data to instances of a new type
1538  * in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or
1539  * G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
1540  *
1541  * For instance:
1542  *
1543  * |[
1544  *   typedef struct _MyObject MyObject;
1545  *   typedef struct _MyObjectClass MyObjectClass;
1546  *
1547  *   typedef struct {
1548  *     gint foo;
1549  *     gint bar;
1550  *   } MyObjectPrivate;
1551  *
1552  *   G_DEFINE_TYPE_WITH_CODE (MyObject, my_object, G_TYPE_OBJECT,
1553  *                            G_ADD_PRIVATE (MyObject))
1554  * ]|
1555  *
1556  * Will add MyObjectPrivate as the private data to any instance of the MyObject
1557  * type.
1558  *
1559  * G_DEFINE_TYPE_* macros will automatically create a private function
1560  * based on the arguments to this macro, which can be used to safely
1561  * retrieve the private data from an instance of the type; for instance:
1562  *
1563  * |[
1564  *   gint
1565  *   my_object_get_foo (MyObject *obj)
1566  *   {
1567  *     MyObjectPrivate *priv = my_object_get_instance_private (obj);
1568  *
1569  *     return priv->foo;
1570  *   }
1571  *
1572  *   void
1573  *   my_object_set_bar (MyObject *obj,
1574  *                      gint      bar)
1575  *   {
1576  *     MyObjectPrivate *priv = my_object_get_instance_private (obj);
1577  *
1578  *     if (priv->bar != bar)
1579  *       priv->bar = bar;
1580  *   }
1581  * ]|
1582  *
1583  * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1584  * macros, since it depends on variable names from those macros.
1585  *
1586  * Also note that private structs added with these macros must have a struct
1587  * name of the form <replaceable>TypeName</replaceable>Private.
1588  *
1589  * Since: 2.38
1590  */
1591 #define G_ADD_PRIVATE(TypeName) { \
1592   TypeName##_private_offset = \
1593     g_type_add_instance_private (g_define_type_id, sizeof (TypeName##Private)); \
1594 }
1595
1596 /**
1597  * G_PRIVATE_OFFSET:
1598  * @TypeName: the name of the type in CamelCase
1599  * @field: the name of the field in the private data structure
1600  *
1601  * Evaluates to the offset of the @field inside the instance private data
1602  * structure for @TypeName.
1603  *
1604  * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1605  * and G_ADD_PRIVATE() macros, since it depends on variable names from
1606  * those macros.
1607  *
1608  * Since: 2.38
1609  */
1610 #define G_PRIVATE_OFFSET(TypeName, field) \
1611   (TypeName##_private_offset + (G_STRUCT_OFFSET (TypeName##Private, field)))
1612
1613 /**
1614  * G_PRIVATE_FIELD_P:
1615  * @TypeName: the name of the type in CamelCase
1616  * @inst: the instance of @TypeName you wish to access
1617  * @field_name: the name of the field in the private data structure
1618  *
1619  * Evaluates to a pointer to the @field_name inside the @inst private data
1620  * structure for @TypeName.
1621  *
1622  * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1623  * and G_ADD_PRIVATE() macros, since it depends on variable names from
1624  * those macros.
1625  *
1626  * Since: 2.38
1627  */
1628 #define G_PRIVATE_FIELD_P(TypeName, inst, field_name) \
1629   G_STRUCT_MEMBER_P (inst, G_PRIVATE_OFFSET (TypeName, field_name))
1630
1631 /**
1632  * G_PRIVATE_FIELD:
1633  * @TypeName: the name of the type in CamelCase
1634  * @inst: the instance of @TypeName you wish to access
1635  * @field_type: the type of the field in the private data structure
1636  * @field_name: the name of the field in the private data structure
1637  *
1638  * Evaluates to the @field_name inside the @inst private data
1639  * structure for @TypeName.
1640  *
1641  * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1642  * and G_ADD_PRIVATE() macros, since it depends on variable names from
1643  * those macros.
1644  *
1645  * Since: 2.38
1646  */
1647 #define G_PRIVATE_FIELD(TypeName, inst, field_type, field_name) \
1648   G_STRUCT_MEMBER (field_type, inst, G_PRIVATE_OFFSET (TypeName, field_name))
1649
1650 /* we need to have this macro under conditional expansion, as it references
1651  * a function that has been added in 2.38. see bug:
1652  * https://bugzilla.gnome.org/show_bug.cgi?id=703191
1653  */
1654 #if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38
1655 #define _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
1656 static void     type_name##_class_intern_init (gpointer klass) \
1657 { \
1658   type_name##_parent_class = g_type_class_peek_parent (klass); \
1659   if (TypeName##_private_offset != 0) \
1660     g_type_class_adjust_private_offset (klass, &TypeName##_private_offset); \
1661   type_name##_class_init ((TypeName##Class*) klass); \
1662 }
1663
1664 #else
1665 #define _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
1666 static void     type_name##_class_intern_init (gpointer klass) \
1667 { \
1668   type_name##_parent_class = g_type_class_peek_parent (klass); \
1669   type_name##_class_init ((TypeName##Class*) klass); \
1670 }
1671 #endif /* GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38 */
1672
1673 #define _G_DEFINE_TYPE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PARENT, flags) \
1674 \
1675 static void     type_name##_init              (TypeName        *self); \
1676 static void     type_name##_class_init        (TypeName##Class *klass); \
1677 static gpointer type_name##_parent_class = NULL; \
1678 static gint     TypeName##_private_offset; \
1679 \
1680 _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
1681 \
1682 G_GNUC_UNUSED \
1683 static inline gpointer \
1684 type_name##_get_instance_private (TypeName *self) \
1685 { \
1686   return (G_STRUCT_MEMBER_P (self, TypeName##_private_offset)); \
1687 } \
1688 \
1689 GType \
1690 type_name##_get_type (void) \
1691 { \
1692   static volatile gsize g_define_type_id__volatile = 0; \
1693   if (g_once_init_enter (&g_define_type_id__volatile))  \
1694     { \
1695       GType g_define_type_id = \
1696         g_type_register_static_simple (TYPE_PARENT, \
1697                                        g_intern_static_string (#TypeName), \
1698                                        sizeof (TypeName##Class), \
1699                                        (GClassInitFunc) type_name##_class_intern_init, \
1700                                        sizeof (TypeName), \
1701                                        (GInstanceInitFunc) type_name##_init, \
1702                                        (GTypeFlags) flags); \
1703       { /* custom code follows */
1704 #define _G_DEFINE_TYPE_EXTENDED_END()   \
1705         /* following custom code */     \
1706       }                                 \
1707       g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
1708     }                                   \
1709   return g_define_type_id__volatile;    \
1710 } /* closes type_name##_get_type() */
1711
1712 #define _G_DEFINE_INTERFACE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PREREQ) \
1713 \
1714 static void     type_name##_default_init        (TypeName##Interface *klass); \
1715 \
1716 GType \
1717 type_name##_get_type (void) \
1718 { \
1719   static volatile gsize g_define_type_id__volatile = 0; \
1720   if (g_once_init_enter (&g_define_type_id__volatile))  \
1721     { \
1722       GType g_define_type_id = \
1723         g_type_register_static_simple (G_TYPE_INTERFACE, \
1724                                        g_intern_static_string (#TypeName), \
1725                                        sizeof (TypeName##Interface), \
1726                                        (GClassInitFunc)type_name##_default_init, \
1727                                        0, \
1728                                        (GInstanceInitFunc)NULL, \
1729                                        (GTypeFlags) 0); \
1730       if (TYPE_PREREQ) \
1731         g_type_interface_add_prerequisite (g_define_type_id, TYPE_PREREQ); \
1732       { /* custom code follows */
1733 #define _G_DEFINE_INTERFACE_EXTENDED_END()      \
1734         /* following custom code */             \
1735       }                                         \
1736       g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
1737     }                                           \
1738   return g_define_type_id__volatile;                    \
1739 } /* closes type_name##_get_type() */
1740
1741 /**
1742  * G_DEFINE_BOXED_TYPE:
1743  * @TypeName: The name of the new type, in Camel case.
1744  * @type_name: The name of the new type, in lowercase, with words
1745  *  separated by '_'.
1746  * @copy_func: the #GBoxedCopyFunc for the new type
1747  * @free_func: the #GBoxedFreeFunc for the new type
1748  *
1749  * A convenience macro for boxed type implementations, which defines a
1750  * type_name_get_type() function registering the boxed type.
1751  *
1752  * Since: 2.26
1753  */
1754 #define G_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) G_DEFINE_BOXED_TYPE_WITH_CODE (TypeName, type_name, copy_func, free_func, {})
1755 /**
1756  * G_DEFINE_BOXED_TYPE_WITH_CODE:
1757  * @TypeName: The name of the new type, in Camel case.
1758  * @type_name: The name of the new type, in lowercase, with words
1759  *  separated by '_'.
1760  * @copy_func: the #GBoxedCopyFunc for the new type
1761  * @free_func: the #GBoxedFreeFunc for the new type
1762  * @_C_: Custom code that gets inserted in the *_get_type() function.
1763  *
1764  * A convenience macro for boxed type implementations.
1765  * Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the
1766  * type_name_get_type() function, e.g. to register value transformations with
1767  * g_value_register_transform_func().
1768  *
1769  * Since: 2.26
1770  */
1771 #define G_DEFINE_BOXED_TYPE_WITH_CODE(TypeName, type_name, copy_func, free_func, _C_) _G_DEFINE_BOXED_TYPE_BEGIN (TypeName, type_name, copy_func, free_func) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1772
1773 /* Only use this in non-C++ on GCC >= 2.7, except for Darwin/ppc64.
1774  * See https://bugzilla.gnome.org/show_bug.cgi?id=647145
1775  */
1776 #if !defined (__cplusplus) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)) && !(defined (__APPLE__) && defined (__ppc64__))
1777 #define _G_DEFINE_BOXED_TYPE_BEGIN(TypeName, type_name, copy_func, free_func) \
1778 GType \
1779 type_name##_get_type (void) \
1780 { \
1781   static volatile gsize g_define_type_id__volatile = 0; \
1782   if (g_once_init_enter (&g_define_type_id__volatile))  \
1783     { \
1784       GType (* _g_register_boxed) \
1785         (const gchar *, \
1786          union \
1787            { \
1788              TypeName * (*do_copy_type) (TypeName *); \
1789              TypeName * (*do_const_copy_type) (const TypeName *); \
1790              GBoxedCopyFunc do_copy_boxed; \
1791            } __attribute__((__transparent_union__)), \
1792          union \
1793            { \
1794              void (* do_free_type) (TypeName *); \
1795              GBoxedFreeFunc do_free_boxed; \
1796            } __attribute__((__transparent_union__)) \
1797         ) = g_boxed_type_register_static; \
1798       GType g_define_type_id = \
1799         _g_register_boxed (g_intern_static_string (#TypeName), copy_func, free_func); \
1800       { /* custom code follows */
1801 #else
1802 #define _G_DEFINE_BOXED_TYPE_BEGIN(TypeName, type_name, copy_func, free_func) \
1803 GType \
1804 type_name##_get_type (void) \
1805 { \
1806   static volatile gsize g_define_type_id__volatile = 0; \
1807   if (g_once_init_enter (&g_define_type_id__volatile))  \
1808     { \
1809       GType g_define_type_id = \
1810         g_boxed_type_register_static (g_intern_static_string (#TypeName), \
1811                                       (GBoxedCopyFunc) copy_func, \
1812                                       (GBoxedFreeFunc) free_func); \
1813       { /* custom code follows */
1814 #endif /* __GNUC__ */
1815
1816 /**
1817  * G_DEFINE_POINTER_TYPE:
1818  * @TypeName: The name of the new type, in Camel case.
1819  * @type_name: The name of the new type, in lowercase, with words
1820  *  separated by '_'.
1821  *
1822  * A convenience macro for pointer type implementations, which defines a
1823  * type_name_get_type() function registering the pointer type.
1824  *
1825  * Since: 2.26
1826  */
1827 #define G_DEFINE_POINTER_TYPE(TypeName, type_name) G_DEFINE_POINTER_TYPE_WITH_CODE (TypeName, type_name, {})
1828 /**
1829  * G_DEFINE_POINTER_TYPE_WITH_CODE:
1830  * @TypeName: The name of the new type, in Camel case.
1831  * @type_name: The name of the new type, in lowercase, with words
1832  *  separated by '_'.
1833  * @_C_: Custom code that gets inserted in the *_get_type() function.
1834  *
1835  * A convenience macro for pointer type implementations.
1836  * Similar to G_DEFINE_POINTER_TYPE(), but allows to insert custom code into the
1837  * type_name_get_type() function.
1838  *
1839  * Since: 2.26
1840  */
1841 #define G_DEFINE_POINTER_TYPE_WITH_CODE(TypeName, type_name, _C_) _G_DEFINE_POINTER_TYPE_BEGIN (TypeName, type_name) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1842
1843 #define _G_DEFINE_POINTER_TYPE_BEGIN(TypeName, type_name) \
1844 GType \
1845 type_name##_get_type (void) \
1846 { \
1847   static volatile gsize g_define_type_id__volatile = 0; \
1848   if (g_once_init_enter (&g_define_type_id__volatile))  \
1849     { \
1850       GType g_define_type_id = \
1851         g_pointer_type_register_static (g_intern_static_string (#TypeName)); \
1852       { /* custom code follows */
1853
1854 /* --- protected (for fundamental type implementations) --- */
1855 GLIB_AVAILABLE_IN_ALL
1856 GTypePlugin*     g_type_get_plugin              (GType               type);
1857 GLIB_AVAILABLE_IN_ALL
1858 GTypePlugin*     g_type_interface_get_plugin    (GType               instance_type,
1859                                                  GType               interface_type);
1860 GLIB_AVAILABLE_IN_ALL
1861 GType            g_type_fundamental_next        (void);
1862 GLIB_AVAILABLE_IN_ALL
1863 GType            g_type_fundamental             (GType               type_id);
1864 GLIB_AVAILABLE_IN_ALL
1865 GTypeInstance*   g_type_create_instance         (GType               type);
1866 GLIB_AVAILABLE_IN_ALL
1867 void             g_type_free_instance           (GTypeInstance      *instance);
1868
1869 GLIB_AVAILABLE_IN_ALL
1870 void             g_type_add_class_cache_func    (gpointer            cache_data,
1871                                                  GTypeClassCacheFunc cache_func);
1872 GLIB_AVAILABLE_IN_ALL
1873 void             g_type_remove_class_cache_func (gpointer            cache_data,
1874                                                  GTypeClassCacheFunc cache_func);
1875 GLIB_AVAILABLE_IN_ALL
1876 void             g_type_class_unref_uncached    (gpointer            g_class);
1877
1878 GLIB_AVAILABLE_IN_ALL
1879 void             g_type_add_interface_check     (gpointer                check_data,
1880                                                  GTypeInterfaceCheckFunc check_func);
1881 GLIB_AVAILABLE_IN_ALL
1882 void             g_type_remove_interface_check  (gpointer                check_data,
1883                                                  GTypeInterfaceCheckFunc check_func);
1884
1885 GLIB_AVAILABLE_IN_ALL
1886 GTypeValueTable* g_type_value_table_peek        (GType               type);
1887
1888
1889 /*< private >*/
1890 GLIB_AVAILABLE_IN_ALL
1891 gboolean         g_type_check_instance          (GTypeInstance      *instance) G_GNUC_PURE;
1892 GLIB_AVAILABLE_IN_ALL
1893 GTypeInstance*   g_type_check_instance_cast     (GTypeInstance      *instance,
1894                                                  GType               iface_type);
1895 GLIB_AVAILABLE_IN_ALL
1896 gboolean         g_type_check_instance_is_a     (GTypeInstance      *instance,
1897                                                  GType               iface_type) G_GNUC_PURE;
1898 GLIB_AVAILABLE_IN_ALL
1899 GTypeClass*      g_type_check_class_cast        (GTypeClass         *g_class,
1900                                                  GType               is_a_type);
1901 GLIB_AVAILABLE_IN_ALL
1902 gboolean         g_type_check_class_is_a        (GTypeClass         *g_class,
1903                                                  GType               is_a_type) G_GNUC_PURE;
1904 GLIB_AVAILABLE_IN_ALL
1905 gboolean         g_type_check_is_value_type     (GType               type) G_GNUC_CONST;
1906 GLIB_AVAILABLE_IN_ALL
1907 gboolean         g_type_check_value             (GValue             *value) G_GNUC_PURE;
1908 GLIB_AVAILABLE_IN_ALL
1909 gboolean         g_type_check_value_holds       (GValue             *value,
1910                                                  GType               type) G_GNUC_PURE;
1911 GLIB_AVAILABLE_IN_ALL
1912 gboolean         g_type_test_flags              (GType               type,
1913                                                  guint               flags) G_GNUC_CONST;
1914
1915
1916 /* --- debugging functions --- */
1917 GLIB_AVAILABLE_IN_ALL
1918 const gchar *    g_type_name_from_instance      (GTypeInstance  *instance);
1919 GLIB_AVAILABLE_IN_ALL
1920 const gchar *    g_type_name_from_class         (GTypeClass     *g_class);
1921
1922
1923 /* --- implementation bits --- */
1924 #ifndef G_DISABLE_CAST_CHECKS
1925 #  define _G_TYPE_CIC(ip, gt, ct) \
1926     ((ct*) g_type_check_instance_cast ((GTypeInstance*) ip, gt))
1927 #  define _G_TYPE_CCC(cp, gt, ct) \
1928     ((ct*) g_type_check_class_cast ((GTypeClass*) cp, gt))
1929 #else /* G_DISABLE_CAST_CHECKS */
1930 #  define _G_TYPE_CIC(ip, gt, ct)       ((ct*) ip)
1931 #  define _G_TYPE_CCC(cp, gt, ct)       ((ct*) cp)
1932 #endif /* G_DISABLE_CAST_CHECKS */
1933 #define _G_TYPE_CHI(ip)                 (g_type_check_instance ((GTypeInstance*) ip))
1934 #define _G_TYPE_CHV(vl)                 (g_type_check_value ((GValue*) vl))
1935 #define _G_TYPE_IGC(ip, gt, ct)         ((ct*) (((GTypeInstance*) ip)->g_class))
1936 #define _G_TYPE_IGI(ip, gt, ct)         ((ct*) g_type_interface_peek (((GTypeInstance*) ip)->g_class, gt))
1937 #ifdef  __GNUC__
1938 #  define _G_TYPE_CIT(ip, gt)             (G_GNUC_EXTENSION ({ \
1939   GTypeInstance *__inst = (GTypeInstance*) ip; GType __t = gt; gboolean __r; \
1940   if (!__inst) \
1941     __r = FALSE; \
1942   else if (__inst->g_class && __inst->g_class->g_type == __t) \
1943     __r = TRUE; \
1944   else \
1945     __r = g_type_check_instance_is_a (__inst, __t); \
1946   __r; \
1947 }))
1948 #  define _G_TYPE_CCT(cp, gt)             (G_GNUC_EXTENSION ({ \
1949   GTypeClass *__class = (GTypeClass*) cp; GType __t = gt; gboolean __r; \
1950   if (!__class) \
1951     __r = FALSE; \
1952   else if (__class->g_type == __t) \
1953     __r = TRUE; \
1954   else \
1955     __r = g_type_check_class_is_a (__class, __t); \
1956   __r; \
1957 }))
1958 #  define _G_TYPE_CVH(vl, gt)             (G_GNUC_EXTENSION ({ \
1959   GValue *__val = (GValue*) vl; GType __t = gt; gboolean __r; \
1960   if (!__val) \
1961     __r = FALSE; \
1962   else if (__val->g_type == __t)                \
1963     __r = TRUE; \
1964   else \
1965     __r = g_type_check_value_holds (__val, __t); \
1966   __r; \
1967 }))
1968 #else  /* !__GNUC__ */
1969 #  define _G_TYPE_CIT(ip, gt)             (g_type_check_instance_is_a ((GTypeInstance*) ip, gt))
1970 #  define _G_TYPE_CCT(cp, gt)             (g_type_check_class_is_a ((GTypeClass*) cp, gt))
1971 #  define _G_TYPE_CVH(vl, gt)             (g_type_check_value_holds ((GValue*) vl, gt))
1972 #endif /* !__GNUC__ */
1973 /**
1974  * G_TYPE_FLAG_RESERVED_ID_BIT:
1975  *
1976  * A bit in the type number that's supposed to be left untouched.
1977  */
1978 #define G_TYPE_FLAG_RESERVED_ID_BIT     ((GType) (1 << 0))
1979 extern GTypeDebugFlags                  _g_type_debug_flags;
1980
1981 G_END_DECLS
1982
1983 #endif /* __G_TYPE_H__ */