summaryrefslogtreecommitdiff
path: root/doc/fr/weechat_plugin_api.fr.txt
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2014-02-21 15:36:14 +0100
committerSebastien Helleu <flashcode@flashtux.org>2014-02-21 15:36:14 +0100
commitf907ea17d51d0446987970ab42b225054c99b12c (patch)
tree682e13d516f36522639433b49d481939c1b33c4f /doc/fr/weechat_plugin_api.fr.txt
parent30191871781575436492eb8ce29c2db660450997 (diff)
parentd6e7c9fda6e6ae4528044c223ab37885adbde90a (diff)
downloadweechat-f907ea17d51d0446987970ab42b225054c99b12c.zip
Merge branch 'trigger'
Diffstat (limited to 'doc/fr/weechat_plugin_api.fr.txt')
-rw-r--r--doc/fr/weechat_plugin_api.fr.txt270
1 files changed, 230 insertions, 40 deletions
diff --git a/doc/fr/weechat_plugin_api.fr.txt b/doc/fr/weechat_plugin_api.fr.txt
index 596b82924..79cef0b85 100644
--- a/doc/fr/weechat_plugin_api.fr.txt
+++ b/doc/fr/weechat_plugin_api.fr.txt
@@ -863,41 +863,6 @@ match3 = weechat.string_match("abcdef", "*def", 0) # 1
match4 = weechat.string_match("abcdef", "*de*", 0) # 1
----
-==== weechat_string_replace
-
-Remplacer toutes les occurrences d'une chaîne par une autre chaîne.
-
-Prototype :
-
-[source,C]
-----
-char *weechat_string_replace (const char *string, const char *search,
- const char *replace);
-----
-
-Paramètres :
-
-* 'string' : chaîne
-* 'search' : chaîne à remplacer
-* 'replace' : remplacement pour la chaîne 'search'
-
-Valeur de retour :
-
-* chaîne avec 'search' remplacée par 'replace' (doit être supprimée par un appel
- à "free" après utilisation)
-
-Exemple en C :
-
-[source,C]
-----
-char *str = weechat_string_replace ("test, test", "s", "x"); /* résultat : "text" */
-/* ... */
-free (str);
-----
-
-[NOTE]
-Cette fonction n'est pas disponible dans l'API script.
-
==== weechat_string_expand_home
_WeeChat ≥ 0.3.3._
@@ -1005,6 +970,58 @@ free (str);
[NOTE]
Cette fonction n'est pas disponible dans l'API script.
+==== weechat_string_convert_escaped_chars
+
+_WeeChat ≥ 0.4.4._
+
+Convertir les caractères échappés par leur valeur :
+
+* `\"` : double guillemet droit
+* `\\` : barre oblique inversée
+* `\a` : alerte (BEL)
+* `\b` : retour arrière
+* `\e` : échappement
+* `\f` : saut de page
+* `\n` : nouvelle ligne
+* `\r` : retour chariot
+* `\t` : tabulation horizontale
+* `\v` : tabulation verticale
+* `\0ooo` : caractère sous forme de valeur octale (ooo a 0 à 3 chiffres)
+* `\xhh` : caractère sous forme de valeur hexadécimale (hh a 1 à 2 chiffres)
+* `\uhhhh` : caractère unicode sous forme de valeur hexadécimale (hhhh a 1 à 4
+ chiffres)
+* `\Uhhhhhhhh` : caractère unicode sous forme de valeur hexadécimale (hhhhhhhh
+ a 1 à 8 chiffres)
+
+Prototype :
+
+[source,C]
+----
+char *weechat_string_convert_escaped_chars (const char *string);
+----
+
+Paramètres :
+
+* 'string' : chaîne
+
+Valeur de retour :
+
+* chaîne avec les caractères échappés remplacés par leur valeur (doit être
+ supprimée par un appel à "free" après utilisation)
+
+Exemple en C :
+
+[source,C]
+----
+char *str = weechat_string_convert_escaped_chars ("snowman: \\u2603");
+/* str == "snowman: ☃" */
+/* ... */
+free (str);
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
==== weechat_string_mask_to_regex
Retourner une expression régulière ("regex"), construite avec un masque où le
@@ -1230,6 +1247,100 @@ highlight = weechat.string_has_highlight_regex(string, regex)
highlight = weechat.string_has_highlight_regex("my test string", "test|word2") # 1
----
+==== weechat_string_replace
+
+Remplacer toutes les occurrences d'une chaîne par une autre chaîne.
+
+Prototype :
+
+[source,C]
+----
+char *weechat_string_replace (const char *string, const char *search,
+ const char *replace);
+----
+
+Paramètres :
+
+* 'string' : chaîne
+* 'search' : chaîne à remplacer
+* 'replace' : remplacement pour la chaîne 'search'
+
+Valeur de retour :
+
+* chaîne avec 'search' remplacée par 'replace' (doit être supprimée par un appel
+ à "free" après utilisation)
+
+Exemple en C :
+
+[source,C]
+----
+char *str = weechat_string_replace ("test, test", "s", "x"); /* résultat : "text" */
+/* ... */
+free (str);
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
+==== weechat_string_replace_regex
+
+_WeeChat ≥ 0.4.4._
+
+Remplacer du texte dans une chaîne en utilisant une expression régulière et du
+texte de remplacement.
+
+Prototype :
+
+[source,C]
+----
+char *weechat_string_replace_regex (const char *string, void *regex,
+ const char *replace, const char reference_char);
+----
+
+Paramètres :
+
+* 'string' : chaîne
+* 'regex' : pointeur vers une expression régulière (structure 'regex_t')
+ compilée avec la fonction WeeChat
+ <<_weechat_string_regcomp,weechat_string_regcomp>> ou regcomp (voir
+ `man regcomp`)
+* 'replace' : texte de remplacement, où les références suivantes sont
+ autorisées :
+** `$0` à `$99` : correspondance 0 à 99 dans l'expression régulière (0 est la
+ correspondance entière, 1 à 99 sont les groupes capturés entre parenthèses)
+** `$+` : la dernière correspondance (avec le numéro le plus élevé)
+** `$.*N` : correspondance `N` (peut être `+` ou de `0` à `99`), avec tous les
+ caractères remplacés par `*` (le caractère `*` peut être n'importe quel
+ caractère entre l'espace (32) et `~` (126))
+* 'reference_char' : le caractère utilisé pour les références aux
+ correspondances (en général '$')
+
+Valeur de retour :
+
+* chaîne avec le texte remplacé, NULL en cas de problème (doit être supprimée
+ par un appel à "free" après utilisation)
+
+Exemple en C :
+
+[source,C]
+----
+regex_t my_regex;
+char *string;
+if (weechat_string_regcomp (&my_regex, "([0-9]{4})-([0-9]{2})-([0-9]{2})",
+ REG_EXTENDED) == 0)
+{
+ string = weechat_string_replace_regex ("date: 2014-02-14", &my_regex,
+ "$3/$2/$1", '$');
+ /* string == "date: 14/02/2014" */
+ if (string)
+ free (string);
+ regfree (&my_regex);
+}
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
==== weechat_string_split
Découper une chaîne à l'aide de délimiteur(s).
@@ -1291,6 +1402,54 @@ weechat_string_free_split (argv);
[NOTE]
Cette fonction n'est pas disponible dans l'API script.
+==== weechat_string_split_shell
+
+_WeeChat ≥ 0.4.4._
+
+Découper une chaîne comme le shell le fait pour une commande avec ses
+paramètres.
+
+Cette fonction est une conversion en C de la classe Python "shlex" (fichier :
+Lib/shlex.py dans le dépôt Python), voir :
+http://docs.python.org/3/library/shlex.html.
+
+Prototype :
+
+[source,C]
+----
+char **weechat_string_split_shell (const char *string, int *num_items);
+----
+
+Paramètres :
+
+* 'string' : chaîne à découper
+* 'num_items' : pointeur vers un entier qui contiendra le nombre de chaînes
+ créées
+
+Valeur de retour :
+
+* tableau de chaînes, NULL en cas de problème (doit être supprimé par un appel à
+ <<_weechat_string_free_split,weechat_string_free_split>> après utilisation)
+
+Exemple en C :
+
+[source,C]
+----
+char **argv;
+int argc;
+argv = weechat_string_split_shell ("test 'first arg' \"second arg\"", &argc);
+/* résultat: argv[0] == "test"
+ argv[1] == "first arg"
+ argv[2] == "second arg"
+ argv[3] == NULL
+ argc == 3
+*/
+weechat_string_free_split (argv);
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
==== weechat_string_free_split
Supprimer une chaîne découpée.
@@ -3381,7 +3540,7 @@ Paramètres :
* 'hashtable' : pointeur vers la table de hachage
* 'key' : pointeur vers la clé
-Valeur en retour :
+Valeur de retour :
* valeur pour la clé, NULL si la clé n'est pas trouvée
@@ -3413,7 +3572,7 @@ Paramètres :
* 'hashtable' : pointeur vers la table de hachage
* 'key' : pointeur vers la clé
-Valeur en retour :
+Valeur de retour :
* 1 si la clé est dans la table de hachage, 0 si la clé n'est pas dans la table
de hachage
@@ -3524,6 +3683,37 @@ weechat_hashtable_map_string (hashtable, &map_cb, NULL);
[NOTE]
Cette fonction n'est pas disponible dans l'API script.
+==== weechat_hashtable_dup
+
+_WeeChat ≥ 0.4.4._
+
+Dupliquer une table de hachage.
+
+Prototype :
+
+[source,C]
+----
+struct t_hashtable *hashtable_dup (struct t_hashtable *hashtable);
+----
+
+Paramètres :
+
+* 'hashtable' : pointeur vers la table de hachage
+
+Valeur de retour :
+
+* table de hachage dupliquée
+
+Exemple en C :
+
+[source,C]
+----
+struct t_hashtable *new_hashtable = weechat_hashtable_dup (hashtable);
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
==== weechat_hashtable_get_integer
_WeeChat ≥ 0.3.3._
@@ -3545,7 +3735,7 @@ Paramètres :
** 'size' : taille du tableau interne "htable" dans la table de hachage
** 'items_count' : nombre d'éléments dans la table de hachage
-Valeur en retour :
+Valeur de retour :
* valeur de la propriété sous forme d'entier
@@ -3600,7 +3790,7 @@ Paramètres :
** 'keys_values_sorted' : chaîne avec la liste des clés et valeurs (triée sur
les clés) (format : "clé1:valeur1,clé2:valeur2,clé3:valeur3")
-Valeur en retour :
+Valeur de retour :
* valeur de la propriété sous forme de chaîne
@@ -3678,7 +3868,7 @@ Paramètres :
* 'infolist_item' : pointeur vers l'objet de l'infolist
* 'prefix' : chaîne utilisée comme préfixe pour les noms dans l'infolist
-Valeur en retour :
+Valeur de retour :
* 1 si ok, 0 en cas d'erreur