Add diagham_command to only create the command string and add option wait to run (#5)

* Add `diagham_command` to only create the command string. Also add option `wait` to `execute_diagham_script` to control whether the process should be waited for.

* format

Author: AFeuerpfeil

src/DiagHamInterface.jl

@@ -4,6 +4,7 @@ Interface to the DiagHam library.
 module DiagHamInterface
 
 export execute_diagham_script
+export diagham_command
 export install_diagham
 
 export read_matrix_from_txt
@@ -17,7 +18,7 @@ using Preferences
 
 include("utility/backup.jl")
 include("utility/diagham_path.jl")
-include("utility/execute_script.jl")
+include("utility/diagham_script.jl")
 include("utility/diagham_install.jl")
 include("utility/fileending.jl")
 include("utility/numbers.jl")

src/utility/execute_script.jl src/utility/diagham_script.jlsrc/utility/execute_script.jl renamed to src/utility/diagham_script.jl

@@ -1,28 +1,16 @@
 """
-    execute_diagham_script(execute; kwargs...)
-
-Run a DiagHam executable. Kwargs are converted to CLI flags (`_` → `-`).
-Single-char keys use `-k`, multi-char use `--key`. Boolean `true` adds flag, `false` omits.
-
-The kwargs of `Cmd()` are supported.
+    diagham_command(execute; kwargs...)
+Construct a command string for running a DiagHam executable with specified kwargs as CLI flags.
 """
-function execute_diagham_script(execute::AbstractString; kwargs...)
-    return execute_diagham_script([execute]; kwargs...)
+function diagham_command(execute::AbstractString; kwargs...)
+    return diagham_command([execute]; kwargs...)
 end
-
-function execute_diagham_script(
+function diagham_command(
         execute::AbstractVector{<:AbstractString};
         diagham_path::AbstractString = get_diagham_path(),
-        ignorestatus::Bool = false,
-        detach::Bool = false,
-        windows_verbatim::Bool = false,
-        windows_hide::Bool = false,
-        env = nothing,
-        dir = "",
         kwargs...
     )
     warn_about_diagham_path()
-
     ex_file = first(execute)
     execute[1] = joinpath(diagham_path, ex_file)
     execute = prod(execute)
@@ -31,10 +19,7 @@ function execute_diagham_script(
     for (k, v) in kwargs
         execute *= diagham_kwarg(k, v)
     end
-
-    execute = Cmd(split(execute, " "))
-    cmd = Cmd(execute; ignorestatus = ignorestatus, detach = detach, windows_verbatim = windows_verbatim, windows_hide = windows_hide, env = env, dir = dir)
-    return run(cmd)
+    return execute
 end
 
 function diagham_kwarg(key, value)
@@ -49,3 +34,33 @@ function diagham_kwarg(key, value)
     end
     return ""
 end
+
+"""
+    execute_diagham_script(execute; kwargs...)
+
+Run a DiagHam executable. Kwargs are converted to CLI flags (`_` → `-`).
+Single-char keys use `-k`, multi-char use `--key`. Boolean `true` adds flag, `false` omits.
+
+The kwargs of `Cmd()` and `run()` are supported.
+"""
+function execute_diagham_script(execute::AbstractString; kwargs...)
+    return execute_diagham_script([execute]; kwargs...)
+end
+function execute_diagham_script(
+        execute::AbstractVector{<:AbstractString};
+        diagham_path::AbstractString = get_diagham_path(),
+        ignorestatus::Bool = false,
+        detach::Bool = false,
+        windows_verbatim::Bool = false,
+        windows_hide::Bool = false,
+        env = nothing,
+        dir = "",
+        wait::Bool = true,
+        cleanup::Bool = false,
+        kwargs...
+    )
+    execute = diagham_command(execute; diagham_path, kwargs...)
+    execute = Cmd(split(execute, " "))
+    cmd = Cmd(execute; ignorestatus = ignorestatus, detach = detach, windows_verbatim = windows_verbatim, windows_hide = windows_hide, env = env, dir = dir)
+    return run(cmd; wait = wait)
+end