mirror of
https://github.com/libguestfs/libguestfs.git
synced 2026-03-21 22:53:37 +00:00
02b64d5cec
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
)
66 lines
2.3 KiB
OCaml
66 lines
2.3 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. *)
|
||
|
||
open Types
|
||
|
||
(* Debug APIs. *)
|
||
|
||
let non_daemon_functions = [
|
||
{ defaults with
|
||
name = "debug_drives"; added = (1, 13, 22);
|
||
style = RStringList (RPlainString, "cmdline"), [], [];
|
||
visibility = VDebug;
|
||
blocking = false;
|
||
shortdesc = "debug the drives (internal use only)";
|
||
longdesc = "\
|
||
This returns the internal list of drives. ‘debug’ commands are
|
||
not part of the formal API and can be removed or changed at any time." };
|
||
|
||
]
|
||
|
||
let daemon_functions = [
|
||
{ defaults with
|
||
name = "debug"; added = (1, 0, 11);
|
||
style = RString (RPlainString, "result"), [String (PlainString, "subcmd"); StringList (PlainString, "extraargs")], [];
|
||
visibility = VDebug;
|
||
shortdesc = "debugging and internals";
|
||
longdesc = {|The C<guestfs_debug> command exposes some internals of
|
||
C<guestfsd> (the guestfs daemon) that runs inside the
|
||
hypervisor.
|
||
|
||
There is no comprehensive help for this command. You have
|
||
to look at the file F<daemon/debug.c> in the libguestfs source
|
||
to find out what you can do.|} };
|
||
|
||
{ defaults with
|
||
name = "debug_upload"; added = (1, 3, 5);
|
||
style = RErr, [String (FileIn, "filename"); String (PlainString, "tmpname"); Int "mode"], [];
|
||
visibility = VDebug;
|
||
cancellable = true;
|
||
shortdesc = "upload a file to the appliance (internal use only)";
|
||
longdesc = {|The C<guestfs_debug_upload> command uploads a file to
|
||
the libguestfs appliance.
|
||
|
||
There is no comprehensive help for this command. You have
|
||
to look at the file F<daemon/debug.c> in the libguestfs source
|
||
to find out what it is for.|} };
|
||
|
||
]
|