fish: Make the 'help' command more helpful.
[libguestfs.git] / generator / generator_structs.mli
1 (* libguestfs
2  * Copyright (C) 2009-2010 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  *)
18
19 (* Please read generator/README first. *)
20
21 (** Structures returned by the API. *)
22
23 type cols = (string * Generator_types.field) list
24 (** List of structure fields (called "columns"). *)
25
26 val structs : (string * cols) list
27 (** List of structures. *)
28
29 val java_structs : (string * string) list
30 (** Of course, Java has to be different from everyone else. *)
31
32 val lvm_pv_cols : cols
33 val lvm_vg_cols : cols
34 val lvm_lv_cols : cols
35 (** These are exported to the daemon code generator where they are
36     used to generate code for parsing the output of commands like
37     [lvs].  One day replace this with liblvm API calls. *)
38
39 val java_name_of_struct : string -> string
40 (** Extract Java name of struct. *)
41
42 val cols_of_struct : string -> cols
43 (** Extract columns of a struct. *)