2 * Copyright (C) 2009-2010 Red Hat Inc.
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.
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.
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
19 (* Please read generator/README first. *)
26 open Generator_docstrings
27 open Generator_optgroups
28 open Generator_actions
29 open Generator_structs
30 open Generator_prepopts
33 let doc_opttype_of = function
34 | Bool n -> "true|false"
40 (* Generate a lot of different functions for guestfish. *)
41 let generate_fish_cmds () =
42 generate_header CStyle GPLv2plus;
46 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
48 let all_functions_sorted =
50 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
51 ) all_functions_sorted in
53 let all_functions_and_fish_commands_sorted =
54 List.sort action_compare (all_functions_sorted @ fish_commands) in
56 pr "#include <config.h>\n";
58 pr "/* It is safe to call deprecated functions from this file. */\n";
59 pr "#undef GUESTFS_WARN_DEPRECATED\n";
61 pr "#include <stdio.h>\n";
62 pr "#include <stdlib.h>\n";
63 pr "#include <string.h>\n";
64 pr "#include <inttypes.h>\n";
66 pr "#include \"c-ctype.h\"\n";
67 pr "#include \"full-write.h\"\n";
68 pr "#include \"xstrtol.h\"\n";
70 pr "#include <guestfs.h>\n";
71 pr "#include \"fish.h\"\n";
72 pr "#include \"fish-cmds.h\"\n";
73 pr "#include \"options.h\"\n";
74 pr "#include \"cmds_gperf.h\"\n";
76 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
77 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
81 fun (name, _, _, _, _, _, _) ->
82 pr "static int run_%s (const char *cmd, size_t argc, char *argv[]);\n"
88 (* List of command_entry structs. *)
90 fun (name, _, _, flags, _, shortdesc, longdesc) ->
91 let name2 = replace_char name '_' '-' in
93 filter_map (function FishAlias n -> Some n | _ -> None) flags in
96 sprintf "\n\nYou can use %s as an alias for this command."
97 (String.concat " or " (List.map (fun s -> "'" ^ s ^ "'") aliases))
101 sprintf "%s - %s\n\n=head1 DESCRIPTION\n\n%s\n\n%s"
102 name2 shortdesc longdesc describe_alias in
104 String.concat "\n" (pod2text ~trim:false ~discard:false "NAME" pod)
107 pr "struct command_entry %s_cmd_entry = {\n" name;
108 pr " .name = \"%s\",\n" name2;
109 pr " .help = \"%s\",\n" (c_quote text);
110 pr " .run = run_%s\n" name;
116 fun (name, (_, args, optargs), _, flags, _, shortdesc, longdesc) ->
117 let name2 = replace_char name '_' '-' in
119 filter_map (function FishAlias n -> Some n | _ -> None) flags in
121 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
126 let args = List.filter (function Key _ -> false | _ -> true) args in
130 (List.map (fun arg -> " " ^ name_of_argt arg) args))
132 (List.map (fun arg ->
133 sprintf " [%s:%s]" (name_of_argt arg) (doc_opttype_of arg)
137 if List.exists (function Key _ -> true | _ -> false) args then
138 "\n\nThis command has one or more key or passphrase parameters.
139 Guestfish will prompt for these separately."
144 if List.mem ProtocolLimitWarning flags then
145 ("\n\n" ^ protocol_limit_warning)
150 match deprecation_notice flags with
152 | Some txt -> "\n\n" ^ txt in
155 if aliases <> [] then
156 sprintf "\n\nYou can use %s as an alias for this command."
157 (String.concat " or " (List.map (fun s -> "'" ^ s ^ "'") aliases))
161 sprintf "%s - %s\n\n=head1 SYNOPSIS\n\n %s\n\n=head1 DESCRIPTION\n\n%s%s%s"
162 name2 shortdesc synopsis longdesc warnings describe_alias in
164 String.concat "\n" (pod2text ~trim:false ~discard:false "NAME" pod)
167 pr "struct command_entry %s_cmd_entry = {\n" name;
168 pr " .name = \"%s\",\n" name2;
169 pr " .help = \"%s\",\n" (c_quote text);
170 pr " .run = run_%s\n" name;
175 (* list_commands function, which implements guestfish -h *)
176 pr "void list_commands (void)\n";
178 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
179 pr " list_builtin_commands ();\n";
181 fun (name, _, _, flags, _, shortdesc, _) ->
182 let name = replace_char name '_' '-' in
183 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
185 ) all_functions_and_fish_commands_sorted;
186 pr " printf (\" %%s\\n\",";
187 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
191 (* display_command function, which implements guestfish -h cmd *)
192 pr "int display_command (const char *cmd)\n";
194 pr " const struct command_table *ct;\n";
196 pr " ct = lookup_fish_command (cmd, strlen (cmd));\n";
198 pr " fputs (ct->entry->help, stdout);\n";
202 pr " return display_builtin_command (cmd);\n";
206 let emit_print_list_function typ =
207 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
210 pr " unsigned int i;\n";
212 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
213 pr " printf (\"[%%d] = {\\n\", i);\n";
214 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
215 pr " printf (\"}\\n\");\n";
221 (* print_* functions *)
225 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
227 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
230 pr " unsigned int i;\n";
236 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
238 pr " printf (\"%%s%s: \", indent);\n" name;
239 pr " for (i = 0; i < 32; ++i)\n";
240 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
241 pr " printf (\"\\n\");\n"
243 pr " printf (\"%%s%s: \", indent);\n" name;
244 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
245 pr " if (c_isprint (%s->%s[i]))\n" typ name;
246 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
248 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
249 pr " printf (\"\\n\");\n"
250 | name, (FUInt64|FBytes) ->
251 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
254 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
257 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
260 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
263 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
265 | name, FOptPercent ->
266 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
267 typ name name typ name;
268 pr " else printf (\"%%s%s: \\n\", indent);\n" name
274 (* Emit a print_TYPE_list function definition only if that function is used. *)
277 | typ, (RStructListOnly | RStructAndList) ->
278 (* generate the function for typ *)
279 emit_print_list_function typ
280 | typ, _ -> () (* empty *)
281 ) (rstructs_used_by all_functions);
283 (* Emit a print_TYPE function definition only if that function is used. *)
286 | typ, (RStructOnly | RStructAndList) ->
287 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
289 pr " print_%s_indent (%s, \"\");\n" typ typ;
292 | typ, _ -> () (* empty *)
293 ) (rstructs_used_by all_functions);
295 (* run_<action> actions *)
297 fun (name, (ret, args, optargs as style), _, flags, _, _, _) ->
299 pr "run_%s (const char *cmd, size_t argc, char *argv[])\n" name;
304 | RBool _ -> pr " int r;\n"
305 | RInt64 _ -> pr " int64_t r;\n"
306 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
307 | RString _ -> pr " char *r;\n"
308 | RStringList _ | RHashtable _ -> pr " char **r;\n"
309 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
310 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
313 pr " size_t size;\n";
319 | OptString n -> pr " const char *%s;\n" n
324 | Key n -> pr " char *%s;\n" n
326 pr " const char *%s;\n" n;
327 pr " size_t %s_size;\n" n
328 | StringList n | DeviceList n -> pr " char **%s;\n" n
329 | Bool n -> pr " int %s;\n" n
330 | Int n -> pr " int %s;\n" n
331 | Int64 n -> pr " int64_t %s;\n" n
332 | Pointer _ -> assert false
335 if optargs <> [] then (
336 pr " struct guestfs_%s_argv optargs_s = { .bitmask = 0 };\n" name;
337 pr " struct guestfs_%s_argv *optargs = &optargs_s;\n" name
340 if args <> [] || optargs <> [] then
341 pr " size_t i = 0;\n";
345 (* Check and convert parameters. *)
346 let argc_minimum, argc_maximum =
348 List.filter (function Key _ -> false | _ -> true) args in
349 let argc_minimum = List.length args_no_keys in
350 let argc_maximum = argc_minimum + List.length optargs in
351 argc_minimum, argc_maximum in
353 if argc_minimum = argc_maximum then (
354 pr " if (argc != %d) {\n" argc_minimum;
355 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
358 pr " if (argc < %d || argc > %d) {\n" argc_minimum argc_maximum;
359 pr " fprintf (stderr, _(\"%%s should have %%d-%%d parameter(s)\\n\"), cmd, %d, %d);\n"
360 argc_minimum argc_maximum;
362 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
366 let parse_integer expr fn fntyp rtyp range name =
368 pr " strtol_error xerr;\n";
371 pr " xerr = %s (%s, NULL, 0, &r, xstrtol_suffixes);\n" fn expr;
372 pr " if (xerr != LONGINT_OK) {\n";
373 pr " fprintf (stderr,\n";
374 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
375 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
380 | Some (min, max, comment) ->
381 pr " /* %s */\n" comment;
382 pr " if (r < %s || r > %s) {\n" min max;
383 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
387 pr " /* The check above should ensure this assignment does not overflow. */\n";
389 pr " %s = r;\n" name;
397 pr " %s = argv[i++];\n" name
399 | Dev_or_Path name ->
400 pr " %s = win_prefix (argv[i++]); /* process \"win:\" prefix */\n" name;
401 pr " if (%s == NULL) return -1;\n" name
403 pr " %s = STRNEQ (argv[i], \"\") ? argv[i] : NULL;\n" name;
406 pr " %s = argv[i];\n" name;
407 pr " %s_size = strlen (argv[i]);\n" name;
410 pr " %s = file_in (argv[i++]);\n" name;
411 pr " if (%s == NULL) return -1;\n" name
413 pr " %s = file_out (argv[i++]);\n" name;
414 pr " if (%s == NULL) return -1;\n" name
415 | StringList name | DeviceList name ->
416 pr " %s = parse_string_list (argv[i++]);\n" name;
417 pr " if (%s == NULL) return -1;\n" name
419 pr " %s = read_key (\"%s\");\n" name name;
420 pr " if (keys_from_stdin)\n";
421 pr " input_lineno++;\n";
422 pr " if (%s == NULL) return -1;\n" name
424 pr " %s = is_true (argv[i++]) ? 1 : 0;\n" name
427 let min = "(-(2LL<<30))"
428 and max = "((2LL<<30)-1)"
430 "The Int type in the generator is a signed 31 bit int." in
431 Some (min, max, comment) in
432 parse_integer "argv[i++]" "xstrtoll" "long long" "int" range name
434 parse_integer "argv[i++]" "xstrtoll" "long long" "int64_t" None name
435 | Pointer _ -> assert false
438 (* Optional arguments are prefixed with <argname>:<value> and
439 * may be missing, so we need to parse those until the end of
442 if optargs <> [] then (
443 let uc_name = String.uppercase name in
445 pr " for (; i < argc; ++i) {\n";
446 pr " uint64_t this_mask;\n";
447 pr " const char *this_arg;\n";
452 let n = name_of_argt argt in
453 let uc_n = String.uppercase n in
454 let len = String.length n in
455 pr "if (STRPREFIX (argv[i], \"%s:\")) {\n" n;
458 pr " optargs_s.%s = is_true (&argv[i][%d]) ? 1 : 0;\n"
462 let min = "(-(2LL<<30))"
463 and max = "((2LL<<30)-1)"
465 "The Int type in the generator is a signed 31 bit int." in
466 Some (min, max, comment) in
467 let expr = sprintf "&argv[i][%d]" (len+1) in
468 parse_integer expr "xstrtoll" "long long" "int" range
469 (sprintf "optargs_s.%s" n)
471 let expr = sprintf "&argv[i][%d]" (len+1) in
472 parse_integer expr "xstrtoll" "long long" "int64_t" None
473 (sprintf "optargs_s.%s" n)
475 pr " optargs_s.%s = &argv[i][%d];\n" n (len+1);
478 pr " this_mask = GUESTFS_%s_%s_BITMASK;\n" uc_name uc_n;
479 pr " this_arg = \"%s\";\n" n;
485 pr " fprintf (stderr, _(\"%%s: unknown optional argument \\\"%%s\\\"\\n\"),\n";
486 pr " cmd, argv[i]);\n";
490 pr " if (optargs_s.bitmask & this_mask) {\n";
491 pr " fprintf (stderr, _(\"%%s: optional argument \\\"%%s\\\" given twice\\n\"),\n";
492 pr " cmd, this_arg);\n";
495 pr " optargs_s.bitmask |= this_mask;\n";
500 (* Call C API function. *)
502 pr " r = guestfs_%s " name
504 pr " r = guestfs_%s_argv " name;
505 generate_c_call_args ~handle:"g" style;
510 | Device _ | String _
511 | OptString _ | Bool _
514 | Pathname name | Dev_or_Path name | FileOut name
516 pr " free (%s);\n" name
518 pr " free_file_in (%s);\n" name
519 | StringList name | DeviceList name ->
520 pr " free_strings (%s);\n" name
521 | Pointer _ -> assert false
524 (* Any output flags? *)
526 let flags = filter_map (
527 function FishOutput flag -> Some flag | _ -> None
533 failwithf "%s: more than one FishOutput flag is not allowed" name in
535 (* Check return value for errors and display command results. *)
537 | RErr -> pr " return r;\n"
539 pr " if (r == -1) return -1;\n";
540 (match fish_output with
542 pr " printf (\"%%d\\n\", r);\n";
543 | Some FishOutputOctal ->
544 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
545 | Some FishOutputHexadecimal ->
546 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
549 pr " if (r == -1) return -1;\n";
550 (match fish_output with
552 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
553 | Some FishOutputOctal ->
554 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
555 | Some FishOutputHexadecimal ->
556 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
559 pr " if (r == -1) return -1;\n";
560 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
563 pr " if (r == NULL) return -1;\n";
564 pr " printf (\"%%s\\n\", r);\n";
566 | RConstOptString _ ->
567 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
570 pr " if (r == NULL) return -1;\n";
571 pr " printf (\"%%s\\n\", r);\n";
575 pr " if (r == NULL) return -1;\n";
576 pr " print_strings (r);\n";
577 pr " free_strings (r);\n";
579 | RStruct (_, typ) ->
580 pr " if (r == NULL) return -1;\n";
581 pr " print_%s (r);\n" typ;
582 pr " guestfs_free_%s (r);\n" typ;
584 | RStructList (_, typ) ->
585 pr " if (r == NULL) return -1;\n";
586 pr " print_%s_list (r);\n" typ;
587 pr " guestfs_free_%s_list (r);\n" typ;
590 pr " if (r == NULL) return -1;\n";
591 pr " print_table (r);\n";
592 pr " free_strings (r);\n";
595 pr " if (r == NULL) return -1;\n";
596 pr " if (full_write (1, r, size) != size) {\n";
597 pr " perror (\"write\");\n";
608 (* run_action function *)
610 pr "run_action (const char *cmd, size_t argc, char *argv[])\n";
612 pr " const struct command_table *ct;\n";
614 pr " ct = lookup_fish_command (cmd, strlen (cmd));\n";
616 pr " return ct->entry->run (cmd, argc, argv);\n";
618 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
619 pr " if (command_num == 1)\n";
620 pr " extended_help_message ();\n";
625 and generate_fish_cmds_h () =
626 generate_header CStyle GPLv2plus;
628 pr "#ifndef FISH_CMDS_H\n";
629 pr "#define FISH_CMDS_H\n";
633 fun (shortname, _, _, _, _, _, _) ->
634 pr "extern int run_%s (const char *cmd, size_t argc, char *argv[]);\n"
639 pr "#endif /* FISH_CMDS_H */\n"
641 (* gperf code to do fast lookups of commands. *)
642 and generate_fish_cmds_gperf () =
643 generate_header CStyle GPLv2plus;
645 let all_functions_sorted =
647 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
648 ) all_functions_sorted in
650 let all_functions_and_fish_commands_sorted =
651 List.sort action_compare (all_functions_sorted @ fish_commands) in
655 %%define lookup-function-name lookup_fish_command
667 #include \"cmds_gperf.h\"
672 fun (name, _, _, _, _, _, _) ->
673 pr "extern struct command_entry %s_cmd_entry;\n" name
674 ) all_functions_and_fish_commands_sorted;
679 struct command_table;
685 fun (name, _, _, flags, _, _, _) ->
686 let name2 = replace_char name '_' '-' in
688 filter_map (function FishAlias n -> Some n | _ -> None) flags in
690 (* The basic command. *)
691 pr "%s, &%s_cmd_entry\n" name name;
693 (* Command with dashes instead of underscores. *)
694 if name <> name2 then
695 pr "%s, &%s_cmd_entry\n" name2 name;
697 (* Aliases for the command. *)
700 pr "%s, &%s_cmd_entry\n" alias name;
702 ) all_functions_and_fish_commands_sorted
704 (* Readline completion for guestfish. *)
705 and generate_fish_completion () =
706 generate_header CStyle GPLv2plus;
710 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
720 #ifdef HAVE_LIBREADLINE
721 #include <readline/readline.h>
726 #ifdef HAVE_LIBREADLINE
728 static const char *const commands[] = {
729 BUILTIN_COMMANDS_FOR_COMPLETION,
732 (* Get the commands, including the aliases. They don't need to be
733 * sorted - the generator() function just does a dumb linear search.
737 fun (name, _, _, flags, _, _, _) ->
738 let name2 = replace_char name '_' '-' in
740 filter_map (function FishAlias n -> Some n | _ -> None) flags in
742 ) (all_functions @ fish_commands) in
743 let commands = List.flatten commands in
745 List.iter (pr " \"%s\",\n") commands;
751 generator (const char *text, int state)
753 static size_t index, len;
761 rl_attempted_completion_over = 1;
763 while ((name = commands[index]) != NULL) {
765 if (STRCASEEQLEN (name, text, len))
766 return strdup (name);
772 #endif /* HAVE_LIBREADLINE */
774 #ifdef HAVE_RL_COMPLETION_MATCHES
775 #define RL_COMPLETION_MATCHES rl_completion_matches
777 #ifdef HAVE_COMPLETION_MATCHES
778 #define RL_COMPLETION_MATCHES completion_matches
780 #endif /* else just fail if we don't have either symbol */
783 do_completion (const char *text, int start, int end)
785 char **matches = NULL;
787 #ifdef HAVE_LIBREADLINE
788 rl_completion_append_character = ' ';
791 matches = RL_COMPLETION_MATCHES (text, generator);
792 else if (complete_dest_paths)
793 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
800 (* Generate the POD documentation for guestfish. *)
801 and generate_fish_actions_pod () =
802 let all_functions_sorted =
804 fun (_, _, _, flags, _, _, _) ->
805 not (List.mem NotInFish flags || List.mem NotInDocs flags)
806 ) all_functions_sorted in
808 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
811 fun (name, (_, args, optargs), _, flags, _, _, longdesc) ->
813 Str.global_substitute rex (
816 try Str.matched_group 1 s
818 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
819 "L</" ^ replace_char sub '_' '-' ^ ">"
821 let name = replace_char name '_' '-' in
823 filter_map (function FishAlias n -> Some n | _ -> None) flags in
827 pr "=head2 %s\n\n" name
832 | Pathname n | Device n | Dev_or_Path n | String n ->
834 | OptString n -> pr " %s" n
835 | StringList n | DeviceList n -> pr " '%s ...'" n
836 | Bool _ -> pr " true|false"
837 | Int n -> pr " %s" n
838 | Int64 n -> pr " %s" n
839 | FileIn n | FileOut n -> pr " (%s|-)" n
840 | BufferIn n -> pr " %s" n
841 | Key _ -> () (* keys are entered at a prompt *)
842 | Pointer _ -> assert false
846 | (Bool n | Int n | Int64 n | String n) as arg ->
847 pr " [%s:%s]" n (doc_opttype_of arg)
852 pr "%s\n\n" longdesc;
854 if List.exists (function FileIn _ | FileOut _ -> true
855 | _ -> false) args then
856 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
858 if List.exists (function Key _ -> true | _ -> false) args then
859 pr "This command has one or more key or passphrase parameters.
860 Guestfish will prompt for these separately.\n\n";
862 if optargs <> [] then
863 pr "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>.\n\n";
865 if List.mem ProtocolLimitWarning flags then
866 pr "%s\n\n" protocol_limit_warning;
868 match deprecation_notice flags with
870 | Some txt -> pr "%s\n\n" txt
871 ) all_functions_sorted
873 (* Generate documentation for guestfish-only commands. *)
874 and generate_fish_commands_pod () =
876 fun (name, _, _, flags, _, _, longdesc) ->
877 let name = replace_char name '_' '-' in
879 filter_map (function FishAlias n -> Some n | _ -> None) flags in
883 pr "=head2 %s\n\n" name
885 pr "%s\n\n" longdesc;
888 and generate_fish_prep_options_h () =
889 generate_header CStyle GPLv2plus;
891 pr "#ifndef PREPOPTS_H\n";
896 const char *name; /* eg. \"fs\" */
898 size_t nr_params; /* optional parameters */
899 struct prep_param *params;
901 const char *shortdesc; /* short description */
902 const char *longdesc; /* long description */
904 /* functions to implement it */
905 void (*prelaunch) (const char *filename, prep_data *);
906 void (*postlaunch) (const char *filename, prep_data *, const char *device);
910 const char *pname; /* parameter name */
911 const char *pdefault; /* parameter default */
912 const char *pdesc; /* parameter description */
915 extern const struct prep preps[];
918 " (List.length prepopts);
921 fun (name, shortdesc, args, longdesc) ->
923 extern void prep_prelaunch_%s (const char *filename, prep_data *data);
924 extern void prep_postlaunch_%s (const char *filename, prep_data *data, const char *device);
930 pr "#endif /* PREPOPTS_H */\n"
932 and generate_fish_prep_options_c () =
933 generate_header CStyle GPLv2plus;
939 #include \"prepopts.h\"
944 fun (name, shortdesc, args, longdesc) ->
945 pr "static struct prep_param %s_args[] = {\n" name;
947 fun (n, default, desc) ->
948 pr " { \"%s\", \"%s\", \"%s\" },\n" n default desc
954 pr "const struct prep preps[] = {\n";
956 fun (name, shortdesc, args, longdesc) ->
957 pr " { \"%s\", %d, %s_args,
960 prep_prelaunch_%s, prep_postlaunch_%s },
962 name (List.length args) name
963 (c_quote shortdesc) (c_quote longdesc)