1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
(* libguestfs
* Copyright (C) 2009-2010 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. *)
open Generator_types
open Generator_utils
open Generator_actions
(* Check function names etc. for consistency. *)
let () =
let contains_uppercase str =
let len = String.length str in
let rec loop i =
if i >= len then false
else (
let c = str.[i] in
if c >= 'A' && c <= 'Z' then true
else loop (i+1)
)
in
loop 0
in
(* Check function names. *)
List.iter (
fun (name, _, _, _, _, _, _) ->
if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
failwithf "function name %s does not need 'guestfs' prefix" name;
if name = "" then
failwithf "function name is empty";
if name.[0] < 'a' || name.[0] > 'z' then
failwithf "function name %s must start with lowercase a-z" name;
if String.contains name '-' then
failwithf "function name %s should not contain '-', use '_' instead."
name
) (all_functions @ fish_commands);
(* Check function parameter/return names. *)
List.iter (
fun (name, style, _, _, _, _, _) ->
let check_arg_ret_name n =
if contains_uppercase n then
failwithf "%s param/ret %s should not contain uppercase chars"
name n;
if String.contains n '-' || String.contains n '_' then
failwithf "%s param/ret %s should not contain '-' or '_'"
name n;
if n = "value" then
failwithf "%s has a param/ret called 'value', which causes conflicts in the OCaml bindings, use something like 'val' or a more descriptive name" name;
if n = "int" || n = "char" || n = "short" || n = "long" then
failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
if n = "i" || n = "n" then
failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
if n = "argv" || n = "args" then
failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
(* List Haskell, OCaml and C keywords here.
* http://www.haskell.org/haskellwiki/Keywords
* http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
* http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
* Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
* |perl -pe 's/(.+)/"$1";/'|fmt -70
* Omitting _-containing words, since they're handled above.
* Omitting the OCaml reserved word, "val", is ok,
* and saves us from renaming several parameters.
*)
let reserved = [
"and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
"char"; "class"; "const"; "constraint"; "continue"; "data";
"default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
"end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
"for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
"hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
"infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
"interface";
"land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
"match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
"newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
"rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
"sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
"type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
"volatile"; "when"; "where"; "while";
] in
if List.mem n reserved then
failwithf "%s has param/ret using reserved word %s" name n;
in
let ret, args, optargs = style in
(match ret with
| RErr -> ()
| RInt n | RInt64 n | RBool n
| RConstString n | RConstOptString n | RString n
| RStringList n | RStruct (n, _) | RStructList (n, _)
| RHashtable n | RBufferOut n ->
check_arg_ret_name n
);
List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) args;
List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) optargs;
) all_functions;
(* Check only certain types allowed in optargs. *)
List.iter (
fun (name, (_, _, optargs), _, _, _, _, _) ->
if List.length optargs > 64 then
failwithf "maximum of 64 optional args allowed for %s" name;
List.iter (
function
| Bool _ | Int _ | Int64 _ | String _ -> ()
| _ ->
failwithf "optional args of %s can only have type Bool|Int|Int64|String" name
) optargs
) all_functions;
(* Some parameter types not supported for daemon functions. *)
List.iter (
fun (name, (_, args, optargs), _, _, _, _, _) ->
let check_arg_type = function
| Pointer _ ->
failwithf "Pointer is not supported for daemon function %s."
name
| _ -> ()
in
List.iter check_arg_type args;
List.iter check_arg_type optargs;
) daemon_functions;
(* Check short descriptions. *)
List.iter (
fun (name, _, _, _, _, shortdesc, _) ->
if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
failwithf "short description of %s should begin with lowercase." name;
let c = shortdesc.[String.length shortdesc-1] in
if c = '\n' || c = '.' then
failwithf "short description of %s should not end with . or \\n." name
) (all_functions @ fish_commands);
(* Check long descriptions. *)
List.iter (
fun (name, _, _, _, _, _, longdesc) ->
if longdesc.[String.length longdesc-1] = '\n' then
failwithf "long description of %s should not end with \\n." name
) (all_functions @ fish_commands);
(* Check proc_nrs. *)
List.iter (
fun (name, _, proc_nr, _, _, _, _) ->
if proc_nr <= 0 then
failwithf "daemon function %s should have proc_nr > 0" name
) daemon_functions;
List.iter (
fun (name, _, proc_nr, _, _, _, _) ->
if proc_nr <> -1 then
failwithf "non-daemon function %s should have proc_nr -1" name
) non_daemon_functions;
let proc_nrs =
List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
daemon_functions in
let proc_nrs =
List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
let rec loop = function
| [] -> ()
| [_] -> ()
| (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
loop rest
| (name1,nr1) :: (name2,nr2) :: _ ->
failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
name1 name2 nr1 nr2
in
loop proc_nrs;
(* Check flags. *)
List.iter (
fun (name, _, _, flags, _, _, _) ->
List.iter (
function
| ProtocolLimitWarning
| DangerWillRobinson
| FishOutput _
| NotInFish
| NotInDocs
| Progress -> ()
| FishAlias n ->
if contains_uppercase n then
failwithf "%s: guestfish alias %s should not contain uppercase chars" name n;
if String.contains n '_' then
failwithf "%s: guestfish alias %s should not contain '_'" name n
| DeprecatedBy n ->
(* 'n' must be a cross-ref to the name of another action. *)
if not (List.exists (
function
| (n', _, _, _, _, _, _) when n = n' -> true
| _ -> false
) all_functions) then
failwithf "%s: DeprecatedBy flag must be cross-reference to another action" name
| Optional n ->
if contains_uppercase n then
failwithf "%s: Optional group name %s should not contain uppercase chars" name n;
if String.contains n '-' || String.contains n '_' then
failwithf "%s: Optional group name %s should not contain '-' or '_'" name n
) flags
) (all_functions @ fish_commands);
(* Check tests. *)
List.iter (
function
(* Ignore functions that have no tests. We generate a
* warning when the user does 'make check' instead.
*)
| name, _, _, _, [], _, _ -> ()
| name, _, _, _, tests, _, _ ->
let funcs =
List.map (
fun (_, _, test) ->
match seq_of_test test with
| [] ->
failwithf "%s has a test containing an empty sequence" name
| cmds -> List.map List.hd cmds
) tests in
let funcs = List.flatten funcs in
let tested = List.mem name funcs in
if not tested then
failwithf "function %s has tests but does not test itself" name
) all_functions
|
