1 /* GObject introspection: struct definitions for the binary
2 * typelib format, validation
4 * Copyright (C) 2005 Matthias Clasen
5 * Copyright (C) 2008,2009 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef __G_TYPELIB_H__
24 #define __G_TYPELIB_H__
27 #include "girepository.h"
33 * @short_description: Layout and accessors for typelib
36 * The "typelib" is a binary, readonly, memory-mappable database
37 * containing reflective information about a GObject library.
39 * The format of GObject typelib is strongly influenced by the Mozilla XPCOM
42 * Some of the differences to XPCOM include:
43 * - Type information is stored not quite as compactly (XPCOM stores it inline
44 * in function descriptions in variable-sized blobs of 1 to n bytes. We store
45 * 16 bits of type information for each parameter, which is enough to encode
46 * simple types inline. Complex (e.g. recursive) types are stored out of line
47 * in a separate list of types.
48 * - String and complex type data is stored outside of typelib entry blobs,
49 * references are stored as offsets relative to the start of the typelib.
50 * One possibility is to store the strings and types in a pools at the end
53 * The typelib has the following general format.
55 * typelib ::= header, directory, blobs, annotations
57 * directory ::= list of entries
59 * entry ::= blob type, name, namespace, offset
60 * blob ::= function|callback|struct|boxed|enum|flags|object|interface|constant|errordomain|union
61 * annotations ::= list of annotations, sorted by offset
62 * annotation ::= offset, key, value
66 * We describe the fragments that make up the typelib in the form of C structs
67 * (although some fall short of being valid C structs since they contain multiple
77 - Add padding to structures
80 - Add class struct concept to ObjectBlob
81 - Add is_class_struct bit to StructBlob
87 - rename metadata to typelib, to follow xpcom terminology
92 + add [u]int, [u]long, [s]size_t
93 + rename string to utf8, add filename
94 - allow blob_type to be zero for non-local entries
100 - drop short_name for ValueBlob
103 - make inline types 4 bytes after all, remove header->types and allow
104 types to appear anywhere
105 - allow error domains in the directory
109 - drop comments about _GOBJ_METADATA
110 - drop string pool, strings can appear anywhere
111 - use 'blob' as collective name for the various blob types
112 - rename 'type' field in blobs to 'blob_type'
113 - rename 'type_name' and 'type_init' fields to 'gtype_name', 'gtype_init'
114 - shrink directory entries to 12 bytes
115 - merge struct and boxed blobs
116 - split interface blobs into enum, object and interface blobs
117 - add an 'unregistered' flag to struct and enum blobs
118 - add a 'wraps_vfunc' flag to function blobs and link them to
120 - restrict value blobs to only occur inside enums and flags again
121 - add constant blobs, allow them toplevel, in interfaces and in objects
122 - rename 'receiver_owns_value' and 'receiver_owns_container' to
123 'transfer_ownership' and 'transfer_container_ownership'
124 - add a 'struct_offset' field to virtual function and field blobs
125 - add 'dipper' and 'optional' flags to arg blobs
126 - add a 'true_stops_emit' flag to signal blobs
127 - add variable blob sizes to header
128 - store offsets to signature blobs instead of including them directly
129 - change the type offset to be measured in words rather than bytes
135 * Identifying prefix for the typelib. This was inspired by XPCOM,
136 * which in turn borrowed from PNG.
138 #define G_IR_MAGIC "GOBJ\nMETADATA\r\n\032"
142 * @BLOB_TYPE_INVALID: Should not appear in code
143 * @BLOB_TYPE_FUNCTION: A #FunctionBlob
144 * @BLOB_TYPE_CALLBACK: A #CallbackBlob
145 * @BLOB_TYPE_STRUCT: A #StructBlob
146 * @BLOB_TYPE_BOXED: Can be either a #StructBlob or #UnionBlob
147 * @BLOB_TYPE_ENUM: An #EnumBlob
148 * @BLOB_TYPE_FLAGS: An #EnumBlob
149 * @BLOB_TYPE_OBJECT: An #ObjectBlob
150 * @BLOB_TYPE_INTERFACE: An #InterfaceBlob
151 * @BLOB_TYPE_CONSTANT: A #ConstantBlob
152 * @BLOB_TYPE_ERROR_DOMAIN: A #ErrorDomainBlob
153 * @BLOB_TYPE_UNION: A #UnionBlob
155 * The integral value of this enumeration appears in each "Blob"
156 * component of a typelib to identify its type.
169 BLOB_TYPE_ERROR_DOMAIN,
173 #define BLOB_IS_REGISTERED_TYPE(blob) \
174 ((blob)->blob_type == BLOB_TYPE_STRUCT || \
175 (blob)->blob_type == BLOB_TYPE_UNION || \
176 (blob)->blob_type == BLOB_TYPE_ENUM || \
177 (blob)->blob_type == BLOB_TYPE_OBJECT || \
178 (blob)->blob_type == BLOB_TYPE_INTERFACE)
182 * @magic: See #G_IR_MAGIC.
183 * @major_version: The version of the typelib format. Minor version changes indicate
184 * compatible changes and should still allow the typelib to be parsed
185 * by a parser designed for the same major_version.
186 * @minor_version: See major_version.
187 * @n_entries: The number of entries in the directory.
188 * @n_local_entries: The number of entries referring to blobs in this typelib. The
189 * local entries must occur before the unresolved entries.
190 * @directory: Offset of the directory in the typelib.
191 * @n_annotations: Number of annotation blocks
192 * @annotations: Offset of the list of annotations in the typelib.
193 * @dependencies: Offset of a single string, which is the list of
194 * dependencies, separated by the '|' character. The
195 * dependencies are required in order to avoid having programs
196 * consuming a typelib check for an "Unresolved" type return
197 * from every API call.
198 * @size: The size in bytes of the typelib.
199 * @namespace: Offset of the namespace string in the typelib.
200 * @nsversion: Offset of the namespace version string in the typelib.
201 * @shared_library: This field is the set of shared libraries associated
202 * with the typelib. The entries are separated by the '|' (pipe) character.
203 * @entry_blob_size: The sizes of fixed-size blobs. Recording this information here
204 * allows to write parser which continue to work if the format is
205 * extended by adding new fields to the end of the fixed-size blobs.
206 * @function_blob_size: See above.
207 * @callback_blob_size: See above.
208 * @signal_blob_size: See above.
209 * @vfunc_blob_size: See above.
210 * @arg_blob_size: See above.
211 * @property_blob_size: See above.
212 * @field_blob_size: See above.
213 * @value_blob_size: See above.
214 * @annotation_blob_size: See above.
215 * @constant_blob_size: See above.
216 * @object_blob_size: See above.
217 * @union_blob_size: See above.
218 * @signature_blob_size: See above.
219 * @enum_blob_size: See above.
220 * @struct_blob_size: See above.
221 * @error_domain_blob_size: See above.
222 * @interface_blob_size: For variable-size blobs, the size of the struct up to the first
223 * flexible array member. Recording this information here allows to
224 * write parser which continue to work if the format is extended by
225 * adding new fields before the first flexible array member in
226 * variable-size blobs.
228 * The header structure appears exactly once at the beginning of a typelib. It is a
229 * collection of meta-information, such as the number of entries and dependencies.
233 guint8 major_version;
234 guint8 minor_version;
237 guint16 n_local_entries;
239 guint32 n_annotations;
242 guint32 dependencies;
247 guint32 shared_library;
249 guint16 entry_blob_size;
250 guint16 function_blob_size;
251 guint16 callback_blob_size;
252 guint16 signal_blob_size;
253 guint16 vfunc_blob_size;
254 guint16 arg_blob_size;
255 guint16 property_blob_size;
256 guint16 field_blob_size;
257 guint16 value_blob_size;
258 guint16 annotation_blob_size;
259 guint16 constant_blob_size;
260 guint16 error_domain_blob_size;
262 guint16 signature_blob_size;
263 guint16 enum_blob_size;
264 guint16 struct_blob_size;
265 guint16 object_blob_size;
266 guint16 interface_blob_size;
267 guint16 union_blob_size;
274 * @blob_type: A #GTypelibBlobType
275 * @local: Whether this entry refers to a blob in this typelib.
276 * @name: The name of the entry.
277 * @offset: If is_local is set, this is the offset of the blob in the typelib.
278 * Otherwise, it is the offset of the namespace in which the blob has
279 * to be looked up by name.
281 * References to directory entries are stored as 1-based 16-bit indexes.
283 * All blobs pointed to by a directory entry start with the same layout for
284 * the first 8 bytes (the reserved flags may be used by some blob types)
290 guint16 reserved :15;
298 * @is_pointer: Indicates whether the type is passed by reference.
300 * @offset: Offset relative to header->types that points to a TypeBlob.
301 * Unlike other offsets, this is in words (ie 32bit units) rather
319 * @name: A suggested name for the parameter.
320 * @in: The parameter is an input to the function
321 * @out: The parameter is used to return an output of the function.
322 * Parameters can be both in and out. Out parameters implicitly
323 * add another level of indirection to the parameter type. Ie if
324 * the type is uint32 in an out parameter, the function actually
326 * @dipper: The parameter is a pointer to a struct or object that will
327 * receive an output of the function.
328 * @allow_none: Only meaningful for types which are passed as pointers.
329 * For an in parameter, indicates if it is ok to pass NULL in, for
330 * an out parameter, whether it may return NULL. Note that NULL is a
331 * valid GList and GSList value, thus allow_none will normally be set
332 * for parameters of these types.
333 * @optional: For an out parameter, indicates that NULL may be passed in
334 * if the value is not needed.
335 * @transfer_ownership: For an in parameter, indicates that the function takes over
336 * ownership of the parameter value. For an out parameter, it
337 * indicates that the caller is responsible for freeing the return
339 * @transfer_container_ownership: For container types, indicates that the
340 * ownership of the container, but not of its contents is transferred. This is typically the case
341 * for out parameters returning lists of statically allocated things.
342 * @is_return_value: The parameter should be considered the return value of the function.
343 * Only out parameters can be marked as return value, and there can be
344 * at most one per function call. If an out parameter is marked as
345 * return value, the actual return value of the function should be
346 * either void or a boolean indicating the success of the call.
347 * @scope: A #GIScopeType. If the parameter is of a callback type, this denotes the scope
348 * of the user_data and the callback function pointer itself
349 * (for languages that emit code at run-time).
350 * @closure: Index of the closure (user_data) parameter associated with the callback,
352 * @destroy: Index of the destroy notfication callback parameter associated with
353 * the callback, or -1.
354 * @arg_type: Describes the type of the parameter. See details below.
356 * Types are specified by four bytes. If the three high bytes are zero,
357 * the low byte describes a basic type, otherwise the 32bit number is an
358 * offset which points to a TypeBlob.
366 guint allow_none : 1;
368 guint transfer_ownership : 1;
369 guint transfer_container_ownership : 1;
370 guint return_value : 1;
377 SimpleTypeBlob arg_type;
382 * @return_type: Describes the type of the return value. See details below.
383 * @may_return_null: Only relevant for pointer types. Indicates whether the caller
384 * must expect NULL as a return value.
385 * @caller_owns_return_value: If set, the caller is responsible for freeing the return value
386 * if it is no longer needed.
387 * @caller_owns_return_container: This flag is only relevant if the return type is a container type.
388 * If the flag is set, the caller is resonsible for freeing the
389 * container, but not its contents.
390 * @n_arguments: The number of arguments that this function expects, also the length
391 * of the array of ArgBlobs.
392 * @arguments: An array of ArgBlob for the arguments of the function.
395 SimpleTypeBlob return_type;
397 guint16 may_return_null : 1;
398 guint16 caller_owns_return_value : 1;
399 guint16 caller_owns_return_container : 1;
400 guint16 reserved :13;
409 * @blob_type: A #GTypelibBlobType
410 * @deprecated: Whether the blob is deprecated.
411 * @name: The name of the blob.
413 * The #CommonBlob is shared between #FunctionBlob,
414 * #CallbackBlob, #SignalBlob.
417 guint16 blob_type; /* 1 */
419 guint16 deprecated : 1;
420 guint16 reserved :15;
427 * @blob_Type: #BLOB_TYPE_FUNCTION
428 * @symbol: The symbol which can be used to obtain the function pointer with
430 * @deprecated: The function is deprecated.
431 * @setter: The function is a setter for a property. Language bindings may
432 * prefer to not bind individual setters and rely on the generic
434 * @getter: The function is a getter for a property. Language bindings may
435 * prefer to not bind individual getters and rely on the generic
437 * @constructor:The function acts as a constructor for the object it is contained
439 * @wraps_vfunc: The function is a simple wrapper for a virtual function.
440 * @index: Index of the property that this function is a setter or getter of
441 * in the array of properties of the containing interface, or index
442 * of the virtual function that this function wraps.
443 * @signature: Offset of the SignatureBlob describing the parameter types and the
445 * @is_static: The function is a "static method"; in other words it's a pure
446 * function whose name is conceptually scoped to the object.
449 guint16 blob_type; /* 1 */
451 guint16 deprecated : 1;
454 guint16 constructor : 1;
455 guint16 wraps_vfunc : 1;
458 /* Note the bits above need to match CommonBlob
459 * and are thus exhausted, extend things using
460 * the reserved block below. */
466 guint16 is_static : 1;
467 guint16 reserved : 15;
468 guint16 reserved2 : 16;
473 * @signature: Offset of the #SignatureBlob describing the parameter types and the
477 guint16 blob_type; /* 2 */
479 guint16 deprecated : 1;
480 guint16 reserved :15;
488 * @pointer: Whether this type represents an indirection
490 * @interface: Index of the directory entry for the interface.
492 * Types which are described by an entry in the typelib have a tag value of 21.
493 * If the interface is an enum of flags type, is_pointer is 0, otherwise it is 1.
505 * @zero_terminated: Indicates that the array must be terminated by a suitable #NULL
507 * @has_length: Indicates that length points to a parameter specifying the length
508 * of the array. If both has_length and zero_terminated are set, the
509 * convention is to pass -1 for the length if the array is
511 * @length: The index of the parameter which is used to pass the length of the
512 * array. The parameter must be an integer type and have the same
513 * direction as this one.
514 * @type: The type of the array elements.
516 * Arrays have a tag value of 20. They are passed by reference, thus is_pointer
524 guint16 zero_terminated :1;
525 guint16 has_length :1;
527 guint16 reserved2 :5;
539 * @n_types: The number of parameter types to follow.
540 * @type: Describes the type of the list elements.
551 SimpleTypeBlob type[];
556 * @n_domains: The number of domains to follow
557 * @domains: Indices of the directory entries for the error domains
572 * @get_quark: The symbol name of the function which must be called to obtain the
573 * GQuark for the error domain.
574 * @error_codes: Index of the InterfaceBlob describing the enumeration which lists
575 * the possible error codes.
578 guint16 blob_type; /* 10 */
580 guint16 deprecated : 1;
581 guint16 reserved :15;
592 * @deprecated: Whether this value is deprecated
593 * @value: The numerical value
594 * @name: Name of blob
596 * Values commonly occur in enums and flags.
599 guint32 deprecated : 1;
600 guint32 reserved :31;
607 * @name: The name of the field.
609 * @writable: How the field may be accessed.
610 * @bits: If this field is part of a bitfield, the number of bits which it
613 * The offset of the field in the struct. The value 0xFFFF indicates
614 * that the struct offset is unknown.
615 * @type: The type of the field.
625 guint16 struct_offset;
633 * RegisteredTypeBlob:
634 * @gtype_name: The name under which the type is registered with GType.
635 * @gtype_init: The symbol name of the get_type() function which registers the type.
639 guint16 deprecated : 1;
640 guint16 unregistered : 1;
641 guint16 reserved :14;
646 } RegisteredTypeBlob;
650 * @blob_type: #BLOB_TYPE_STRUCT
651 * @deprecated: Whether this structure is deprecated
652 * @unregistered: If this is set, the type is not registered with GType.
653 * @alignment: The byte boundary that the struct is aligned to in memory
654 * @is_class_struct: Whether this structure is the "class structure" for a GObject
655 * @size: The size of the struct in bytes.
656 * @gtype_name: String name of the associated #GType
657 * @gtype_init: String naming the symbol which gets the runtime #GType
659 * @n_functions: The lengths of the arrays.
660 * @fields: An array of n_fields FieldBlobs.
661 * @functions: An array of n_functions FunctionBlobs. The described functions
662 * should be considered as methods of the struct.
667 guint16 deprecated : 1;
668 guint16 unregistered : 1;
669 guint16 is_class_struct : 1;
670 guint16 alignment : 6;
671 guint16 reserved : 7;
687 /* variable-length parts of the blob */
689 FunctionBlob methods[];
695 * @unregistered: If this is set, the type is not registered with GType.
696 * @discriminated: Is set if the union is discriminated
697 * @alignment: The byte boundary that the union is aligned to in memory
698 * @size: The size of the union in bytes.
699 * @gtype_name: String name of the associated #GType
700 * @gtype_init: String naming the symbol which gets the runtime #GType
701 * @n_fields: Length of the arrays
702 * @discriminator_offset: Offset from the beginning of the union where the
703 * discriminator of a discriminated union is located.
704 * The value 0xFFFF indicates that the discriminator offset
706 * @discriminator_type: Type of the discriminator
707 * @discriminator_values: On discriminator value per field
708 * @fields: Array of FieldBlobs describing the alternative branches of the union
712 guint16 deprecated : 1;
713 guint16 unregistered : 1;
714 guint16 discriminated : 1;
715 guint16 alignment : 6;
716 guint16 reserved : 7;
730 gint32 discriminator_offset;
731 SimpleTypeBlob discriminator_type;
735 FunctionBlob functions[];
736 ConstantBlob discriminator_values[]
742 * @unregistered: If this is set, the type is not registered with GType.
743 * @storage_type: The tag of the type used for the enum in the C ABI
744 * (will be a signed or unsigned integral type)
745 * @gtype_name: String name of the associated #GType
746 * @gtype_init: String naming the symbol which gets the runtime #GType
747 * @n_values: The lengths of the values arrays.
748 * @values: Describes the enum values.
753 guint16 deprecated : 1;
754 guint16 unregistered : 1;
755 guint16 storage_type : 5;
756 guint16 reserved : 9;
773 * @name: The name of the property.
777 * @construct_only: The ParamFlags used when registering the property.
778 * @type: Describes the type of the property.
783 guint32 deprecated : 1;
784 guint32 readable : 1;
785 guint32 writable : 1;
786 guint32 construct : 1;
787 guint32 construct_only : 1;
788 guint32 reserved :27;
797 * @name: The name of the signal.
804 * @no_hooks: The flags used when registering the signal.
805 * @has_class_closure: Set if the signal has a class closure.
806 * @true_stops_emit: Whether the signal has true-stops-emit semantics
807 * @class_closure: The index of the class closure in the list of virtual functions
808 * of the object or interface on which the signal is defined.
809 * @signature: Offset of the SignatureBlob describing the parameter types and the
813 guint16 deprecated : 1;
814 guint16 run_first : 1;
815 guint16 run_last : 1;
816 guint16 run_cleanup : 1;
817 guint16 no_recurse : 1;
818 guint16 detailed : 1;
820 guint16 no_hooks : 1;
821 guint16 has_class_closure : 1;
822 guint16 true_stops_emit : 1;
823 guint16 reserved : 6;
825 guint16 class_closure;
836 * @name: The name of the virtual function.
837 * @must_chain_up: If set, every implementation of this virtual function must
838 * chain up to the implementation of the parent class.
839 * @must_be_implemented: If set, every derived class must override this virtual function.
840 * @must_not_be_implemented: If set, derived class must not override this virtual function.
841 * @class_closure: Set if this virtual function is the class closure of a signal.
842 * @signal: The index of the signal in the list of signals of the object or
843 * interface to which this virtual function belongs.
845 * The offset of the function pointer in the class struct. The value
846 * 0xFFFF indicates that the struct offset is unknown.
848 * Offset of the SignatureBlob describing the parameter types and the
854 guint16 must_chain_up : 1;
855 guint16 must_be_implemented : 1;
856 guint16 must_not_be_implemented : 1;
857 guint16 class_closure : 1;
858 guint16 reserved :12;
861 guint16 struct_offset;
870 * @blob_type: #BLOB_TYPE_OBJECT
871 * @gtype_name: String name of the associated #GType
872 * @gtype_init: String naming the symbol which gets the runtime #GType
873 * @parent: The directory index of the parent type. This is only set for
874 * objects. If an object does not have a parent, it is zero.
881 * @n_constants: The lengths of the arrays.Up to 16bits of padding may be inserted
882 * between the arrays to ensure that they start on a 32bit boundary.
883 * @interfaces: An array of indices of directory entries for the implemented
885 * @fields: Describes the fields.
886 * @methods: Describes the methods, constructors, setters and getters.
887 * @properties: Describes the properties.
888 * @signals: Describes the signals.
889 * @vfuncs: Describes the virtual functions.
890 * @constants: Describes the constants.
893 guint16 blob_type; /* 7 */
894 guint16 deprecated : 1;
895 guint16 abstract : 1;
896 guint16 reserved :14;
903 guint16 class_struct;
905 guint16 n_interfaces;
907 guint16 n_properties;
917 guint16 interfaces[];
920 /* variable-length parts of the blob */
922 PropertyBlob properties[];
923 FunctionBlob methods[];
924 SignalBlob signals[];
926 ConstantBlob constants[];
932 * @n_prerequisites: Number of prerequisites
933 * @n_properties: Number of properties
934 * @n_methods: Number of methods
935 * @n_signals: Number of signals
936 * @n_vfuncs: Number of virtual functions
937 * @n_constants: The lengths of the arrays.
938 * Up to 16bits of padding may be inserted between the arrays to ensure that they
939 * start on a 32bit boundary.
940 * @prerequisites: An array of indices of directory entries for required interfaces.
941 * @methods: Describes the methods, constructors, setters and getters.
942 * @properties: Describes the properties.
943 * @signals: Describes the signals.
944 * @vfuncs: Describes the virtual functions.
945 * @constants: Describes the constants.
949 guint16 deprecated : 1;
950 guint16 reserved :15;
956 guint16 n_prerequisites;
957 guint16 n_properties;
966 guint16 prerequisites[];
969 /* variable-length parts of the blob */
970 PropertyBlob properties[];
971 FunctionBlob methods[];
972 SignalBlob signals[];
974 ConstantBlob constants[];
980 * @type: The type of the value. In most cases this should be a numeric
982 * @size: The size of the value in bytes.
983 * @offset: The offset of the value in the typelib.
987 guint16 deprecated : 1;
988 guint16 reserved :15;
1001 * @offset: The offset of the typelib entry to which this annotation refers.
1002 * Annotations are kept sorted by offset, so that the annotations
1003 * of an entry can be found by a binary search.
1004 * @name: The name of the annotation, a string.
1005 * @value: The value of the annotation (also a string)
1016 gboolean owns_memory;
1021 DirEntry *g_typelib_get_dir_entry (GTypelib *typelib,
1024 void g_typelib_check_sanity (void);
1026 #define g_typelib_get_string(typelib,offset) ((const gchar*)&(typelib->data)[(offset)])
1031 G_TYPELIB_ERROR_INVALID,
1032 G_TYPELIB_ERROR_INVALID_HEADER,
1033 G_TYPELIB_ERROR_INVALID_DIRECTORY,
1034 G_TYPELIB_ERROR_INVALID_ENTRY,
1035 G_TYPELIB_ERROR_INVALID_BLOB
1038 #define G_TYPELIB_ERROR (g_typelib_error_quark ())
1040 GQuark g_typelib_error_quark (void);
1042 gboolean g_typelib_validate (GTypelib *typelib,
1048 #endif /* __G_TYPELIB_H__ */