From cc2b44a8ec1930cb385a1d38939c7a48a37029db Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= <flashcode@flashtux.org>
Date: Mon, 28 Aug 2023 17:39:33 +0200
Subject: [PATCH] core: add key ctrl+z to suspend WeeChat process (closes #985)

---
 ChangeLog.adoc                  |  2 +-
 doc/de/weechat_user.de.adoc     | 10 ++++++++++
 doc/en/weechat_user.en.adoc     |  9 +++++++++
 doc/fr/weechat_user.fr.adoc     |  9 +++++++++
 doc/it/weechat_user.it.adoc     | 10 ++++++++++
 doc/ja/weechat_user.ja.adoc     | 10 ++++++++++
 doc/pl/weechat_user.pl.adoc     | 10 ++++++++++
 doc/sr/weechat_user.sr.adoc     | 10 ++++++++++
 src/core/wee-command.c          | 23 +++++++++++++++++------
 src/core/wee-signal.c           | 12 ++++++++++++
 src/core/wee-signal.h           |  1 +
 src/gui/curses/gui-curses-key.c |  1 +
 12 files changed, 100 insertions(+), 7 deletions(-)

diff --git a/ChangeLog.adoc b/ChangeLog.adoc
index f008f4cfc..e33c3682e 100644
--- a/ChangeLog.adoc
+++ b/ChangeLog.adoc
@@ -15,7 +15,7 @@ For a list of important changes that require manual actions, please look at rele
 
 New features::
 
-  * core: add command `/sys` to show resource limits and usage
+  * core: add command `/sys` to show resource limits/usage and suspend WeeChat process (issue #985)
   * core: ignore key bindings with empty command
   * core: add support of quotes in commands `/key bind` and `/key bindctxt`
   * core: evaluate command given to `/repeat` with contextual variables (issue #2007)
diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index 6adeb3603..71d4211e9 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -1558,6 +1558,16 @@ Sie können mit dem Befehl <<command_weechat_key,/key>> geändert und neue hinzu
 | kbd:[Ctrl+↓] | ruft nächsten Befehl/Nachricht aus dem globalen Verlaufsspeicher auf (für alle Buffer). | `+/input history_global_next+`
 |===
 
+// TRANSLATION MISSING
+[[key_bindings_cmdline_system]]
+==== System
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| Taste        | Beschreibung | Befehl
+| kbd:[Ctrl+z] | Suspend WeeChat process. | `+/sys suspend+`
+|===
+
 [[key_bindings_buffers]]
 === Buffer
 
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index ad29093ab..6abbe6d4d 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -1545,6 +1545,15 @@ They can be changed and new ones can be added with the <<command_weechat_key,/ke
 | kbd:[Ctrl+↓] | Call next command/message in global history (common for all buffers). | `+/input history_global_next+`
 |===
 
+[[key_bindings_cmdline_system]]
+==== System
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| Key          | Description | Command
+| kbd:[Ctrl+z] | Suspend WeeChat process. | `+/sys suspend+`
+|===
+
 [[key_bindings_buffers]]
 === Buffers
 
diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 24ed5368d..b07c0f4a9 100644
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -1581,6 +1581,15 @@ Ils peuvent être modifiés et de nouveaux peuvent être ajoutés avec la comman
 | kbd:[Ctrl+↓] | Rappeler la commande suivante dans l'historique global (commun à tous les tampons). | `+/input history_global_next+`
 |===
 
+[[key_bindings_cmdline_system]]
+==== Système
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| Touche       | Description | Commande
+| kbd:[Ctrl+z] | Suspendre le processus WeeChat. | `+/sys suspend+`
+|===
+
 [[key_bindings_buffers]]
 === Tampons
 
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index e28536830..f9a92a258 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -1691,6 +1691,16 @@ They can be changed and new ones can be added with the <<command_weechat_key,/ke
 | kbd:[Ctrl+↓] | Chiama il comando/messaggio successivo nella cronologia globale (identico per tutti i buffer). | `+/input history_global_next+`
 |===
 
+// TRANSLATION MISSING
+[[key_bindings_cmdline_system]]
+==== System
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| Tasti        | Descrizione | Comando
+| kbd:[Ctrl+z] | Suspend WeeChat process. | `+/sys suspend+`
+|===
+
 // TRANSLATION MISSING
 [[key_bindings_buffers]]
 === Buffers
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index d367055c9..ea73f2829 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -1647,6 +1647,16 @@ They can be changed and new ones can be added with the <<command_weechat_key,/ke
 | kbd:[Ctrl+↓] | グローバル履歴から次のコマンド/メッセージを呼び出す (すべてのバッファに対して共通の履歴) | `+/input history_global_next+`
 |===
 
+// TRANSLATION MISSING
+[[key_bindings_cmdline_system]]
+==== System
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| キー         | 説明 | コマンド
+| kbd:[Ctrl+z] | Suspend WeeChat process. | `+/sys suspend+`
+|===
+
 // TRANSLATION MISSING
 [[key_bindings_buffers]]
 === Buffers
diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index ce52ff1d7..9ce0d54c4 100644
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -1555,6 +1555,16 @@ Można je zmienić oraz dodać nowe za pomocą komendy <<command_weechat_key,/ke
 | kbd:[Ctrl+↓] | Pokaż następną komendę/wiadomość w historii globalnej (wspólnej dla wszystkich buforów). | `+/input history_global_next+`
 |===
 
+// TRANSLATION MISSING
+[[key_bindings_cmdline_system]]
+==== System
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| Skrót        | Opis | Komenda
+| kbd:[Ctrl+z] | Suspend WeeChat process. | `+/sys suspend+`
+|===
+
 [[key_bindings_buffers]]
 === Bufory
 
diff --git a/doc/sr/weechat_user.sr.adoc b/doc/sr/weechat_user.sr.adoc
index 03c95a29f..0f317a6a2 100644
--- a/doc/sr/weechat_user.sr.adoc
+++ b/doc/sr/weechat_user.sr.adoc
@@ -1459,6 +1459,16 @@ WeeChat нуди доста подразумеваних тастерских п
 | kbd:[Ctrl+↓] | Позив наредне команде/поруке у глобалној историји (заједничкој за све бафере). | `+/input history_global_next+`
 |===
 
+// TRANSLATION MISSING
+[[key_bindings_cmdline_system]]
+==== System
+
+[width="100%",cols="^.^3,.^8,.^5",options="header"]
+|===
+| Тастер       | Опис | Команда
+| kbd:[Ctrl+z] | Suspend WeeChat process. | `+/sys suspend+`
+|===
+
 [[key_bindings_buffers]]
 === Бафери
 
diff --git a/src/core/wee-command.c b/src/core/wee-command.c
index 58e767b2b..10a3a823a 100644
--- a/src/core/wee-command.c
+++ b/src/core/wee-command.c
@@ -59,12 +59,13 @@
 #include "wee-secure.h"
 #include "wee-secure-buffer.h"
 #include "wee-secure-config.h"
+#include "wee-signal.h"
 #include "wee-string.h"
+#include "wee-sys.h"
 #include "wee-upgrade.h"
 #include "wee-utf8.h"
 #include "wee-util.h"
 #include "wee-version.h"
-#include "wee-sys.h"
 #include "../gui/gui-bar.h"
 #include "../gui/gui-bar-item.h"
 #include "../gui/gui-bar-item-custom.h"
@@ -7801,6 +7802,12 @@ COMMAND_CALLBACK(sys)
         return WEECHAT_RC_OK;
     }
 
+    if (string_strcmp (argv[1], "suspend") == 0)
+    {
+        signal_suspend ();
+        return WEECHAT_RC_OK;
+    }
+
     COMMAND_ERROR;
 }
 
@@ -9489,12 +9496,16 @@ command_init ()
     hook_command (
         NULL, "sys",
         N_("system actions"),
-        N_("get rlimit|rusage"),
-        N_("   get: display system info\n"
-           "rlimit: display resource limits "
+        N_("get rlimit|rusage"
+            " || suspend"),
+        N_("    get: display system info\n"
+           " rlimit: display resource limits "
            "(see /help weechat.startup.sys_rlimit and man getrlimit)\n"
-           "rusage: display resource usage (see man getrusage)"),
-        "get rlimit|rusage",
+           " rusage: display resource usage (see man getrusage)\n"
+           "suspend: suspend WeeChat and go back to the shell, by sending "
+           "signal SIGTSTP to the WeeChat process"),
+        "get rlimit|rusage"
+        " || suspend",
         &command_sys, NULL, NULL);
 }
 
diff --git a/src/core/wee-signal.c b/src/core/wee-signal.c
index 54c7019e5..d29cf6468 100644
--- a/src/core/wee-signal.c
+++ b/src/core/wee-signal.c
@@ -37,6 +37,7 @@
 #include "wee-log.h"
 #include "wee-string.h"
 #include "../gui/gui-buffer.h"
+#include "../gui/gui-window.h"
 #include "../plugins/plugin.h"
 
 
@@ -293,6 +294,17 @@ signal_handle ()
     signal_sigterm_count = 0;
 }
 
+/*
+ * Suspends WeeChat process.
+ */
+
+void
+signal_suspend ()
+{
+    kill (getpid (), SIGTSTP);
+    gui_window_ask_refresh (2);
+}
+
 /*
  * Initializes signal.
  */
diff --git a/src/core/wee-signal.h b/src/core/wee-signal.h
index 8d8c43fb4..90f7e7c12 100644
--- a/src/core/wee-signal.h
+++ b/src/core/wee-signal.h
@@ -32,6 +32,7 @@ extern int signal_search_number (int signal_number);
 extern int signal_search_name (const char *name);
 extern void signal_catch (int signum, void (*handler)(int));
 extern void signal_handle ();
+extern void signal_suspend ();
 extern void signal_init ();
 
 #endif /* WEECHAT_SIGNAL_H */
diff --git a/src/gui/curses/gui-curses-key.c b/src/gui/curses/gui-curses-key.c
index d1f451c62..44444f3a8 100644
--- a/src/gui/curses/gui-curses-key.c
+++ b/src/gui/curses/gui-curses-key.c
@@ -102,6 +102,7 @@ gui_key_default_bindings (int context, int create_option)
         BIND("ctrl-u",            "/input delete_beginning_of_line");
         BIND("meta-ctrl-u",       "/input delete_beginning_of_input");
         BIND("ctrl-y",            "/input clipboard_paste");
+        BIND("ctrl-z",            "/sys suspend");
         BIND("home",              "/input move_beginning_of_line");
         BIND("ctrl-a",            "/input move_beginning_of_line");
         BIND("shift-home",        "/input move_beginning_of_input");