weechat.register(name, author, version, license, description, shutdown_function, charset)
Ce manuel documente le client de messagerie instantanée WeeChat, il fait partie de WeeChat.
La dernière version de ce document peut être téléchargée sur cette page : http://www.weechat.org/doc
WeeChat (Wee Enhanced Environment for Chat) est un client de discussion libre, rapide et léger, conçu pour différents systèmes d’exploitation.
Ce manuel documente la façon d'écrire des scripts pour WeeChat, en utilisant l’un des cinq langages de script supportés : perl, python, ruby, lua ou tcl.
Note
|
La majorité des exemples de cette documentation sont écrits en Python, mais l’API est la même pour les autres langages. |
Quelques choses sont spécifiques aux langages :
perl :
les fonctions sont appelées par weechat::xxx(arg1, arg2, ...);
python :
vous devez utiliser import weechat
les fonctions print* se nomment prnt* en python (car print est un mot clé réservé)
les fonctions sont appelées par weechat.xxx(arg1, arg2, ...)
ruby :
vous devez définir weechat_init et appeler register dedans
les fonctions sont appelées par Weechat.xxx(arg1, arg2, ...)
tcl :
les fonctions sont appelées par weechat::xxx arg1 arg2 ...
Tous les scripts WeeChat doivent s’enregistrer ("register") auprès de WeeChat, et cela doit être la première fonction WeeChat appelée dans le script.
Prototype :
weechat.register(name, author, version, license, description, shutdown_function, charset)
Paramètres :
name : chaîne, nom interne du script
author : chaîne, nom de l’auteur
version : chaîne, version du script
license : chaîne, licence du script
description : chaîne, description courte du script
shutdown_function : chaîne, nom de la fonction appelée lorsque le script est déchargé
charset : chaîne, jeu de caractères du script (optionnel, si votre script est UTF-8, vous pouvez utiliser une valeur vide ici, car UTF-8 est le jeu de caractères par défaut)
Exemple, pour chaque langage :
perl :
weechat::register("test_perl", "FlashCode", "1.0", "GPL3", "Script de test", "", ""); weechat::print("", "Bonjour, du script perl !");
python :
import weechat weechat.register("test_python", "FlashCode", "1.0", "GPL3", "Script de test", "", "") weechat.prnt("", "Bonjour, du script python !")
ruby :
def weechat_init Weechat.register("test_ruby", "FlashCode", "1.0", "GPL3", "Script de test", "", "") Weechat.print("", "Bonjour, du script ruby !") return Weechat::WEECHAT_RC_OK end
lua :
weechat.register("test_lua", "FlashCode", "1.0", "GPL3", "Script de test", "", "") weechat.print("", "Bonjour, du script lua !")
tcl :
weechat::register "test_tcl" "FlashCode" "1.0" "GPL3" "Script de test" "" "" weechat::print "" "Bonjour, du script tcl !"
Vous devez utiliser la commande, dépendant du langage :
/perl load perl/script.pl /python load python/script.py /ruby load ruby/script.rb /lua load lua/script.lua /tcl load tcl/script.tcl
Vous pouvez faire un lien dans le répertoire langage/autoload pour charger automatiquement le script quand WeeChat démarre.
Par exemple en Python :
$ cd ~/.weechat/python/autoload $ ln -s ../script.py
L’API script est quasiment identique à l’API C. Vous pouvez consulter la Référence API Extension WeeChat pour le détail de chaque fonction de l’API : prototype, paramètres, valeurs de retour, exemples.
Il est important de bien faire la différence entre une extension et un script : une extension est un fichier binaire compilé et chargé avec la commande /plugin, tandis qu’un script est un fichier texte chargé par une extension comme pyhton par la commande /python.
Quand votre script test.py appelle une fonction de l’API WeeChat, le chemin est le suivant :
(API script) (API C) \/ \/ test.py -------> extension python (python.so) -------> WeeChat core
Quand WeeChat appelle un "callback" dans votre script test.py, le chemin est inversé :
(API C) (API script) \/ \/ WeeChat core -------> extension plugin (python.so) -------> test.py
Comme vous le savez probablement, il n’y a pas vraiment de "pointeurs" dans les scripts. Donc quand les fonctions de l’API retournent un pointeur, il est converti en chaîne pour le script.
Par exemple, si une fonction retourne le pointeur 0x1234ab56, le script recevra la chaîne "0x1234ab56".
Et quand une fonction de l’API attend un pointeur dans ses paramètres, le script doit envoyer cette valeur sous forme de chaîne. L’extension C la convertira en pointeur réel avant d’appeler la fonction de l’API C.
Une chaîne vide ou "0x0" sont autorisées, cela signifie le pointeur NULL en C. Par exemple, pour afficher un message sur le tampon core (tampon principal WeeChat), vous pouvez faire :
weechat.prnt("", "bonjour !")
Warning
|
Dans beaucoup de fonctions, pour des raisons de vitesse, WeeChat ne vérifie pas si votre pointeur est correct ou pas. Il est de votre responsabilité de vérifier que vous donnez un pointeur valide, sinon vous pourriez voir un joli rapport de crash ;) |
Tous les "callbacks" WeeChat doivent retourner WEECHAT_RC_OK ou WEECHAT_RC_ERROR (l’exception est le callback du "modifier", qui retourne une chaîne de caractères).
Les "callbacks" C utilisent un paramètre "data", qui est un pointeur. Dans l’API script, ce "data" est une chaîne de caractères avec n’importe quelle valeur (ce n’est pas un pointeur).
Par exemple :
weechat.hook_timer(1000, 0, 1, "mon_timer_cb", "mes données") def mon_timer_cb(data, remaining_calls): # cela affichera : "mes données" weechat.prnt("", data) return weechat.WEECHAT_RC_OK
Pour plus d’informations sur les fonctions de l’API, merci de consulter la Référence API Extension WeeChat.
Liste des fonctions de l’API script :
Catégorie | Fonctions |
---|---|
général |
register |
extensions |
plugin_get_name |
chaînes |
charset_set, iconv_to_internal, iconv_from_internal, gettext, ngettext, |
répertoires |
mkdir_home, mkdir, mkdir_parents |
listes triées |
list_new, list_add, list_search, list_casesearch, list_get, list_set, list_next, list_prev, list_string, list_size, list_remove, list_remove_all, list_free |
fichiers de configuration |
config_new, config_new_section, config_search_section, config_new_option,
config_search_option, |
affichage |
prefix, color, print (for python: prnt), print_date_tags (for python: prnt_date_tags), print_y (for python: prnt_y), log_print |
hooks |
hook_command, hook_command_run, hook_timer, hook_fd, hook_process, hook_connect, hook_print, hook_signal, hook_signal_send, hook_config, hook_completion, hook_completion_list_add, hook_modifier, hook_modifier_exec, hook_info, hook_infolist, unhook, unhook_all |
tampons |
buffer_new, current_buffer, buffer_search, buffer_search_main, buffer_clear, buffer_close, buffer_merge, buffer_unmerge, buffer_get_integer, buffer_get_string, buffer_get_pointer, buffer_set, buffer_string_replace_local_var |
fenêtres |
current_window, window_get_integer, window_get_string, window_get_pointer, window_set_title |
liste des pseudos |
nicklist_add_group, nicklist_search_group, nicklist_add_nick, nicklist_search_nick, nicklist_remove_group, nicklist_remove_nick, nicklist_remove_all |
barres |
bar_item_search, bar_item_new, bar_item_update, bar_item_remove, bar_search, bar_new, bar_set, bar_update, bar_remove |
commandes |
command |
infos |
info_get |
infolists |
infolist_new, infolist_new_item, infolist_new_var_integer,
infolist_new_var_string, infolist_new_var_pointer, infolist_new_var_time, |
mise à jour |
upgrade_new, upgrade_write_object, upgrade_read, upgrade_close |
Liste des constantes de l’API script :
Catégorie | Constantes |
---|---|
codes retour |
WEECHAT_RC_OK, WEECHAT_RC_OK_EAT, WEECHAT_RC_ERROR |
fichiers de configuration |
WEECHAT_CONFIG_READ_OK, WEECHAT_CONFIG_READ_MEMORY_ERROR,
WEECHAT_CONFIG_READ_FILE_NOT_FOUND, WEECHAT_CONFIG_WRITE_OK,
WEECHAT_CONFIG_WRITE_ERROR, WEECHAT_CONFIG_WRITE_MEMORY_ERROR, |
listes triées |
WEECHAT_LIST_POS_SORT, WEECHAT_LIST_POS_BEGINNING, WEECHAT_LIST_POS_END |
hotlist |
WEECHAT_HOTLIST_LOW, WEECHAT_HOTLIST_MESSAGE, WEECHAT_HOTLIST_PRIVATE, WEECHAT_HOTLIST_HIGHLIGHT |
hook process |
WEECHAT_HOOK_PROCESS_RUNNING, WEECHAT_HOOK_PROCESS_ERROR |
hook connect |
WEECHAT_HOOK_CONNECT_OK, WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND, WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND, WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED, WEECHAT_HOOK_CONNECT_PROXY_ERROR, WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR, WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR, WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR, WEECHAT_HOOK_CONNECT_MEMORY_ERROR |
hook signal |
WEECHAT_HOOK_SIGNAL_STRING, WEECHAT_HOOK_SIGNAL_INT, WEECHAT_HOOK_SIGNAL_POINTER |
Ce chapitre montre quelques tâches courantes, avec des exemples. Seule une partie de l’API est utilisée ici, pour une référence complète, voir la Référence API Extension WeeChat.
Une chaîne vide est souvent utilisée pour travailler avec le tampon core WeeChat. Pour les autres tampons, vous devez passer un pointeur (sous forme de chaîne, voir pointeurs).
Exemples :
# afficher "bonjour" sur le tampon core weechat.prnt("", "bonjour") # afficher le préfixe "==>" et le message "bonjour" sur le tampon courant # (le préfixe et le message doivent être séparés par une tabulation) weechat.prnt(weechat.current_buffer(), "==>\tbonjour") # afficher un message d'erreur sur le tampon core (avec le préfixe d'erreur) weechat.prnt("", "%smauvais paramètres" % weechat.prefix("error")) # afficher un message avec de la couleur sur le tampon core weechat.prnt("", "texte %sjaune sur bleu" % weechat.color("yellow,blue")) # chercher un tampon et afficher un message # (le nom complet d'un tampon est extension.nom, par exemple : "irc.freenode.#weechat") buffer = weechat.buffer_search("irc", "freenode.#weechat") weechat.prnt(buffer, "message sur le canal #weechat") # autre solution pour chercher un tampon IRC (meilleure) # (notez que le serveur et le canal sont séparés par une virgule) buffer = weechat.info_get("irc_buffer", "freenode,#weechat") weechat.prnt(buffer, "message sur le canal #weechat")
Note
|
La fonction d’affichage est appelée print en Perl/Ruby/Lua/Tcl et prnt en Python. |
Vous pouvez envoyer du texte ou une commande à un tampon. C’est exactement comme si vous tapiez le texte sur la ligne de commande et que vous pressiez [Enter].
Exemples :
# exécuter la commande "/help" sur le tampon core weechat.command("", "/help") # envoyer "bonjour" au canal IRC #weechat (les utilisateurs sur le canal verront le message) buffer = weechat.info_get("irc_buffer", "freenode,#weechat") weechat.command(buffer, "bonjour")
Vous pouvez créer un nouveau tampon dans votre script, et l’utiliser pour afficher des messages.
Deux "callbacks" peuvent être appelés (ils sont optionnels) : un pour les données en entrée (quand vous tapez du texte et pressez [Enter] sur le tampon), l’autre est appelé lorsque le tampon est fermé (par exemple avec /buffer close).
Exemple :
# callback pour les données reçues en entrée def buffer_input_cb(data, buffer, input_data): # ... return weechat.WEECHAT_RC_OK # callback appelé lorsque le tampon est fermé def buffer_close_cb(data, buffer): # ... return weechat.WEECHAT_RC_OK # créer le tampon buffer = weechat.buffer_new("montampon", "buffer_input_cb", "", "buffer_close_cb", "") # définir le titre weechat.buffer_set(buffer, "title", "Ceci est le titre du tampon.") # désactiver l'enregistrement (log), en définissant la variable locale "no_log" à "1" weechat.buffer_set(buffer, "localvar_set_no_log", "1")
Vous pouvez lire des propriétés du tampon, sous forme de chaîne, entier ou pointeur.
Exemples :
buffer = weechat.current_buffer() number = weechat.buffer_get_integer(buffer, "number") name = weechat.buffer_get_string(buffer, "name") short_name = weechat.buffer_get_string(buffer, "short_name")
Il est possible d’ajouter, lire ou supprimer des variables locales dans le tampon :
# ajouter une variable locale weechat.buffer_set(buffer, "localvar_set_myvar", "my_value") # lire une variable locale myvar = weechat.buffer_get_string(buffer, "localvar_myvar") # supprimer une variable locale weechat.buffer_set(buffer, "localvar_del_myvar", "")
Pour voir les variables locales d’un tampon, exécutez cette commande dans WeeChat :
/buffer localvar
Ajoutez une nouvelle commande avec hook_command. Vous pouvez utiliser une complétion personnalisée pour compléter les paramètres de votre commande.
Exemple :
def my_command_cb(data, buffer, args): # ... return weechat.WEECHAT_RC_OK hook = weechat.hook_command("monfiltre", "description de mon filtre", "[list] | [enable|disable|toggle [name]] | [add name plugin.buffer tags regex] | [del name|-all]", "description des paramètres...", "list" " || enable %(filters_names)" " || disable %(filters_names)" " || toggle %(filters_names)" " || add %(filters_names) %(buffers_plugins_names)|*" " || del %(filters_names)|-all", "my_command_cb", "")
Puis sous WeeChat :
/help monfiltre /monfiltre paramètres...
Ajoutez un timer avec hook_timer.
Exemple :
def timer_cb(data, remaining_calls): # ... return weechat.WEECHAT_RC_OK # timer appelé chaque minute quand la seconde est 00 weechat.hook_timer(60 * 1000, 60, 0, "timer_cb", "")
Vous pouvez lancer un processus en tâche de fond avec hook_process. Votre "callback" sera appelé quand des données seront prêtes. Il peut être appelé plusieurs fois.
Pour le dernier appel à votre "callback", rc est positionné à 0 ou une valeur positive, c’est le code retour de la commande.
Exemple :
# Afficher la version des noyaux Linux. kernel_txt = "" def kernel_process_cb(data, command, rc, stdout, stderr): """ Callback qui lit la sortie de la commande. """ global kernel_txt if stdout != "": kernel_txt += stdout if int(rc) >= 0: weechat.prnt("", kernel_txt) return weechat.WEECHAT_RC_OK weechat.hook_process("python -c \"import urllib; " \ "print urllib.urlopen('http://www.kernel.org/kdist/finger_banner').read()\"", 10 * 1000, "kernel_process_cb", "")
La fonction config_is_set_plugin est utilisée pour vérifier si une option est définie ou pas, et config_set_plugin pour définir une option.
Exemple :
script_options = { "option1" : "valeur1", "option2" : "valeur2", "option3" : "valeur3", } for option, default_value in script_options.iteritems(): if not weechat.config_is_set_plugin(option): weechat.config_set_plugin(option, default_value)
Vous devez utiliser hook_config pour être notifié si l’utilisateur modifie certaines options du script.
Exemple :
SCRIPT_NAME = "monscript" # ... def config_cb(data, option, value): """ Callback appelé lorsqu'une option du script est modifiée. """ # par exemple, relire toutes les options du script dans des variables du script... # ... return weechat.WEECHAT_RC_OK # ... weechat.hook_config("plugins.var.python." + SCRIPT_NAME + ".*", "config_cb", "") # pour les autres languages, remplacez "python" par le language ("perl", "ruby", "lua" ou "tcl")
La fonction config_get retourne un pointeur vers une option. Ensuite, en fonction du type de l’option, il faut appeler config_string, config_boolean, config_integer ou config_color.
# chaîne weechat.prnt("", "la valeur de l'option weechat.look.item_time_format est : %s" % (weechat.config_string(weechat.config_get("weechat.look.item_time_format")))) # booléen weechat.prnt("", "la valeur de l'option weechat.look.day_change est : %d" % (weechat.config_boolean(weechat.config_get("weechat.look.day_change")))) # entier weechat.prnt("", "la valeur de l'option weechat.look.scroll_page_percent est : %d" % (weechat.config_integer(weechat.config_get("weechat.look.scroll_page_percent")))) # couleur weechat.prnt("", "la valeur de l'option weechat.color.chat_delimiters est : %s" % (weechat.config_color(weechat.config_get("weechat.color.chat_delimiters"))))
L’extension IRC envoie deux signaux pour un message reçu (xxx est le nom interne du serveur IRC, yyy est le nom de la commande IRC comme JOIN, QUIT, PRIVMSG, 301, ..):
signal envoyé avant traitement du message
message sent après traitement du message
def join_cb(data, signal, signal_data): # signal est par exemple : "freenode,irc_in2_join" # signal_data est le message IRC, par exemple : ":nick!user@host JOIN :#canal" nick = weechat.info_get("irc_nick_from_host", signal_data) server = signal.split(",")[0] channel = signal_data.split(":")[-1] buffer = weechat.info_get("irc_buffer", "%s,%s" % (server, channel)) if buffer: weechat.prnt(buffer, "Eheh, %s a rejoint le canal !" % nick) return weechat.WEECHAT_RC_OK # il est pratique ici d'utiliser "*" comme serveur, pour intercepter les # messages JOIN de tous les serveurs IRC weechat.hook_signal("*,irc_in2_join", "join_cb", "")
Le meilleur moyen de vérifier la version est de demander "version_number" et de faire une comparaison entre nombre entiers avec la version hexadécimale de la version.
Exemple :
version = weechat.info_get("version_number", "") or 0 if int(version) >= 0x00030200: weechat.prnt("", "C'est WeeChat 0.3.2 ou plus récent") else: weechat.prnt("", "C'est WeeChat 0.3.1 ou plus ancien")
Note
|
Les versions < = 0.3.1.1 retournent une chaîne vide pour info_get("version_number"), donc vous devez vérifier que la valeur de retour n’est pas vide. |
Pour obtenir la version sous forme de chaîne :
# ceci affichera par exemple "Version 0.3.2" weechat.prnt("", "Version %s" % weechat.info_get("version", ""))
# répertoire de WeeChat, par exemple : "/home/xxxx/.weechat" weechat.prnt("", "Répertoire WeeChat : %s" % weechat.info_get("weechat_dir", "")) # inactivité clavier weechat.prnt("", "Inactivité depuis %s secondes" % weechat.info_get("inactivity", ""))
Vous pouvez lire une infolist construite par WeeChat ou d’autres extensions.
Exemple :
# lecture de l'infolist "buffer", pour avoir la liste des tampons infolist = weechat.infolist_get("buffer", "", "") if infolist: while weechat.infolist_next(infolist): name = weechat.infolist_string(infolist, "name") weechat.prnt("", "buffer: %s" % name) weechat.infolist_free(infolist)
Important
|
N’oubliez pas d’appeler infolist_free pour libérer la mémoire utilisée par l’infolist, car WeeChat ne libère par automatiquement cette mémoire. |