Further code generation ** NOT WORKING **

[virt-mem.git] / extract / codegen / code_generation.mli

diff --git a/extract/codegen/code_generation.mli b/extract/codegen/code_generation.mli
new file mode 100644 (file)
index 0000000..efe282f
--- /dev/null
+++ b/extract/codegen/code_generation.mli
@@ -0,0 +1,50 @@
+(** Code generation. *)
+(* Memory info command for virtual domains.
+   (C) Copyright 2008 Richard W.M. Jones, Red Hat Inc.
+   http://libvirt.org/
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *)
+
+(**
+   This module is concerned with actually generating code
+   for types, parsers, etc.
+
+   We generate two output files, [kernel.mli] is the interface
+   to the kernel structures, and [kernel.ml] is the implementation.
+*)
+
+(** {2 Generate types} *)
+
+val generate_types :
+  (string
+   * Struct_classify.shape_field_struct list
+   * Struct_classify.content_field_struct list) list ->
+  Camlp4.PreCast.Syntax.Ast.str_item * Camlp4.PreCast.Syntax.Ast.sig_item
+    (** [generate_types structures] generates the internal
+       types used to store variants of each structure, including:
+       - shape field structures
+       - content field structures
+    *)
+
+(** {2 Output final files} *)
+
+val output_interf : output_file:string ->
+  Camlp4.PreCast.Syntax.Ast.sig_item -> unit
+  (** Output the interface file. *)
+
+val output_implem : output_file:string ->
+  Camlp4.PreCast.Syntax.Ast.str_item -> unit
+  (** Output the implementation file. *)