Files
libguestfs/generator/prepopts.ml
Richard W.M. Jones 02b64d5cec generator: Use quoted string literals in many places
This change was done almost entirely automatically using the script
below.  This uses the OCaml lexer to read the source files and extract
the strings and locations.  Strings which are "candidates" (in this
case, longer than 3 lines) are replaced in the output with quoted
string literals.

Since the OCaml lexer is used, it already substitutes all escape
sequences correctly.  I diffed the output of the generator and it is
identical after this change, except for UUIDs, which change because of
how Utils.stable_uuid is implemented.

Thanks: Nicolas Ojeda Bar

$ ocamlfind opt -package unix,compiler-libs.common find_strings.ml \
                -o find_strings.opt -linkpkg
$ for f in $( git ls-files -- \*.ml ) ; do ./find_strings.opt $f ; done

open Printf

let read_whole_file path =
  let buf = Buffer.create 16384 in
  let chan = open_in path in
  let maxlen = 16384 in
  let b = Bytes.create maxlen in
  let rec loop () =
    let r = input chan b 0 maxlen in
    if r > 0 then (
      Buffer.add_substring buf (Bytes.to_string b) 0 r;
      loop ()
    )
  in
  loop ();
  close_in chan;
  Buffer.contents buf

let count_chars c str =
  let count = ref 0 in
  for i = 0 to String.length str - 1 do
    if c = String.unsafe_get str i then incr count
  done;
  !count

let subs = ref []

let consider_string str loc =
  let nr_lines = count_chars '\n' str in
  if nr_lines > 3 then
    subs := (str, loc) :: !subs

let () =
  Lexer.init ();
  let filename = Sys.argv.(1) in
  let content = read_whole_file filename in
  let lexbuf = Lexing.from_string content in
  let rec loop () =
    let token = Lexer.token lexbuf in
    (match token with
     | Parser.EOF -> ();
     | STRING (s, loc, sopt) ->
        consider_string s loc; (* sopt? *)
        loop ();
     | token ->
        loop ();
    )
  in
  loop ();

  (* The list of subs is already reversed, which is convenient
   * because we must the file substitutions in reverse order.
   *)
  let subs = !subs in
  let new_content = ref content in
  List.iter (
    fun (str, loc) ->
      let { Location.loc_start = { pos_cnum = p1 };
            loc_end = { pos_cnum = p2 } } = loc in
      let len = String.length !new_content in
      let before = String.sub !new_content 0 (p1-1) in
      let after = String.sub !new_content (p2+1) (len - p2 - 1) in
      new_content := before ^ "{|" ^ str ^ "|}" ^ after
  ) subs;

  let new_content = !new_content in

  if content <> new_content then (
    (* Update the file in place. *)
    let new_filename = filename ^ ".new"
    and backup_filename = filename ^ ".bak" in
    let chan = open_out new_filename in
    fprintf chan "%s" new_content;
    close_out chan;
    Unix.rename filename backup_filename;
    Unix.rename new_filename filename
  )
2025-09-01 17:08:52 +01:00

105 lines
4.4 KiB
OCaml

(* libguestfs
* Copyright (C) 2009-2025 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. *)
type optargs = (string * string * string) list
type prepopt = string * string * optargs * string
(* Used for the guestfish -N (prepared disk images) option.
*)
let prepopts = [
("disk",
"create a blank disk",
[ "size", "1G", "the size of the disk image" ],
"Create a blank disk, size 1G (by default).
The default size can be changed by supplying an optional parameter.");
("part",
"create a partitioned disk",
[ "size", "1G", "the size of the disk image";
"partition", "mbr", "partition table type" ],
{|Create a disk with a single partition. By default the size of the disk
is 1G (the available space in the partition will be a tiny bit smaller)
and the partition table will be MBR (old DOS-style).
These defaults can be changed by supplying optional parameters.|});
("fs",
"create a filesystem",
[ "filesystem", "ext2", "the type of filesystem to use";
"size", "1G", "the size of the disk image";
"partition", "mbr", "partition table type" ],
{|Create a disk with a single partition, with the partition containing
an empty filesystem. This defaults to creating a 1G disk (the available
space in the filesystem will be a tiny bit smaller) with an MBR (old
DOS-style) partition table and an ext2 filesystem.
These defaults can be changed by supplying optional parameters.|});
("lv",
"create a disk with logical volume",
[ "name", "/dev/VG/LV", "the name of the VG and LV to use";
"size", "1G", "the size of the disk image";
"partition", "mbr", "partition table type" ],
{|Create a disk with a single partition, set up the partition as an
LVM2 physical volume, and place a volume group and logical volume
on there. This defaults to creating a 1G disk with the VG and
LV called C</dev/VG/LV>. You can change the name of the VG and LV
by supplying an alternate name as the first optional parameter.
Note this does not create a filesystem. Use 'lvfs' to do that.|});
("lvfs",
"create a disk with logical volume and filesystem",
[ "name", "/dev/VG/LV", "the name of the VG and LV to use";
"filesystem", "ext2", "the type of filesystem to use";
"size", "1G", "the size of the disk image";
"partition", "mbr", "partition table type" ],
{|Create a disk with a single partition, set up the partition as an
LVM2 physical volume, and place a volume group and logical volume
on there. Then format the LV with a filesystem. This defaults to
creating a 1G disk with the VG and LV called C</dev/VG/LV>, with an
ext2 filesystem.|});
("bootroot",
"create a boot and root filesystem",
[ "bootfs", "ext2", "the type of filesystem to use for boot";
"rootfs", "ext2", "the type of filesystem to use for root";
"size", "1G", "the size of the disk image";
"bootsize", "128M", "the size of the boot filesystem";
"partition", "mbr", "partition table type" ],
"Create a disk with two partitions, for boot and root filesystem.
Format the two filesystems independently. There are several optional
parameters which control the exact layout and filesystem types.");
("bootrootlv",
"create a boot and root filesystem using LVM",
[ "name", "/dev/VG/LV", "the name of the VG and LV for root";
"bootfs", "ext2", "the type of filesystem to use for boot";
"rootfs", "ext2", "the type of filesystem to use for root";
"size", "1G", "the size of the disk image";
"bootsize", "128M", "the size of the boot filesystem";
"partition", "mbr", "partition table type" ],
"This is the same as C<bootroot> but the root filesystem (only) is
placed on a logical volume, named by default C</dev/VG/LV>. There are
several optional parameters which control the exact layout.");
]