inspector: Generate language bindings for OCaml.
authorRichard Jones <rjones@trick.home.annexia.org>
Fri, 2 Oct 2009 14:42:14 +0000 (15:42 +0100)
committerRichard Jones <rjones@redhat.com>
Tue, 13 Oct 2009 16:53:20 +0000 (17:53 +0100)
commitd37f69795396ec2354eb2d8480d64b9e5bdafacc
tree0685bb56dd3032d4e413930f23f93aac323b4cd9
parentc6b8db6493dd633bf48b13daf72cdc9c078b5f9a
inspector: Generate language bindings for OCaml.

This commit adds a generic mechanism for deriving language bindings
for virt-inspector, and implements one concrete binding, for OCaml.

The bindings are generated from the RELAX NG schema (virt-inspector.rng)
which is supposed to be a correct and always up to date description
of the XML that the virt-inspector program can generate.

From the RNG we generate a set of types to describe the output of
virt-inspector for the language, plus an XML parser, plus some
glue code to actually run an external instance of virt-inspector
and parse the resulting XML.

At runtime, an external 'virt-inspector --xml <name>' command runs
and the XML is parsed into language-specific structures.

This has been tested on the four example files (inspector/example?.xml)

The only particular difficulty about the OCaml binding is the use of
Obj.magic, which is naughty but works because of the isomorphism
between the representation of tuples and records in OCaml.  This
seems to cause no problems in my test program.  Apart from this, the
OCaml binding is straightforward and could be adapted easily for any
other languages that want type-safe virt-inspector bindings.

It's important to keep virt-inspector.rng up to date with changes
to virt-inspector's XML output format.
.gitignore
Makefile.am
README
configure.ac
inspector/Makefile.am
inspector/inspector_generator.ml [new file with mode: 0644]
ocaml/.depend
ocaml/META.in
ocaml/Makefile.am
ocaml/t/guestfs_500_inspect.ml [new file with mode: 0644]