1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
|
=====================
GObject Introspection
=====================
.. title:: Overview
.. toctree::
:hidden:
:titlesonly:
:maxdepth: 1
changelog
goals
architecture
users
build_test
writingbindableapis
buildsystems/index
annotations/index
writingbindings/index
tools/index
GObject introspection is a middleware layer between C libraries (using
GObject) and language bindings. The C library can be scanned at compile time
and generate metadata files, in addition to the actual native C library. Then
language bindings can read this metadata and automatically provide bindings to
call into the C library.
.. figure:: images/overview.svg
:width: 85%
:align: center
The GI project consists of:
* an XML format called GIR containing introspection information in a machine parseable format
* a Python package to create and parse the GIR format
* a scanner to generate GIR format from C source and headers
* a typelib similar to xpcom/msole which stores the information on disk in a binary format
* a compiler to compile the typelib from a xml format (and vice versa)
* C library to read the typelib, :doc:`writingbindings/libgirepository`.
Getting the code
----------------
The latest stable release is available from
https://download.gnome.org/sources/gobject-introspection
GObject Introspection is stored in git and can be fetched:
.. code-block:: text
git clone https://gitlab.gnome.org/GNOME/gobject-introspection.git
You can browse the repository online `here <https://gitlab.gnome.org/GNOME/gobject-introspection/>`__.
Reporting bugs
--------------
For a list of existing bugs and feature requests, see the `issues page
<https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues>`__. You can also
`open an issue
<https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/new>`__.
Contact
-------
For questions or additional information, please use:
* Discourse: https://discourse.gnome.org/tag/introspection
* IRC: #introspection on irc.gnome.org
|