Windows port: the tmpfile is going to be an exe...
[platform/upstream/gobject-introspection.git] / README
1 GObject Introspection
2 =====================
3 The goal of the project is to describe the APIs and  collect them in
4 a uniform, machine readable format.
5
6 GIR XML format
7 ==============
8
9 There's an XML format called GIR used by GObjectIntrospection.
10 The purpose of it is to provide a common structure to access the complete
11 available API that a library or other unit of code exports.
12 It is meant to be language agnostic using namespaces to separate
13 core, language or library specific functionality.
14 There are currently only C based tools that work on the format, but it's
15 meant to be usable to use in other situations, for instance to/from another
16 set of languages.
17
18 Typelib
19 =======
20
21 The typelib is a to disk version of the GIR designed to be fast, memory
22 efficient and complete enough so that language bindings can be written
23 on top of it without other sources of information.
24 It is normally compiled from a GIR when a library/program is installed and
25 accessed from the language binding or another application who wishes to
26 use the information.
27
28 Tools
29 =====
30
31 Three tools are shipped with GObject Introspection:
32 - g-ir-compile, a typelib compiler. It converts one or more GIR files
33   into one or more typelib blobs. It can either emit the raw typelib
34   blob or C code (--code).
35 - g-ir-generate, an GIR generator, using the repository API. It generates
36   GIR files from binary typelib which can be in a shared object, or a raw
37   typelib blob.
38 - g-ir-scanner, a tool which generates GIR XML files by parsing headers
39   and introspecting GObject based libraries.
40
41 API library
42 ===========
43
44 There's also a C based library called libgirepository which provides
45 an API to access to the typelib metadata. It also contains an API to
46 invoke functions, given the function info object. The implementation is
47 based on libffi (3.0 or higher of libffi required, can be found at
48 http://sourceware.org/libffi).
49
50 There are a number of GIR test files in tests/, and a script to do
51 roundtrip tests (GIR -> typelib -> GIR).
52
53 Helping out
54 ===========
55 The introspection framework needs a lot more work, see TODO.
56
57 Homepage
58 ========
59 http://live.gnome.org/GObjectIntrospection
60
61 Reporting bugs
62 ==============
63 Bugs should be reported in http://bugzilla.gnome.org/, the glib product and
64 the introspection component.
65
66 Contact
67 =======
68 Mail: gtk-devel-list@gnome.org
69 IRC: #introspection@irc.gnome.org