api: add new function hdata_check_pointer

doc/de/weechat_scripting.de.txt

@@ -356,8 +356,9 @@ Liste der Skript API Funktionen:
   infolist_time, infolist_free
 | hdata               |
   hdata_get, hdata_get_var_offset, hdata_get_var_type_string,
-  hdata_get_var_hdata, hdata_get_list, hdata_move, hdata_integer, hdata_long,
-  hdata_string, hdata_pointer, hdata_time, hdata_get_string
+  hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move,
+  hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer,
+  hdata_time, hdata_get_string
 | Upgrade             |
   upgrade_new, upgrade_write_object, upgrade_read, upgrade_close
 |========================================

doc/en/weechat_plugin_api.en.txt

@@ -12324,8 +12324,16 @@ C example:
 int offset = weechat_hdata_get_var_offset (hdata, "name");
 ----------------------------------------
 
-[NOTE]
-This function is not available in scripting API.
+Script (Python):
+
+[source,python]
+----------------------------------------
+# prototype
+offset = weechat.hdata_get_var_offset(hdata, name)
+
+# example
+offset = weechat.hdata_get(hdata, "name")
+----------------------------------------
 
 weechat_hdata_get_var_type
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -12585,6 +12593,65 @@ hdata = weechat.hdata_get("buffer")
 buffers = weechat.hdata_get_list(hdata, "gui_buffers")
 ----------------------------------------
 
+weechat_hdata_check_pointer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+_New in version 0.3.7._
+
+Check if a pointer is valid for a hdata and a list pointer.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointer);
+----------------------------------------
+
+Arguments:
+
+* 'hdata': hdata pointer
+* 'list': list pointer
+* 'pointer': pointer to check
+
+Return value:
+
+* 1 if pointer is in list, 0 if not found
+
+C example:
+
+[source,C]
+----------------------------------------
+/* check if a buffer pointer is valid */
+struct t_hdata *hdata = weechat_hdata_get ("buffer");
+if (weechat_hdata_check_pointer (hdata,
+                                 weechat_hdata_get_list (hdata, "gui_buffers"),
+                                 ptr_buffer))
+{
+    /* valid pointer */
+}
+else
+{
+    /* invalid pointer */
+}
+----------------------------------------
+
+Script (Python):
+
+[source,python]
+----------------------------------------
+# prototype
+rc = weechat.hdata_check_pointer(hdata, list, pointer)
+
+# example
+hdata = weechat.hdata_get("buffer")
+if weechat.hdata_check_pointer(hdata, weechat.hdata_get_list(hdata, "gui_buffers"), ptr_buffer):
+    # valid pointer
+    # ...
+else:
+    # invalid pointer
+    # ...
+----------------------------------------
+
 weechat_hdata_move
 ^^^^^^^^^^^^^^^^^^
 

doc/en/weechat_scripting.en.txt

@@ -347,8 +347,9 @@ List of functions in script API:
   infolist_time, infolist_free
 | hdata               |
   hdata_get, hdata_get_var_offset, hdata_get_var_type_string,
-  hdata_get_var_hdata, hdata_get_list, hdata_move, hdata_integer, hdata_long,
-  hdata_string, hdata_pointer, hdata_time, hdata_get_string
+  hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move,
+  hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer,
+  hdata_time, hdata_get_string
 | upgrade             |
   upgrade_new, upgrade_write_object, upgrade_read, upgrade_close
 |========================================

doc/fr/weechat_plugin_api.fr.txt

@@ -1141,10 +1141,10 @@ Paramètres :
 * 'separators' : délimiteurs utilisés pour le découpage
 * 'keep_eol' : si différent de 0, alors chaque paramètre contiendra toutes les
   chaînes jusqu'à la fin de la ligne (voir exemple ci-dessous)
-** 0: chaque chaîne contiendra un mot
-** 1: chaque chaîne contiendra toute la chaîne jusqu'à la fin de la ligne (voir
+** 0 : chaque chaîne contiendra un mot
+** 1 : chaque chaîne contiendra toute la chaîne jusqu'à la fin de la ligne (voir
    exemple ci-dessous)
-** 2: comme 1, mais ne supprime pas les séparateurs en fin de chaîne avant le
+** 2 : comme 1, mais ne supprime pas les séparateurs en fin de chaîne avant le
    découpage (_nouveau dans la version 0.3.6_)
 * 'num_items_max' : nombre maximum de chaînes à créer (0 = pas de limite)
 * 'num_items' : pointeur vers un entier qui contiendra le nombre de chaînes
@@ -6776,7 +6776,7 @@ toujours).
 
 [NOTE]
 La taille du tampon pour l'envoi des données au "callback" est de 64 Ko (il y a
-2 tampons: un pour stdout et un pour stderr).
+2 tampons : un pour stdout et un pour stderr).
 Si la sortie du processus fils (stdout ou stderr) est plus longue que 64 Ko, le
 "callback" sera appelé plusieurs fois.
 
@@ -8072,7 +8072,7 @@ my_completion_cb (void *data, const char *completion_item,
 }
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -8572,7 +8572,7 @@ weechat_hook_hdata
 
 Accroche un hdata : le "callback" retournera un pointeur vers le hdata demandé.
 
-Prototype:
+Prototype :
 
 [source,C]
 ----------------------------------------
@@ -8712,7 +8712,7 @@ relâché). +
 ^(4)^ Il s'agit de la date lorsque WeeChat ajoute la ligne dans le tampon
 (supérieure ou égale à "_chat_line_date").
 
-Informations additionnelles pour l'objet de barre "buffer_nicklist":
+Informations additionnelles pour l'objet de barre "buffer_nicklist" :
 
 [width="70%",cols="3m,3,8",options="header"]
 |========================================
@@ -9219,7 +9219,7 @@ Paramètres :
 ** 'number' : numéro du tampon (commence à 1)
 ** 'layout_number' : numéro du tampon sauvegardé dans le "layout"
 ** 'layout_number_merge_order' : ordre du tampon mélangé pour le "layout"
-** 'short_name_is_set': 1 si le nom court est défini, 0 si non défini
+** 'short_name_is_set' : 1 si le nom court est défini, 0 si non défini
 ** 'type' : type de tampon (0 : formaté, 1 : contenu libre)
 ** 'notify' : niveau de notification du tampon
 ** 'num_displayed' : nombre de fenêtres affichant ce tampon
@@ -9760,7 +9760,7 @@ struct t_gui_window *weechat_window_search_with_buffer (struct t_gui_buffer *buf
 
 Paramètre :
 
-* 'buffer': buffer pointer
+* 'buffer' : pointeur vers le tampon
 
 Valeur de retour :
 
@@ -9776,7 +9776,7 @@ weechat_printf (NULL,
                 weechat_window_search_with_buffer (weechat_buffer_search_main ()));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12491,7 +12491,7 @@ Exemple en C :
 struct t_hdata *hdata = weechat_hdata_get ("irc_server");
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12532,8 +12532,16 @@ Exemple en C :
 int offset = weechat_hdata_get_var_offset (hdata, "name");
 ----------------------------------------
 
-[NOTE]
-Cette fonction n'est pas disponible dans l'API script.
+Script (Python) :
+
+[source,python]
+----------------------------------------
+# prototype
+offset = weechat.hdata_get_var_offset(hdata, name)
+
+# exemple
+offset = weechat.hdata_get(hdata, "name")
+----------------------------------------
 
 weechat_hdata_get_var_type
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -12625,7 +12633,7 @@ Exemple en C :
 weechat_printf (NULL, "type = %s", weechat_hdata_get_var_type_string (hdata, "name"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12666,7 +12674,7 @@ Exemple en C :
 weechat_printf (NULL, "hdata = %s", weechat_hdata_get_var_hdata (hdata, "name"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12782,7 +12790,7 @@ struct t_hdata *hdata = weechat_hdata_get ("buffer");
 struct t_gui_buffer *buffers = weechat_hdata_get_list (hdata, "gui_buffers");
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12794,6 +12802,65 @@ hdata = weechat.hdata_get("buffer")
 buffers = weechat.hdata_get_list(hdata, "gui_buffers")
 ----------------------------------------
 
+weechat_hdata_check_pointer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+_Nouveau dans la version 0.3.7._
+
+Vérifie si un pointeur est valide pour un hdata et un pointeur de liste.
+
+Prototype :
+
+[source,C]
+----------------------------------------
+int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointer);
+----------------------------------------
+
+Paramètres :
+
+* 'hdata' : pointeur vers le hdata
+* 'list' : pointeur vers une liste
+* 'pointer' : pointeur à vérifier
+
+Valeur de retour :
+
+* 1 si le pointeur est dans la liste, 0 si non trouvé
+
+Exemple en C :
+
+[source,C]
+----------------------------------------
+/* vérifie si le pointeur vers le tampon est valide */
+struct t_hdata *hdata = weechat_hdata_get ("buffer");
+if (weechat_hdata_check_pointer (hdata,
+                                 weechat_hdata_get_list (hdata, "gui_buffers"),
+                                 ptr_buffer))
+{
+    /* pointeur valide */
+}
+else
+{
+    /* pointeur invalide */
+}
+----------------------------------------
+
+Script (Python) :
+
+[source,python]
+----------------------------------------
+# prototype
+rc = weechat.hdata_check_pointer(hdata, list, pointer)
+
+# exemple
+hdata = weechat.hdata_get("buffer")
+if weechat.hdata_check_pointer(hdata, weechat.hdata_get_list(hdata, "gui_buffers"), ptr_buffer):
+    # pointeur valide
+    # ...
+else:
+    # pointeur invalide
+    # ...
+----------------------------------------
+
 weechat_hdata_move
 ^^^^^^^^^^^^^^^^^^
 
@@ -12834,7 +12901,7 @@ if (buffer)
     buffer = weechat_hdata_move (hdata, buffer, -1);
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12885,7 +12952,7 @@ Exemple en C :
 weechat_printf (NULL, "letter = %c", weechat_hdata_char (hdata, pointer, "letter"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12930,7 +12997,7 @@ struct t_gui_buffer *buffer = weechat_buffer_search_main ();
 weechat_printf (NULL, "number = %d", weechat_hdata_integer (hdata, buffer, "number"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -12975,7 +13042,7 @@ Exemple en C :
 weechat_printf (NULL, "longvar = %ld", weechat_hdata_long (hdata, pointer, "longvar"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -13020,7 +13087,7 @@ struct t_gui_buffer *buffer = weechat_buffer_search_main ();
 weechat_printf (NULL, "name = %s", weechat_hdata_string (hdata, buffer, "name"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -13067,7 +13134,7 @@ struct t_gui_buffer *buffer = weechat_buffer_search_main ();
 weechat_printf (NULL, "lines = %lx", weechat_hdata_pointer (hdata, buffer, "lines"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -13130,7 +13197,7 @@ if (ptr)
 }
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------
@@ -13199,7 +13266,7 @@ weechat_printf (NULL, "variables dans le hdata: %s" weechat_hdata_get_string (hd
 weechat_printf (NULL, "listes dans le hdata: %s" weechat_hdata_get_string (hdata, "list_keys"));
 ----------------------------------------
 
-Script (Python):
+Script (Python) :
 
 [source,python]
 ----------------------------------------

doc/fr/weechat_scripting.fr.txt

@@ -356,8 +356,9 @@ Liste des fonctions de l'API script :
   infolist_time, infolist_free
 | hdata               |
   hdata_get, hdata_get_var_offset, hdata_get_var_type_string,
-  hdata_get_var_hdata, hdata_get_list, hdata_move, hdata_integer, hdata_long,
-  hdata_string, hdata_pointer, hdata_time, hdata_get_string
+  hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move,
+  hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer,
+  hdata_time, hdata_get_string
 | mise à jour               |
   upgrade_new, upgrade_write_object, upgrade_read, upgrade_close
 |========================================

doc/it/weechat_plugin_api.it.txt

@@ -12441,8 +12441,16 @@ Esempio in C:
 int offset = weechat_hdata_get_var_offset (hdata, "name");
 ----------------------------------------
 
-[NOTE]
-Questa funzione non è disponibile nelle API per lo scripting.
+Script (Python):
+
+[source,python]
+----------------------------------------
+# prototipo
+offset = weechat.hdata_get_var_offset(hdata, name)
+
+# esempio
+offset = weechat.hdata_get(hdata, "name")
+----------------------------------------
 
 weechat_hdata_get_var_type
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -12703,6 +12711,69 @@ hdata = weechat.hdata_get("buffer")
 buffers = weechat.hdata_get_list(hdata, "gui_buffers")
 ----------------------------------------
 
+weechat_hdata_check_pointer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+_Novità nella versione 0.3.7._
+
+// TRANSLATION MISSING
+Check if a pointer is valid for a hdata and a list pointer.
+
+Prototipo:
+
+[source,C]
+----------------------------------------
+int weechat_hdata_check_pointer (struct t_hdata *hdata, void *list, void *pointer);
+----------------------------------------
+
+Argomenti:
+
+* 'hdata': puntatore hdata
+// TRANSLATION MISSING
+* 'list': list pointer
+// TRANSLATION MISSING
+* 'pointer': pointer to check
+
+Valore restituito:
+
+// TRANSLATION MISSING
+* 1 if pointer is in list, 0 if not found
+
+Esempio in C:
+
+[source,C]
+----------------------------------------
+/* check if a buffer pointer is valid */
+struct t_hdata *hdata = weechat_hdata_get ("buffer");
+if (weechat_hdata_check_pointer (hdata,
+                                 weechat_hdata_get_list (hdata, "gui_buffers"),
+                                 ptr_buffer))
+{
+    /* valid pointer */
+}
+else
+{
+    /* invalid pointer */
+}
+----------------------------------------
+
+Script (Python):
+
+[source,python]
+----------------------------------------
+# prototipo
+rc = weechat.hdata_check_pointer(hdata, list, pointer)
+
+# esempio
+hdata = weechat.hdata_get("buffer")
+if weechat.hdata_check_pointer(hdata, weechat.hdata_get_list(hdata, "gui_buffers"), ptr_buffer):
+    # valid pointer
+    # ...
+else:
+    # invalid pointer
+    # ...
+----------------------------------------
+
 weechat_hdata_move
 ^^^^^^^^^^^^^^^^^^
 

doc/it/weechat_scripting.it.txt

@@ -353,10 +353,11 @@ Elenco di funzioni nelle API per gli script:
   infolist_get, infolist_next, infolist_prev, infolist_reset_item_cursor, +
   infolist_fields, infolist_integer, infolist_string, infolist_pointer, +
   infolist_time, infolist_free
-| hdata               |
+| hdata                  |
   hdata_get, hdata_get_var_offset, hdata_get_var_type_string,
-  hdata_get_var_hdata, hdata_get_list, hdata_move, hdata_integer, hdata_long,
-  hdata_string, hdata_pointer, hdata_time, hdata_get_string
+  hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move,
+  hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer,
+  hdata_time, hdata_get_string
 | aggiornamento          |
   upgrade_new, upgrade_write_object, upgrade_read, upgrade_close
 |========================================

doc/pl/weechat_scripting.pl.txt

@@ -347,8 +347,9 @@ Lista funkcji w API skryptów:
   infolist_time, infolist_free
 | hdata               |
   hdata_get, hdata_get_var_offset, hdata_get_var_type_string,
-  hdata_get_var_hdata, hdata_get_list, hdata_move, hdata_integer, hdata_long,
-  hdata_string, hdata_pointer, hdata_time, hdata_get_string
+  hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move,
+  hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer,
+  hdata_time, hdata_get_string
 | uaktualnienie       |
   upgrade_new, upgrade_write_object, upgrade_read, upgrade_close
 |========================================