summaryrefslogtreecommitdiffstats
path: root/generator/structs.mli
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2012-09-02 18:26:48 +0100
committerRichard W.M. Jones <rjones@redhat.com>2012-09-02 19:47:33 +0100
commitd331fd70e2c3ba2815460c8cd93a97eb9a81c6a5 (patch)
tree40ff4f1be508a66ecf7d52e6511a6e446938a465 /generator/structs.mli
parent11d655ab83211eb6808d32296cbbab31fc023aac (diff)
downloadlibguestfs-d331fd70e2c3ba2815460c8cd93a97eb9a81c6a5.tar.gz
libguestfs-d331fd70e2c3ba2815460c8cd93a97eb9a81c6a5.tar.xz
libguestfs-d331fd70e2c3ba2815460c8cd93a97eb9a81c6a5.zip
generator: Rename 'generator_*' as '*'.
This is a simple renaming of the files/modules. Note that in OCaml, module names are derived from filenames by capitalizing the first letter. Thus the old module names had the form "Generator_api_versions". The new modules names have the form "Api_versions".
Diffstat (limited to 'generator/structs.mli')
-rw-r--r--generator/structs.mli43
1 files changed, 43 insertions, 0 deletions
diff --git a/generator/structs.mli b/generator/structs.mli
new file mode 100644
index 00000000..56987e0f
--- /dev/null
+++ b/generator/structs.mli
@@ -0,0 +1,43 @@
+(* libguestfs
+ * Copyright (C) 2009-2012 Red Hat Inc.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *)
+
+(* Please read generator/README first. *)
+
+(** Structures returned by the API. *)
+
+type cols = (string * Types.field) list
+(** List of structure fields (called "columns"). *)
+
+val structs : (string * cols) list
+(** List of structures. *)
+
+val camel_structs : (string * string) list
+(** For bindings which want camel case struct names *)
+
+val lvm_pv_cols : cols
+val lvm_vg_cols : cols
+val lvm_lv_cols : cols
+(** These are exported to the daemon code generator where they are
+ used to generate code for parsing the output of commands like
+ [lvs]. One day replace this with liblvm API calls. *)
+
+val camel_name_of_struct : string -> string
+(** Camel case name of struct. *)
+
+val cols_of_struct : string -> cols
+(** Extract columns of a struct. *)