From 8ba5a13d175ce0868bd03083f0862cb340feaca1 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Wed, 4 Nov 2009 11:43:13 -0500 Subject: [PATCH] [gtypelib.h] Document SimpleTypeBlob more --- gtypelib.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/gtypelib.h b/gtypelib.h index 488c1b33b..015682e20 100644 --- a/gtypelib.h +++ b/gtypelib.h @@ -303,6 +303,20 @@ typedef struct { * @offset: Offset relative to header->types that points to a TypeBlob. * Unlike other offsets, this is in words (ie 32bit units) rather * than bytes. + * + * The SimpleTypeBlob is the general purpose "reference to a type" construct, used + * in method parameters, returns, callback definitions, fields, constants, etc. + * It's actually just a 32 bit integer which you can see from the union definition. + * This is for efficiency reasons, since there are so many references to types. + * + * SimpleTypeBlob is divided into two cases; first, if "reserved" and "reserved2", the + * type tag for a basic type is embedded in the "tag" bits. This allows e.g. + * GI_TYPE_TAG_UTF8, GI_TYPE_TAG_INT and the like to be embedded directly without + * taking up extra space. + * + * References to "interfaces" (objects, interfaces) are more complicated; In this case, + * the integer is actually an offset into the directory (see above). Because the header + * is larger than 2^8=256 bits, all offsets will have one of the upper 24 bits set. */ typedef union {