add script command

Author: SamWindell

RELEASE.md

@@ -4,6 +4,10 @@ The macOS version is a universal binary, codesigned and notarized.
 
 Changes:
 
+0.3.0:
+- Slightly change behaviour of `--output-folder`: now, if the input files are within the CWD, the output files will be put into the output folder with the same structure of subfolders.
+- Add `script` command to run a series of subcommands.
+
 0.2.0:
 - Rename subcommand `remove-silence` to `trim-silence`
 - Change `norm` subcommand to take a `--mode` argument; one of `peak` or `rms` rather than `--rms` flag. Default mode is `peak`.

code/common/common.cpp

@@ -162,6 +162,24 @@ std::unique_ptr<FILE, void (*)(FILE *)> OpenFile(const fs::path &path, const cha
     return {nullptr, SafeFClose};
 }
 
+std::string ReadEntireFile(const fs::path &path) {
+    std::string result {};
+    auto f = OpenFile(path, "rb");
+    if (!f) return result;
+
+    fseek(f.get(), 0, SEEK_END);
+    const auto size = ftell(f.get());
+    fseek(f.get(), 0, SEEK_SET);
+
+    result.resize(size);
+    auto const num_read = fread(result.data(), 1, size, f.get());
+    if (num_read != (size_t)size) {
+        WarningWithNewLine("Signet", {}, "could not read file {} for reason: {}", path, strerror(errno));
+        return {};
+    }
+    return result;
+}
+
 TEST_CASE("Common") {
     {
         REQUIRE(GetFreqWithCentDifference(100, 1200) == 200);

code/common/common.h

@@ -112,3 +112,4 @@ double GetFreqWithCentDifference(double starting_hz, double cents);
 
 std::unique_ptr<FILE, void (*)(FILE *)> OpenFile(const fs::path &path, const char *mode);
 FILE *OpenFileRaw(const fs::path &path, const char *mode, std::error_code *ec = nullptr);
+std::string ReadEntireFile(const fs::path &path);

code/signet/signet_interface.cpp

@@ -120,11 +120,12 @@ int SignetInterface::Main(const int argc, const char *const argv[]) {
                       [](const CLI::App *a, const CLI::App *b) { return a->get_name() < b->get_name(); });
 
             std::map<std::string, std::vector<std::string>> command_categories;
-            command_categories["Signet Utility"] = {"undo", "clear-backup", "make-docs"};
+            command_categories["Signet Utility"] = {"undo", "clear-backup", "make-docs", "script"};
             command_categories["Filepath"] = {"rename", "move", "folderise"};
             command_categories["Audio"] = {
-                "add-loop", "auto-tune", "fade",    "fix-pitch-drift", "gain", "highpass",     "lowpass", "norm",
-                "pan",       "reverse", "seamless-loop",   "trim", "trim-silence", "tune",    "zcross-offset",
+                "add-loop",     "auto-tune", "fade",          "fix-pitch-drift", "gain",          "highpass",
+                "lowpass",      "norm",      "pan",           "reverse",         "seamless-loop", "trim",
+                "trim-silence", "tune",      "zcross-offset",
             };
             command_categories["File Data"] = {"convert", "embed-sampler-info"};
             command_categories["Info"] = {"detect-pitch", "print-info"};
@@ -302,6 +303,58 @@ int SignetInterface::Main(const int argc, const char *const argv[]) {
         }
     }
 
+    {
+        auto script = app.add_subcommand(
+            "script",
+            "Run a script file containing a list of commands to run. The script file should be a text file with one command per line. The commands should be in the same format as you would use on the command line. Empty lines or lines starting with # are ignored.");
+        script->add_option("script-file", m_script_filepath, "The filepath for the script file.")
+            ->check(CLI::ExistingPath);
+        script->final_callback([&]() {
+            auto file_data = ReadEntireFile(m_script_filepath);
+            if (file_data.empty()) {
+                throw CLI::ParseError("script file not accessible or empty", 1);
+            }
+
+            Replace(file_data, "\r\n", "\n");
+            Replace(file_data, "\r", "\n");
+            auto lines = Split(file_data, "\n", false);
+
+            for (auto line : lines) {
+                while (line.size() && std::isspace(line.front()))
+                    line.remove_prefix(1);
+                while (line.size() && std::isspace(line.back()))
+                    line.remove_suffix(1);
+
+                if (line.empty()) continue;
+                if (line[0] == '#') continue;
+
+                std::string_view command_name {};
+                {
+                    size_t pos = 0;
+                    while (pos < line.size() && !std::isspace(line[pos])) {
+                        ++pos;
+                    }
+                    command_name = line.substr(0, pos);
+                }
+
+                bool found = false;
+                for (auto subcommand : app.get_subcommands({})) {
+                    if (subcommand == script) continue;
+                    if (subcommand->get_name() != command_name) continue;
+
+                    subcommand->clear();
+                    subcommand->parse(std::string(line.substr(command_name.size())));
+                    found = true;
+                    break;
+                }
+
+                if (!found) {
+                    WarningWithNewLine("Signet", {}, "Unknown command: {}", command_name);
+                }
+            }
+        });
+    }
+
     const auto PrintSuccess = []() {
         fmt::print(fmt::fg(fmt::terminal_color::green), "Signet completed successfully.\n");
     };

code/signet/signet_interface.h

@@ -36,6 +36,7 @@ class SignetInterface final {
     AudioFiles m_input_audio_files {};
     bool m_recursive_directory_search {};
     fs::path m_make_docs_filepath {};
+    fs::path m_script_filepath {};
     std::optional<fs::path> m_output_path {};
     std::optional<fs::path> m_single_output_file {};
 };

docs/usage.md

@@ -50,6 +50,7 @@ This is an auto-generated file based on the output of `signet --help`. It contai
 - [Signet Utility Commands](#Signet-Utility-Commands)
   - [clear-backup](#sound-clear-backup)
   - [make-docs](#sound-make-docs)
+  - [script](#sound-script)
   - [undo](#sound-undo)
 
 # General Usage
@@ -806,6 +807,17 @@ Creates a Github flavour markdown file containing the full CLI - based on runnin
 `output-file TEXT REQUIRED`
 The filepath for the generated markdown file.
 
+## :sound: script
+### Description:
+Run a script file containing a list of commands to run. The script file should be a text file with one command per line. The commands should be in the same format as you would use on the command line. Empty lines or lines starting with # are ignored.
+
+### Usage:
+  `script` `[script-file]`
+
+### POSITIONALS:
+`script-file TEXT:PATH(existing)`
+The filepath for the script file.
+
 ## :sound: undo
 ### Description:
 Undo any changes made by the last run of Signet; files that were overwritten are restored, new files that were created are destroyed, and files that were renamed are un-renamed. You can only undo once - you cannot keep going back in history.