summaryrefslogtreecommitdiff
path: root/docs/global-module-registry.txt
blob: 989f403edc997007d84d5c6586c6ca18d0c3699c (plain)
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
Problem statement
=================
On-disk registry for mapping namespace to typelib. 
Conceptually similar to mono /etc/mono/config.

It should be possible in a dynamic language such as python to just do:

>>> import PythonIntrospectionBindings
>>> import Gtk


Gtk should be a special namespace provided by the package containing the
Gtk namespace

Layout of the on disk tool
==========================

Location to should be /var/lib/glib/introspection-registry.xml
Should be read completely. Not expected to be larger than one page on most
systems.

Layout in XML:

<root>
  <registry-path location="/usr/lib/typelibs/1.0/">
  <registry-path location="$HOME/.typelibs/">
  <entry namespace="Gtk" 
         library-location="libgtk-x11-2.0.so.0"
         typelib-location="gtk.typelib"/>
</root>

FIXME: version?
FIXME: pkg-config name?

The overhead should be reduced to a minimum, both runtime and memory footprint.
Thus a binary format that is mmap(2):able is ideal:

gir-registry-tool
================
Is a command line utility, probably written in C which should be used
to update/modify the registry.

Example use cases, installing a new typelib

gir-registry-tool --install Gtk /usr/lib/glib/introspection/gtk.typelib 2.12.0
gir-registry-tool --uninstall Gtk /usr/lib/glib/introspection/gtk.typelib 2.12.0

It's the registry tools responsibility to sort the disk format.

API
===

libgirepository should provide an api:

gi_locale_typelib (const gchar *name, const gchar * version);

version should NULL, if so it should pick the first one in the on-disk registry.

libgirepository should mmap the registry and read it when that API is called
the first time.