added gd-translate command (#28)

* added gd-translate command

* switched from tmpfile to subprocess lib

* include cpp-subprocess dependency

* rm bundled file

* use cpp-subprocess

* wrap output in string view

* mention how to avoid the installation error

* remove tail

* fix

* fix format

* remove redundant variable

* change type of spoiler to bool

---------

Co-authored-by: Ren Tatsumoto <tatsu@autistici.org>

Author: NicolasNewman

README.md

@@ -188,6 +188,32 @@ This script searches Anki cards in your collection that contain %GDWORD%.
 gd-ankisearch --field-name VocabKanji --show-fields VocabKanji,SentKanji,Image,SentAudio --word %GDWORD%
 ```
 
+## gd-translate
+
+**Usage**
+
+```
+gd-translate --sentence %GDSEARCH%
+gd-translate --spoiler yes --to fr --sentence %GDSEARCH%
+```
+
+**Dependencies**
+
+This script requires [Argos Translate](https://github.com/argosopentech/argos-translate) and the JA -> target language package to be installed.
+
+```sh
+pipx install argostranslate
+argospm install translate-ja_en
+
+argos-translate -f ja --t en "Hello World!"
+```
+
+If you can't install `argostranslate` due to an error, try an older version of python.
+
+```sh
+pipx install --python /usr/bin/python3.9 argostranslate
+```
+
 ## gd-mandarin
 
 This script passes a sentence through mecab in order to make every part of the sentence clickable.

src/main.cpp

@@ -23,6 +23,7 @@
 #include "massif.h"
 #include "mecab_split.h"
 #include "precompiled.h"
+#include "translate.h"
 #include "util.h"
 
 static constexpr std::string_view help_text = R"EOF(usage: {} ACTION [OPTIONS]
@@ -32,6 +33,7 @@ ACTIONS
   ankisearch  Search word in Anki.
   massif      Search word on Massif.
   images      Search images on Bing.
+  translate   Translate text using argostranslate.
   marisa      Split search string using MARISA.
   mecab       Split search string using Mecab.
   strokeorder Show stroke order of a word.
@@ -92,6 +94,8 @@ auto take_action(std::span<std::string_view const> const args) -> void
     return massif(rest);
   case "gd-images"_h:
     return images(rest);
+  case "gd-translate"_h:
+    return translate(rest);
   case "gd-marisa"_h:
     return marisa_split(rest);
   case "gd-mecab"_h:
@@ -114,6 +118,8 @@ auto take_action(std::span<std::string_view const> const args) -> void
     return massif(rest);
   case "images"_h:
     return images(rest);
+  case "translate"_h:
+    return translate(rest);
   case "marisa"_h:
     return marisa_split(rest);
   case "mecab"_h:

src/precompiled.h

@@ -29,7 +29,7 @@
 
 // Other
 #include <cpr/cpr.h>
-
+#include <subprocess.hpp>
 #include <marisa/trie.h>
 #include <mecab.h>
 #include <nlohmann/json.hpp>

src/translate.cpp

@@ -0,0 +1,101 @@
+/*
+ *  gd-tools - a set of programs to enhance goldendict for immersion learning.
+ *  Copyright (C) 2025 Ajatt-Tools
+ *
+ *  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 3 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, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "precompiled.h"
+#include "util.h"
+
+using namespace std::literals;
+namespace sp = subprocess;
+
+static constexpr std::string_view help_text = R"EOF(usage: gd-translate [OPTIONS]
+
+Translate text from Japanese to target language
+
+OPTIONS
+  --to LANG            target language (default: en)
+  --sentence SENTENCE  japanese sentence to translate
+  --spoiler yes/no     black out the sentence with a spoiler box (default: no)
+
+EXAMPLES
+  gd-translate --spoiler yes --sentence %GDSEARCH%
+  gd-translate --spoiler yes --to fr --sentence %GDSEARCH%
+)EOF";
+static constexpr std::string_view css_style = R"EOF(<style>
+    .spoiler {
+      background-color: black;
+      padding: 6px;
+      width: fit-content;
+    }
+    .spoiler:hover {
+      background-color: white;
+    }
+</style>)EOF";
+
+struct translate_params
+{
+  std::string to{ "en" };
+  std::string gd_word;
+  bool spoiler{ false };
+
+  void assign(std::string_view const key, std::string_view const value)
+  {
+    if (key == "--to") {
+      to = value;
+    } else if (key == "--sentence") {
+      gd_word = value;
+    } else if (key == "--spoiler" and value == "yes") {
+      spoiler = true;
+    }
+  }
+};
+
+void exec_translate(translate_params const& params)
+{
+  auto cmd_argos = sp::Popen(
+    {
+      "argos-translate",
+      "-f",
+      "ja",
+      "-t",
+      params.to,
+      params.gd_word,
+    },
+    sp::output{ sp::PIPE },
+    sp::error{ sp::PIPE }
+  );
+
+  auto const [stdout, stderr] = cmd_argos.communicate();
+
+  std::println("<div{}>", params.spoiler ? " class=\"spoiler\"" : "");
+  std::println("{}", std::string_view(stdout.buf.data(), stdout.length));
+  std::println("</div>");
+  std::println("{}", css_style);
+}
+
+void translate(std::span<std::string_view const> const args)
+{
+  try {
+    exec_translate(fill_args<translate_params>(args));
+  } catch (gd::help_requested const& ex) {
+    std::print(help_text);
+  } catch (gd::runtime_error const& ex) {
+    std::println("{}", ex.what());
+  } catch (std::runtime_error const& ex) {
+    std::println("subprocess error. {}", ex.what());
+  }
+}

src/translate.h

@@ -0,0 +1,5 @@
+#pragma once
+
+#include "precompiled.h"
+
+void translate(std::span<std::string_view const> const args);

xmake.lua

@@ -14,6 +14,7 @@ add_rules("mode.debug", "mode.release")
 add_rules("plugin.compile_commands.autoupdate", {outputdir = "build"})
 
 add_requires("cpr >= 1.11", {configs = {ssl = true}})
+add_requires("cpp-subprocess")
 add_requires("nlohmann_json", "marisa", "rdricpp", "mecab")
 
 if is_mode("debug") then
@@ -61,7 +62,7 @@ end
 -- Main target
 target(main_bin_name)
     set_kind("binary")
-    add_packages("cpr","nlohmann_json", "marisa", "rdricpp", "mecab")
+    add_packages("cpr","nlohmann_json", "marisa", "rdricpp", "mecab", "cpp-subprocess")
     add_files("src/*.cpp")
     add_cxflags("-D_GLIBCXX_ASSERTIONS")
     set_pcxxheader("src/precompiled.h")
@@ -130,7 +131,7 @@ if has_config("tests") then
     -- Tests target
     target("tests")
         set_kind("binary")
-        add_packages("cpr", "nlohmann_json", "marisa", "catch2", "rdricpp", "mecab")
+        add_packages("cpr", "nlohmann_json", "marisa", "catch2", "rdricpp", "mecab", "cpp-subprocess")
         add_files("src/*.cpp", "tests/*.cpp")
         remove_files("src/main.cpp")
         set_pcxxheader("src/precompiled.h")
@@ -160,3 +161,33 @@ package("rdricpp")
         import("package.tools.xmake").install(package)
     end)
 package_end()
+
+package("cpp-subprocess")
+    set_kind("library", {headeronly = true})
+    set_homepage("https://github.com/arun11299/cpp-subprocess")
+    set_description("Subprocessing with modern C++.")
+    set_license("MIT")
+
+    set_urls("https://github.com/arun11299/cpp-subprocess.git")
+    add_versions("2024.01.25", "4025693decacaceb9420efedbf4967a04cb028e7")
+
+    add_links("cpp-subprocess")
+
+    on_install(function (package)
+        os.cp("subprocess.hpp", package:installdir("include"))
+    end)
+
+    on_test(function (package)
+        assert(package:check_cxxsnippets({test = [[
+            #include <subprocess.hpp>
+            #include <cstring>
+            #include <thread>
+            namespace sp = subprocess;
+            int main() {
+                auto obuf = sp::check_output({"ls", "-l"});
+                std::cout << "Data : " << obuf.buf.data() << std::endl;
+                std::cout << "Data len: " << obuf.length << std::endl;
+            }
+        ]]}, {configs = {languages = "c++23"}}))
+    end)
+package_end()