README

   1 This is a very first prototype of an introspection framework for GObject.
   2
   3 The metadata format is described in metadata-format.txt, the XML IDL format
   4 follows the DTD in gidl.dtd. Look at the files in tests/ for testcases,
   5 and at examples/ for bigger examples.
   6
   7 The code in src/ currently produces four things:
   8 - g-idl-compile, a metadata compiler. It converts one or more IDL files
   9   into one or more metadata blobs. It can either emit the raw metadata
  10   blob (--raw) or C code (--code).
  11 - libirepository, the repository API.
  12 - g-idl-generate, an IDL generator, using the repository API. It generates
  13   IDL files from binary metadata which can be in a shared object, or a raw
  14   metadata blob (--raw).
  15 - a function to invoke functions, given the function info object. The
  16   implementation is based on libffi (a recent snapshot of libffi can
  17   be found at http://spindazzle.org/libffi-green.tar.gz). After the
  18   autoconfiscation, configure expects to find a ffi.pc file. The
  19   ffi.pc.in file in this directory may be helpful in construction
  20   such a file.
  21
  22 There are a number of IDL test files in test/, and a script to do
  23 roundtrip tests (IDL -> binary -> IDL).
  24
  25 The introspection framework needs a lot more work, see TODO.