api: add integer return code for functions hook_{signal|hsignal}_send

4 files changed, 134 insertions, 46 deletions

diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index 4a24853ec..a4663b962 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -8047,14 +8047,16 @@ hook = weechat.hook_signal("quit", "my_signal_cb", "")
 
 ==== weechat_hook_signal_send
 
+_Updated in 0.4.4._
+
 Send a signal.
 
 Prototype:
 
 [source,C]
 ----
-void weechat_hook_signal_send (const char *signal, const char *type_data,
-                               void *signal_data);
+int weechat_hook_signal_send (const char *signal, const char *type_data,
+                              void *signal_data);
 ----
 
 Arguments:
@@ -8064,11 +8066,19 @@ Arguments:
   <<_weechat_hook_signal,weechat_hook_signal>>)
 * 'signal_data': data sent with signal
 
+Return value (_WeeChat ≥ 0.4.4)_:
+
+* return code of last callback executed ('WEECHAT_RC_OK' if no callback was
+  executed):
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 C example:
 
 [source,C]
 ----
-weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
+int rc = weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
 ----
 
 Script (Python):
@@ -8076,10 +8086,10 @@ Script (Python):
 [source,python]
 ----
 # prototype
-weechat.hook_signal_send(signal, type_data, signal_data)
+rc = weechat.hook_signal_send(signal, type_data, signal_data)
 
 # example
-weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
+rc = weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
 ----
 
 [[signal_logger_backlog]]
@@ -8354,7 +8364,7 @@ hook = weechat.hook_hsignal("test", "my_hsignal_cb", "")
 
 ==== weechat_hook_hsignal_send
 
-_WeeChat ≥ 0.3.4._
+_WeeChat ≥ 0.3.4, updated in 0.4.4._
 
 Send a hsignal (signal with hashtable).
 
@@ -8362,7 +8372,7 @@ Prototype:
 
 [source,C]
 ----
-void weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
+int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
 ----
 
 Arguments:
@@ -8370,10 +8380,19 @@ Arguments:
 * 'signal': signal to send
 * 'hashtable': hashtable
 
+Return value (_WeeChat ≥ 0.4.4)_:
+
+* return code of last callback executed ('WEECHAT_RC_OK' if no callback was
+  executed):
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 C example:
 
 [source,C]
 ----
+int rc;
 struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                        WEECHAT_HASHTABLE_STRING,
                                                        WEECHAT_HASHTABLE_STRING,
@@ -8382,7 +8401,7 @@ struct t_hashtable *hashtable = weechat_hashtable_new (8,
 if (hashtable)
 {
     weechat_hashtable_set (hashtable, "key", "value");
-    weechat_hook_hsignal_send ("my_hsignal", hashtable);
+    rc = weechat_hook_hsignal_send ("my_hsignal", hashtable);
     weechat_hashtable_free (hashtable);
 }
 ----
@@ -8392,10 +8411,10 @@ Script (Python):
 [source,python]
 ----
 # prototype
-weechat.hook_hsignal_send(signal, hashtable)
+rc = weechat.hook_hsignal_send(signal, hashtable)
 
 # example
-weechat.hook_hsignal_send("my_hsignal", { "key": "value" })
+rc = weechat.hook_hsignal_send("my_hsignal", { "key": "value" })
 ----
 
 [[hsignal_irc_redirect_command]]
@@ -11573,7 +11592,7 @@ bar_item = weechat.bar_item_search("myitem")
 
 ==== weechat_bar_item_new
 
-_Updated in version 0.4.2._
+_Updated in 0.4.2._
 
 Create a new bar item.
 
@@ -12063,7 +12082,7 @@ This function is not available in scripting API.
 
 ==== weechat_network_connect_to
 
-_Updated in version 0.4.3._
+_Updated in 0.4.3._
 
 Establish a connection to a remote host.
 
diff --git a/doc/fr/weechat_plugin_api.fr.txt b/doc/fr/weechat_plugin_api.fr.txt
index a64729715..8c833b32f 100644
--- a/doc/fr/weechat_plugin_api.fr.txt
+++ b/doc/fr/weechat_plugin_api.fr.txt
@@ -8177,14 +8177,16 @@ hook = weechat.hook_signal("quit", "my_signal_cb", "")
 
 ==== weechat_hook_signal_send
 
+_Mis à jour dans la 0.4.4._
+
 Envoyer un signal.
 
 Prototype :
 
 [source,C]
 ----
-void weechat_hook_signal_send (const char *signal, const char *type_data,
-                               void *signal_data);
+int weechat_hook_signal_send (const char *signal, const char *type_data,
+                              void *signal_data);
 ----
 
 Paramètres :
@@ -8194,11 +8196,19 @@ Paramètres :
   <<_weechat_hook_signal,weechat_hook_signal>>)
 * 'signal_data' : données envoyées avec le signal
 
+Valeur de retour (_WeeChat ≥ 0.4.4)_ :
+
+* code retour du dernier "callback" exécuté ('WEECHAT_RC_OK' si aucun "callback"
+  n'a été exécuté) :
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 Exemple en C :
 
 [source,C]
 ----
-weechat_hook_signal_send ("mon_signal", WEECHAT_HOOK_SIGNAL_STRING, ma_chaine);
+int rc = weechat_hook_signal_send ("mon_signal", WEECHAT_HOOK_SIGNAL_STRING, ma_chaine);
 ----
 
 Script (Python) :
@@ -8206,10 +8216,10 @@ Script (Python) :
 [source,python]
 ----
 # prototype
-weechat.hook_signal_send(signal, type_data, signal_data)
+rc = weechat.hook_signal_send(signal, type_data, signal_data)
 
 # exemple
-weechat.hook_signal_send("mon_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, ma_chaine)
+rc = weechat.hook_signal_send("mon_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, ma_chaine)
 ----
 
 [[signal_logger_backlog]]
@@ -8493,7 +8503,7 @@ hook = weechat.hook_hsignal("test", "my_hsignal_cb", "")
 
 ==== weechat_hook_hsignal_send
 
-_WeeChat ≥ 0.3.4._
+_WeeChat ≥ 0.3.4, mis à jour dans la 0.4.4._
 
 Envoyer un hsignal (signal avec table de hachage).
 
@@ -8501,7 +8511,7 @@ Prototype :
 
 [source,C]
 ----
-void weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
+int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
 ----
 
 Paramètres :
@@ -8509,10 +8519,19 @@ Paramètres :
 * 'signal' : signal à envoyer
 * 'hashtable' : table de hachage
 
+Valeur de retour (_WeeChat ≥ 0.4.4)_ :
+
+* code retour du dernier "callback" exécuté ('WEECHAT_RC_OK' si aucun "callback"
+  n'a été exécuté) :
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 Exemple en C :
 
 [source,C]
 ----
+int rc;
 struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                        WEECHAT_HASHTABLE_STRING,
                                                        WEECHAT_HASHTABLE_STRING,
@@ -8521,7 +8540,7 @@ struct t_hashtable *hashtable = weechat_hashtable_new (8,
 if (hashtable)
 {
     weechat_hashtable_set (hashtable, "clé", "valeur");
-    weechat_hook_hsignal_send ("my_hsignal", hashtable);
+    rc = weechat_hook_hsignal_send ("my_hsignal", hashtable);
     weechat_hashtable_free (hashtable);
 }
 ----
@@ -8531,10 +8550,10 @@ Script (Python) :
 [source,python]
 ----
 # prototype
-weechat.hook_hsignal_send(signal, hashtable)
+rc = weechat.hook_hsignal_send(signal, hashtable)
 
 # exemple
-weechat.hook_hsignal_send("my_hsignal", { "clé": "valeur" })
+rc = weechat.hook_hsignal_send("my_hsignal", { "clé": "valeur" })
 ----
 
 [[hsignal_irc_redirect_command]]
@@ -11786,7 +11805,7 @@ bar_item = weechat.bar_item_search("myitem")
 
 ==== weechat_bar_item_new
 
-_Mis à jour dans la version 0.4.2._
+_Mis à jour dans la 0.4.2._
 
 Créer un nouvel objet de barre.
 
@@ -12289,7 +12308,7 @@ Cette fonction n'est pas disponible dans l'API script.
 
 ==== weechat_network_connect_to
 
-_Mis à jour dans la version 0.4.3._
+_Mis à jour dans la 0.4.3._
 
 Établir une connexion à une machine distante.
 
diff --git a/doc/it/weechat_plugin_api.it.txt b/doc/it/weechat_plugin_api.it.txt
index 0cbe26703..80c4aa9cd 100644
--- a/doc/it/weechat_plugin_api.it.txt
+++ b/doc/it/weechat_plugin_api.it.txt
@@ -8220,14 +8220,17 @@ hook = weechat.hook_signal("quit", "my_signal_cb", "")
 
 ==== weechat_hook_signal_send
 
+// TRANSLATION MISSING
+_Updated in 0.4.4._
+
 Invia un segnale.
 
 Prototipo:
 
 [source,C]
 ----
-void weechat_hook_signal_send (const char *signal, const char *type_data,
-                               void *signal_data);
+int weechat_hook_signal_send (const char *signal, const char *type_data,
+                              void *signal_data);
 ----
 
 Argomenti:
@@ -8237,11 +8240,21 @@ Argomenti:
   <<_weechat_hook_signal,weechat_hook_signal>>)
 * 'signal_data': dati inviati con il segnale
 
+// TRANSLATION MISSING
+Return value (_WeeChat ≥ 0.4.4)_:
+
+// TRANSLATION MISSING
+* return code of last callback executed ('WEECHAT_RC_OK' if no callback was
+  executed):
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 Esempio in C:
 
 [source,C]
 ----
-weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
+int rc = weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
 ----
 
 Script (Python):
@@ -8249,10 +8262,10 @@ Script (Python):
 [source,python]
 ----
 # prototipo
-weechat.hook_signal_send(signal, type_data, signal_data)
+rc = weechat.hook_signal_send(signal, type_data, signal_data)
 
 # esempio
-weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
+rc = weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
 ----
 
 [[signal_logger_backlog]]
@@ -8544,7 +8557,8 @@ hook = weechat.hook_hsignal("test", "my_hsignal_cb", "")
 
 ==== weechat_hook_hsignal_send
 
-_WeeChat ≥ 0.3.4._
+// TRANSLATION MISSING
+_WeeChat ≥ 0.3.4, updated in 0.4.4._
 
 Invia un hsignal (segnale con tabella hash).
 
@@ -8552,7 +8566,7 @@ Prototipo:
 
 [source,C]
 ----
-void weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
+int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
 ----
 
 Argomenti:
@@ -8560,10 +8574,21 @@ Argomenti:
 * 'signal': segnale da inviare
 * 'hashtable': tabella hash
 
+// TRANSLATION MISSING
+Return value (_WeeChat ≥ 0.4.4)_:
+
+// TRANSLATION MISSING
+* return code of last callback executed ('WEECHAT_RC_OK' if no callback was
+  executed):
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 Esempio in C:
 
 [source,C]
 ----
+int rc;
 struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                        WEECHAT_HASHTABLE_STRING,
                                                        WEECHAT_HASHTABLE_STRING,
@@ -8572,7 +8597,7 @@ struct t_hashtable *hashtable = weechat_hashtable_new (8,
 if (hashtable)
 {
     weechat_hashtable_set (hashtable, "key", "value");
-    weechat_hook_hsignal_send ("my_hsignal", hashtable);
+    rc = weechat_hook_hsignal_send ("my_hsignal", hashtable);
     weechat_hashtable_free (hashtable);
 }
 ----
@@ -8582,10 +8607,10 @@ Script (Python):
 [source,python]
 ----
 # prototipo
-weechat.hook_hsignal_send(signal, hashtable)
+rc = weechat.hook_hsignal_send(signal, hashtable)
 
 # esempio
-weechat.hook_hsignal_send("my_hsignal", { "key": "value" })
+rc = weechat.hook_hsignal_send("my_hsignal", { "key": "value" })
 ----
 
 [[hsignal_irc_redirect_command]]
@@ -11840,7 +11865,7 @@ bar_item = weechat.bar_item_search("myitem")
 ==== weechat_bar_item_new
 
 // TRANSLATION MISSING
-_Updated in version 0.4.2._
+_Updated in 0.4.2._
 
 Crea un nuovo elemento barra.
 
@@ -12349,7 +12374,7 @@ Questa funzione non è disponibile nelle API per lo scripting.
 ==== weechat_network_connect_to
 
 // TRANSLATION MISSING
-_Updated in version 0.4.3._
+_Updated in 0.4.3._
 
 Stabilisce una connessione con un host remoto.
 
diff --git a/doc/ja/weechat_plugin_api.ja.txt b/doc/ja/weechat_plugin_api.ja.txt
index f54fc30de..977d63120 100644
--- a/doc/ja/weechat_plugin_api.ja.txt
+++ b/doc/ja/weechat_plugin_api.ja.txt
@@ -8042,14 +8042,17 @@ hook = weechat.hook_signal("quit", "my_signal_cb", "")
 
 ==== weechat_hook_signal_send
 
+// TRANSLATION MISSING
+_Updated in 0.4.4._
+
 シグナルを送信。
 
 プロトタイプ:
 
 [source,C]
 ----
-void weechat_hook_signal_send (const char *signal, const char *type_data,
-                               void *signal_data);
+int weechat_hook_signal_send (const char *signal, const char *type_data,
+                              void *signal_data);
 ----
 
 引数:
@@ -8059,11 +8062,21 @@ void weechat_hook_signal_send (const char *signal, const char *type_data,
   (<<_weechat_hook_signal,weechat_hook_signal>> を参照)
 * 'signal_data': シグナルと一緒に送信するデータ
 
+// TRANSLATION MISSING
+Return value (_WeeChat ≥ 0.4.4)_:
+
+// TRANSLATION MISSING
+* return code of last callback executed ('WEECHAT_RC_OK' if no callback was
+  executed):
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 C 言語での使用例:
 
 [source,C]
 ----
-weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
+int rc = weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
 ----
 
 スクリプト (Python) での使用例:
@@ -8071,10 +8084,10 @@ weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);
 [source,python]
 ----
 # プロトタイプ
-weechat.hook_signal_send(signal, type_data, signal_data)
+rc = weechat.hook_signal_send(signal, type_data, signal_data)
 
 # 例
-weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
+rc = weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
 ----
 
 [[signal_logger_backlog]]
@@ -8349,7 +8362,8 @@ hook = weechat.hook_hsignal("test", "my_hsignal_cb", "")
 
 ==== weechat_hook_hsignal_send
 
-_WeeChat バージョン 0.3.4 以上で利用可。_
+// TRANSLATION MISSING
+_WeeChat バージョン 0.3.4 以上で利用可。, updated in 0.4.4._
 
 hsignal (ハッシュテーブルを持つシグナル) を送信。
 
@@ -8357,7 +8371,7 @@ hsignal (ハッシュテーブルを持つシグナル) を送信。
 
 [source,C]
 ----
-void weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
+int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);
 ----
 
 引数:
@@ -8365,10 +8379,21 @@ void weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtabl
 * 'signal': 送信するシグナル
 * 'hashtable': ハッシュテーブル
 
+// TRANSLATION MISSING
+Return value (_WeeChat ≥ 0.4.4)_:
+
+// TRANSLATION MISSING
+* return code of last callback executed ('WEECHAT_RC_OK' if no callback was
+  executed):
+** 'WEECHAT_RC_OK'
+** 'WEECHAT_RC_OK_EAT'
+** 'WEECHAT_RC_ERROR'
+
 C 言語での使用例:
 
 [source,C]
 ----
+int rc;
 struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                        WEECHAT_HASHTABLE_STRING,
                                                        WEECHAT_HASHTABLE_STRING,
@@ -8377,7 +8402,7 @@ struct t_hashtable *hashtable = weechat_hashtable_new (8,
 if (hashtable)
 {
     weechat_hashtable_set (hashtable, "key", "value");
-    weechat_hook_hsignal_send ("my_hsignal", hashtable);
+    rc = weechat_hook_hsignal_send ("my_hsignal", hashtable);
     weechat_hashtable_free (hashtable);
 }
 ----
@@ -8387,10 +8412,10 @@ if (hashtable)
 [source,python]
 ----
 # プロトタイプ
-weechat.hook_hsignal_send(signal, hashtable)
+rc = weechat.hook_hsignal_send(signal, hashtable)
 
 # 例
-weechat.hook_hsignal_send("my_hsignal", { "key": "value" })
+rc = weechat.hook_hsignal_send("my_hsignal", { "key": "value" })
 ----
 
 [[hsignal_irc_redirect_command]]