generator/generator_fish.ml

   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 open Printf
  22
  23 open Generator_types
  24 open Generator_utils
  25 open Generator_pr
  26 open Generator_docstrings
  27 open Generator_optgroups
  28 open Generator_actions
  29 open Generator_structs
  30 open Generator_prepopts
  31 open Generator_c
  32
  33 (* Generate a lot of different functions for guestfish. *)
  34 let generate_fish_cmds () =
  35   generate_header CStyle GPLv2plus;
  36
  37   let all_functions =
  38     List.filter (
  39       fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
  40     ) all_functions in
  41   let all_functions_sorted =
  42     List.filter (
  43       fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
  44     ) all_functions_sorted in
  45
  46   let all_functions_and_fish_commands_sorted =
  47     List.sort action_compare (all_functions_sorted @ fish_commands) in
  48
  49   pr "#include <config.h>\n";
  50   pr "\n";
  51   pr "#include <stdio.h>\n";
  52   pr "#include <stdlib.h>\n";
  53   pr "#include <string.h>\n";
  54   pr "#include <inttypes.h>\n";
  55   pr "\n";
  56   pr "#include <guestfs.h>\n";
  57   pr "#include \"c-ctype.h\"\n";
  58   pr "#include \"full-write.h\"\n";
  59   pr "#include \"xstrtol.h\"\n";
  60   pr "#include \"fish.h\"\n";
  61   pr "\n";
  62   pr "/* Valid suffixes allowed for numbers.  See Gnulib xstrtol function. */\n";
  63   pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
  64   pr "\n";
  65
  66   (* list_commands function, which implements guestfish -h *)
  67   pr "void list_commands (void)\n";
  68   pr "{\n";
  69   pr "  printf (\"    %%-16s     %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
  70   pr "  list_builtin_commands ();\n";
  71   List.iter (
  72     fun (name, _, _, flags, _, shortdesc, _) ->
  73       let name = replace_char name '_' '-' in
  74       pr "  printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
  75         name shortdesc
  76   ) all_functions_and_fish_commands_sorted;
  77   pr "  printf (\"    %%s\\n\",";
  78   pr "          _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
  79   pr "}\n";
  80   pr "\n";
  81
  82   (* display_command function, which implements guestfish -h cmd *)
  83   pr "int display_command (const char *cmd)\n";
  84   pr "{\n";
  85
  86   List.iter (
  87     fun (name, _, _, flags, _, shortdesc, longdesc) ->
  88       let name2 = replace_char name '_' '-' in
  89       let aliases =
  90         filter_map (function FishAlias n -> Some n | _ -> None) flags in
  91       let describe_alias =
  92         if aliases <> [] then
  93           sprintf "\n\nYou can use %s as an alias for this command."
  94             (String.concat " or " (List.map (fun s -> "'" ^ s ^ "'") aliases))
  95         else "" in
  96
  97       pr "  if (";
  98       pr "STRCASEEQ (cmd, \"%s\")" name;
  99       if name <> name2 then
 100         pr " || STRCASEEQ (cmd, \"%s\")" name2;
 101       List.iter (
 102         fun alias ->
 103           pr " || STRCASEEQ (cmd, \"%s\")" alias
 104       ) aliases;
 105       pr ") {\n";
 106       pr "    pod2text (\"%s\", _(\"%s\"), %S);\n"
 107         name2 shortdesc
 108         ("=head1 DESCRIPTION\n\n" ^
 109          longdesc ^ describe_alias);
 110       pr "    return 0;\n";
 111       pr "  }\n";
 112       pr "  else\n"
 113   ) fish_commands;
 114
 115   List.iter (
 116     fun (name, (_, args, optargs), _, flags, _, shortdesc, longdesc) ->
 117       let name2 = replace_char name '_' '-' in
 118       let aliases =
 119         filter_map (function FishAlias n -> Some n | _ -> None) flags in
 120       let longdesc = replace_str longdesc "C<guestfs_" "C<" in
 121       let synopsis =
 122         match args with
 123         | [] -> name2
 124         | args ->
 125             let args = List.filter (function Key _ -> false | _ -> true) args in
 126             sprintf "%s%s%s"
 127               name2
 128               (String.concat ""
 129                  (List.map (fun arg -> " " ^ name_of_argt arg) args))
 130               (String.concat ""
 131                  (List.map (fun arg -> sprintf " [%s:..]" (name_of_argt arg)) optargs)) in
 132
 133       let warnings =
 134         if List.exists (function Key _ -> true | _ -> false) args then
 135           "\n\nThis command has one or more key or passphrase parameters.
 136 Guestfish will prompt for these separately."
 137         else "" in
 138
 139       let warnings =
 140         warnings ^
 141           if List.mem ProtocolLimitWarning flags then
 142             ("\n\n" ^ protocol_limit_warning)
 143           else "" in
 144
 145       (* For DangerWillRobinson commands, we should probably have
 146        * guestfish prompt before allowing you to use them (especially
 147        * in interactive mode). XXX
 148        *)
 149       let warnings =
 150         warnings ^
 151           if List.mem DangerWillRobinson flags then
 152             ("\n\n" ^ danger_will_robinson)
 153           else "" in
 154
 155       let warnings =
 156         warnings ^
 157           match deprecation_notice flags with
 158           | None -> ""
 159           | Some txt -> "\n\n" ^ txt in
 160
 161       let describe_alias =
 162         if aliases <> [] then
 163           sprintf "\n\nYou can use %s as an alias for this command."
 164             (String.concat " or " (List.map (fun s -> "'" ^ s ^ "'") aliases))
 165         else "" in
 166
 167       pr "  if (";
 168       pr "STRCASEEQ (cmd, \"%s\")" name;
 169       if name <> name2 then
 170         pr " || STRCASEEQ (cmd, \"%s\")" name2;
 171       List.iter (
 172         fun alias ->
 173           pr " || STRCASEEQ (cmd, \"%s\")" alias
 174       ) aliases;
 175       pr ") {\n";
 176       pr "    pod2text (\"%s\", _(\"%s\"), %S);\n"
 177         name2 shortdesc
 178         ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
 179          "=head1 DESCRIPTION\n\n" ^
 180          longdesc ^ warnings ^ describe_alias);
 181       pr "    return 0;\n";
 182       pr "  }\n";
 183       pr "  else\n"
 184   ) all_functions;
 185
 186   pr "    return display_builtin_command (cmd);\n";
 187   pr "}\n";
 188   pr "\n";
 189
 190   let emit_print_list_function typ =
 191     pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
 192       typ typ typ;
 193     pr "{\n";
 194     pr "  unsigned int i;\n";
 195     pr "\n";
 196     pr "  for (i = 0; i < %ss->len; ++i) {\n" typ;
 197     pr "    printf (\"[%%d] = {\\n\", i);\n";
 198     pr "    print_%s_indent (&%ss->val[i], \"  \");\n" typ typ;
 199     pr "    printf (\"}\\n\");\n";
 200     pr "  }\n";
 201     pr "}\n";
 202     pr "\n";
 203   in
 204
 205   (* print_* functions *)
 206   List.iter (
 207     fun (typ, cols) ->
 208       let needs_i =
 209         List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
 210
 211       pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
 212       pr "{\n";
 213       if needs_i then (
 214         pr "  unsigned int i;\n";
 215         pr "\n"
 216       );
 217       List.iter (
 218         function
 219         | name, FString ->
 220             pr "  printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
 221         | name, FUUID ->
 222             pr "  printf (\"%%s%s: \", indent);\n" name;
 223             pr "  for (i = 0; i < 32; ++i)\n";
 224             pr "    printf (\"%%c\", %s->%s[i]);\n" typ name;
 225             pr "  printf (\"\\n\");\n"
 226         | name, FBuffer ->
 227             pr "  printf (\"%%s%s: \", indent);\n" name;
 228             pr "  for (i = 0; i < %s->%s_len; ++i)\n" typ name;
 229             pr "    if (c_isprint (%s->%s[i]))\n" typ name;
 230             pr "      printf (\"%%c\", %s->%s[i]);\n" typ name;
 231             pr "    else\n";
 232             pr "      printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
 233             pr "  printf (\"\\n\");\n"
 234         | name, (FUInt64|FBytes) ->
 235             pr "  printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
 236               name typ name
 237         | name, FInt64 ->
 238             pr "  printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
 239               name typ name
 240         | name, FUInt32 ->
 241             pr "  printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
 242               name typ name
 243         | name, FInt32 ->
 244             pr "  printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
 245               name typ name
 246         | name, FChar ->
 247             pr "  printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
 248               name typ name
 249         | name, FOptPercent ->
 250             pr "  if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
 251               typ name name typ name;
 252             pr "  else printf (\"%%s%s: \\n\", indent);\n" name
 253       ) cols;
 254       pr "}\n";
 255       pr "\n";
 256   ) structs;
 257
 258   (* Emit a print_TYPE_list function definition only if that function is used. *)
 259   List.iter (
 260     function
 261     | typ, (RStructListOnly | RStructAndList) ->
 262         (* generate the function for typ *)
 263         emit_print_list_function typ
 264     | typ, _ -> () (* empty *)
 265   ) (rstructs_used_by all_functions);
 266
 267   (* Emit a print_TYPE function definition only if that function is used. *)
 268   List.iter (
 269     function
 270     | typ, (RStructOnly | RStructAndList) ->
 271         pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
 272         pr "{\n";
 273         pr "  print_%s_indent (%s, \"\");\n" typ typ;
 274         pr "}\n";
 275         pr "\n";
 276     | typ, _ -> () (* empty *)
 277   ) (rstructs_used_by all_functions);
 278
 279   (* run_<action> actions *)
 280   List.iter (
 281     fun (name, (ret, args, optargs as style), _, flags, _, _, _) ->
 282       pr "static int run_%s (const char *cmd, size_t argc, char *argv[])\n" name;
 283       pr "{\n";
 284       (match ret with
 285        | RErr
 286        | RInt _
 287        | RBool _ -> pr "  int r;\n"
 288        | RInt64 _ -> pr "  int64_t r;\n"
 289        | RConstString _ | RConstOptString _ -> pr "  const char *r;\n"
 290        | RString _ -> pr "  char *r;\n"
 291        | RStringList _ | RHashtable _ -> pr "  char **r;\n"
 292        | RStruct (_, typ) -> pr "  struct guestfs_%s *r;\n" typ
 293        | RStructList (_, typ) -> pr "  struct guestfs_%s_list *r;\n" typ
 294        | RBufferOut _ ->
 295            pr "  char *r;\n";
 296            pr "  size_t size;\n";
 297       );
 298       List.iter (
 299         function
 300         | Device n
 301         | String n
 302         | OptString n -> pr "  const char *%s;\n" n
 303         | Pathname n
 304         | Dev_or_Path n
 305         | FileIn n
 306         | FileOut n
 307         | Key n -> pr "  char *%s;\n" n
 308         | BufferIn n ->
 309             pr "  const char *%s;\n" n;
 310             pr "  size_t %s_size;\n" n
 311         | StringList n | DeviceList n -> pr "  char **%s;\n" n
 312         | Bool n -> pr "  int %s;\n" n
 313         | Int n -> pr "  int %s;\n" n
 314         | Int64 n -> pr "  int64_t %s;\n" n
 315       ) args;
 316
 317       if optargs <> [] then (
 318         pr "  struct guestfs_%s_argv optargs_s = { .bitmask = 0 };\n" name;
 319         pr "  struct guestfs_%s_argv *optargs = &optargs_s;\n" name
 320       );
 321
 322       if args <> [] || optargs <> [] then
 323         pr "  size_t i = 0;\n";
 324
 325       pr "\n";
 326
 327       (* Check and convert parameters. *)
 328       let argc_minimum, argc_maximum =
 329         let args_no_keys =
 330           List.filter (function Key _ -> false | _ -> true) args in
 331         let argc_minimum = List.length args_no_keys in
 332         let argc_maximum = argc_minimum + List.length optargs in
 333         argc_minimum, argc_maximum in
 334
 335       if argc_minimum = argc_maximum then (
 336         pr "  if (argc != %d) {\n" argc_minimum;
 337         pr "    fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
 338           argc_minimum;
 339       ) else (
 340         pr "  if (argc < %d || argc > %d) {\n" argc_minimum argc_maximum;
 341         pr "    fprintf (stderr, _(\"%%s should have %%d-%%d parameter(s)\\n\"), cmd, %d, %d);\n"
 342           argc_minimum argc_maximum;
 343       );
 344       pr "    fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
 345       pr "    return -1;\n";
 346       pr "  }\n";
 347
 348       let parse_integer expr fn fntyp rtyp range name =
 349         pr "  {\n";
 350         pr "    strtol_error xerr;\n";
 351         pr "    %s r;\n" fntyp;
 352         pr "\n";
 353         pr "    xerr = %s (%s, NULL, 0, &r, xstrtol_suffixes);\n" fn expr;
 354         pr "    if (xerr != LONGINT_OK) {\n";
 355         pr "      fprintf (stderr,\n";
 356         pr "               _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
 357         pr "               cmd, \"%s\", \"%s\", xerr);\n" name fn;
 358         pr "      return -1;\n";
 359         pr "    }\n";
 360         (match range with
 361          | None -> ()
 362          | Some (min, max, comment) ->
 363              pr "    /* %s */\n" comment;
 364              pr "    if (r < %s || r > %s) {\n" min max;
 365              pr "      fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
 366                name;
 367              pr "      return -1;\n";
 368              pr "    }\n";
 369              pr "    /* The check above should ensure this assignment does not overflow. */\n";
 370         );
 371         pr "    %s = r;\n" name;
 372         pr "  }\n";
 373       in
 374
 375       List.iter (
 376         function
 377         | Device name
 378         | String name ->
 379             pr "  %s = argv[i++];\n" name
 380         | Pathname name
 381         | Dev_or_Path name ->
 382             pr "  %s = resolve_win_path (argv[i++]);\n" name;
 383             pr "  if (%s == NULL) return -1;\n" name
 384         | OptString name ->
 385             pr "  %s = STRNEQ (argv[i], \"\") ? argv[i] : NULL;\n" name;
 386             pr "  i++;\n"
 387         | BufferIn name ->
 388             pr "  %s = argv[i];\n" name;
 389             pr "  %s_size = strlen (argv[i]);\n" name;
 390             pr "  i++;\n"
 391         | FileIn name ->
 392             pr "  %s = file_in (argv[i++]);\n" name;
 393             pr "  if (%s == NULL) return -1;\n" name
 394         | FileOut name ->
 395             pr "  %s = file_out (argv[i++]);\n" name;
 396             pr "  if (%s == NULL) return -1;\n" name
 397         | StringList name | DeviceList name ->
 398             pr "  %s = parse_string_list (argv[i++]);\n" name;
 399             pr "  if (%s == NULL) return -1;\n" name
 400         | Key name ->
 401             pr "  %s = read_key (\"%s\");\n" name name;
 402             pr "  if (%s == NULL) return -1;\n" name
 403         | Bool name ->
 404             pr "  %s = is_true (argv[i++]) ? 1 : 0;\n" name
 405         | Int name ->
 406             let range =
 407               let min = "(-(2LL<<30))"
 408               and max = "((2LL<<30)-1)"
 409               and comment =
 410                 "The Int type in the generator is a signed 31 bit int." in
 411               Some (min, max, comment) in
 412             parse_integer "argv[i++]" "xstrtoll" "long long" "int" range name
 413         | Int64 name ->
 414             parse_integer "argv[i++]" "xstrtoll" "long long" "int64_t" None name
 415       ) args;
 416
 417       (* Optional arguments are prefixed with <argname>:<value> and
 418        * may be missing, so we need to parse those until the end of
 419        * the argument list.
 420        *)
 421       if optargs <> [] then (
 422         let uc_name = String.uppercase name in
 423         pr "\n";
 424         pr "  for (; i < argc; ++i) {\n";
 425         pr "    uint64_t this_mask;\n";
 426         pr "    const char *this_arg;\n";
 427         List.iter (
 428           fun argt ->
 429             let n = name_of_argt argt in
 430             let uc_n = String.uppercase n in
 431             let len = String.length n in
 432             pr "    if (STRPREFIX (argv[i], \"%s:\")) {\n" n;
 433             (match argt with
 434              | Bool n ->
 435                  pr "      optargs_s.%s = is_true (&argv[i][%d]) ? 1 : 0;\n"
 436                    n (len+1);
 437              | Int n ->
 438                  let range =
 439                    let min = "(-(2LL<<30))"
 440                    and max = "((2LL<<30)-1)"
 441                    and comment =
 442                      "The Int type in the generator is a signed 31 bit int." in
 443                    Some (min, max, comment) in
 444                  let expr = sprintf "&argv[i][%d]" (len+1) in
 445                  parse_integer expr "xstrtoll" "long long" "int" range name
 446              | Int64 n ->
 447                  let expr = sprintf "&argv[i][%d]" (len+1) in
 448                  parse_integer expr "xstrtoll" "long long" "int64_t" None name
 449              | String n ->
 450                  pr "      optargs_s.%s = &argv[i][%d];\n" n (len+1);
 451              | _ -> assert false
 452             );
 453             pr "      this_mask = GUESTFS_%s_%s_BITMASK;\n" uc_name uc_n;
 454             pr "      this_arg = \"%s\";\n" n;
 455             pr "    }\n";
 456         ) optargs;
 457
 458         pr "    if (optargs_s.bitmask & this_mask) {\n";
 459         pr "      fprintf (stderr, _(\"%%s: optional argument %%s given twice\\n\"),\n";
 460         pr "               cmd, this_arg);\n";
 461         pr "      return -1;\n";
 462         pr "    }\n";
 463         pr "    optargs_s.bitmask |= this_mask;\n";
 464         pr "  }\n";
 465         pr "\n";
 466       );
 467
 468       (* Call C API function. *)
 469       if optargs = [] then
 470         pr "  r = guestfs_%s " name
 471       else
 472         pr "  r = guestfs_%s_argv " name;
 473       generate_c_call_args ~handle:"g" style;
 474       pr ";\n";
 475
 476       List.iter (
 477         function
 478         | Device _ | String _
 479         | OptString _ | Bool _
 480         | Int _ | Int64 _
 481         | BufferIn _ -> ()
 482         | Pathname name | Dev_or_Path name | FileOut name
 483         | Key name ->
 484             pr "  free (%s);\n" name
 485         | FileIn name ->
 486             pr "  free_file_in (%s);\n" name
 487         | StringList name | DeviceList name ->
 488             pr "  free_strings (%s);\n" name
 489       ) args;
 490
 491       (* Any output flags? *)
 492       let fish_output =
 493         let flags = filter_map (
 494           function FishOutput flag -> Some flag | _ -> None
 495         ) flags in
 496         match flags with
 497         | [] -> None
 498         | [f] -> Some f
 499         | _ ->
 500             failwithf "%s: more than one FishOutput flag is not allowed" name in
 501
 502       (* Check return value for errors and display command results. *)
 503       (match ret with
 504        | RErr -> pr "  return r;\n"
 505        | RInt _ ->
 506            pr "  if (r == -1) return -1;\n";
 507            (match fish_output with
 508             | None ->
 509                 pr "  printf (\"%%d\\n\", r);\n";
 510             | Some FishOutputOctal ->
 511                 pr "  printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
 512             | Some FishOutputHexadecimal ->
 513                 pr "  printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
 514            pr "  return 0;\n"
 515        | RInt64 _ ->
 516            pr "  if (r == -1) return -1;\n";
 517            (match fish_output with
 518             | None ->
 519                 pr "  printf (\"%%\" PRIi64 \"\\n\", r);\n";
 520             | Some FishOutputOctal ->
 521                 pr "  printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
 522             | Some FishOutputHexadecimal ->
 523                 pr "  printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
 524            pr "  return 0;\n"
 525        | RBool _ ->
 526            pr "  if (r == -1) return -1;\n";
 527            pr "  if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
 528            pr "  return 0;\n"
 529        | RConstString _ ->
 530            pr "  if (r == NULL) return -1;\n";
 531            pr "  printf (\"%%s\\n\", r);\n";
 532            pr "  return 0;\n"
 533        | RConstOptString _ ->
 534            pr "  printf (\"%%s\\n\", r ? : \"(null)\");\n";
 535            pr "  return 0;\n"
 536        | RString _ ->
 537            pr "  if (r == NULL) return -1;\n";
 538            pr "  printf (\"%%s\\n\", r);\n";
 539            pr "  free (r);\n";
 540            pr "  return 0;\n"
 541        | RStringList _ ->
 542            pr "  if (r == NULL) return -1;\n";
 543            pr "  print_strings (r);\n";
 544            pr "  free_strings (r);\n";
 545            pr "  return 0;\n"
 546        | RStruct (_, typ) ->
 547            pr "  if (r == NULL) return -1;\n";
 548            pr "  print_%s (r);\n" typ;
 549            pr "  guestfs_free_%s (r);\n" typ;
 550            pr "  return 0;\n"
 551        | RStructList (_, typ) ->
 552            pr "  if (r == NULL) return -1;\n";
 553            pr "  print_%s_list (r);\n" typ;
 554            pr "  guestfs_free_%s_list (r);\n" typ;
 555            pr "  return 0;\n"
 556        | RHashtable _ ->
 557            pr "  if (r == NULL) return -1;\n";
 558            pr "  print_table (r);\n";
 559            pr "  free_strings (r);\n";
 560            pr "  return 0;\n"
 561        | RBufferOut _ ->
 562            pr "  if (r == NULL) return -1;\n";
 563            pr "  if (full_write (1, r, size) != size) {\n";
 564            pr "    perror (\"write\");\n";
 565            pr "    free (r);\n";
 566            pr "    return -1;\n";
 567            pr "  }\n";
 568            pr "  free (r);\n";
 569            pr "  return 0;\n"
 570       );
 571       pr "}\n";
 572       pr "\n"
 573   ) all_functions;
 574
 575   (* run_action function *)
 576   pr "int run_action (const char *cmd, size_t argc, char *argv[])\n";
 577   pr "{\n";
 578
 579   List.iter (
 580     fun (name, _, _, flags, _, _, _) ->
 581       let name2 = replace_char name '_' '-' in
 582       let aliases =
 583         filter_map (function FishAlias n -> Some n | _ -> None) flags in
 584       pr "  if (";
 585       pr "STRCASEEQ (cmd, \"%s\")" name;
 586       if name <> name2 then
 587         pr " || STRCASEEQ (cmd, \"%s\")" name2;
 588       List.iter (
 589         fun alias ->
 590           pr " || STRCASEEQ (cmd, \"%s\")" alias;
 591       ) aliases;
 592       pr ")\n";
 593       pr "    return run_%s (cmd, argc, argv);\n" name;
 594       pr "  else\n";
 595   ) all_functions_and_fish_commands_sorted;
 596
 597   pr "    {\n";
 598   pr "      fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
 599   pr "      if (command_num == 1)\n";
 600   pr "        extended_help_message ();\n";
 601   pr "      return -1;\n";
 602   pr "    }\n";
 603   pr "  return 0;\n";
 604   pr "}\n";
 605   pr "\n"
 606
 607 (* Readline completion for guestfish. *)
 608 and generate_fish_completion () =
 609   generate_header CStyle GPLv2plus;
 610
 611   let all_functions =
 612     List.filter (
 613       fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
 614     ) all_functions in
 615
 616   pr "\
 617 #include <config.h>
 618
 619 #include <stdio.h>
 620 #include <stdlib.h>
 621 #include <string.h>
 622
 623 #ifdef HAVE_LIBREADLINE
 624 #include <readline/readline.h>
 625 #endif
 626
 627 #include \"fish.h\"
 628
 629 #ifdef HAVE_LIBREADLINE
 630
 631 static const char *const commands[] = {
 632   BUILTIN_COMMANDS_FOR_COMPLETION,
 633 ";
 634
 635   (* Get the commands, including the aliases.  They don't need to be
 636    * sorted - the generator() function just does a dumb linear search.
 637    *)
 638   let commands =
 639     List.map (
 640       fun (name, _, _, flags, _, _, _) ->
 641         let name2 = replace_char name '_' '-' in
 642         let aliases =
 643           filter_map (function FishAlias n -> Some n | _ -> None) flags in
 644         name2 :: aliases
 645     ) (all_functions @ fish_commands) in
 646   let commands = List.flatten commands in
 647
 648   List.iter (pr "  \"%s\",\n") commands;
 649
 650   pr "  NULL
 651 };
 652
 653 static char *
 654 generator (const char *text, int state)
 655 {
 656   static size_t index, len;
 657   const char *name;
 658
 659   if (!state) {
 660     index = 0;
 661     len = strlen (text);
 662   }
 663
 664   rl_attempted_completion_over = 1;
 665
 666   while ((name = commands[index]) != NULL) {
 667     index++;
 668     if (STRCASEEQLEN (name, text, len))
 669       return strdup (name);
 670   }
 671
 672   return NULL;
 673 }
 674
 675 #endif /* HAVE_LIBREADLINE */
 676
 677 #ifdef HAVE_RL_COMPLETION_MATCHES
 678 #define RL_COMPLETION_MATCHES rl_completion_matches
 679 #else
 680 #ifdef HAVE_COMPLETION_MATCHES
 681 #define RL_COMPLETION_MATCHES completion_matches
 682 #endif
 683 #endif /* else just fail if we don't have either symbol */
 684
 685 char **
 686 do_completion (const char *text, int start, int end)
 687 {
 688   char **matches = NULL;
 689
 690 #ifdef HAVE_LIBREADLINE
 691   rl_completion_append_character = ' ';
 692
 693   if (start == 0)
 694     matches = RL_COMPLETION_MATCHES (text, generator);
 695   else if (complete_dest_paths)
 696     matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
 697 #endif
 698
 699   return matches;
 700 }
 701 ";
 702
 703 (* Generate the POD documentation for guestfish. *)
 704 and generate_fish_actions_pod () =
 705   let all_functions_sorted =
 706     List.filter (
 707       fun (_, _, _, flags, _, _, _) ->
 708         not (List.mem NotInFish flags || List.mem NotInDocs flags)
 709     ) all_functions_sorted in
 710
 711   let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
 712
 713   List.iter (
 714     fun (name, (_, args, optargs), _, flags, _, _, longdesc) ->
 715       let longdesc =
 716         Str.global_substitute rex (
 717           fun s ->
 718             let sub =
 719               try Str.matched_group 1 s
 720               with Not_found ->
 721                 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
 722             "L</" ^ replace_char sub '_' '-' ^ ">"
 723         ) longdesc in
 724       let name = replace_char name '_' '-' in
 725       let aliases =
 726         filter_map (function FishAlias n -> Some n | _ -> None) flags in
 727
 728       List.iter (
 729         fun name ->
 730           pr "=head2 %s\n\n" name
 731       ) (name :: aliases);
 732       pr " %s" name;
 733       List.iter (
 734         function
 735         | Pathname n | Device n | Dev_or_Path n | String n ->
 736             pr " %s" n
 737         | OptString n -> pr " %s" n
 738         | StringList n | DeviceList n -> pr " '%s ...'" n
 739         | Bool _ -> pr " true|false"
 740         | Int n -> pr " %s" n
 741         | Int64 n -> pr " %s" n
 742         | FileIn n | FileOut n -> pr " (%s|-)" n
 743         | BufferIn n -> pr " %s" n
 744         | Key _ -> () (* keys are entered at a prompt *)
 745       ) args;
 746       List.iter (
 747         function
 748         | Bool n | Int n | Int64 n | String n -> pr " [%s:..]" n
 749         | _ -> assert false
 750       ) optargs;
 751       pr "\n";
 752       pr "\n";
 753       pr "%s\n\n" longdesc;
 754
 755       if List.exists (function FileIn _ | FileOut _ -> true
 756                       | _ -> false) args then
 757         pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
 758
 759       if List.exists (function Key _ -> true | _ -> false) args then
 760         pr "This command has one or more key or passphrase parameters.
 761 Guestfish will prompt for these separately.\n\n";
 762
 763       if optargs <> [] then
 764         pr "This command has one or more optional arguments.  See L</OPTIONAL ARGUMENTS>.\n\n";
 765
 766       if List.mem ProtocolLimitWarning flags then
 767         pr "%s\n\n" protocol_limit_warning;
 768
 769       if List.mem DangerWillRobinson flags then
 770         pr "%s\n\n" danger_will_robinson;
 771
 772       match deprecation_notice flags with
 773       | None -> ()
 774       | Some txt -> pr "%s\n\n" txt
 775   ) all_functions_sorted
 776
 777 (* Generate documentation for guestfish-only commands. *)
 778 and generate_fish_commands_pod () =
 779   List.iter (
 780     fun (name, _, _, flags, _, _, longdesc) ->
 781       let name = replace_char name '_' '-' in
 782       let aliases =
 783         filter_map (function FishAlias n -> Some n | _ -> None) flags in
 784
 785       List.iter (
 786         fun name ->
 787           pr "=head2 %s\n\n" name
 788       ) (name :: aliases);
 789       pr "%s\n\n" longdesc;
 790   ) fish_commands
 791
 792 and generate_fish_prep_options_h () =
 793   generate_header CStyle GPLv2plus;
 794
 795   pr "#ifndef PREPOPTS_H\n";
 796   pr "\n";
 797
 798   pr "\
 799 struct prep {
 800   const char *name;             /* eg. \"fs\" */
 801
 802   size_t nr_params;             /* optional parameters */
 803   struct prep_param *params;
 804
 805   const char *shortdesc;        /* short description */
 806   const char *longdesc;         /* long description */
 807
 808                                 /* functions to implement it */
 809   void (*prelaunch) (const char *filename, prep_data *);
 810   void (*postlaunch) (const char *filename, prep_data *, const char *device);
 811 };
 812
 813 struct prep_param {
 814   const char *pname;            /* parameter name */
 815   const char *pdefault;         /* parameter default */
 816   const char *pdesc;            /* parameter description */
 817 };
 818
 819 extern const struct prep preps[];
 820 #define NR_PREPS %d
 821
 822 " (List.length prepopts);
 823
 824   List.iter (
 825     fun (name, shortdesc, args, longdesc) ->
 826       pr "\
 827 extern void prep_prelaunch_%s (const char *filename, prep_data *data);
 828 extern void prep_postlaunch_%s (const char *filename, prep_data *data, const char *device);
 829
 830 " name name;
 831   ) prepopts;
 832
 833   pr "\n";
 834   pr "#endif /* PREPOPTS_H */\n"
 835
 836 and generate_fish_prep_options_c () =
 837   generate_header CStyle GPLv2plus;
 838
 839   pr "\
 840 #include \"fish.h\"
 841 #include \"prepopts.h\"
 842
 843 ";
 844
 845   List.iter (
 846     fun (name, shortdesc, args, longdesc) ->
 847       pr "static struct prep_param %s_args[] = {\n" name;
 848       List.iter (
 849         fun (n, default, desc) ->
 850           pr "  { \"%s\", \"%s\", \"%s\" },\n" n default desc
 851       ) args;
 852       pr "};\n";
 853       pr "\n";
 854   ) prepopts;
 855
 856   pr "const struct prep preps[] = {\n";
 857   List.iter (
 858     fun (name, shortdesc, args, longdesc) ->
 859       pr "  { \"%s\", %d, %s_args,
 860     \"%s\",
 861     \"%s\",
 862     prep_prelaunch_%s, prep_postlaunch_%s },
 863 "
 864         name (List.length args) name
 865         (c_quote shortdesc) (c_quote longdesc)
 866         name name;
 867   ) prepopts;
 868   pr "};\n"