fix: add --output to wat2wasm, wasm2wat and opt cmd

CHANGES.md

@@ -1,5 +1,6 @@
 ## unreleased
 
+- `wat2wasm` emit wasm files in same dir as wat files 
 - add `--emit-file` option to `wasm2wat` to emit .wat files
 - adds flags `--fail-on-trap-only` and `fail-on-assertion-only`
 - parameterize the `Thread` module on the symbolic memory and the `Choice_monad` module on a Thread

example/README.md

@@ -53,11 +53,11 @@ COMMANDS
  validate [--debug] [OPTION]… [ARG]…
  Validate a module
 
- wasm2wat [--emit-file] [OPTION]… [ARG]…
+ wasm2wat [--emit-file] [--output=FILE] [OPTION]… ARG
  Generate a text format file (.wat) from a binary format file
  (.wasm)
 
- wat2wasm [OPTION]… [ARG]…
+ wat2wasm [OPTION]… ARG
  Generate a binary format file (.wasm) from a text format file
  (.wat)
 

example/wasm2wat/README.md

@@ -28,12 +28,15 @@ NAME
  file (.wasm)
 
 SYNOPSIS
- owi wasm2wat [--emit-file] [OPTION]… [ARG]…
+ owi wasm2wat [--emit-file] [--output=FILE] [OPTION]… ARG
 
 OPTIONS
  --emit-file
  emit (.wat) files from corresponding (.wasm) files
 
+ -o FILE, --output=FILE
+ wasm
+
 COMMON OPTIONS
  --help[=FMT] (default=auto)
  Show this help in format FMT. The value FMT must be one of auto,

example/wat2wasm/README.md

@@ -34,12 +34,15 @@ NAME
  format file (.wat)
 
 SYNOPSIS
- owi wat2wasm [OPTION]… [ARG]…
+ owi wat2wasm [OPTION]… ARG
 
 OPTIONS
  -d, --debug
  debug mode
 
+ -o FILE, --output=FILE
+ wat
+
  --optimize
  optimize mode
 

src/ast/binary_encoder.ml

@@ -759,17 +759,17 @@ let encode
  encode_section buf '\x0B' encode_datas data;
  Buffer.contents buf
 
-let write_file filename content =
+let write_file outfile filename content =
  let _dir, filename = Fpath.split_base filename in
- let filename, _ext = Fpath.split_ext filename in
- let filename = Fpath.add_ext ".wasm" filename in
+ let filename = Fpath.set_ext "wasm" filename in
+ let filename = match outfile with Some name -> Fpath.v name | None -> filename in
  let filename = Fpath.to_string filename in
  let oc = Out_channel.open_bin filename in
  Out_channel.output_string oc content;
  Out_channel.close oc
 
-let convert (filename : Fpath.t) ~unsafe ~optimize m =
+let convert (outfile: string option) (filename : Fpath.t) ~unsafe ~optimize m =
  Log.debug0 "bin encoding ...@\n";
  let+ m = Compile.Text.until_optimize ~unsafe ~optimize m in
  let content = encode m in
- write_file filename content
+ write_file outfile filename content

src/ast/binary_encoder.mli

@@ -3,7 +3,8 @@
 (* Written by the Owi programmers *)
 
 val convert :
- Fpath.t
+ string option
+ -> Fpath.t
  -> unsafe:bool
  -> optimize:bool
  -> Text.modul

src/bin/owi.ml

@@ -39,6 +39,16 @@ let files =
  let f = existing_non_dir_file in
  Cmdliner.Arg.(value & pos_all f [] (info [] ~doc))
 
+let sourcefile ty =
+ let doc = Fmt.str "%s source file" ty in
+ let f = existing_non_dir_file in
+ Cmdliner.Arg.(required & pos 0 (some f) None (info [] ~doc))
+
+let outfile ty =
+ let doc = Fmt.str "%s" ty in
+ Cmdliner.Arg.(
+ value & opt (some string) None & info [ "o"; "output" ] ~docv:"FILE" ~doc )
+
 let emit_files =
  let doc = "emit (.wat) files from corresponding (.wasm) files" in
  Cmdliner.Arg.(value & flag & info [ "emit-file" ] ~doc)
@@ -249,7 +259,8 @@ let wasm2wat_cmd =
  let man = [] @ shared_man in
  Cmd.info "wasm2wat" ~version ~doc ~sdocs ~man
  in
- Cmd.v info Term.(const Cmd_wasm2wat.cmd $ files $ emit_files)
+ Cmd.v info
+ Term.(const Cmd_wasm2wat.cmd $ sourcefile "wasm" $ emit_files $ outfile "wasm")
 
 let wat2wasm_cmd =
  let open Cmdliner in
@@ -261,7 +272,9 @@ let wat2wasm_cmd =
  Cmd.info "wat2wasm" ~version ~doc ~sdocs ~man
  in
  Cmd.v info
- Term.(const Cmd_wat2wasm.cmd $ profiling $ debug $ unsafe $ optimize $ files)
+ Term.(
+ const Cmd_wat2wasm.cmd $ profiling $ debug $ unsafe $ optimize
+ $ outfile "wat" $ sourcefile "wat" )
 
 let cli =
  let open Cmdliner in

src/cmd/cmd_wasm2wat.ml

@@ -5,16 +5,24 @@
 open Syntax
 
 (** Utility function to handle writing to a file or printing to stdout *)
-let cmd_one emitfile file =
+let cmd_one emitfile outfile file =
  let ext = Fpath.get_ext file in
- let wat_file = Fpath.set_ext "wat" file in
+ let _dir, wat_file = Fpath.split_base file in
+ let wat_file = Fpath.set_ext "wat" wat_file in
 
  match ext with
  | ".wasm" ->
  let* m = Parse.Binary.Module.from_file file in
  let m = Binary_to_text.modul m in
- if emitfile then Bos.OS.File.writef wat_file "%a@\n" Text.pp_modul m
+ let outname, output =
+ begin
+ match outfile with
+ | Some name -> Fpath.v name, true
+ | None -> wat_file, false
+ end
+ in
+ if emitfile || output then Bos.OS.File.writef outname "%a@\n" Text.pp_modul m
  else Ok (Fmt.pr "%a@\n" Text.pp_modul m)
  | ext -> Error (`Unsupported_file_extension ext)
 
-let cmd files emitfile = list_iter (cmd_one emitfile) files
+let cmd file emitfile outfile = cmd_one emitfile outfile file

src/cmd/cmd_wasm2wat.mli

@@ -2,4 +2,4 @@
 (* Copyright © 2021-2024 OCamlPro *)
 (* Written by the Owi programmers *)
 
-val cmd : Fpath.t list -> bool -> unit Result.t
+val cmd : Fpath.t -> bool -> string option -> unit Result.t

src/cmd/cmd_wat2wasm.ml

@@ -4,15 +4,15 @@
 
 open Syntax
 
-let cmd_one ~unsafe ~optimize file =
+let cmd_one ~unsafe ~optimize outfile file =
  let ext = Fpath.get_ext file in
  match ext with
  | ".wat" ->
  let* modul = Parse.Text.Module.from_file file in
- Binary_encoder.convert file ~unsafe ~optimize modul
+ Binary_encoder.convert outfile file ~unsafe ~optimize modul
  | ext -> Error (`Unsupported_file_extension ext)
 
-let cmd profiling debug unsafe optimize files =
+let cmd profiling debug unsafe optimize outfile file =
  if profiling then Log.profiling_on := true;
  if debug then Log.debug_on := true;
- list_iter (cmd_one ~unsafe ~optimize) files
+ cmd_one ~unsafe ~optimize outfile file

src/cmd/cmd_wat2wasm.mli

@@ -2,4 +2,4 @@
 (* Copyright © 2021-2024 OCamlPro *)
 (* Written by the Owi programmers *)
 
-val cmd : bool -> bool -> bool -> bool -> Fpath.t list -> unit Result.t
+val cmd : bool -> bool -> bool -> bool -> string option -> Fpath.t -> unit Result.t

test/help/help.t

@@ -31,11 +31,11 @@ no subcommand should print help
  validate [--debug] [OPTION]… [ARG]…
  Validate a module
 
- wasm2wat [--emit-file] [OPTION]… [ARG]…
+ wasm2wat [--emit-file] [--output=FILE] [OPTION]… ARG
  Generate a text format file (.wat) from a binary format file
  (.wasm)
 
- wat2wasm [OPTION]… [ARG]…
+ wat2wasm [OPTION]… ARG
  Generate a binary format file (.wasm) from a text format file
  (.wat)
 

test/wasm2wat/not_exists.t

@@ -1,6 +1,6 @@
  $ owi wasm2wat idontexist.wat
  owi: no file 'idontexist.wat'
- Usage: owi wasm2wat [--emit-file] [OPTION]… [ARG]…
+ Usage: owi wasm2wat [--emit-file] [--output=FILE] [OPTION]… ARG
  Try 'owi wasm2wat --help' or 'owi --help' for more information.
  [124]
  $ owi wasm2wat bad.ext

test/wat2wasm/not_exists.t

@@ -1,6 +1,6 @@
  $ owi wat2wasm not_exists.wat
  owi: no file 'not_exists.wat'
- Usage: owi wat2wasm [OPTION]… [ARG]…
+ Usage: owi wat2wasm [OPTION]… ARG
  Try 'owi wat2wasm --help' or 'owi --help' for more information.
  [124]
  $ owi wat2wasm bad.ext