Questo manuale documenta il client di chat WeeChat, ed è parte del programma stesso.

La versione più recente di questo documento si trova qui: https://weechat.org/doc

1. Introduzione

WeeChat (Wee Enhanced Environment for Chat) è un client di chat libero, veloce e leggero, realizzato per molti sistemi operativi.

Questo manuale documenta le API per i plugin di WeeChat, utilizzate dai plugin C per interagire con il core di WeeChat.

2. Plugin in WeeChat

Un plugin è un programma C che può richiamare le funzioni di WeeChat definite in un’interfaccia.

Questo programma C non richiede i sorgenti di WeeChat per essere compilato e può essere caricato dinamicamente in WeeChat con il comano /plugin.

Il plugin deve essere una libreria dinamica, per essere caricato dinamicamente dal del sistema operativo. In GNU/Linux, il file ha estensione ".so", ".dll" in Windows.

Il plugin deve includere il file "weechat-plugin.h" (disponibile nel codice sorgente di WeeChat). Il file definisce strutture e tipi utilizzati per comunicare con WeeChat.

2.1. Macro

Il plugin deve utilizzare alcune macro (per definire alcune variabili):

WEECHAT_PLUGIN_NAME("nome")

nome del plugin

WEECHAT_PLUGIN_DESCRIPTION("descrizione")

breve descrizione del plugin

WEECHAT_PLUGIN_VERSION("1.0")

versione del plugin

WEECHAT_PLUGIN_LICENSE("GPL3")

licenza del plugin

2.2. Funzioni principali

Il plugin deve usare due funzioni:

  • weechat_plugin_init

  • weechat_plugin_end

2.2.1. weechat_plugin_init

Questa funzione viene chiamata quando il plugin è caricato. da WeeChat.

Prototipo:

Argomenti:

  • plugin: puntatore alla struttura del plugin di WeeChat

  • argc: numero di argomenti per il plugin (fornito dalla riga di comando dall’utente)

  • argv: argomenti per il plugin

Valori restituiti:

  • WEECHAT_RC_OK se l’operazione ha successo (il plugin verrà caricato)

  • WEECHAT_RC_ERROR se c'è un errore (il plugin NON verrà caricato)

2.2.2. weechat_plugin_end

Questa funzione viene chiamata quando il plugin viene scaricato da WeeChat.

Prototipo:

Argomenti:

  • plugin: puntatore alla struttura plugin di WeeChat

Valori restituiti:

  • WEECHAT_RC_OK se l’operazione ha successo

  • WEECHAT_RC_ERROR se c'è un errore

2.3. Compilazione del plugin

La compilazione non richiede i sorgenti di WeeChat, è richiesto solo il file weechat-plugin.h.

Per compilare un plugin che ha un file "tizio.c" (in GNU/Linux):

$ gcc -fPIC -Wall -c tizio.c
$ gcc -shared -fPIC -o libtizio.so tizio.o

2.4. Caricamento del plugin

Copiare il file libtizio.so nella cartella plugin di sistema (ad esempio /usr/local/lib/weechat/plugins) oppure nella cartella plugin dell’utente (ad esempio /home/xxx/.weechat/plugins).

In WeeChat:

/plugin load tizio

2.5. Plugin di esempio

Un esempio completo di plugin, che aggiunge un comando /double: visualizza due volte gli argomenti nel buffer corrente, oppure esegue un comando due volte (ok, non sarà molto utile, ma è solo un esempio!):

3. Plugin API

I capitoli seguenti descrivono le funzioni nelle API, organizzate in categorie.

Per ogni funzione, viene fornita:

  • descrizione della funzione,

  • prototipo C,

  • dettaglio degli argomenti,

  • valore restituito,

  • esempio C,

  • esempio nello script Python (la sintassi è simile per gli altri linguaggi di scripting).

3.1. Plugin

Funzioni per ottenere informazioni sui plugin.

3.1.1. weechat_plugin_get_name

Ottiene il nome del plugin.

Prototipo:

Argomenti:

  • plugin: puntatore alla struttura plugin di WeeChat (può essere NULL)

Valore restituito:

  • nome del plugin, "core" per il core di WeeChat (se il puntatore al plugin è NULL)

Esempio in C:

Script (Python):

3.2. Stringhe

Molte delle funzioni stringa che seguono sono già disponibili tramite funzioni standard in C, ma si raccomanda di utilizzare le funzioni in questa API perché compatibili con UTF-8 e il locale.

3.2.1. weechat_charset_set

Imposta il nuovo set caratteri del nuovo plugin (il set caratteri predefinito è UTF-8, così se il plugin usa UTF-8 non è necessario chiamare questa funzione).

Prototipo:

Argomenti:

  • charset: nuovo set caratteri da usare

Esempio in C:

Script (Python):

3.2.2. weechat_iconv_to_internal

Converte le stringhe per il set caratteri interno di WeeChat (UTF-8).

Prototipo:

Argomenti:

  • charset: set caratteri da convertire

  • string: stringa da convertire

Valore restituito:

  • la stringa convertita (deve essere liberata richiamando "free" dopo l’utilizzo)

Esempio in C:

Script (Python):

3.2.3. weechat_iconv_from_internal

Converte la stringa dal set caratteri interno di WeeChat (UTF-8) in un’altra.

Prototipo:

Argomenti:

  • charset: set caratteri in uscita

  • string: stringa da convertire

Valore restituito:

  • la stringa convertita (deve essere liberata richiamando "free" dopo l’utilizzo

Esempio in C:

Script (Python):

3.2.4. weechat_gettext

Restituisce la stringa tradotta (dipende dalla lingua).

Prototipo:

Argomenti:

  • string: stringa da tradurre

Valore restituito:

  • stringa tradotta

Esempio in C:

Script (Python):

3.2.5. weechat_ngettext

Restituisce la stringa tradotta, utilizzando il singolare o il plurale, in base all’argomento count (contatore).

Prototipo:

Argomenti:

  • string: stringa da tradurre, singolare

  • plural: stringa da tradurre, plurale

  • count: utilizzato per scegliere tra singolare e plurale (la scelta viene fatta in base alla lingua locale)

Valore restituito:

  • stringa tradotta

Esempio in C:

Script (Python):

3.2.6. weechat_strndup

Restituisce una stringa duplicata, con un massimo di caratteri impostato su chars.

Prototipo:

Argomenti:

  • string: stringa da duplicare

  • length: caratteri massimi da duplicare

Valore restituito:

  • stringa duplicata (deve essere liberata chiamando "free" dopo l’utilizzo)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.7. weechat_string_tolower

Converte una stringa UTF-8 in minuscolo.

Prototipo:

Argomenti:

  • string: stringa da convertire

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.8. weechat_string_toupper

Converte una stringa UTF-8 in maiuscolo.

Prototipo:

Argomenti:

  • string: stringa da convertire

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.9. weechat_strcasecmp

Updated in 1.0.

Confronta stringa non sensibile alle maiuscole e alla localizzazione.

Prototipo:

Argomenti:

  • string1: prima stringa da comparare

  • string2: seconda stringa da comparare

Valore restituito:

  • -1 se stringa1 < stringa2

  • 0 se stringa1 == stringa1

  • 1 se stringa1 > stringa2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.10. weechat_strcasecmp_range

WeeChat ≥ 0.3.7, updated in 1.0.

Confronta stringa non sensibile alle maiuscole e alla localizzazione, usando una serie per il confronto.

Prototipo:

Argomenti:

  • string1: prima stringa da comparare

  • string2: seconda stringa da comparare

  • range: numero di caratteri nel confronto maiuscole/minuscole, ad esempio:

    • 26: "A-Z" vengono ridotti ad "a-z"

    • 29: "A-Z [ \ ]" vengono ridotti ad "a-z { | }"

    • 30: "A-Z [ \ ] ^" vengono ridotti ad "a-z { | } ~"

Nota
I valori 29 e 30 vengono usati da alcuni protocolli come IRC.

Valore restituito:

  • -1 se stringa1 < stringa2

  • 0 se stringa1 == stringa1

  • 1 se stringa1 > stringa2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.11. weechat_strncasecmp

Updated in 1.0.

Confronta stringa indipendente non sensibile alle maiuscole e alla localizzazione, per un numero max di caratteri.

Prototipo:

Argomenti:

  • string1: prima stringa da comparare

  • string2: seconda stringa da comparare

  • max: numero massimo di caratteri da comparare

Valore restituito:

  • -1 se stringa1 < stringa2

  • 0 se stringa1 == stringa1

  • 1 se stringa1 > stringa2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.12. weechat_strncasecmp_range

WeeChat ≥ 0.3.7, updated in 1.0.

Confronta una stringa non sensibile alle maiuscole e alla localizzazione, per un numero max di caratteri, usando una serie per il confronto.

Prototipo:

Argomenti:

  • string1: prima stringa da comparare

  • string2: seconda stringa da comparare

  • max: numero massimo di caratteri da comparare

  • range: numero di caratteri nel confronto maiuscole/minuscole, ad esempio:

    • 26: "A-Z" vengono ridotti ad "a-z"

    • 29: "A-Z [ \ ]" vengono ridotti ad "a-z { | }"

    • 30: "A-Z [ \ ] ^" vengono ridotti ad "a-z { | } ~"

Nota
I valori 29 e 30 vengono usati da alcuni protocolli come IRC.

Valore restituito:

  • -1 se stringa1 < stringa2

  • 0 se stringa1 == stringa1

  • 1 se stringa1 > stringa2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.13. weechat_strcmp_ignore_chars

Updated in 1.0.

Confronta una stringa localizzata (e opzionalmente non sensibile alle maiuscole), ignorando alcuni caratteri.

Prototipo:

Argomenti:

  • string1: prima stringa per il confronto

  • string2: seconda stringa per il confronto

  • chars_ignored: stringa con caratteri da ignorare

  • case_sensitive: 1 per il confronto sensibile alle maiuscole, altrimenti 0

Valore restituito:

  • -1 se stringa1 < stringa2

  • 0 se stringa1 == stringa1

  • 1 se stringa1 > stringa2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.14. weechat_strcasestr

Cerca una stringa non sensibile alle maiuscole e indipendente dalla localizzazione.

Prototipo:

Argomenti:

  • string: stringa

  • search: stringa da cercare in string

Valore restituito:

  • puntatore alla stringa trovata, o NULL se non trovata

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.15. weechat_strlen_screen

WeeChat ≥ 0.4.2.

Restituisce il numero di caratteri necessari per visualizzare la stringa UTF-8 su schermo. Non-printable chars have a width of 1 (this is the difference with the function weechat_utf8_strlen_screen).

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • numero di caratteri necessari per visualizzare la stringa UTF-8 su schermo

Esempio in C:

Script (Python):

3.2.16. weechat_string_match

Updated in 1.0.

Verifica se una stringa coincide ad una mask.

Prototipo:

Argomenti:

  • string: stringa

  • mask: mask with wildcards ("*"), each wildcard matches 0 or more chars in the string

  • case_sensitive: 1 per il confronto sensibile alle maiuscole, altrimenti 0

Nota
Since version 1.0, wildcards are allowed inside the mask (not only beginning/end of mask).

Valore restituito:

  • 1 se la stringa coincide alla mask, altrimenti 0

Esempio in C:

Script (Python):

3.2.17. weechat_string_expand_home

WeeChat ≥ 0.3.3.

Sostituisce la ~ iniziale con la stringa con la cartella home. Se la stringa non inizia con ~, viene restituita la stessa stringa.

Prototipo:

Argomenti:

  • path: percorso

Valore restituito:

  • percorso con la ~ iniziale sostituita dalla cartella home (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.18. weechat_string_remove_quotes

Rimuove le virgolette all’inizio e alla fine della stringa (ignora gli spazi se presenti prima delle prime virgolette o dopo le ultime virgolette).

Prototipo:

Argomenti:

  • string: stringa

  • quotes: stringa con elenco di virgolette

Valore restituito:

  • stringa senza virgolette all’inizio/fine (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.19. weechat_string_strip

Rimuove i caratteri ad inizio/fine della stringa.

Prototipo:

Argomenti:

  • string: stringa

  • left: rimuove i caratteri a sinistra se diversi da 0

  • right: rimuove i caratteri a destra se diversi da 0

  • chars: stringa con i caratteri da rimuovere

Valore restituito:

  • stringa corretta (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.20. weechat_string_convert_escaped_chars

WeeChat ≥ 1.0.

Convert escaped chars to their value:

  • \": double quote

  • \\: backslash

  • \a: alert (BEL)

  • \b: backspace

  • \e: escape

  • \f: form feed

  • \n: new line

  • \r: carriage return

  • \t: horizontal tab

  • \v: vertical tab

  • \0ooo: char as octal value (ooo is 0 to 3 digits)

  • \xhh: char as hexadecimal value (hh is 1 to 2 digits)

  • \uhhhh: unicode char as hexadecimal value (hhhh is 1 to 4 digits)

  • \Uhhhhhhhh: unicode char as hexadecimal value (hhhhhhhh is 1 to 8 digits)

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • string with escaped chars replaced by their value (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.21. weechat_string_mask_to_regex

Restituisce una espressione regolare con una mask, dove l’unico carattere speciale è "*". Tutti gli altri caratteri speciali per le espressioni regolari non vengono riconosciuti.

Prototipo:

Argomenti:

  • mask: mask

Valore restituito:

  • espressione regolare, come stringa (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Script (Python):

3.2.22. weechat_string_regex_flags

WeeChat ≥ 0.3.7.

Restituisce sia il puntatore sulla stringa dopo le flag che la mask con le flag per compilare l’espressione regolare.

Prototipo:

Argomenti:

  • regex: POSIX extended regular expression

  • default_flags: combinazione dei seguenti valori (consultare man regcomp):

    • REG_EXTENDED

    • REG_ICASE

    • REG_NEWLINE

    • REG_NOSUB

  • flags: pointer value is set with flags used in regular expression (default flags + flags set in regular expression)

Flags must be at beginning of regular expression. Format is: "(?eins-eins)string".

Allowed flags are:

  • e: POSIX extended regular expression (REG_EXTENDED)

  • i: case insensitive (REG_ICASE)

  • n: match-any-character operators don’t match a newline (REG_NEWLINE)

  • s: support for substring addressing of matches is not required (REG_NOSUB)

Valore restituito:

  • pointer in regex, after flags

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.23. weechat_string_regcomp

WeeChat ≥ 0.3.7.

Compile a POSIX extended regular expression using optional flags at beginning of string (for format of flags, see weechat_string_regex_flags).

Prototipo:

Argomenti:

  • preg: pointer to regex_t structure

  • regex: POSIX extended regular expression

  • default_flags: combination of following values (see man regcomp):

    • REG_EXTENDED

    • REG_ICASE

    • REG_NEWLINE

    • REG_NOSUB

Valore restituito:

  • same return code as function regcomp (0 if ok, other value for error, see man regcomp)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.24. weechat_string_has_highlight

Controlla se una stringa ha uno o più eventi, usando la lista di parole per gli eventi.

Prototipo:

Argomenti:

  • string: stringa

  • highlight_words: lista di parole per gli eventi, separate da virgole

Valore restituito:

  • 1 se la stringa ha uno o più eventi, altrimenti 0

Esempio in C:

Script (Python):

3.2.25. weechat_string_has_highlight_regex

WeeChat ≥ 0.3.4.

Check if a string has one or more highlights, using a POSIX extended regular expression.
For at least one match of regular expression on string, it must be surrounded by delimiters (chars different from: alphanumeric, "-", "_" and "|").

Prototipo:

Argomenti:

  • string: stringa

  • regex: POSIX extended regular expression

Valore restituito:

  • 1 se la stringa ha uno o più eventi, altrimenti 0

Esempio in C:

Script (Python):

3.2.26. weechat_string_replace

Sostituisce tutte le ricorrenze di una stringa con un’altra.

Prototipo:

Argomenti:

  • string: stringa

  • search: stringa da sostituire

  • replace: sostituzione per la stringa search

Valore restituito:

  • la stringa dopo search sostituita da replace (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.27. weechat_string_replace_regex

WeeChat ≥ 1.0.

Replace text in a string using a regular expression, replacement text and optional callback.

Prototipo:

Argomenti:

  • string: string

  • regex: pointer to a regular expression (regex_t structure) compiled with WeeChat function weechat_string_regcomp or regcomp (see man regcomp)

  • replace: replacement text, where following references are allowed:

    • $0 to $99: match 0 to 99 in regular expression (0 is the whole match, 1 to 99 are groups captured between parentheses)

    • $+: the last match (with highest number)

    • $.*N: match N (can be + or 0 to 99), with all chars replaced by * (the * char can be any char between space (32) and ~ (126))

  • reference_char: the char used for reference to match (commonly $)

  • callback: an optional callback called for each reference in replace (except for matches replaced by a char); the callback must return:

    • newly allocated string: it is used as replacement text (it is freed after use)

    • NULL: the text received in callback is used as replacement text (without changes)

  • callback_data: pointer given to callback when it is called

Valore restituito:

  • string with text replaced, NULL if problem (must be freed by calling "free" after use)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.28. weechat_string_split

Divide una stringa in base a uno o più delimitatori.

Prototipo:

Argomenti:

  • string: stringa da dividere

  • separators: delimitatori usati per dividere

  • keep_eol:

    • 0: ogni stringa conterrà una parola

    • 1: ogni stringa conterrà tutte le stringhe fino a fine riga (consultare il seguente esempio)

    • 2: come il punto 1, ma non rimuove i delimitatori alla fine della stringa prima della divisione (WeeChat ≥ 0.3.6)

  • num_items_max: numero massimo di elementi creati (0 = nessun limite)

  • num_items: puntatore ad int che conterrà il numero di elementi creati

Valore restituito:

Esempi:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.29. weechat_string_split_shell

WeeChat ≥ 1.0.

Split a string like the shell does for a command with arguments.

This function is a C conversion of Python class "shlex" (file: Lib/shlex.py in Python repository), see: http://docs.python.org/3/library/shlex.html.

Prototipo:

Argomenti:

  • string: stringa da dividere

  • num_items: puntatore ad int che conterrà il numero di elementi creati

Valore restituito:

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.30. weechat_string_free_split

Libera la memoria usata per la divisione di una stringa.

Prototipo:

Argomenti:

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.31. weechat_string_build_with_split_string

Compila una stringa con una stringa divisa.

Prototipo:

Argomenti:

  • split_string: stringa divisa dalla funzione weechat_string_split

  • separator: stringa usata per separare le stringhe

Valore restituito:

  • stringa compilata con la stringa divisa (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.32. weechat_string_split_command

Divide una lista di comandi separata da separator (che può essere omesso aggiungendo "\" nella stringa).

Prototipo:

Argomenti:

  • command: comando da dividere

  • separator: separatore

Valore restituito:

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.33. weechat_string_free_split_command

Libera la memoria utilizzata dalla divisione di un comando.

Prototipo:

Argomenti:

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.34. weechat_string_format_size

Compila una stringa con un file di dimensione fissa ed una unità tradotta nella lingua locale.

Prototipo:

Argomenti:

  • size: dimensione (in byte)

Valore restituito:

  • stringa formattata (deve essere liberata chiamando "free" dopo l’uso)

Esempi in C:

3.2.35. weechat_string_remove_color

Rimuove i colori di WeeChat da una stringa.

Prototipo:

Argomenti:

  • string: stringa

  • replacement: se non NULL e non vuota, i codici colore di WeeChat sono sostituiti dal primo carattere di questa stringa, altrimenti i codici colori di WeeChat ed i caratteri seguenti (se correlate al colore) sono rimossi dalla stringa

Valore restituito:

  • stringa senza un colore (deve essere liberata chiamando "free" dopo l’uso)

Esempi:

Script (Python):

3.2.36. weechat_string_encode_base64

WeeChat ≥ 0.3.2.

Codifica una stringa in base64.

Prototipo:

Argomenti:

  • from: stringa da codificare

  • length: lunghezza della stringa da codificare (ad esempio strlen(from))

  • to: puntatore alla stringa per memorizzare il risultato (deve essere sufficientemente lunga, il risultato è più lungo della stringa iniziale)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.37. weechat_string_decode_base64

WeeChat ≥ 0.3.2.

Decodifica una stringa in base64.

Prototipo:

Argomenti:

  • from: stringa da decodificare

  • to: puntatore alla stringa per memorizzare il risultato (deve essere sufficientemente lunga, il risultato è più lungo della stringa iniziale)

Valore restituito:

  • lunghezza della stringa memorizzata in *to (lo \0 finale non conta)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.2.38. weechat_string_is_command_char

WeeChat ≥ 0.3.2.

Verifica che il primo carattere della stringa sia un carattere comando (il comando carattere predefinito è /).

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • 1 se il primo carattere della stringa è un comando carattere, altrimenti 0

Esempi in C:

Script (Python):

3.2.39. weechat_string_input_for_buffer

WeeChat ≥ 0.3.2.

Restituisce il puntatore al testo in input per il buffer (puntatore all’interno dell’argomento "string"), oppure NULL se è un comando.

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • puntatore all’interno di "string", oppure NULL

Esempi in C:

Script (Python):

3.2.40. weechat_string_eval_expression

WeeChat ≥ 0.4.0, updated in 0.4.2 and 1.1.

Evaluate an expression and return result as a string. Special variables with format ${variable} are expanded (see table below).

Nota
Since version 1.0, nested variables are supported, for example: ${color:${variable}}.

Prototipo:

Argomenti:

  • expr: the expression to evaluate (see table below)

  • pointers: hashtable with pointers (keys must be string, values must be pointer); pointers "window" and "buffer" are automatically added if they are not in hashtable (with pointer to current window/buffer) (can be NULL):

    • regex: pointer to a regular expression (regex_t structure) compiled with WeeChat function weechat_string_regcomp or regcomp (see man regcomp); this option is similar to regex in hashtable options (below), but is used for better performance

  • extra_vars: extra variables that will be expanded (can be NULL)

  • options: a hashtable with some options (keys and values must be string) (can be NULL):

    • type: default behavior is just to replace values in expression, other types can be selected:

      • condition: the expression is evaluated as a condition: operators and parentheses are used, result is a boolean ("0" or "1")

    • prefix: prefix before variables to replace (default: "${")

    • suffix: suffix after variables to replace (default: "}")

    • regex: a regex used to replace text in expr (which is then not evaluated)

    • regex_replace: the replacement text to use with regex, to replace text in expr (the regex_replace is evaluated on each match of regex against expr, until no match is found)

Valore restituito:

  • evaluated expression (must be freed by calling "free" after use), or NULL if problem (invalid expression or not enough memory)

List of variables expanded in expression (by order of priority, from first expanded to last):

Format Description Examples Results

${name}

Variable name from hashtable extra_vars

${name}

value

${esc:xxx}
${\xxx}

String with escaped chars

${esc:prefix\tmessage}
${\ua9}

prefix<TAB>message
©

${hide:x,value}

String with hidden chars (all chars in value replaced x)

${hide:*,password}

********

${re:N}

Regex captured group: 0 = whole string matching, 1 to 99 = group captured, + = last group captured

${re:1}

test

${color:name}

WeeChat color code (the name of color has optional attributes)

${color:red}red text
${color:*214}bold orange text

red text (in red)
bold orange text (in bold orange)

${info:name}
${indo:name,arguments}

Info from WeeChat or a plugin, see function weechat_info_get

${info:version}
${info:irc_nick_color_name,foo}

1.0
lightblue

${sec.data.name}

Value of the secured data name

${sec.data.freenode_pass}

my_password

${file.section.option}

Value of the option

${weechat.look.buffer_time_format}

%H:%M:%S

${name}

Value of local variable name in buffer

${nick}

FlashCode

${hdata.var1.var2...}
${hdata[list].var1.var2...}

Hdata value (pointers window and buffer are set by default with current window/buffer)

${buffer[gui_buffers].full_name}
${window.buffer.number}

core.weechat
1

Esempi in C:

Script (Python):

3.3. UTF-8

Alcune funzioni stringa UTF-8.

3.3.1. weechat_utf8_has_8bits

Verifica che una stringa abbia caratteri a 8-bit.

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • 1 se la stringa ha caratteri a 8-bit, 0 se solo a 7-bit

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.2. weechat_utf8_is_valid

Verifica che una stringa sia valida in UTF-8.

Prototipo:

Argomenti:

  • string: stringa

  • error: se non NULL, error è impostato con il puntatore al primo carattere UTF-8 non valido nella stringa, se esiste

Valore restituito:

  • 1 se la stringa UTF-8 è valida, altrimenti 0

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.3. weechat_utf8_normalize

Normalizza le stringhe UTF-8: rimuove i caratteri non UTF-8 e li sostituisce con un carattere.

Prototipo:

Argomenti:

  • string: stringa

  • replacement: carattere sotitutivo per i caratteri non validi

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.4. weechat_utf8_prev_char

Restituisce il puntatore al carattere UTF-8 precedente in una stringa.

Prototipo:

Argomenti:

  • string_start: inizio della stringa (la funzione non restituirà un carattere prima di questo puntatore)

  • string: puntatore alla stringa (deve essere ≥ string_start)

Valore restituito:

  • puntatore al precedente carattere UTF-8, NULL se non trovata (raggiunta l’inizio della stringa)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.5. weechat_utf8_next_char

Restituisce il puntatore al successivo carattere UTF-8 in una stringa.

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • puntatore al carattere UTF-8 successivo, NULL se non trovato (raggiunta la fine della stringa)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.6. weechat_utf8_char_int

Restituisce un carattere UTF-8 come intero.

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • carattere UTF-8 come intero

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.7. weechat_utf8_char_size

Restituisce la dimensione di un carattere UTF-8 (in byte).

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • dimensione carattere UTF-8 (in byte)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.8. weechat_utf8_strlen

Restituisce la lunghezza della stringa UTF-8 (nei caratteri UTF-8).

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • lunghezza della stringa UTF-8 (numero di caratteri UTF-8)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.9. weechat_utf8_strnlen

Restituisce la lunghezza della stringa UTF-8 (in caratteri UTF-8), per un massimo di bytes nella stringa.

Prototipo:

Argomenti:

  • string: stringa

  • bytes: massimo di byte

Valore restituito:

  • lunghezza della stringa UTF-8 (numero di caratteri UTF-8)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.10. weechat_utf8_strlen_screen

Restituisce il numero di caratteri necessari per visualizzare la stringa UTF-8 su schermo.

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • numero di caratteri necessari per visualizzare la stringa UTF-8 su schermo

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.11. weechat_utf8_charcmp

Updated in 1.0.

Confronta due caratteri UTF-8.

Prototipo:

Argomenti:

  • string1: prima stringa da comparare

  • string2: seconda stringa da comparare

Valore restituito:

  • -1 se string1 < string2

  • 0 se string1 == string2

  • 1 se string1 > string2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.12. weechat_utf8_charcasecmp

Updated in 1.0.

Confronta due caratteri UTF-8, ignorando la sensibilità alle maiuscole.

Prototipo:

Argomenti:

  • string1: prima stringa da comparare

  • string2: seconda stringa da comparare

Valore restituito:

  • -1 se string1 < string2

  • 0 se string1 == string2

  • 1 se string1 > string2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.13. weechat_utf8_char_size_screen

Restituisce il numero di caratteri necessari per visualizzare il carattere UTF-8 sullo schermo.

Prototipo:

Argomenti:

  • string: stringa

Valore restituito:

  • numero di caratteri necessario per visualizzare il carattere UTF-8 su schermo

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.14. weechat_utf8_add_offset

Si sposta in avanti di N caratteri in una stringa UTF-8.

Prototipo:

Argomenti:

  • string: stringa

  • offset: numero di caratteri

Valore restituito:

  • puntatore alla stringa, N caratteri dopo (NULL se non raggiungibile)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.15. weechat_utf8_real_pos

Restituisce la posizione reale nella stringa UTF-8.

Prototipo:

Argomenti:

  • string: stringa

  • pos: posizione (numero di caratteri)

Valore restituito:

  • pozisione reale (in byte)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.16. weechat_utf8_pos

Restituisce la posizione nella stringa UTF-8.

Prototipo:

Argomenti:

  • string: stringa

  • real_pos: posizione (byte)

Valore restituito:

  • posizione (numero di caratteri)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.3.17. weechat_utf8_strndup

Restituisce la stringa duplicata, di lunghezza massima lenght.

Prototipo:

Argomenti:

  • string: stringa

  • length: caratteri massimi da duplicare

Valore restituito:

  • stringa duplicata (deve essere liberata chiamando "free" dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.4. Cartelle

Alcune funzioni legate alle cartelle.

3.4.1. weechat_mkdir_home

Crea una cartella nella home di WeeChat.

Prototipo:

Argomenti:

  • directory: nome della cartella da creare

  • mode: modalità per la cartella

Valore restituito:

  • 1 se la cartella è stata creata con successo, 0 in caso di errore

Esempio in C:

Script (Python):

3.4.2. weechat_mkdir

Crea una cartella.

Prototipo:

Argomenti:

  • directory: nome della cartella da creare

  • mode: modalità per la cartella

Valore restituito:

  • 1 se la cartella è stata creata con successo, 0 in caso di errore

Esempio in C:

Script (Python):

3.4.3. weechat_mkdir_parents

Crea una cartella e le cartelle genitore se necessario.

Prototipo:

Argomenti:

  • directory: nome della cartella da creare

  • mode: modalità per la cartella

Valore restituito:

  • 1 se la cartella è stata creata con successo, 0 in caso di errore

Esempio in C:

Script (Python):

3.4.4. weechat_exec_on_files

Cerca i file in una cartella ed esegue una callback su ogni file.

Prototipo:

Argomenti:

  • directory: cartella in cui cercare i file

  • hidden_files: 1 per includere i file nascosti, altrimenti 0

  • data: puntatore fornito alla callback quando chiamata da WeeChat

  • callback: funzione chiamata per ogni file trovato, argomenti:

    • void *data: puntatore

    • const char *filename: nome file trovato

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.4.5. weechat_file_get_content

WeeChat ≥ 0.3.1.

Ottiene il contenuto del file di testo in una stringa.

Prototipo:

Argomenti:

  • filename: percorso e nome file

Valore restituito:

  • contenuto del file come stringa (deve essere liberata chiamando "free dopo l’uso)

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.5. Utilità

Alcune funzioni utili.

3.5.1. weechat_util_timeval_cmp

Confronta due strutture "timeval".

Prototipo:

Argomenti:

  • tv1: prima struttura "timeval"

  • tv2: seconda struttura "timeval"

Valore restituito:

  • -1 se tv1 < tv2

  • zero se tv1 == tv2

  • +1 se tv1 > tv2

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.5.2. weechat_util_timeval_diff

Updated in 1.1.

Return difference (in microseconds) between two "timeval" structures.

Prototipo:

Argomenti:

  • tv1: prima struttura "timeval"

  • tv2: seconda struttura "timeval"

Valore restituito:

  • difference in microseconds

Nota
With WeeChat ≤ 1.0, the returned value was in milliseconds.

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.5.3. weechat_util_timeval_add

Updated in 1.1.

Add interval (in microseconds) to a timeval structure.

Prototipo:

Argomenti:

  • tv: struttura timeval

  • interval: interval (in microseconds)

Nota
With WeeChat ≤ 1.0, the interval was expressed in milliseconds.

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.5.4. weechat_util_get_time_string

WeeChat ≥ 0.3.2.

Riceve data/ora come stringa compilata con "strftime".

Prototipo:

Argomenti:

  • date: puntatore alla data

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.5.5. weechat_util_version_number

WeeChat ≥ 0.3.9.

Convert a string with WeeChat version to a number.

Prototipo:

Argomenti:

  • version: WeeChat version as string (example: "0.3.9" or "0.3.9-dev")

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.6. Elenchi ordinati

Funzioni lista ordinata.

3.6.1. weechat_list_new

Crea una nuova lista.

Prototipo:

Valore restituito:

  • puntatore alla nuova lista

Esempio in C:

Script (Python):

3.6.2. weechat_list_add

Aggiunge un elemento in una lista.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • data: dati da inserire nella lista

  • where: posizione nella lista:

    • WEECHAT_LIST_POS_SORT: aggiunge alla lista, mantenendola ordinata

    • WEECHAT_LIST_POS_BEGINNING: aggiunge all’inizio della lista

    • WEECHAT_LIST_POS_END: aggiunge alla fine della lista

  • user_data: qualsiasi puntatore

Valore restituito:

  • puntatore al nuovo elemento

Esempio in C:

Script (Python):

Cerca un elemento nella lista.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • data: dati da cercare nella lista

Valore restituito:

  • puntatore all’elemento trovato, NULL se non trovato

Esempio in C:

Script (Python):

3.6.4. weechat_list_search_pos

WeeChat ≥ 0.3.4.

Cerca la posizione di un elemento nella lista.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • data: dati da cercare nella lista

Valore restituito:

  • posizione dell’elemento trovato, -1 se non trovato

Esempio in C:

Script (Python):

3.6.5. weechat_list_casesearch

Cerca un elemento nella lista, senza effettuare una ricerca esatta.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • data: dati da cercare nella lista

Valore restituito:

  • puntatore all’elemento trovato, NULL se non trovato

Esempio in C:

Script (Python):

3.6.6. weechat_list_casesearch_pos

WeeChat ≥ 0.3.4.

Cerca la posizione di un elemento in una lista, ricerca normale.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • data: dati da cercare nella lista

Valore restituito:

  • posizione dell’elemento trovato, -1 se non trovato

Esempio in C:

Script (Python):

3.6.7. weechat_list_get

Restituisce un elemento in una lista in base alla sua posizione.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • position: posizione nella lista (il primo elemento è 0)

Valore restituito:

  • puntatore all’elemento trovato, NULL se non trovato

Esempio in C:

Script (Python):

3.6.8. weechat_list_set

Imposta un nuovo valore per un elemento.

Prototipo:

Argomenti:

  • item: puntatore all’elemento

  • value: nuovo valore per l’elemento

Esempio in C:

Script (Python):

3.6.9. weechat_list_next

Restituisce l’elemento successivo nella lista.

Prototipo:

Argomenti:

  • item: puntatore all’elemento

Valore restituito:

  • puntatore all’elemento successivo, NULL se il puntatore è l’ultimo oggetto nella lista

Esempio in C:

Script (Python):

3.6.10. weechat_list_prev

Restituisce l’elemento precedente nella lista.

Prototipo:

Argomenti:

  • item: puntatore all’elemento

Valore restituito:

  • pointer to previous item, NULL if pointer was first item in list

Esempio in C:

Script (Python):

3.6.11. weechat_list_string

Restituisce il valore stringa di un elemento.

Prototipo:

Argomenti:

  • item: puntatore all’elemento

Valore restituito:

  • valore stringa di un elemento

Esempio in C:

Script (Python):

3.6.12. weechat_list_size

Restituisce la dimensione della lista (numero di elementi).

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

Valore restituito:

  • dimensione della lista (numero di elementi), 0 se la lista è vuota

Esempio in C:

Script (Python):

3.6.13. weechat_list_remove

Rimuove un elemento in una lista.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

  • item: puntatore all’elemento

Esempio in C:

Script (Python):

3.6.14. weechat_list_remove_all

Rimuove tutti gli elementi in una lista.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

Esempio in C:

Script (Python):

3.6.15. weechat_list_free

Libera una lista.

Prototipo:

Argomenti:

  • weelist: puntatore alla lista

Esempio in C:

Script (Python):

3.7. Tabelle hash

Funzioni per le tabelle hash.

3.7.1. weechat_hashtable_new

WeeChat ≥ 0.3.3.

Crea una nuova tabella hash.

Prototipo:

Argomenti:

  • size: dimensione dell’array interno per memorizzare le chiavi con hash, un valore più alto usa più memoria, ma ha migliori performance. (questo non è un limite per il numero di elementi nella tabella hash)

  • type_keys: tipo per le chiavi nella tabella hash:

    • WEECHAT_HASHTABLE_INTEGER

    • WEECHAT_HASHTABLE_STRING

    • WEECHAT_HASHTABLE_POINTER

    • WEECHAT_HASHTABLE_BUFFER

    • WEECHAT_HASHTABLE_TIME

  • type_values: tipo per i valori nella tabella hash:

    • WEECHAT_HASHTABLE_INTEGER

    • WEECHAT_HASHTABLE_STRING

    • WEECHAT_HASHTABLE_POINTER

    • WEECHAT_HASHTABLE_BUFFER

    • WEECHAT_HASHTABLE_TIME

  • callback_hash_key: callback used to "hash" a key (key as integer value), can be NULL if key type is not "buffer" (a default hash function is used), arguments and return value:

    • struct t_hashtable *hashtable: puntatore alla tabella hash

    • const void *key: chiave

    • return value: hash della chiave

  • callback_keycmp: callback used to compare two keys, can be NULL if key type is not "buffer" (a default comparison function is used), arguments and return value:

    • struct t_hashtable *hashtable: puntatore alla tabella hash

    • const void *key1: prima chiave

    • const void *key2: seconda chiave

    • valore restituito:

      • numero negativo se key1 è minore di key2

      • 0 se key1 è uguale a key2

      • numero positivo se key1 è maggiore di key2

Valore restituito:

  • puntatore alla nuova tabella hash, NULL in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.2. weechat_hashtable_set_with_size

WeeChat ≥ 0.3.3, updated in 0.4.2.

Aggiunge o aggiorna un elemento nella tabella hash con la dimensione per la chiave ed il valore.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • key: puntatore alla chiave

  • key_size: dimensione della chiave (in byte), usata solo se il tipo delle chiavi nella tabella hash è "buffer"

  • value: puntatore al valore

  • value_size: dimensione del valore (in byte), utilizzata solo se il tipo dei valori nella tabella è "buffer"

Valore restituito:

  • pointer to item created/updated, NULL if error

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.3. weechat_hashtable_set

WeeChat ≥ 0.3.3, updated in 0.4.2.

Aggiunge o aggiorna un elemento nella tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • key: puntatore alla chiave

  • value: puntatore al valore

Valore restituito:

  • pointer to item created/updated, NULL if error

Esempio in C:

3.7.4. weechat_hashtable_get

WeeChat ≥ 0.3.3.

Ottiene il valore associato ad una chiave in una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • key: puntatore alla chiave

Valore restituito:

  • valore per la chiave, NULL se non trovata

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.5. weechat_hashtable_has_key

WeeChat ≥ 0.3.4.

Check if a key is in the hashtable.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • key: puntatore alla chiave

Valore restituito:

  • 1 se la chiave si trova nella tabella hash, 0 in caso contrario

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.6. weechat_hashtable_map

WeeChat ≥ 0.3.3.

Chiama una funzione su tutte le voci della tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • callback_map: funzione chiamata per ogni voce nella tabella hash

  • callback_map_data: puntatore fornito alla mappa di callback quando chiamata

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.7. weechat_hashtable_map_string

WeeChat ≥ 0.3.7.

Chiama una funzione su tutte le voci della tabella hash, inviando chiavi e valori come stringhe.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • callback_map: funzione chiamata per ogni voce nella tabella hash

  • callback_map_data: puntatore fornito alla mappa di callback quando chiamata

Nota
Le stringhe key e value inviate alla callback sono temporanee, vengono eliminate dopo la chiamata alla callback.

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.8. weechat_hashtable_dup

WeeChat ≥ 1.0.

Duplicate a hashtable.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

Valore restituito:

  • duplicated hashtable

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.9. weechat_hashtable_get_integer

WeeChat ≥ 0.3.3.

Restituisce un valore intero per la proprietà di una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • property: nome della proprietà:

    • size: dimensione dell’array interno "htable" nella tabella hash

    • items_count: numero di elementi nella tabella hash

Valore restituito:

  • valore intero della proprietà

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.10. weechat_hashtable_get_string

WeeChat ≥ 0.3.4.

Restituisce il valore stringa della proprietà di una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • property: nome della proprietà:

    • type_keys: tipo per le chiavi:

      • integer: intero

      • string: stringa

      • pointer: puntatore

      • buffer: buffer

      • time: tempo

    • type_values: tipo per i valori:

      • integer: intero

      • string: stringa

      • pointer: puntatore

      • buffer: buffer

      • time: tempo

    • keys: stringa con la lista di chiavi (formato: "chiave1,chiave2,chiave3")

    • keys_sorted: stringa con l’elenco di chiavi ordinate (formato: "chiave1,chiave2,chiave3")

    • values: stringa con la lista di valori (formato: "valore1,valore2,valore3")

    • keys_values: stringa con la lista di valori e chiavi (formato: "chiave1:valore1,chiave2:valore2,chiave3:valore3")

    • keys_values_sorted: stringa con la lista di chiavi e valori (ordinata per chiavi) (formato: "chiave1:valore1,chiave2:valore2,chiave3:valore3")

Valore restituito:

  • valore stringa della proprietà

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.11. weechat_hashtable_set_pointer

WeeChat ≥ 0.3.4.

Imposta il valore puntatore della proprietà di una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • property: nome della proprietà:

    • callback_free_key: set callback function used to free keys in hashtable (WeeChat ≥ 0.4.2)

    • callback_free_value: imposta la funzione callback usata per liberare i valori nella tabella hash

  • pointer: new pointer value for property

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.12. weechat_hashtable_add_to_infolist

WeeChat ≥ 0.3.3.

Aggiunge elementi della tabella hash ad un elemento della lista info.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • infolist_item: puntatore all’elemento della lista info

  • prefix: stringa usata come prefisso per i nomi nella lista info

Valore restituito:

  • 1 se ok, 0 in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.13. weechat_hashtable_remove

WeeChat ≥ 0.3.3.

Rimuove un elemento in una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

  • key: puntatore alla chiave

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.14. weechat_hashtable_remove_all

WeeChat ≥ 0.3.3.

Rimuove tutti gli elementi in una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.7.15. weechat_hashtable_free

WeeChat ≥ 0.3.3.

Libera una tabella hash.

Prototipo:

Argomenti:

  • hashtable: puntatore alla tabella hash

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.8. File di configurazione

Funzioni per i file di configurazione.

3.8.1. weechat_config_new

Crea un nuovo file di configurazione.

Prototipo:

Argomenti:

  • name: nome del file di configurazione (senza percorso o estensione)

  • callback_reload: funzione chiamata quando il file di configurazione viene ricaricato con /reload (opzionale, può essere NULL), argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_file *config_file: puntatore al file di configurazione

    • valore restituito:

      • WEECHAT_CONFIG_READ_OK

      • WEECHAT_CONFIG_READ_MEMORY_ERROR

      • WEECHAT_CONFIG_READ_FILE_NOT_FOUND

  • callback_reload_data: puntatore fornito per ricaricare il callback quando richiesto da WeeChat

Valore restituito:

  • puntatore al nuovo file di configurazione, NULL in caso di errore

Nota
Il file NON viene creato su disco da questa funzione. Verrà creato chiamando la funzione weechat_config_write. Si dovrebbe chiamare questa funzione solo dopo aver aggiunto alcune sezioni (con weechat_config_new_section) e le opzioni (con weechat_config_new_option).

Esempio in C:

Script (Python):

3.8.2. weechat_config_new_section

Crea una nuova sezione nel file di configurazione.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • name: nome della sezione

  • user_can_add_options: 1 se l’utente può creare nuove opzioni nella sezione, oppure 0 se non gli è consentito

  • user_can_delete_options: 1 se l’utente può eliminare le opzioni nella sezione, oppure 0 se non gli è consentito

  • callback_read: funzione chiamata quando un’opzione nella sezione viene letta da disco (dovrebbe essere NULL in molti casi, tranne se l’opzione nella sezione necessita di una funzione personalizza), argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_file *config_file: puntatore al file di configurazione

    • struct t_config_section *section: puntatore alla sezione

    • const char *option_name: nome dell’opzione

    • const char *value: valore

    • valore restituito:

      • WEECHAT_CONFIG_READ_OK

      • WEECHAT_CONFIG_READ_MEMORY_ERROR

      • WEECHAT_CONFIG_READ_FILE_NOT_FOUND

  • callback_read_data: puntatore fornito alla callback quando chiamata da WeeChat

  • callback_write: funzione chiamata quando la sezione è scritta nel file (dovrebbe essere NULL in molti casi, tranne se la sezione necessita di una funzione personalizzata), argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_file *config_file: puntatore al file di configurazione

    • struct t_config_section *section: puntatore alla sezione

    • const char *option_name: nome dell’opzione

    • valore restituito:

      • WEECHAT_CONFIG_WRITE_OK

      • WEECHAT_CONFIG_WRITE_ERROR

      • WEECHAT_CONFIG_WRITE_MEMORY_ERROR

  • callback_write_data: puntatore fornito alla callback quando chiamata da WeeChat

  • callback_write_default: funzione chiamata quando i valori predefiniti per la sezione devono essere scritti in un file, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_file *config_file: puntatore al file di configurazione

    • const char *section_name: nome della sezione

    • valore restituito:

      • WEECHAT_CONFIG_WRITE_OK

      • WEECHAT_CONFIG_WRITE_ERROR

      • WEECHAT_CONFIG_WRITE_MEMORY_ERROR

  • callback_write_default_data: puntatore fornito alla callback quando chiamata da WeeChat

  • callback_create_option: funzione chiamata quando viene creata una nuova opzione nella sezione (NULL se la sezione non consente di creare nuove opzioni), argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_file *config_file: puntatore al file di configurazione

    • struct t_config_section *section: puntatore alla sezione

    • const char *option_name: nome dell’opzione

    • const char *value: valore

    • valore restituito:

      • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED

      • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE

      • WEECHAT_CONFIG_OPTION_SET_ERROR

      • WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND

  • callback_create_option_data: puntatore fornito alla callback quando chiamata da WeeChat

  • callback_delete_option: funzione chiamata quando un’opzione viene eliminata nella sezione (NULL se la sezione non consente di eliminare delle opzioni), argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_file *config_file: puntatore al file di configurazione

    • struct t_config_section *section: puntatore alla sezione

    • struct t_config_option *option: puntatore all’opzione

    • valore restituito:

      • WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET

      • WEECHAT_CONFIG_OPTION_UNSET_OK_RESET

      • WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED

      • WEECHAT_CONFIG_OPTION_UNSET_ERROR

  • callback_delete_option_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore alla nuova sezione nel file di configurazione, NULL in caso di errore

Esempio in C:

Script (Python):

3.8.3. weechat_config_search_section

Cerca una sezione in un file di configurazione.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • section_name: nome della sezione da cercare

Valore restituito:

  • puntatore alla sezione trovata, NULL se non trovata

Esempio in C:

Script (Python):

3.8.4. weechat_config_new_option

Crea una nuova opzione nella sezione di un file di configurazione.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • section: puntatore alla sezione

  • name: nome dell’opzione

  • type: tipo dell’opzione:

    • boolean: valore booleano (on/off)

    • integer: valore intero (con stringhe opzionali per i valori)

    • string: valore stringa

    • color: colore

  • description: descrizione dell’opzione

  • string_values: valori come stringa (separati da "|"), usato dal tipo integer (opzionale)

  • min: valore minimo (per il tipo integer)

  • max: valore massimo (per il tipo integer)

  • default_value: valore predefinito per l’opzione (usato per il reset dell’opzione)

  • value: valore per l’opzione

  • null_value_allowed: 1 se null (valore non definito) è consentito per l’opzione, altrimenti 0

  • callback_check_value: funzione chiamata per verificare il nuovo valore per l’opzione (ozionale), argomenti e valore restituito:

    • void *data: puntatore

    • struct t_config_option *option: puntatore all’opzione

    • const char *value: nuovo valore per l’opzione

    • valore restituito:

      • 1 se il valore è corretto

      • 0 se il valore non è valido

  • callback_check_value_data: puntatore fornito alla callback check_value quando chiamata da WeeChat

  • callback_change: funzione chiamata quando il valore dell’opzione è stata cambiata (opzionale), argomenti:

    • void *data: puntatore

    • struct t_config_option *option: puntatore all’opzione

  • callback_change_data: puntatore fornito per cambiare alla callback quando chiamato da WeeChat

  • callback_delete: funzione chiamata quando l’opzione verrà eliminata (opzionale), argomenti:

    • void *data: puntatore

    • struct t_config_option *option: puntatore all’opzione

  • callback_delete_data: puntatore fornito per eiliminare alla callback quando chiamato da WeeChat

Valore restituito:

alla nuova opzione nella sezione, NULL in caso di errore

Esempio in C:

Script (Python):

Nota
In Ruby, the 3 callbacks + data (6 strings) must be given in an array of 6 strings (due to a Ruby limitation of 15 arguments by function), see the WeeChat Scripting Guide for more info (fixed in version 0.4.1).

3.8.5. weechat_config_search_option

Cerca un’opzione nella sezione di un file di configurazione.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • section: puntatore alla sezione

  • name: nome dell’opzione da cercare

Valore restituito:

  • puntatore all’opzione trovata, NULL se non trovata

Esempio in C:

Script (Python):

3.8.6. weechat_config_search_section_option

Cerca una sezione ed un’opzione in un file di configurazione o sezione.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • section: puntatore alla sezione

  • option_name: nome dell’opzione

  • section_found: puntatore al puntatore della sezione, sarà impostato alla sezione dell’opzione, se viene trovata

  • option_found: puntatore al puntatore dell’opzione, sarà impostato al puntatore di un’opzione, se viene trovata

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.8.7. weechat_config_search_with_string

Get file/section/option info about an option with full name.

Prototipo:

Argomenti:

  • option_name: nome completo dell’opzione (formato: "file.section.option")

  • config_file: puntatore al puntatore del file di configurazione, sarà impostato al puntatore al file di configurazione se l’opzione viene trovata

  • section: puntatore al puntatore della sezione, sarà impostato alla sezione dell’opzione, se viene trovata

  • option: puntatore al puntatore dell’opzione, sarà impostato al puntatore di un’opzione, se viene trovata

  • pos_option_name: pointer to a string pointer, will be set to pointer to name of option, if found

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.8.8. weechat_config_string_to_boolean

Verifica se un testo è "vero" o "falso", come valore booleano.

Prototipo:

Argomenti:

  • text: testo da analizzare

Valore restituito:

  • 1 se il testo è "true" ("on", "yes", "y", "true", "t", "1")

  • 0 se il testo è "false" ("off", "no", "n", "false", "f", "0")

Esempio in C:

Script (Python):

3.8.9. weechat_config_option_reset

Resetta un’opzione al proprio valore predefinito.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

  • run_callback: 1 per la chiamata alla callbackse il valore dell’opzione è cambiato, altrimenti 0

Valore restituito:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED se il valore dell’opzione è stato resettato

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE se il valore non è stato modificato

  • WEECHAT_CONFIG_OPTION_SET_ERROR in caso di errore

Esempio in C:

Script (Python):

3.8.10. weechat_config_option_set

Imposta un nuovo valore per l’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

  • value: nuovo valore per l’opzione

  • run_callback: 1 per la chiamata alla callback chang se il valore dell’opzione è cambiato, altrimenti 0

Valore restituito:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED se il valore dell’opzione è cambiato

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE se il valore non è cambiato

  • WEECHAT_CONFIG_OPTION_SET_ERROR in caso di errore

Esempio in C:

Script (Python):

3.8.11. weechat_config_option_set_null

Imposta null (valore non definito) per un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

  • run_callback: 1 per la chiamata alla callback chang se il valore dell’opzione è cambiato (se non è null), altrimenti 0

Nota
È possibile impostare il valore a null solo se è consentito per l’opzione (consultare weechat_config_new_option).

Valore restituito:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED se il valore dell’opzione è cambiato

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE se il valore non è cambiato

  • WEECHAT_CONFIG_OPTION_SET_ERROR in caso di errore

Esempio in C:

Script (Python):

3.8.12. weechat_config_option_unset

Rimuove/ripristina un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET se il valore dell’opzione non è stato ripristinato

  • WEECHAT_CONFIG_OPTION_UNSET_OK_RESET se il valore dell’opzione è stato ripristinato

  • WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED se l’opzione è stata rimossa

  • WEECHAT_CONFIG_OPTION_UNSET_ERROR in caso di errore

Esempio in C:

Script (Python):

3.8.13. weechat_config_option_rename

Rinomina un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

  • new_name: nuovo nome per l’opzione

Esempio in C:

Script (Python):

3.8.14. weechat_config_option_get_pointer

Restituisce un puntatore alla proprietà di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

  • property: nome della proprietà:

    • config_file: puntatore al file di configurazione (struct t_config_file *)

    • section: puntatore alla sezione (struct t_config_section *)

    • name: nome dell’opzione (char *)

    • type: tipo dell’opzione (int *)

    • description: descrizione dell’opzione (char *)

    • string_values: valori stringa (char *)

    • min: valore minimo (int *)

    • max: valore massimo (int *)

    • default_value: valore predefinito (dipende dal tipo)

    • value: valore corrente (dipende dal tipo)

    • prev_option: puntatore all’opzione precedente (struct t_config_option *)

    • next_option: puntatore all’opzione successiva (struct t_config_option *)

Valore restituito:

  • puntatore alla proprietà richiesta

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.8.15. weechat_config_option_is_null

Verifica se un opzione è "null" (valore non definito).

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • 1 se il valore dell’opzione è "null"

  • 0 se il valore dell’opzione non è "null"

Esempio in C:

Script (Python):

3.8.16. weechat_config_option_default_is_null

Verifica che il valore predefinito di un’opzione sia "null" (valore non definito).

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • 1 se il valore predefinito di un’opzione è "null"

  • 0 se il valore predefinito di un’opzione non è "null"

Esempio in C:

Script (Python):

3.8.17. weechat_config_boolean

Restituisce il valore bool di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore bool di un’opzione (0 o 1)

Esempio in C:

Script (Python):

3.8.18. weechat_config_boolean_default

Restituisce il valore bool predefinito di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • il valore bool predefinito di un’opzione (0 o 1)

Esempio in C:

Script (Python):

3.8.19. weechat_config_integer

Restituisce il valore intero di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore intero di un’opzione

Esempio in C:

Script (Python):

3.8.20. weechat_config_integer_default

Restituisce il valore intero predefinito di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore intero predefinito di un’opzione

Esempio in C:

Script (Python):

3.8.21. weechat_config_string

Restituisce il valore stringa di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore stringa di un’opzione

Esempio in C:

Script (Python):

3.8.22. weechat_config_string_default

Restituisce il valore stringa predefinito di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore stringa predefinito di un’opzione

Esempio in C:

Script (Python):

3.8.23. weechat_config_color

Restituisce il valore colore di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore colore dell’opzione (stringa con il nome del colore)

Esempio in C:

Script (Python):

3.8.24. weechat_config_color_default

Restituisce il valore colore predefinito di un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Valore restituito:

  • valore colore predefinito di un’opzione (stringa con il nome del colore)

Esempio in C:

Script (Python):

3.8.25. weechat_config_write_option

Scrive una riga nel file di configurazione con l’opzione ed il suo valore (questa funzione dovrebbe essere chiamata solo nelle callback "write" o "write_default" per una sezione).

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • option: puntatore all’opzione

Esempio in C:

Script (Python):

3.8.26. weechat_config_write_line

Scrive una riga nel file di configurazione (questa funzione dovrebbe essere chiamata solo nelle callback "write" o "write_default" per una sezione).

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

  • option_name: nome dell’opzione

  • value: valore (se NULL, allora la riga con il nome della sezione viene scritto, ad esempio: "[section]")

Esempio in C:

Script (Python):

3.8.27. weechat_config_write

Scrive il file di configurazione su disco.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

Valore restituito:

  • WEECHAT_CONFIG_WRITE_OK se la configurazione è stata scritta

  • WEECHAT_CONFIG_WRITE_MEMORY_ERROR se non c'è memoria sufficiente

  • WEECHAT_CONFIG_WRITE_ERROR se si è verificato un altro errore

Esempio in C:

Script (Python):

3.8.28. weechat_config_read

Legge il file di configurazione da disco.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

Valore restituito:

  • WEECHAT_CONFIG_READ_OK se la configurazione è stata caricata

  • WEECHAT_CONFIG_READ_MEMORY_ERROR se non c'è memoria sufficiente

  • WEECHAT_CONFIG_READ_FILE_NOT_FOUND se il file non è stato trovato

Esempio in C:

Script (Python):

3.8.29. weechat_config_reload

Ricarica il file di configurazione da disco.

Prototipo:

Argomenti:

  • config_file: configuration file pointer

Valore restituito:

  • WEECHAT_CONFIG_READ_OK se il file di configurazione è stato ricaricato

  • WEECHAT_CONFIG_READ_MEMORY_ERROR se non c'è memoria sufficiente

  • WEECHAT_CONFIG_READ_FILE_NOT_FOUND se il file non è stato trovato

Esempio in C:

Script (Python):

3.8.30. weechat_config_option_free

Libera un’opzione.

Prototipo:

Argomenti:

  • option: puntatore all’opzione

Esempio in C:

Script (Python):

3.8.31. weechat_config_section_free_options

Libera tutte le opzioni in una sessione.

Prototipo:

Argomenti:

  • section: puntatore alla sezione

Esempio in C:

Script (Python):

3.8.32. weechat_config_section_free

Libera una sezione.

Prototipo:

Argomenti:

  • section: puntatore alla sezione

Esempio in C:

Script (Python):

3.8.33. weechat_config_free

Libera un file di configurazione.

Prototipo:

Argomenti:

  • config_file: puntatore al file di configurazione

Esempio in C:

Script (Python):

3.8.34. weechat_config_get

Cerca un’opzione con il nome completo.

Prototipo:

Argomenti:

  • option_name: nome completo dell’opzione (formato: "file.section.option")

Valore restituito:

  • puntatore all’opzione trovata, NULL se non trovata

Esempio in C:

Script (Python):

3.8.35. weechat_config_get_plugin

Cerca un’opzione nei file di configurazione dei plugin (plugins.conf).

Prototipo:

Argomenti:

  • option_name: nome dell’opzione, WeeChat aggiungerà il prefisso "plugins.var.xxx." (dove "xxx" è il nome del plugin corrente)

Valore restituito:

  • valore dell’opzione trovata, NULL se non trovata

Esempio in C:

Script (Python):

3.8.36. weechat_config_is_set_plugin

Verifica se un’opzione è impostata nel file di configurazione dei plugin (plugins.conf).

Prototipo:

Argomenti:

  • option_name: nome dell’opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." (dove "xxx" è il nome del plugin corrente)

Valore restituito:

  • 1 se l’opzione è impostata, 0 se l’opzione non esiste

Esempio in C:

Script (Python):

3.8.37. weechat_config_set_plugin

Imposta il nuovo valore per l’opzione nel file di configurazione dei plugin (plugins.conf).

Prototipo:

Argomenti:

  • option_name: nome dell’opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." (dove "xxx" è il nome del plugin corrente)

  • value: new value for option

Valore restituito:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED se il valore dell’opzione è stato modificato

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE se il valore non è cambiato

  • WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND se l’opzione non è stata trovata

  • WEECHAT_CONFIG_OPTION_SET_ERROR in caso di errore

Esempio in C:

Script (Python):

3.8.38. weechat_config_set_desc_plugin

WeeChat ≥ 0.3.5.

Imposta la descrizione per l’opzione nel file di configurazione dei plugin (plugins.conf).

Prototipo:

Argomenti:

  • option_name: nome dell’opzione, WeeChat aggiungerà il prefisso "plugins.desc.xxx." (dove "xxx" è il nome del plugin corrente)

  • description: descrizione per l’opzione

Nota
Non è un problema se l’opzione (plugins.var.xx.option_name) non esiste. Una futura creazione dell’opzione con questo nome userà questa descrizione.

Esempio in C:

Script (Python):

3.8.39. weechat_config_unset_plugin

Disattiva l’opzione nel file di configurazione dei plugin (plugins.conf).

Prototipo:

Argomenti:

  • option_name: nome dell’opzione, WeeChat aggiunge il prefisso "plugins.var.xxx." (dove xxx è il nome del plugin corrente)

Valore restituito:

  • WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET se il valore dell’opzione non è stato resettato

  • WEECHAT_CONFIG_OPTION_UNSET_OK_RESET se il valore dell’opzione è stato resettato

  • WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED se l’opzione è stata rimossa

  • WEECHAT_CONFIG_OPTION_UNSET_ERROR in caso di errore

Esempio in C:

Script (Python):

3.9. Combinazione tasti

Funzioni per le combinazioni dei tasti.

3.9.1. weechat_key_bind

WeeChat ≥ 0.3.6.

Aggiunge una nuova combinazione tasto.

Nota
A differenza del comando /key bind, questa funzione non cambia mai una combinazione tasti esistente, ma ne vengono create di nuove. Per rimuovere una combinazione tasti, usare weechat_key_unbind.

Prototipo:

Argomenti:

  • context: contesto per i tasti:

    • default: contesto default (azioni comuni)

    • search: contesto search (quando si cerca testo nel buffer)

    • cursor: movimento libero del cursore sullo schermo

    • mouse: tasti per gli eventi del mouse

  • keys: tabella hash con le combinazioni dei tasti

Valore restituito:

  • numero delle combinazioni tasti aggiunte

Esempio in C:

Script (Python):

3.9.2. weechat_key_unbind

WeeChat ≥ 0.3.6.

Rimuove una o più associazioni tasti.

Avvertenza
Alla chiamata di questa funzione, assicurarsi che non venga rimossa una combinazione tasti definita dall’utente.

Prototipo:

Argomenti:

  • context: contesto per i tasti (consultare weechat_key_bind)

  • key: tasto da rimuovere o un valore speciale "area:XXX" per rimuovere tutti i tasti che hanno XXX come prima o seconda area

Valore restituito:

  • numero di combinazioni tasti rimosse

Esempio in C:

Script (Python):

3.10. Visualizzazione

Funzioni per visualizzare il testo nei buffer.

3.10.1. weechat_prefix

Restituisce un prefisso.

Prototipo:

Argomenti:

  • prefix: nome del prefisso, see table below

Valore restituito:

  • valore del prefisso (stringa con prefisso e codici colori), stringa vuota se il prefisso non è stato trovato

List of prefixes:

Prefisso Valore Colore Descrizione

error

=!=

giallo

Messaggio di errore

network

--

magenta

Messaggio dalla rete

action

*

bianco

Azione automatica

join

-->

verde chiaro

Qualcuno entra nella chat corrente

quit

<--

rosso chiaro

Qualcuno lascia la chat corrente

Nota
Valori e colori possono essere personalizzati con il comando /set.

Esempio in C:

Script (Python):

3.10.2. weechat_color

Restituisce una codice colore stringa da visualizzare.

Prototipo:

Argomenti:

  • color_name: nome del colore, uno di:

    • nome opzione di WeeChat (da weechat.color.xxx), ad esempio chat_delimiters

    • colore con attributi/sfondo opzionali (vedi sotto)

    • attributo:

      • bold: imposta grassetto

      • -bold: rimuove grassetto

      • reverse: imposta inverso

      • -reverse: rimuove inverso

      • italic: imposta corsivo

      • -italic: rimuove corsivo

      • underline: imposta sottolineato

      • -underline: rimuove sottolineato

      • emphasis: toggle the emphasis for text (note: this should be used only in bars, because WeeChat uses text emphasis when searching text in buffer) (WeeChat ≥ 0.4.2)

    • nome colore della barra:

      • bar_fg: colore di primo piano della barra

      • bar_delim: colore dei delimitatori della barra

      • bar_bg: colore di sfondo della barra

    • reset:

      • reset: ripristina colore ed attributi

      • resetcolor: ripristina colore (mantiene attributi) (WeeChat ≥ 0.3.6)

Il formato del colore è: attributi (opzionale) + nome colore +",sfondo" (opzionale). Gli attributi possibili sono:

  • * : testo in grassetto

  • ! : video inverso

  • / : corsivo

  • _ : testo sottolineato

  • | : mantiene attributi: non ripristina grassetto/inverso/corsivo/sottolineato al cambio di colore (WeeChat ≥ 0.3.6)

Esempi:

  • yellow : giallo

  • _green : verde sottolineato

  • *214 : arancione grassetto

  • yellow,red : giallo su rosso

  • |cyan : ciano (e mantiene qualsiasi attributo impostato in precedenza)

Valore restituito:

  • stringa con il codice colore, o una stringa vuota se non trovata

Esempio in C:

Script (Python):

3.10.3. weechat_printf

Visualizza un messaggio su un buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat

  • message: messaggio da visualizzare

Nota
La prima tabulazione nel messaggio ("\t") è usata per separare il prefisso dal messaggio.
Se il proprio messaggio ha alcune tabulazioni e non si vuole il prefisso, allora bisogna utilizzare uno spazio, una tabulazione, poi il messaggio (consultare l’esempio successivo): ciò disabilita il prefisso (lo spazio prima della tabulazione non verrà mostrato).
Nota
With two tabs ("\t") at beginning of message, time will not be displayed and message will have no alignment at all. Moreover, the date in message will be set to 0.

Esempio in C:

Script (Python):

Nota
La funzione è chiamata "print" negli script ("prnt" in Python).

3.10.4. weechat_printf_date

Visualizza un messaggio sul buffer, utilizzando una data personalizzata.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer, se NULL, il messaggio viene visualizzato sul buffer di WeeChat

  • date: data per il messaggio (0 indica data/ora corrente)

  • message: messaggio da visualizzare

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.10.5. weechat_printf_tags

Visualizza un messaggio sul buffer, utilizzando tag personalizzati.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat

  • tags: lista di tag separati da virgole

  • message: messaggio da visualizzare

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.10.6. weechat_printf_date_tags

Visualizza un messaggio sul buffer, usando tag e data personalizzati.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer, se NULL il messaggio viene visualizzato sul buffer di WeeChat

  • date: data per il messaggio (0 indica data/ora corrente)

  • tags: lista di tag separati da virgole

  • message: messaggio da visualizzare

Tag usati di frequente (elenco non esaustivo):

Tag Descrizione

no_filter

La riga non può essere filtrata

no_highlight

Evidenziazione non possibile sulla riga

no_log

La riga non viene scritta nel file di log

log0 … log9

Livello di log per la riga (consultare /help logger)

notify_none

Il buffer con la riga non viene aggiunto alla hotlist

notify_message

Il buffer con la riga viene aggiunto alla hotlist con il livello "message"

notify_private

Il buffer con la riga viene aggiunto alla hotlist con il livello "private"

notify_highlight

Il buffer con la riga viene aggiunto alla hotlist con il livello "higlight"

nick_xxx

Il messaggio viene dal nick "xxx"

prefix_nick_ccc

Il prefisso è un nick con il colore "ccc"

host_xxx

Username and host in message

irc_xxx

Messaggio IRC "xxx" (può essere un comando o un numero di 3 cifre)

irc_numeric

Messaggio IRC numerico

irc_error

Errore dal server IRC

irc_action

Azione da un nic (comando /me)

irc_ctcp

Messaggio CTCP

irc_ctcp_reply

Risposta ad un messaggio CTCP

irc_smart_filter

Messaggio IRC filtrabile tramite lo "smart filter" (filtro intelligente)

away_info

Messagio con informazioni sull’assenza

Esempio in C:

Script (Python):

Nota
La funzione è chiamata "print_date_tags" negli script ("prnt_date_tags" in Python).

3.10.7. weechat_printf_y

Visualizza un messaggio sulla riga di un buffer con contenuto libero.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • y: numero di riga (la prima riga è 0); a negative value adds a line after last line displayed: absolute value of y is the number of lines after last line (for example -1 is immediately after last line, -2 is 2 lines after last line) (WeeChat ≥ 1.0)

  • message: messaggio da visualizzare

Esempio in C:

Script (Python):

Nota
La funzione è chiamata "print_y" negli script ("prnt_y in Python).

3.10.8. weechat_log_printf

Scrive un messaggio nel file di log di WeeChat (weechat.log).

Prototipo:

Argomenti:

  • message: messaggio da scrivere

Esempio in C:

Script (Python):

Nota
La funzione è chiamata "log_print" negli script.

3.11. Hook

Priorità degli hook

WeeChat ≥ 0.3.4.

In alcuni hook è possibile impostare una priorità. Un hook con priorità maggiore si trova all’inizio della lista, in modo da poter essere eseguita prima di altri. Può risultare utile per i modificatori, data l’importanza nell’ordine di esecuzione.

Per impostare la priorità, è necessario usare questa sintassi per gli argomenti dove è consentita la priorità: "nnn|nome" dove "nnn" è un intero non negativo con la priorità e "nome" è il nome per l’argomenti (la priorità non compare nel nome, viene rimossa automaticamente dalla stringa).

La priorità predefinita è 1000.

Esempio in C:

I tipi di hook che seguono consentono la priorità: command, command_run, signal, hsignal, config, completion, modifier, info, info_hashtable, infolist, hdata, focus.

3.11.1. weechat_hook_command

Hook su un comando.

Prototipo:

Argomenti:

  • command: nome del comando (priorità consentita, consultare la nota riguardo la priority)

  • description: descrizione per il comando (visualizzata con /help comando)

  • args: argomenti per il comando (visualizzati con /help command)

  • args_description: descrizione degli argomenti (visualizzata con /help command)

  • completion: modello di completamento per il comando:: elenco di completamenti per ogni argomento, separati da spazio. Sono possibili più completamenti sono possibili per un singolo argomento, separati da "|". Più modelli sono possibili per lo stesso comando, separati da "||".

  • callback: funzione chiamata quando viene utilizzato il comando, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_gui_buffer *buffer: buffer quando il comando viene eseguito

    • int argc: numero di argomenti forniti per un comando

    • char **argv: argomenti forniti per un comando

    • char **argv_eol: argomenti forniti per un comando (fino a fine riga per ogni argomento)

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito dalla callback quando chiamata da WeeChat

I codici predefiniti per il completamento sono:

Plugin Nome Descrizione

alias

alias

elenco di alias

alias

alias_value

valore dell’alias

aspell

aspell_dicts

elenco dei dizionari aspell installati

aspell

aspell_langs

elenco di tutte lingue supportate da aspell

exec

exec_commands_ids

ids (numbers and names) of executed commands

guile

guile_script

elenco degli script

irc

irc_channel

canale IRC corrente

irc

irc_channel_nicks_hosts

nick e host del canale IRC corrente

irc

irc_channel_topic

argomento del canale IRC attivo

irc

irc_channels

canali su tutti i server IRC

irc

irc_ignores_numbers

numero di ignore definiti

irc

irc_msg_kick

default kick message

irc

irc_msg_part

messaggio di uscita predefinito per il canale IRC

irc

irc_notify_nicks

nick nella lista notifiche

irc

irc_privates

privati su tutti i server IRC

irc

irc_server

server IRC corrente

irc

irc_server_channels

canali sul server IRC corrente

irc

irc_server_nick

nick sul server IRC corrente

irc

irc_server_nicks

nick su tutti i canali del server IRC corrente

irc

irc_server_privates

privati sul server IRC corrente

irc

irc_servers

server IRC (nomi interni)

irc

nick

nick del canale IRC corrente

lua

lua_script

elenco degli script

perl

perl_script

elenco degli script

python

python_script

elenco degli script

relay

relay_free_port

prima porta libera per il plugin relay

relay

relay_protocol_name

protocollo.nome possibile per il plugin relay

relay

relay_relays

protocollo.nome dei relay correnti per il plugin relay

ruby

ruby_script

elenco degli script

script

script_files

file nella directory degli script

script

script_scripts

elenco degli script nel repository

script

script_scripts_installed

elenco degli script installati (dal repository)

script

script_tags

tag degli script nel repository

tcl

tcl_script

elenco degli script

trigger

trigger_hook_arguments

default arguments for a hook

trigger

trigger_hook_command

default command for a hook

trigger

trigger_hook_conditions

default conditions for a hook

trigger

trigger_hook_rc

default return codes for hook callback

trigger

trigger_hook_regex

default regular expression for a hook

trigger

trigger_hooks

hooks for triggers

trigger

trigger_hooks_filter

hooks for triggers (for filter in monitor buffer)

trigger

trigger_names

triggers

trigger

trigger_names_default

default triggers

trigger

trigger_option_value

value of a trigger option

trigger

trigger_options

options for triggers

weechat

bars_names

nomi delle barre

weechat

bars_options

opzioni per le barre

weechat

buffer_properties_get

proprietà che possono essere lette su un buffer

weechat

buffer_properties_set

proprietà che possono essere impostate su un buffer

weechat

buffers_names

nomi dei buffer

weechat

buffers_numbers

numeri dei buffer

weechat

buffers_plugins_names

nomi dei buffer (inclusi i nomi dei plugin)

weechat

commands

comandi (weechat e plugin)

weechat

config_files

file di configurazione

weechat

config_option_values

valori per una opzione di configurazione

weechat

config_options

opzioni di configurazione

weechat

cursor_areas

aree ("chat" o nome barra) per il movimento libero del cursore

weechat

env_value

value of an environment variable

weechat

env_vars

environment variables

weechat

filename

nome file

weechat

filters_names

nomi dei filtri

weechat

infolists

nomi degli hook liste info

weechat

infos

nomi degli hook sulle info

weechat

keys_codes

codici tasto

weechat

keys_codes_for_reset

codici tasti che possono essere ripristinati (tasti aggiunti, ridefiniti o rimossi)

weechat

keys_contexts

contesti del tasto

weechat

layouts_names

nomi dei layout

weechat

nicks

nick nella lista nick del buffer corrente

weechat

palette_colors

Tavolozza dei colori

weechat

plugins_commands

comandi definiti dai plugin

weechat

plugins_installed

names of plugins installed

weechat

plugins_names

nomi dei plugin

weechat

proxies_names

nomi dei proxy

weechat

proxies_options

opzioni per i proxy

weechat

secured_data

names of secured data (file sec.conf, section data)

weechat

weechat_commands

comandi di weechat

weechat

windows_numbers

numeri delle finestre

xfer

nick

nick della chat DCC

Codici speciali:

  • %%command: riutilizza il modello di completamento dal comando command

  • %-: ferma completamento

  • %*: ripete l’ultimo completamento

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Ad esempio, se il comando chiamato è /comando abc def ghi, allora argv e argv_eol contengono i seguenti valori:

  • argv:

    • argv[0] == "/command"

    • argv[1] == "abc"

    • argv[2] == "def"

    • argv[3] == "ghi"

  • argv_eol:

    • argv_eol[0] == "/command abc def ghi"

    • argv_eol[1] == "abc def ghi"

    • argv_eol[2] == "def ghi"

    • argv_eol[3] == "ghi"

Per gli script, args ha valore "abc def ghi".

Script (Python):

3.11.2. weechat_hook_command_run

Hook su un comando quando eseguito da WeeChat.

Prototipo:

Argomenti:

  • command: comando su cui eseguire l’hook (wildcard "*" is allowed) (priorità consentita, consultare la nota riguardo la priority)

  • callback: funzione chiamata quando il comando è in esecuzione, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_gui_buffer *buffer: buffer dove viene eseguito il comando

    • const char *command: il comando eseguito, con i propri argomenti

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_OK_EAT

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Nota
La callback può restituire WEECHAT_RC_OK o WEECHAT_RC_OK_EAT (il comando non verrà eseguito da WeeChat dopo la callback).

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.3. weechat_hook_timer

Hook sul timer.

Prototipo:

Argomenti:

  • interval: intervallo tra due chiamate (millisecondi, 1000 = 1 secondo)

  • align_second: allineamento su un secondo. Per esempio, rrent time is 09:00, if interval = 60000 (60 seconds), and align_second = 60, then timer is called each minute when second is 0

  • max_calls: number of calls to timer (if 0, then timer has no end)

  • callback: function called when time is reached, argomenti e valore restituito:

    • void *data: pointer

    • int remaining_calls: remaining calls (-1 if timer has no end)

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: pointer given to callback when it is called by WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.4. weechat_hook_fd

Hook su un descrittore file (file oppure socket).

Prototipo:

Argomenti:

  • fd: descrittore file

  • flag_read: 1 = cattura l’evento lettura (read), 0 = ignora

  • flag_write: 1 = cattura l’evento scrittura (write), 0 = ignora

  • flag_exception: 1 = cattura l’eccezione evento (event), 0 = ignora

  • callback: funzione che chiama un evento selezionato che si verifica per un file (o un socket), argomenti e valore restituito:

    • void *data: puntatore

    • int fd: descrittore file

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla calback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.5. weechat_hook_process

Hook su un processo (lanciato con un fork), e cattura l’output.

Nota
Since version 0.3.9.2, the shell is not used any more to execute the command. WeeChat makes an automatic split of command and arguments (like the shell does). If the split is not correct (according to quotes in your command), or if you want to use shell, you can use function weechat_hook_process_hashtable with arguments in the hashtable options (WeeChat ≥ 0.4.0).

Prototipo:

Argomenti:

  • command: comando da avviare nel processo figlio o URL (WeeChat ≥ 0.3.7), segue:

  • timeout: timeout per il comando (in millisecondi): dopo questo timeout, il processo figlio viene terminato (0 indica nessun timeout)

  • callback: funzione chiamata quando i dati dal processo figlio sono disponibili, oppure quando è terminato, argomenti e valore restituito:

    • void *data: puntatore

    • const char *command: comando eseguito dal processo figlio

    • int return_code: codice restituito:

      • >= 0: codice ritorno figlio per un comando, e per un URL i valori possibili sono:

        • 0: trasferimento riuscito

        • 1: URL non valido

        • 2: errore di trasferimento

        • 3: memoria non sufficiente

        • 4: errore con un file

      • < 0: WEECHAT_HOOK_PROCESS_RUNNING (dati disponibili, ma figlio ancora in esecuzione) o WEECHAT_HOOK_PROCESS_ERROR (errore nella esecuzione del comando)

    • out: output standard del comando (stdout)

    • err: output di errore del comando (stderr)

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Quando il comando ha terminato, o se viene raggiunto il timeout, WeeChat effettua automaticamente l’unhook (e termina il processo se ancora in esecuzione).

Il comando può essere un URL con il formato: "url:http://www.esempio.com", per scaricare il contenuto dell’URL (WeeChat ≥ 0.3.7). Le opzioni per un URL sono disponibili con la funzione weechat_hook_process_hashtable.

Suggerimento
If you want to retrieve infos about WeeChat (like current stable version, latest git commit, …), you can use URLs on page https://weechat.org/dev/info
Nota
La dimensione del buffer per l’invio dei dati alla callback è di 64KB (ci sono 2 buffer: uno per stdout ed uno per stderr). Se l’output che viene da un processo figlio (stdout o stderr) è più lungo di 64KB, la callback verrà chiamata più di una volta.
Importante
Anche se la maggior parte delle volte la callback viene chiamata una sola volta, ci si deve assicurare che più chiamate alla callback siano corrette nel codice: bisogna concatenare i dati forniti da più chiamate ed utilizzarli quando il codice restituito è non-negativo.

Esempio in C:

Script (Python):

3.11.6. weechat_hook_process_hashtable

WeeChat ≥ 0.3.7.

Hook su un processo (avviato con un fork) usando le opzioni nella tabella hash, e cattura dell’output.

Prototipo:

Gli argomenti sono gli stessi della funzione weechat_hook_process, con un argomento aggiuntivo:

  • options: le opzioni per il comando eseguito; la tabella hash è duplicata nella funzione, per cui è possibile liberarla dopo questa chiamata

For a standard command (not beginning with "url:"), following options are available:

Option Value Description

argN (N ≥ 1)
(WeeChat ≥ 0.4.0)

any string

Arguments for command; if no argument is given with these options, the command is automatically split like the shell does (and then command arguments are read in the command argument)

stdin
(WeeChat ≥ 0.4.3)

(not used)

Create a pipe for writing data on standard input (stdin) of child process (see function weechat_hook_set)

buffer_flush
(WeeChat ≥ 1.0)

number of bytes

Minimum number of bytes to flush stdout/stderr (to send output to callback), between 1 and 65536 (default); 1 = send any output immediately to the callback

detached
(WeeChat ≥ 1.0)

(not used)

Run the process in a detached mode: stdout and stderr are redirected to /dev/null

Per il comando "url:…" sono disponibili le seguenti opzioni (consultare man curl_easy_setopt per la descrizione di ogni opzione):

Opzione Tipo Costanti (1)

verbose

long

header

long

noprogress

long

nosignal

long

wildcardmatch

long

failonerror

long

proxy

string

proxyport

long

port

long

httpproxytunnel

long

interface

string

dns_cache_timeout

long

proxytype

long

http, socks4, socks5, socks4a, socks5_hostname, http_1_0

buffersize

long

tcp_nodelay

long

localport

long

localportrange

long

address_scope

long

protocols

mask

http, https, ftp, ftps, scp, sftp, telnet, ldap, ldaps, dict, file, tftp, all, imap, imaps, pop3, pop3s, smtp, smtps, rtsp, rtmp, rtmpt, rtmpe, rtmpte, rtmps, rtmpts, gopher

redir_protocols

mask

http, https, ftp, ftps, scp, sftp, telnet, ldap, ldaps, dict, file, tftp, all, imap, imaps, pop3, pop3s, smtp, smtps, rtsp, rtmp, rtmpt, rtmpe, rtmpte, rtmps, rtmpts, gopher

noproxy

string

socks5_gssapi_service

string

socks5_gssapi_nec

long

tcp_keepalive

long

tcp_keepidle

long

tcp_keepintvl

long

netrc

long

ignored, optional, required

userpwd

string

proxyuserpwd

string

httpauth

mask

none, basic, digest, gssnegotiate, ntlm, any, anysafe, digest_ie, only, ntlm_wb, negotiate

proxyauth

mask

none, basic, digest, gssnegotiate, ntlm, any, anysafe, digest_ie, only, ntlm_wb, negotiate

netrc_file

string

username

string

password

string

proxyusername

string

proxypassword

string

tlsauth_type

mask

none, srp

tlsauth_username

string

tlsauth_password

string

sasl_ir

long

xoauth2_bearer

string

login_options

string

autoreferer

long

followlocation

long

put

long

post

long

postfields

string

referer

string

useragent

string

cookie

string

cookiefile

string

postfieldsize

long

maxredirs

long

httpget

long

cookiejar

string

http_version

long

none, 1_0, 1_1

cookiesession

long

unrestricted_auth

long

postfieldsize_large

long long

cookielist

string

ignore_content_length

long

accept_encoding

string

transfer_encoding

long

http_content_decoding

long

http_transfer_decoding

long

copypostfields

string

postredir

mask

post_301, post_302

expect_100_timeout_ms

long

headeropt

mask

unified, separate

mail_from

string

mail_auth

string

tftp_blksize

long

ftpport

string

ftp_use_epsv

long

ftp_use_eprt

long

ftp_create_missing_dirs

long

ftp_response_timeout

long

ftpsslauth

long

default, ssl, tls

ftp_account

string

ftp_skip_pasv_ip

long

ftp_filemethod

long

multicwd, nocwd, singlecwd

ftp_alternative_to_user

string

ftp_ssl_ccc

long

ccc_none, ccc_active, ccc_passive

dirlistonly

long

append

long

ftp_use_pret

long

rtsp_request

long

options, describe, announce, setup, play, pause, teardown, get_parameter, set_parameter, record, receive

rtsp_session_id

string

rtsp_stream_uri

string

rtsp_transport

string

rtsp_client_cseq

long

rtsp_server_cseq

long

crlf

long

range

string

resume_from

long

customrequest

string

nobody

long

infilesize

long

upload

long

timecondition

long

none, ifmodsince, ifunmodsince, lastmod

timevalue

long

transfertext

long

filetime

long

maxfilesize

long

proxy_transfer_mode

long

resume_from_large

long long

infilesize_large

long long

maxfilesize_large

long long

timeout

long

low_speed_limit

long

low_speed_time

long

fresh_connect

long

forbid_reuse

long

connecttimeout

long

ipresolve

long

whatever, v4, v6

connect_only

long

max_send_speed_large

long long

max_recv_speed_large

long long

timeout_ms

long

connecttimeout_ms

long

maxconnects

long

use_ssl

long

none, try, control, all

dns_servers

string

accepttimeout_ms

long

dns_interface

string

dns_local_ip4

string

dns_local_ip6

string

sslcert

string

sslversion

long

default, tlsv1, sslv2, sslv3

ssl_verifypeer

long

cainfo

string

random_file

string

egdsocket

string

ssl_verifyhost

long

ssl_cipher_list

string

sslcerttype

string

sslkey

string

sslkeytype

string

sslengine

string

sslengine_default

long

capath

string

ssl_sessionid_cache

long

krblevel

string

keypasswd

string

issuercert

string

crlfile

string

certinfo

long

gssapi_delegation

long

none, policy_flag, flag

ssl_options

long

allow_beast

ssl_enable_alpn

long

ssl_enable_npn

long

ssh_auth_types

mask

none, policy_flag, flag

ssh_public_keyfile

string

ssh_private_keyfile

string

ssh_host_public_key_md5

string

ssh_knownhosts

string

new_file_perms

long

new_directory_perms

long

Nota
(1) Quando sono disponibili le costanti, esse vanno usate come valore per l’opzione. Per le opzioni con il tipo "mask" il formato è: "value1+value2+value3".

Per un URL, sono consentite due opzioni aggiuntive (stringhe) per il file in input/output:

  • file_in: file da leggere e inviare con gli URL (invio del file "post")

  • file_out: scrive URL scaricato/file in questo file (invece dello standard

  • output)

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.7. weechat_hook_connect

Hook su una connessione (connessione in secondo piano ad un host remoto).

Prototipo:

Argomenti:

  • proxy: nome del proxy da utilizzare per la connessione (opzionale, NULL significa connessione senza proxy)

  • address: nome o indirizzo IP al quale connettersi

  • port: numero della porta

  • ipv6: 1 to use IPv6 (with fallback to IPv4), 0 to use only IPv4

  • retry: retry count, used to fallback to IPv4 hosts if IPv6 hosts connect but then fail to accept the client

  • gnutls_sess: sessione GnuTLS (opzionale)

  • gnutls_cb callback GnuTLS (opzionale)

  • gnutls_dhkey_size: dimensione della chiave utilizzata nello Scambio Chiavi Diffie-Hellman (GnuTLS)

  • gnutls_priorities: priorità per gnutls (per la sintassi, consultare la documentazione della funzione gnutls_priority_init nel manuale di gnutls), i valori di base sono:

    • PERFORMANCE

    • NORMAL (predefinito)

    • SECURE128

    • SECURE256

    • EXPORT

    • NONE

  • local_hostname: nome host locale da utilizzare per la connessione (opzionale)

  • callback: funzione chiamata quando la connessione è avvenuta con successo oppure no, argomenti e valore restituito:

    • void *data: puntatore

    • int status: stato della connessione:

      • WEECHAT_HOOK_CONNECT_OK: connessione avvenuta con successo

      • WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND: indirizzo non trovato

      • WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND: indirizzo IP non trovato

      • WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED: connessione rifiutata

      • WEECHAT_HOOK_CONNECT_PROXY_ERROR: errore con il proxy

      • WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR: errore con il nome host locale

      • WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR: errore inizializzazione GnuTLS

      • WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR: errore di handshake GnuTLS

      • WEECHAT_HOOK_CONNECT_MEMORY_ERROR: memoria insufficiente

      • WEECHAT_HOOK_CONNECT_TIMEOUT: timeout

      • WEECHAT_HOOK_CONNECT_SOCKET_ERROR: errore nella creazione socket

    • gnutls_rc: valore del risultato di gnutls_handshake()

    • sock: socket utilizzato per la connessione

    • const char *error: valore del risultato di gnutls_strerror(gnutls_rc)

    • const char *ip_address: indirizzo IP trovato

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.8. weechat_hook_print

Updated in 0.4.3 and 1.0.

Hook su un messaggio stampato.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer, se NULL, verranno catturati i messaggi da qualsiasi buffer

  • tags: catch only messages with these tags (optional):

    • with WeeChat ≥ 0.4.3: comma-separated list of tags that must be in message (logical "or"); it is possible to combine many tags as a logical "and" with separator "+"; wildcard "*" is allowed in tags

    • with WeeChat ≤ 0.4.2: comma-separated list of tags that must all be in message (logical "and")

  • message: verranno catturati solo i messaggi con questa stringa (opzionale, non sensibile alle maiuscole)

  • strip_colors: se 1, i colori verranno estratti dal messaggio visualizzato, prima di chiamare la callback

  • callback: funzione chiamata quando viene stampato un messaggio, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_gui_buffer *buffer: puntatore al buffer

    • time_t date: data

    • int tags_count: numero di tag per riga

    • const char **tags: array con tag per riga

    • int displayed: 1 se la riga è visualizzata, 0 se filtrata (nascosta)

    • int highlight: 1 se la riga viene evidenziata, altrimenti 0

    • const char *prefix: prefisso

    • const char *message: messaggio

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Importante
In scripts, with WeeChat ≥ 1.0, the callback arguments displayed and highlight are integers (with WeeChat ≤ 0.4.3, they were strings).
To be compatible with all versions, it is recommended to convert the argument to integer before testing it, for example in Python: "if int(highlight):".

Esempio in C:

Script (Python):

3.11.9. weechat_hook_signal

Hook su un segnale.

Prototipo:

Argomenti:

  • signal: segnale da catturare, wildcard "*" is allowed (priorità consentita, consultare la nota riguardo la priority), see table below

  • callback: funzione chiamata a segnale ricevuto, argomenti e valore restituito:

    • void *data: puntatore

    • const char *signal: segnale ricevuto

    • const char *type_data: tipo di dati inviati con il segnale:

      • WEECHAT_HOOK_SIGNAL_STRING: stringa

      • WEECHAT_HOOK_SIGNAL_INT: numero intero

      • WEECHAT_HOOK_SIGNAL_POINTER: puntatore

    • void *signal_data: dati inviati con il segnale

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_OK_EAT (stop sending the signal immediately) (WeeChat ≥ 0.4.0)

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

List of signals sent by WeeChat and plugins:

Plugin Segnale Argomenti Descrizione

aspell

aspell_suggest
(WeeChat ≥ 0.4.0)

Pointer: buffer

New suggestions for a misspelled word

guile

guile_script_loaded
(WeeChat ≥ 0.3.9)

String: path to script

Scheme script loaded

guile

guile_script_unloaded
(WeeChat ≥ 0.3.9)

String: path to script

Scheme script unloaded

guile

guile_script_installed
(WeeChat ≥ 0.3.9)

String: comma-separated list of paths to scripts installed

Scheme script(s) installed

guile

guile_script_removed
(WeeChat ≥ 0.3.9)

String: comma-separated list of scripts removed

Scheme script(s) removed

irc

xxx,irc_in_yyy (1)

String: messaggio

Messaggio IRC dal server (prima di essere utilizzato dal plugin irc, il segnale viene inviato solo se il messaggio non viene ignorato)

irc

xxx,irc_in2_yyy (1)

String: messaggio

Messaggio IRC dal server (dopo essere stato utilizzato dal plugin irc, il segnale viene inviato solo se il messaggio non viene ignorato)

irc

xxx,irc_raw_in_yyy (1)
(WeeChat ≥ 0.3.2)

String: messaggio

Messaggio IRC dal server (prima di essere utilizzato dal plugin irc, il segnale viene inviato anche se il messaggio è stato ignorato)

irc

xxx,irc_raw_in2_yyy (1)
(WeeChat ≥ 0.3.2)

String: messaggio

Messaggio IRC dal server (dopo essere stato utilizzato dal plugin irc, il segnale viene inviato anche se il messaggio è stato ignorato)

irc

xxx,irc_out1_yyy (1)
(WeeChat ≥ 0.3.7)

String: messaggio

Messaggio IRC inviato al server (prima della divisione automatica da adattare in 512 byte)

irc

xxx,irc_out_yyy (1)

String: messaggio

Messaggio IRC inviato al server (dopo la divisione automatica da adattare in 512 byte)

irc

xxx,irc_outtags_yyy (1)
(WeeChat ≥ 0.3.4)

Stringa: tag + ";" + messaggio

Tag + messaggio IRC inviato al server

irc

irc_ctcp

String: messaggio

CTCP ricevuto

irc

irc_dcc

String: messaggio

Nuova DCC

irc

irc_pv

String: messaggio

Messaggio privato ricevuto

irc

irc_channel_opened

Puntatore: buffer

Canale aperto

irc

irc_pv_opened

Puntatore: buffer

Chat privata aperta

irc

irc_server_opened
(WeeChat ≥ 0.3.7)

Puntatore: buffer

Server del buffer aperto

irc

irc_server_connecting

String: nome server

Connessione al server

irc

irc_server_connected

String: nome server

Connesso al server

irc

irc_server_disconnected

String: nome server

Disconnesso dal server

irc

irc_ignore_removing

Puntatore: ignore

Rimozione dell’ignore

irc

irc_ignore_removed

-

Ignore rimosso

irc

irc_notify_join
(WeeChat ≥ 0.3.8)

String: nome server + "," + nick

Un nick nella lista notifiche è entrato sul server

irc

irc_notify_quit
(WeeChat ≥ 0.3.8)

String: nome server + "," + nick

Un nick nella lista notifiche è uscito dal server

irc

irc_notify_away
(WeeChat ≥ 0.3.8)

String: nome server + "," + nick + "," + messaggio di assenza

Un nick nella lista notifiche è ora assente sul server

irc

irc_notify_still_away
(WeeChat ≥ 0.3.8)

String: nome server + "," + nick + "," + messaggio di assenza

Un nick nella lista notifiche è ancora assente sul server (messaggio di assenza cambiato)

irc

irc_notify_back
(WeeChat ≥ 0.3.8)

String: nome server + "," + nick

Un nick nella lista notifiche è tornato (messaggio di assenza rimosso)

logger

logger_start

Puntatore: buffer

Avvia il logging per il buffer

logger

logger_stop

Puntatore: buffer

Ferma il logging per il buffer

logger

logger_backlog

Puntatore: buffer

Visualizza log precedenti per il buffer

lua

lua_script_loaded
(WeeChat ≥ 0.3.9)

String: path to script

Lua script loaded

lua

lua_script_unloaded
(WeeChat ≥ 0.3.9)

String: path to script

Lua script unloaded

lua

lua_script_installed
(WeeChat ≥ 0.3.9)

String: comma-separated list of paths to scripts installed

Lua script(s) installed

lua

lua_script_removed
(WeeChat ≥ 0.3.9)

String: comma-separated list of scripts removed

Lua script(s) removed

perl

perl_script_loaded
(WeeChat ≥ 0.3.9)

String: path to script

Perl script loaded

perl

perl_script_unloaded
(WeeChat ≥ 0.3.9)

String: path to script

Perl script unloaded

perl

perl_script_installed
(WeeChat ≥ 0.3.9)

String: comma-separated list of paths to scripts installed

Perl script(s) installed

perl

perl_script_removed
(WeeChat ≥ 0.3.9)

String: comma-separated list of scripts removed

Perl script(s) removed

python

python_script_loaded
(WeeChat ≥ 0.3.9)

String: path to script

Python script loaded

python

python_script_unloaded
(WeeChat ≥ 0.3.9)

String: path to script

Python script unloaded

python

python_script_installed
(WeeChat ≥ 0.3.9)

String: comma-separated list of paths to scripts installed

Python script(s) installed

python

python_script_removed
(WeeChat ≥ 0.3.9)

String: comma-separated list of scripts removed

Python script(s) removed

relay

relay_client_connecting
(WeeChat ≥ 1.0)

Pointer: relay client

A relay client is connecting

relay

relay_client_waiting_auth
(WeeChat ≥ 1.0)

Pointer: relay client

Waiting for authentication from a relay client

relay

relay_client_auth_ok
(WeeChat ≥ 1.0)

Pointer: relay client

Successful authentication from a relay client

relay

relay_client_connected
(WeeChat ≥ 1.0)

Pointer: relay client

A relay client is connected

relay

relay_client_auth_failed
(WeeChat ≥ 1.0)

Pointer: relay client

Authentication of a relay client has failed

relay

relay_client_disconnected
(WeeChat ≥ 1.0)

Pointer: relay client

A relay client is disconnected

ruby

ruby_script_loaded
(WeeChat ≥ 0.3.9)

String: path to script

Ruby script loaded

ruby

ruby_script_unloaded
(WeeChat ≥ 0.3.9)

String: path to script

Ruby script unloaded

ruby

ruby_script_installed
(WeeChat ≥ 0.3.9)

String: comma-separated list of paths to scripts installed

Ruby script(s) installed

ruby

ruby_script_removed
(WeeChat ≥ 0.3.9)

String: comma-separated list of scripts removed

Ruby script(s) removed

tcl

tcl_script_loaded
(WeeChat ≥ 0.3.9)

String: path to script

Tcl script loaded

tcl

tcl_script_unloaded
(WeeChat ≥ 0.3.9)

String: path to script

Tcl script unloaded

tcl

tcl_script_installed
(WeeChat ≥ 0.3.9)

String: comma-separated list of paths to scripts installed

Tcl script(s) installed

tcl

tcl_script_removed
(WeeChat ≥ 0.3.9)

String: comma-separated list of scripts removed

Tcl script(s) removed

weechat

buffer_opened

Puntatore: buffer

Buffer aperto

weechat

buffer_closing

Puntatore: buffer

Chiusura del buffer

weechat

buffer_closed

Puntatore: buffer

Buffer chiuso

weechat

buffer_cleared

Puntatore: buffer

Buffer cleared

weechat

buffer_hidden

Pointer: buffer

Buffer hidden

weechat

buffer_unhidden

Pointer: buffer

Buffer unhidden

weechat

buffer_line_added
(WeeChat ≥ 0.3.7)

Puntatore: riga

Riga aggiunta in un buffer

weechat

buffer_lines_hidden

Puntatore: buffer

Righe nascoste nel buffer

weechat

buffer_localvar_added

Puntatore: buffer

Variabili locali aggiunte

weechat

buffer_localvar_changed

Puntatore: buffer

Variabili locali modificate

weechat

buffer_localvar_removed

Puntatore: buffer

Variabili locali rimosse

weechat

buffer_merged

Puntatore: buffer

Buffer merged

weechat

buffer_unmerged

Puntatore: buffer

Buffer unmerged

weechat

buffer_moved

Puntatore: buffer

Buffer spostato

weechat

buffer_renamed

Puntatore: buffer

Buffer rinominato

weechat

buffer_switch

Puntatore: buffer

Passaggio tra buffer

weechat

buffer_title_changed

Puntatore: buffer

Titolo del buffer modificato

weechat

buffer_type_changed

Puntatore: buffer

Tipo di buffer modificato

weechat

buffer_zoomed
(WeeChat ≥ 0.4.3)

Puntatore: buffer

Merged buffer zoomed

weechat

buffer_unzoomed
(WeeChat ≥ 0.4.3)

Puntatore: buffer

Merged buffer unzoomed

weechat

day_changed
(WeeChat ≥ 0.3.2)

String: nuova data, formato: "2010-01-31"

Data di sistema modificata

weechat

debug_dump

Stringa: nome plugin

Richiesta di dump

weechat

debug_libs

-

Display external libraries used

weechat

filter_added

Puntatore: filtro

Filtro aggiunto

weechat

filter_removing

Puntatore: filtro

Rimozione del filtro

weechat

filter_removed

-

Filtro rimosso

weechat

filters_enabled

-

Filtri abilitati

weechat

filters_disabled

-

Filtri disabilitati

weechat

hotlist_changed

-

Hotlist modificata

weechat

input_paste_pending

-

Incolla testo in attesa

weechat

input_search

Puntatore: buffer

Ricerca testo nel buffer

weechat

input_text_changed

Puntatore: buffer

Testo in input modificato

weechat

input_text_cursor_moved

Puntatore: buffer

Cursore del testo di input spostato

weechat

key_bind

String: key

Key added

weechat

key_unbind

String: key

Key removed

weechat

key_pressed

String: tasto digitato

Tasto digitato

weechat

key_combo_default
(WeeChat ≥ 1.0)

String: key combo

Key combo in default context

weechat

key_combo_search
(WeeChat ≥ 1.0)

String: key combo

Key combo in search context

weechat

key_combo_cursor
(WeeChat ≥ 1.0)

String: key combo

Key combo in cursor context

weechat

mouse_enabled
(WeeChat ≥ 1.1)

-

Mouse enabled

weechat

mouse_disabled
(WeeChat ≥ 1.1)

-

Mouse disabled

weechat

nicklist_group_added
(WeeChat ≥ 0.3.2)

String: buffer pointer + "," + group name

Group added in nicklist

weechat

nicklist_group_changed
(WeeChat ≥ 0.3.4)

String: buffer pointer + "," + group name

Group changed in nicklist

weechat

nicklist_group_removing
(WeeChat ≥ 0.4.1)

String: buffer pointer + "," + group name

Removing group from nicklist

weechat

nicklist_group_removed
(WeeChat ≥ 0.3.2)

String: buffer pointer + "," + group name

Group removed from nicklist

weechat

nicklist_nick_added
(WeeChat ≥ 0.3.2)

String: buffer pointer + "," + nick name

Nick added in nicklist

weechat

nicklist_nick_changed
(WeeChat ≥ 0.3.4)

String: buffer pointer + "," + nick name

Nick changed in nicklist

weechat

nicklist_nick_removing
(WeeChat ≥ 0.4.1)

String: buffer pointer + "," + nick name

Removing nick from nicklist

weechat

nicklist_nick_removed
(WeeChat ≥ 0.3.2)

String: buffer pointer + "," + nick name

Nick removed from nicklist

weechat

partial_completion

-

Completamento parziale avvenuto

weechat

plugin_loaded
(WeeChat ≥ 0.3.9)

String: path to plugin loaded

Plugin loaded

weechat

plugin_unloaded
(WeeChat ≥ 0.3.9)

String: name of plugin unloaded (example: "irc")

Plugin unloaded

weechat

quit

String: argomenti per /quit

Comando /quit digitato dall’utente

weechat

signal_sigwinch
(WeeChat ≥ 0.4.3)

-

Signal SIGWINCH received (terminal was resized)

weechat

upgrade

String: "quit" if "-quit" argument was given for /upgrade, otherwise NULL

Comando /upgrade digitato dall’utente

weechat

upgrade_ended
(WeeChat ≥ 0.3.4)

-

Fine del processo di aggiornamento (comando /upgrade)

weechat

weechat_highlight

String: messaggio con prefisso

Evento accaduto

weechat

weechat_pv

String: messaggio con prefisso

Messaggio privato visualizzato

weechat

window_closing
(WeeChat ≥ 0.3.6)

Puntatore: finestra

Closing window

weechat

window_closed
(WeeChat ≥ 0.3.6)

Puntatore: finestra

Window closed

weechat

window_opened
(WeeChat ≥ 0.4.1)

Puntatore: finestra

Window opened

weechat

window_scrolled

Puntatore: finestra

Scroll nella finestra

weechat

window_switch
(WeeChat ≥ 0.3.7)

Puntatore: finestra

Passaggio alla finestra

weechat

window_zoom

Puntatore: finestra corrente

Massimizzazione della finestra

weechat

window_zoomed

Puntatore: finestra corrente

Finestra massimizzata

weechat

window_unzoom

Puntatore: finestra corrente

Minimizzazione della finestra

weechat

window_unzoomed

Puntatore: finestra corrente

Finestra minimizzata

xfer

xfer_add

Puntatore: lista info con info per xfer

Nuovo xfer

xfer

xfer_send_ready

Puntatore: lista info xon info per xfer

Xfer pronto

xfer

xfer_accept_resume

Puntatore: lista info con info per xfer

Accept xfer resume

xfer

xfer_send_accept_resume

Puntatore: lista info con info per xfer

Xfer resumed

xfer

xfer_start_resume

Puntatore: lista info con info per xfer

Avvia ripresa

xfer

xfer_resume_ready

Puntatore: lista info con info per xfer

Ripresa xfer pronta

xfer

xfer_ended
(WeeChat ≥ 0.3.2)

Puntatore: lista info con info per xfer

Xfer terminato

Nota
(1) xxx è il nome del server IRC, yyy è il nome del comando IRC.

Esempio in C:

Script (Python):

3.11.10. weechat_hook_signal_send

Updated in 1.0.

Invia un segnale.

Prototipo:

Argomenti:

  • signal: segnale da inviare

  • type_data: tipo di dati inviati con il segnale (consultare weechat_hook_signal)

  • signal_data: dati inviati con il segnale

Return value (WeeChat ≥ 1.0):

  • 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:

Script (Python):

Signal logger_backlog

Il segnale "logger_backlog" può essere inviato per visualizzare il backlog (cronologia di chat) nel buffer (ad esempio se il proprio buffer viene aperto in un plugin/script).

L’argomento è un puntatore al buffer.

Esempio in C:

Script (Python):

Signals xxx_script_install

Cinque segnali che possono essere inviati per installare uno script, a seconda del linguaggio:

  • perl_script_install

  • python_script_install

  • ruby_script_install

  • lua_script_install

  • tcl_script_install

La callback compirà le seguenti azioni alla ricezione del segnale:

  1. scarica e rimuove lo script installato

  2. sposta il nuovo script nella cartella ~/.weechat/xxx/ (dove xxx è il linguaggio)

  3. crea un link al nuovo script nella cartella ~/.weechat/xxx/autoload/

  4. carica il nuovo script

These signals are used by script plugin to install scripts.

L’argomento è una stringa con il percorso dello script da installare.

Esempio in C:

Script (Python):

Signals xxx_script_remove

Cinque segnali che possono essere inviati per rimuovere un elenco di script, a seconda del linguaggio:

  • perl_script_remove

  • python_script_remove

  • ruby_script_remove

  • lua_script_remove

  • tcl_script_remove

Per ogni script nella lista, la callback scaricherà e rimuoverà lo script.

These signals are used by script plugin to remove scripts.

L’argomento è una stringa con una lista separata da virgole di script da rimuovere (script è il nome senza percorso, ad esempio script.py).

Esempio in C:

Script (Python):

Signal irc_input_send

WeeChat ≥ 0.3.4.

Il segnale "irc_input_send" può essere inviato per simulare input in un buffer irc (server, canale o privato).

L’argomento è una stringa con il seguente formato:

  • nome interno del server (richiesto)

  • punto e virgola

  • nome canale (opzionale)

  • punto e virgola

  • flag usate per l’invio del messaggio (opzionale, la predefinita è 1):

    • 1: coda con la priorità maggiore (come i messaggi utente)

    • 2: coda con la priorità minore (come i messaggi inviati automaticamente da WeeChat)

  • punto e virgola

  • elenco separato da virgole di tag usate per l’invio di un messaggio (opzionale)

  • punto e virgola

  • testo o comando (richiesto)

Esempi in C:

Script (Python):

3.11.11. weechat_hook_hsignal

WeeChat ≥ 0.3.4.

Hook su hsignal (segnale con tabella hash).

Prototipo:

Argomenti:

  • signal: segnale da catturare, wildcard "*" is allowed (priorità consentita, consultare la nota a proposito di priority), see table below

  • callback: funzione chiamata a segnale ricevuto, argomenti e valore restituito:

    • void *data: puntatore

    • const char *signal: segnale ricevuto

    • struct t_hashtable *hashtable: tabella hash

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_OK_EAT (stop sending the signal immediately) (WeeChat ≥ 0.4.0)

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

List of hsignals sent by WeeChat and plugins:

Plugin Segnale Argomenti Descrizione

irc

irc_redirection_xxx_yyy (1)
(WeeChat ≥ 0.3.4)

Consultare hsignal_irc_redirect_command

Redirection output

weechat

nicklist_group_added
(WeeChat ≥ 0.4.1)

buffer (struct t_gui_buffer *): buffer
parent_group (struct t_gui_nick_group *): parent group
group (struct t_gui_nick_group *): group

Group added in nicklist

weechat

nicklist_nick_added
(WeeChat ≥ 0.4.1)

buffer (struct t_gui_buffer *): buffer
parent_group (struct t_gui_nick_group *): parent group
nick (struct t_gui_nick *): nick

Nick added in nicklist

weechat

nicklist_group_removing
(WeeChat ≥ 0.4.1)

buffer (struct t_gui_buffer *): buffer
parent_group (struct t_gui_nick_group *): parent group
group (struct t_gui_nick_group *): group

Removing group from nicklist

weechat

nicklist_nick_removing
(WeeChat ≥ 0.4.1)

buffer (struct t_gui_buffer *): buffer
parent_group (struct t_gui_nick_group *): parent group
nick (struct t_gui_nick *): nick

Removing nick from nicklist

weechat

nicklist_group_changed
(WeeChat ≥ 0.4.1)

buffer (struct t_gui_buffer *): buffer
parent_group (struct t_gui_nick_group *): parent group
group (struct t_gui_nick_group *): group

Group changed in nicklist

weechat

nicklist_nick_changed
(WeeChat ≥ 0.4.1)

buffer (struct t_gui_buffer *): buffer
parent_group (struct t_gui_nick_group *): parent group
nick (struct t_gui_nick *): nick

Nick changed in nicklist

Nota
(1) xxx è l’argomento del segnale usato nella redirezione, yyy è lo schema di redirezione.

Esempio in C:

Script (Python):

3.11.12. weechat_hook_hsignal_send

WeeChat ≥ 0.3.4, updated in 1.0.

Invia un hsignal (segnale con tabella hash).

Prototipo:

Argomenti:

  • signal: segnale da inviare

  • hashtable: tabella hash

Return value (WeeChat ≥ 1.0):

  • 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:

Script (Python):

Hsignal irc_redirect_command

WeeChat ≥ 0.3.4.

L’hsignal "irc_redirect_command" può essere inviato per redirigere l’output di un comando irc ad una callback.

L’argomento è una tabella hash con le seguenti componenti (chiavi e valori sono stringhe):

  • server: nome interno del server (richiesto)

  • pattern: schema di redirezione da usare (richiesto), sia uno di default (definito dal plugin irc), oppure definito dall’utente (consultare [hsignal_irc_redirect_pattern]), gli schemi predefiniti sono:

    • ison

    • list

    • mode_channel

    • mode_channel_ban ("mode #channel b")

    • mode_channel_ban_exception ("mode #channel e")

    • mode_channel_invite ("mode #channel I")

    • mode_user

    • monitor

    • names

    • ping

    • time

    • topic

    • userhost

    • who

    • whois

    • whowas

  • signal: nome segnale (richiesto)

  • count: numero di volte in cui verrà utilizzata la redirezione (opzionale, predefinito è 1)

  • string: stringa che deve essere presente nei messaggi irc ricevuti (opzionale, ma raccomandata, se una stringa può essere usata per identificare i messaggi)

  • timeout: timeout per la redirezione, in secondi (opzionale, predefiniti sono)

  • cmd_filter: elenco separato da virgole di comandi irc da filtrare (solo questi comandi verranno inviati alle callback, altri ignorati) (opzionale)

Subito dopo aver inviato questo hsignal, è necessario inviare il comando al server irc, e la redirezione verrà usata per questo comando.

Quando è stata ricevuta la risposta completa dal proprio comando, verrà inviato un hsignal. Questo hsignal ha il nome irc_redirection_xxx_yyy dove xxx è il segnale e yyy lo schema usato.

La tabella hash inviata in hsignal ha il seguente contenuto (chiavi e valori sono stringhe):

  • output: output del comando (i messaggi vengono separati da "\n")

  • output_size: numero di byte in output (come stringa)

  • error: stringa di errore (in caso di errore):

    • timeout: redirezione fermata dopo il timeout

  • server: nome interno del server

  • pattern: schema di redirezione

  • signal: nome del segnale

  • command: comando rediretto

Esempio in C:

Script (Python):

Hsignal irc_redirect_pattern

WeeChat ≥ 0.3.4.

L’hsignal "irc_redirect_pattern" può essere inviato per creare uno schema per la redirezione irc (consultare [hsignal_irc_redirect_command]).

L’argomento è una tabella hash con le seguenti voci (chiavi e valori sono stringa):

  • pattern: nome dello schema (richiesto)

  • timeout: timeout predefinito per lo schema, in secondi (opzionale, predefinito è 60)

  • cmd_start: elenco separato da virgole di comandi che avviano la redirezione (opzionale)

  • cmd_stop: elenco separato da virgole di comandi che fermano la redirezione (richiesto)

  • cmd_extra: elenco separato da virgole di comandi che possono essere ricevuti dopo aver fermato i comandi (opzionale)

Per ogni comando in cmd_start, cmd_stop e cmd_extra, è possibile fornire un intero con la posizione di "string" che va trovato nel messaggio ricevuto, ad esempio:

352:1,354,401:1

Per i comandi 352 e 401, "string" deve essere trovata nel messaggio ricevuto, come primo argomento.

Importante
Lo schema viene rimosso quando usato da una redirezione. Se uno schema si rivelasse necessario per diverse redirezioni, è necessario crearne uno prima di ogni redirezione.

Esempio in C:

Script (Python):

3.11.13. weechat_hook_config

Hook su un’opzione di configurazione.

Prototipo:

Argomenti:

  • option: opzione, il formato è il nome completo, come usato con il comando /set (ad esempio: weechat.look.item_time_format), wildcard "*" is allowed (priorità consentita, consultare la note riguardo la priority)

  • callback: funzione chiamata quando l’opzione di configurazione è cambiata, argomenti e valore restituito:

    • void *data: puntatore

    • const char *option: nome dell’opzione

    • const char *value: nuovo valore per l’opzione

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.14. weechat_hook_completion

Hook su un completamento.

Prototipo:

Argomenti:

  • completion_item: nome dell’elemento del completamento, è possibile usare in seguito %(name) in un comando con un hook (argomento completion) (priorità consentita, consultare la nota riguardo la priority)

  • callback: funzione chiamata quando viene usato l’elemento completamento (l’utente sta completando qualcosa usando questo elemento), argomenti e valore restituito:

    • void *data: puntatore

    • const char *completion_item: nome dell’elemento del completamento

    • struct t_gui_buffer *buffer: buffer dove viene eseguito il completamento

    • struct t_gui_completion *completion: struttura usata per aggiungere parole per il completamento (consultare weechat_hook_completion_list_add)

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Nota
I nomi del completamento sono globali (condivisi tra WeeChat e plugin). Si raccomanda pertanto di scegliere un nome con un prefisso unico, come "plugin_xxx" (dove "xxx" è il nome del proprio elemento).
Importante
The callback must only call function weechat_hook_completion_list_add and must NOT update the command line.
To update the command line when Tab is pressed, you can use the function weechat_hook_command_run with command: "/input complete_next" (and you must return WEECHAT_RC_OK_EAT if your callback has updated the command line, so that WeeChat will not perform the completion).

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.15. weechat_hook_completion_get_string

Novità nella versioe 0.3.4.

Ottiene il completamento di una proprietà come stringa.

Prototipo:

Argomenti:

  • completion: puntatore al completamento

  • property: nome della proprietà:

    • base_command: comando usato per il completamento

    • base_word: parola che viene completata

    • args: argomenti del comando (inclusa la parola base)

Esempio in C:

Script (Python):

3.11.16. weechat_hook_completion_list_add

Aggiunge una parola per il completamento.

Prototipo:

Argomenti:

  • completion: puntatore al completamento

  • word: parola da aggiungere

  • nick_completion: 1 se la parola è un nick, altrimenti 0

  • where: posizione in cui la parola sarà inserita nella lista:

    • WEECHAT_LIST_POS_SORT: qualunque posizione, per mantenere la lista ordinata

    • WEECHAT_LIST_POS_BEGINNING: inizio della lista

    • WEECHAT_LIST_POS_END: fine della lista

Esempio in C: consultare weechat_hook_completion.

Script (Python):

3.11.17. weechat_hook_modifier

Hook su un modificatore.

Prototipo:

Argomenti:

  • modifier: nome modificatore, lista di modificatori utilizzati da Weechat o dai plugin (priorità consentita, consultare la nota riguardo la priority), see table below

  • callback: funzione chiamata quando viene usato il modificatore, argomenti e valore restituito:

    • void *data: puntatore

    • const char *modifier: nome del modificatore

    • const char *modifier_data: dati per il modificatore

    • const char *string: stringa da modificare

    • valore restituito: nuova stringa

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

List of modifiers used by WeeChat and plugins:

Modificatore Dati modificatore Stringa Output

charset_decode

plugin.buffer_name

Qualsiasi stringa

Stringa codificata dal set caratteri trovato per plugin/buffer in UTF-8

charset_encode

plugin.buffer_name

Qualsiasi stringa

Stringa codificata da UTF-8 al set caratteri trovato per il plugin/buffer

irc_color_decode

"1" per mantenere i colori, "0" per rimuovere i colori

Qualsiasi stringa

String with IRC colors converted to WeeChat colors (or IRC colors removed)

irc_color_encode

"1" per mantenere i colori, "0" per rimuovere i colori

Qualsiasi stringa

String with IRC colors (or IRC colors removed)

irc_color_decode_ansi
(WeeChat ≥ 1.0)

"1" per mantenere i colori, "0" per rimuovere i colori

Qualsiasi stringa

String with ANSI colors converted to IRC colors (or ANSI colors removed)

irc_command_auth
(WeeChat ≥ 0.4.1)

Nome server

Authentication command (for example: /msg nickserv identify password)

Command with hidden password (for example: /msg nickserv identify ********)

irc_message_auth
(WeeChat ≥ 0.4.1)

Nome server

Message displayed after /msg sent to nickserv

Message with hidden password

irc_in_xxx (1)

Nome server

Contenuto del messaggio ricevuto dal server IRC (prima della codifica del set caratteri)

Nuovo contenuto del messaggio

irc_in2_xxx (1)
(WeeChat ≥ 0.3.5)

Nome server

Contenuto del messaggio ricevuto dal server IRC (dopo la codifica del set caratteri)

Nuovo contenuto del messaggio

irc_out1_xxx (1)
(WeeChat ≥ 0.3.7)

Nome server

Contenuto del messaggio che sta per essere inviato al server IRC (prima della divisione automatica da adattare in 512 byte)

Nuovo contenuto del messaggio

irc_out_xxx (1)

Nome server

Contenuto del messaggio che sta per essere inviato al server IRC (dopo la divisione automatica da adattare in 512 byte)

Nuovo contenuto del messaggio

color_decode_ansi
(WeeChat ≥ 1.0)

"1" per mantenere i colori, "0" per rimuovere i colori

Qualsiasi stringa

String with ANSI colors converted to WeeChat colors (or ANSI colors removed)

bar_condition_yyy (2)

Stringa con puntatore alla finestra ("0x123..")

Stringa vuota

"1" per visualizzare la barra, "0" per nasconderla

history_add
(WeeChat ≥ 0.3.2)

Stringa con puntatore al buffer ("0x123..")

Contenuto della riga di comando da aggiungere nella cronologia comandi (buffer e globale

Stringa aggiunta alla cronologia comandi

input_text_content

Stringa con puntatore al buffer ("0x123..")

Contenuto della riga di comando

Nuovo contenuto della riga di comando

input_text_display

Stringa con puntatore al buffer ("0x123..")

Contenuto della riga di comando, senza tag al cursore

Nuova stringa, solo da mostrare (la riga di comando non viene modificata)

input_text_display_with_cursor

Stringa con puntatore al buffer ("0x123..")

Contenuto della riga di comando, con tag al cursore

Nuova stringa, solo da mostrare (la riga di comando non viene modificata)

input_text_for_buffer
(WeeChat ≥ 0.3.7)

Stringa con puntatore al buffer ("0x123..")

Contenuto della riga di comando inviata al buffer (testo o comando)

Nuovo contenuto della riga di comando inviata al buffer

weechat_print

plugin + ";" + buffer_name + ";" + tags

Messaggio stampato

Nuovo messaggio stampato

Nota
(1) xxx è il nome del comando IRC.
(2) yyy è il nome della barra.

Esempio in C:

Script (Python):

3.11.18. weechat_hook_modifier_exec

Esegue modificatore(i).

Prototipo:

Argomenti:

  • modifier: nome modificatore

  • modifier_data: dati modificatore

  • string: stringa da modificare

Valore restituito:

  • stringa modificata, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.19. weechat_hook_info

Hook su una informazione (la callback prende e restituisce una stringa).

Prototipo:

Argomenti:

  • info_name: nome della info (priorità consentita, consultare la nota riguardo la priority)

  • description: descrizione

  • args_description: descrizione degli argomenti

  • callback: funzione chiamata alla richiesta di una info, argomenti e valore restituito:

    • void *data: puntatore

    • const char *info_name: nome della info

    • const char *arguments: argomenti addizionali, dipendono dalle info

    • valore restituito: valore dell’info richiesta

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.20. weechat_hook_info_hashtable

WeeChat ≥ 0.3.4.

Hook su una informazione (la callback prende e restituisce una tabella hash).

Prototipo:

Argomenti:

  • info_name: nome della info (priorità consentita, consultare la nota riguardo la priority)

  • description: descrizione

  • args_description: descrizione della tabella hash attesa (opzionale, può essere NULL)

  • output_description: descrizione della tabella hash restituita dalla callback (opzionale, può essere NULL)

  • callback: funzione chiamata alla richiesta della info, argomenti e valore restituito:

    • void *data: puntatore

    • const char *info_name: nome della info

    • struct t_hashtable *hashtable: tabella hash, in base alla info

    • valore restituito: tabella hash richiesta

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.21. weechat_hook_infolist

Hook su una lista info: la callback restituisce il puntatore alla lista info richiesta.

Prototipo:

Argomenti:

  • infolist_name: nome della lista info (priotità consentita, consultare la nota riguardo la priority)

  • description: descrizione

  • pointer_description: descrizione del puntatore (opzionale, può essere NULL)

  • args_description: descrizione degli argomenti (opzionale, può essere NULL)

  • callback: funzione chiamata alla richiesta della lista info, argomenti e valore restituito:

    • void *data: puntatore

    • const char *infolist_name: nome della lista info

    • void *pointer: puntatore ad un oggetto che la lista info deve restituire (per ricevere un solo elemento della lista info)

    • const char *arguments: argomento aggiuntivo, dipende dalla lista info

    • valore restituito: lista info richiesta

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.22. weechat_hook_hdata

Hook di un hdata: la callback restituisce il puntatore all’hdata richiesto.

Prototipo:

Argomenti:

  • hdata_name: nome dell’hdata (priorità consentita, consultare la nota a proposito di priority)

  • description: descrizione

  • callback: funzione chiamata alla richiesta di hdata, argomenti e valore restituito:

    • void *data: puntatore

    • const char *hdata_name: nome dell’hdata

    • return value: hdata richiesto

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.11.23. weechat_hook_focus

Hook sul foucus: evento del mouse o tasto premuto nella modalità cursore (movimento libero del cursore).

Prototipo:

Argomenti:

  • area: "chat" per la zona di chat, o il nome di un elemento barra (priorità consentita, consultare la nota a riguardo di priority)

  • callback: funzione chiamata al momento del focus, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_hashtable *info: tabella hash con informazioni sul focus e stringhe restituite da altre chiamate alle callback sul focus (con la priorità più alta) (consultare la tabella in basso)

    • valore restituito: sia il puntatore "info" tabella hash completa), o il puntatore ad una nuova tabella hash (creata dalla callback, con chiavi e valori di tipo "string), questa nuovo contenuto della tabella hash verrà aggiunto ad info per le altre chiamate alle callback del focus

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Importante
Per l’azione di un mouse, la callback verrà chiamata due volte: la prima quando il pulsante viene premuto (qui la zona corrisponde sempre alla propria area), la seconda quando il pulsante viene rilasciato, e allora la zona potrà non corrispondere con la propria: per cui bisogna sempre verificare nella propria callback se l’area corrisponde prima di usare le informazioni nella tabella hash.

Contenuto della tabella hash inviata alla callback (tasti e valori sono di tipo "string"):

Key (1) Descrizione Valori di esempio Valore se N/D

_x

Colonna sullo schermo

"0" … "n"

_y

Riga sullo schermo

"0" … "n"

_key

Evento tasto o mouse

"button1", "button2-gesture-left", …

_window

Puntatore alla finestra

"0x12345678"

""

_window_number

Numero della finestra

"1" … "n"

"*"

_buffer

Puntatore al buffer

"0x12345678"

""

_buffer_number

Numero del buffer

"1" … "n"

"-1"

_buffer_plugin

Nome plugin del buffer

"core", "irc", …

""

_buffer_name

Nome del buffer

"weechat", "freenode.#weechat", …

""

_buffer_full_name

Nome completo del buffer

"core.weechat", "irc.freenode.#weechat", …

""

_buffer_localvar_XXX (2)

Variabili locali del buffer

qualsiasi valore

non impostato

_chat

Indicatore area di chat

"0" o "1"

"0"

_chat_line_x

Colonna nella riga (3)

"0" … "n"

"-1"

_chat_line_y

Numero della riga (3)

"0" … "n"

"-1"

_chat_line_date

Riga con data/ora

"1313237175"

"0"

_chat_line_date_printed

Riga con data/ora (4)

"1313237175"

"0"

_chat_line_time

Ora visualizzata

"14:06:15"

""

_chat_line_tags

Tag della riga

"irc_privmsg,nick_flashy,log1"

""

_chat_line_nick

Nick della riga

"FlashCode"

""

_chat_line_prefix

Prefisso della riga

"@FlashCode"

""

_chat_line_message

Messaggio della riga

"Hello world!"

""

_chat_word

Parola a (x,y)

"Hello"

""

_chat_bol

Inizio della riga ⇒ (x-1,y)

"He"

""

_chat_eol

(x,y) ⇒ fine della riga

"llo world!"

""

_bar_name

Nome della barra

"title", "nicklist", …

""

_bar_filling

Riempimento della barra

"horizontal", "vertical", …

""

_bar_item_name

Nome dell’elemento barra

"buffer_nicklist", "hotlist", …

""

_bar_item_line

Riga nell’elemento barra

"0" … "n"

"-1"

_bar_item_col

Colonna nell’elemento barra

"0" … "n"

"-1"

Nota
(1) Ci sono alcune chiavi con il suffisso "2" (es: "_x2", "_y2", "_window2", …) con informazioni sul secondo punto (utile solo per le azioni del mouse, per sapere dove il pulsante del mouse è stato rilasciato).
(2) XXX è il nome della variabile locale nel buffer.
(3) È impostato solo per l buffer con contenuto libero.
(4) Data/ora in cui WeeChat aggiunge una riga nel buffer (maggiore o uguale a "chat_line_date").

Informazioni aggiuntive per l’elemento barra "buffer_nicklist":

Chiave Plugin Descrizione

nick

core

Nick

prefix

core

Prefisso per il nick

group

core

Nome gruppo

irc_host

irc

Host per il nick (se conosciuto)

Nota
(1) Il nome del plugin che definisce un hook_focus per restituire informazioni su questo elemento della barra (ad esempio se il plugin è "irc", tale informazione sarà disponibile solo sui buffer irc).

Valore restituito:

  • puntatore al nuovo hook, NULL in caso di errore

Esempio in C:

Script (Python):

3.11.24. weechat_hook_set

WeeChat ≥ 0.3.9 (script: WeeChat ≥ 0.4.3).

Set string value of a hook property.

Prototipo:

Argomenti:

  • hook: qualcosa su cui è presente un hook con "weechat_hook_xxx()"

  • property: nome della proprietà (see table below)

  • value: new value for property

Properties:

Nome Hook type Valore Descrizione

subplugin

any type

qualsiasi stringa

Name of sub plugin (commonly script name, which is displayed in /help command for a hook of type command)

stdin
(WeeChat ≥ 0.4.3)

process, process_hashtable

qualsiasi stringa

Send data on standard input (stdin) of child process

stdin_close
(WeeChat ≥ 0.4.3)

process, process_hashtable

(not used)

Close pipe used to send data on standard input (stdin) of child process

signal
(WeeChat ≥ 1.0)

process, process_hashtable

signal number or one of these names: hup, int, quit, kill, term, usr1, usr2

Send a signal to the child process

Esempio in C:

Script (Python):

3.11.25. weechat_unhook

Rimuove un hook.

Prototipo:

Argomenti:

  • hook: qualcosa su cui è presente un hook con "weechat_hook_xxx()"

Esempio in C:

Script (Python):

3.11.26. weechat_unhook_all

Rimuove l’hook in qualsiasi punto in cui è stato attivato dal plugin corrente.

Prototipo:

Esempio in C:

Script (Python):

3.12. Buffer

Funzioni per creare/richiedere/chiudere buffer.

3.12.1. weechat_buffer_new

Apre un nuovo buffer.

Prototipo:

Argomenti:

  • name: nome del buffer (deve essere unico per il plugin)

  • input_callback: funzione chiamata quando il testo in input è stato inserito nel buffer, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_gui_buffer *buffer: puntatore al buffer

    • const char *input_data: dati in input

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

  • close_callback: funzione chiamata alla chiusura del buffer, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_gui_buffer *buffer: puntatore al buffer

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo buffer, NULL in caso di errore

Esempio in C:

Script (Python):

3.12.2. weechat_current_buffer

Restituisce il puntatore al buffer corrente (buffer visualizzato nella finestra corrente).

Prototipo:

Valore restituito:

  • puntatore al buffer corrente

Esempio in C:

Script (Python):

Updated in 1.0.

Cerca un buffer tramite plugin e/o nome.

Prototipo:

Argomenti:

  • plugin: name of plugin, following special value is allowed:

    • ==: the name used is the buffer full name (for example: irc.freenode.#weechat instead of freenode.#weechat) (WeeChat ≥ 1.0)

  • name: name of buffer, if it is NULL or empty string, the current buffer is returned (buffer displayed by current window); if the name starts with (?i), the search is case insensitive (WeeChat ≥ 1.0)

Valore restituito:

  • puntatore al buffer trovato, NULL in caso contrario

Esempio in C:

Script (Python):

3.12.4. weechat_buffer_search_main

Cerca nel buffer principale di WeeChat (per primo nel buffer core, il primo visualizzato all’avvio di WeeChat).

Prototipo:

Valore restituito:

  • puntatore al buffer principale di WeeChat (buffer core)

Esempio in C:

Script (Python):

3.12.5. weechat_buffer_clear

Pulisce il contenuto del buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

Esempio in C:

Script (Python):

3.12.6. weechat_buffer_close

Chiude un buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

Esempio in C:

Script (Python):

3.12.7. weechat_buffer_merge

Unisce un buffer in un altro: entrambi i buffer esistono separatamente, ma con lo stesso numero, e WeeChat visualizzerà le righe di entrambi i buffer (righe mischiate).

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • target_buffer: buffer di destinazione, dove il buffer verrà unito

Esempio in C:

Script (Python):

3.12.8. weechat_buffer_unmerge

Stacca un buffer da un gruppo di buffer uniti.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • number: numero di destinazione per il buffer staccato, se è < 1, allora il buffer verrà spostato al numero di buffer +1

Esempio in C:

Script (Python):

3.12.9. weechat_buffer_get_integer

Restituisce il valore intero della proprietà di un buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • property: nome della proprietà:

    • number: numero del buffer (inizia da 1)

    • layout_number: numero del buffer salvato nel layout

    • layout_number_merge_order: ordine di unione per i layout

    • short_name_is_set: 1 se il nome breve è impostato, 0 in caso contrario

    • type: tipo dibuffer (0: formattato, 1: contenuto libero)

    • notify: livello di notifica per il buffer

    • num_displayed: numero delle finestre che visualizzano il buffer

    • active: 2 if buffer is the only active (merged), 1 se il buffer è attivo, 0 se il buffer è unito e non selezionato

    • hidden: 1 if buffer is hidden, otherwise 0 (WeeChat ≥ 1.0)

    • zoomed: 1 if buffer is merged and zoomed, otherwise 0 (WeeChat ≥ 1.0)

    • print_hooks_enabled: 1 se gli hook sulla stampa sono abilitati, altrimenti 0

    • day_change: 1 if messages for the day change are displayed, otherwise 0 (WeeChat ≥ 0.4.3)

    • clear: 1 if buffer can be cleared with command /buffer clear, otherwise 0 (WeeChat ≥ 1.0)

    • filter: 1 if filters are enabled on buffer, otherwise 0 (WeeChat ≥ 1.0)

    • lines_hidden: 1 se almeno una riga è nascosta sul buffer (filtrata), oppure 0 se vengono visualizzate tutte le righe

    • prefix_max_length: lunghezza massima del prefisso in questo buffer

    • time_for_each_line: 1 se l’ora è visualizzata per ogni riga nel buffer (predefinito), altrimenti 0

    • nicklist: 1 se la lista nick è abilitata, altrimenti 0

    • nicklist_case_sensitive: 1 se i nick sono sensibili alle maiuscole, altrimenti 0

    • nicklist_max_length: lunghezza massima per un nick

    • nicklist_display_groups: 1 se i gruppi vengono visualizzati, altrimenti 0

    • nicklist_count: number of nicks and groups in nicklist

    • nicklist_groups_count: number of groups in nicklist

    • nicklist_nicks_count: number of nicks in nicklist

    • nicklist_visible_count: numero di nick/gruppi visualizzati

    • input: 1 se l’input è abilitato, altrimenti 0

    • input_get_unknown_commands: 1 se i comandi sconosciuti vengono inviati alla callback di input, altrimenti 0

    • input_size: dimensione per l’input (in byte)

    • input_length: lunghezza dell’input (numero di caratteri)

    • input_pos: posizione del cursore nell’input del buffer

    • input_1st_display: primo carattere visualizzato su schermo

    • num_history: numero di comandi nella cronologia

    • text_search: tipo di ricerca nel testo:

      • 0: nessuna ricerca in questo momento

      • 1: ricerca all’indietro (direzione: messaggi più vecchi)

      • 2: ricerca in avanti (direzione: messaggi più nuovi)

    • text_search_exact: 1 se la ricerca testo è esatta

    • text_search_found: 1 se il testo viene trovato, altrimenti 0

Valore restituito:

  • valore intero della proprietà

Esempio in C:

Script (Python):

3.12.10. weechat_buffer_get_string

Restituisce il valore stringa di una proprietà del buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • property: nome proprietà:

    • plugin: nome del plugin che ha creato questo buffer ("core" per il buffer principale di WeeChat)

    • name: nome del buffer

    • full_name: nome completo del buffer ("plugin.nome") (WeeChat ≥ 0.3.7)

    • short_name: nome breve del buffer (nota: usato solo per il display e può essere cambiato dall’utente, questo nome non va usato per trovare il nome del buffer, utilizzare invece name, fullname o la variabile locale channel)

    • title: titolo del buffer

    • input: testo in ingresso

    • text_search_input: input salvato prima della ricerca nel testo

    • highlight_words: elenco di parole da evidenziare

    • highlight_regex: POSIX extended regular expression for highlight

    • highlight_tags_restrict: restrict highlights to messages with these tags

    • highlight_tags: force highlight on messages with these tags

    • hotlist_max_level_nicks: livello massimo della hotlist per alcuni nick

    • localvar_xxx: ottiene il contenuto della variabile locale "xxx" (sostituire "xxx" con il nome della variabile da leggere)

Valore restituito:

  • valore stringa della proprietà

Esempio in C:

Script (Python):

3.12.11. weechat_buffer_get_pointer

Restituisce il valore puntatore della proprietà di un buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • property: nome proprietà:

    • plugin: puntatore al plugin che ha creato questo buffer (NULL per il buffer principale di WeeChat)

    • highlight_regex_compiled: espressione regolare highlight_regex compilata

Valore restituito:

  • valore puntatore della proprietà

Esempio in C:

Script (Python):

3.12.12. weechat_buffer_set

Imposta il valore stringa della proprietà di un buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • property: nome della proprietà (see table below)

  • value: new value for property

Properties:

Nome Valore Descrizione

hotlist

"+", "-", WEECHAT_HOTLIST_LOW, WEECHAT_HOTLIST_MESSAGE, WEECHAT_HOTLIST_PRIVATE, WEECHAT_HOTLIST_HIGHLIGHT, "-1"

"+": abilita hotlist (impostazione globale , il puntatore al buffer pointer non è utilizzato)
"-": disabilita hotlist (impostazione globale, il puntatore al buffer non è utilizzato)
priorità: aggiunge il buffer alla hotlist con questa proprietà
"-1": remove buffer from hotlist (WeeChat ≥ 1.0)

completion_freeze

"0" oppure "1"

"0": no freeze of completion (default value) (impostazione globale, il puntatore al buffer non è utilizzato)
"1": do not stop completion when command line is updated (impostazione globale, il puntatore al buffer non è utilizzato)

unread

-

Imposta l’evidenziatore di lettura dopo l’ultima riga del buffer

display

"1" oppure "auto"

"1": passa a questo buffer nella finestra corrente
"auto": passa a questo buffer nella finestra corrente, l’evidenziatore di lettura non viene resettato

hidden
(WeeChat ≥ 1.0)

"0" oppure "1"

"0": unhide the buffer
"1": hide the buffer

number

numero

Sposta buffer a questo numero

name

qualsiasi stringa

Imposta nuovo nome per il buffer

short_name

qualsiasi stringa

Imposta nuovo nome breve per il buffer

type

"formatted" oppure "free"

Imposta tipo per il: "formatted" (per stampare i messaggi di chat), oppure "free" (per contenuto libero); when the value is "free", the property clear is forced to "0" (WeeChat ≥ 1.0)

notify

"0", "1", "2", "3"

Imposta il livello di notifica per il buffer: "0" = non aggiungere alla hotlist, "1" = aggiungere solo per gli eventi, "2" = aggiungere per eventi e messaggi, "3" = aggiungere per tutti i messaggi

print_hooks_enabled

"0" oppure "1"

"0" to disable print hooks, "1" to enable them (default for a new buffer)

day_change
(WeeChat ≥ 0.4.3)

"0" oppure "1"

"0" to hide messages for the day change, "1" to see them (default for a new buffer)

clear
(WeeChat ≥ 1.0)

"0" or "1"

"0" to prevent user from clearing buffer with the command /buffer clear, "1" to let user clear the buffer (default for a new buffer) (note: even when it is set to "0", the buffer can still be cleared with the function weechat_buffer_clear)

filter
(WeeChat ≥ 1.0)

"0" or "1"

"0": disable filters on buffer
"1": enable filters on buffer

title

qualsiasi stringa

Imposta nuovo titolo per il buffer

time_for_each_line

"0" oppure "1"

"0" per nascondere l’orario in tutte le righe del buffer, "1" per visualizzarlo su tutte le righe (predefinito per un nuovo buffer)

nicklist

"0" oppure "1"

"0" per rimuovere la lista nick per il buffer, "1" per aggiungere la lista nick per il buffer

nicklist_case_sensitive

"0" oppure "1"

"0" per avere una lista nick non sensibile alle maiuscole, "1" per una lista nick sensibile alle maiuscole

nicklist_display_groups

"0" oppure "1"

"0" per nascondere i gruppi nella lista nick, "1" per visualizzare i gruppi della lista nick

highlight_words

"-" oppure elenco di parole separato da virgole

"-" è un valore speciale per disabilitare qualsiasi evento su questo buffer, o un elenco di parole separate da virgole da evidenziare in questo buffer, ad esempio: "abc,def,ghi"

highlight_words_add

elenco di parole separate da virgole

Elenco di parole separate da virgole da evidenziare in questo buffer, queste parole vengono aggiunte alle parole evidenziate esistenti nel buffer

highlight_words_del

elenco di parole separate da virgole

Elenco di parole separate da virgole da rimuovere dalle parole evidenziate nel buffer

highlight_regex

qualsiasi stringa

POSIX extended regular expression for highlight

highlight_tags_restrict

elenco separato da virgole di tag

Restrict highlights to messages with these tags in this buffer (it is possible to combine many tags as a logical "and" with separator "+", for example: "nick_toto+irc_action")

highlight_tags

elenco separato da virgole di tag

Force highlight on messages with these tags in this buffer (it is possible to combine many tags as a logical "and" with separator "+", for example: "nick_toto+irc_action")

hotlist_max_level_nicks

elenco separado da virgole di "nick:livello"

Elenco separato da virgole di nick con il livello massimo per la hotlist su questo buffer (il livello può essere: -1: mai nella hotlist, 0: basso, 1: messaggio, 2: privato, 3: evento), ad esempio: "joe:2,mike:-1,robert:-1" (joe non produce eventi sul buffer, mike e robert non modificano la hotlist)

hotlist_max_level_nicks_add

elenco separato da virgole di "nick:livello"

Elenco separato da virgole di nick con il livello per la hotlist, questi nick vengono aggiunti a quelli esistenti nel buffer

hotlist_max_level_nicks_del

elenco separato da virgole di nick

Elenco separato da virgole di nick da rimuovere dai livelli massimi della hotlist

key_bind_xxx

qualsiasi stringa

Assegna un nuovo tasto xxx, specifico per questo buffer, il valore è il comando da eseguire per questo tasto

key_unbind_xxx

-

Rimuove l’assegnazione del tasto xxx per questo buffer

input

qualsiasi stringa

Imposta un nuovo valore per l’input del buffer

input_pos

posizione

Imposta la posizione del cursore per l’input del buffer

input_get_unknown_commands

"0" oppure "1"

"0" per disabilitare i comandi sconosciuti per questo buffer (comportamento predefinito), "1" per ricevere i comandi sconosciuti, ad esempio se l’utente digita "/unknowncmd", verrà ricevuto dal buffer (nessun errore riguardo il comando sconosciuto)

localvar_set_xxx

qualsiasi stringa

Imposta il nuovo valore per la variabile locale xxx (la variabile verrà creata se non esiste)

localvar_del_xxx

-

Rimuove la variabile locale xxx

Esempio in C:

Script (Python):

3.12.13. weechat_buffer_set_pointer

Imposta il valore puntatore per la proprietà di un buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • property: nome della proprietà:

    • close_callback: set close callback function

    • close_callback_data: set close callback data

    • input_callback: set input callback function

    • input_callback_data: set input callback data

    • nickcmp_callback: set nick comparison callback function (this callback is called when searching nick in nicklist) (WeeChat ≥ 0.3.9)

    • nickcmp_callback_data: set nick comparison callback data (WeeChat ≥ 0.3.9)

  • pointer: new pointer value for property

Prototypes for callbacks:

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.12.14. weechat_buffer_string_replace_local_var

Sostituisce le variabili globali in una stringa con i loro valori, utilizzando le variabili del buffer locale.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • string: stringa con testo e variabili locali che utilizzano il formato "$var"

Valore restituito:

  • stringa con i valori delle variabili locali

Esempio in C:

Script (Python):

3.12.15. weechat_buffer_match_list

WeeChat ≥ 0.3.5.

Verifica se il buffer corrisponde ad una lista di buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • string: elenco separato da virgole di buffer:

    • "*" indica tutti i buffer

    • il nome preceduto da "!" viene escluso

    • wildcard "*" is allowed in name

Valore restituito:

  • 1 se il buffer coincide con la lista, altrimenti 0

Esempio in C:

Script (Python):

3.13. Finestre

Funzioni per richiedere finestre.

3.13.1. weechat_current_window

Restituisce il puntatore alla finestra corrente

Prototipo:

Valore restituito:

  • puntatore alla finestra corrente

Esempio in C:

Script (Python):

3.13.2. weechat_window_search_with_buffer

WeeChat ≥ 0.3.5.

Restituisce il puntatore alla finestra che mostra il buffer.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

Valore restituito:

  • puntatore alla finestra che mostra il buffer (NULL se nessuna finestra sta mostrando il buffer)

Esempio in C:

Script (Python):

3.13.3. weechat_window_get_integer

Restituisce il valore intero della proprietà di una finestra.

Prototipo:

Argomenti:

  • window: puntatore alla finestra

  • property: nome della proprietà:

    • number: numero della finestra (inizia da 1)

    • win_x: posizione X della finestra nel terminale (la prima colonna è 0)

    • win_y: posizione Y della finestra nel terminale (la prima riga è 0)

    • win_width: larghezza della finestra, in caratteri

    • win_height: altezza della finestra, in caratteri

    • win_width_pct: misura percentuale, paragonata alla finestra genitore (ad esempio 50 indica metà grandezza)

    • win_height_pct: misura percentuale, paragonata alla finestra genitore (ad esempio 50 indica metà grandezza)

    • win_chat_x: posizione X della finestra di chat nel terminale (la prima colonna è 0)

    • win_chat_y: posizione Y della finestra di chat nel terminale (la prima riga è 0)

    • win_chat_width: larghezza della finestra di chat, in caratteri

    • win_chat_height: altezza della finestra di chat, in caratteri

    • first_line_displayed: 1 se la prima riga del buffer viene visualizzata su schermo, altrimenti 0

    • scrolling: 1 se lo scorrimento è attivo sulla finestra (ultima riga non visualizzata)

    • lines_after: numero di righe non visualizzate dopo l’ultima visualizzata (durante lo scorrimento)

Valore restituito:

  • valore intero della proprietà

Esempio in C:

Script (Python):

3.13.4. weechat_window_get_string

Restituisce il valore stringa della proprietà di una finestra.

Nota
La funzione non è utilizzata oggi, è riservata per una versione futura.

Prototipo:

Argomenti:

  • window: puntatore alla finestra

  • property: nome della proprietà

Valore restituito:

  • valore stringa della proprietà

3.13.5. weechat_window_get_pointer

Restituisce il valore puntatore della proprietà di una finestra.

Prototipo:

Argomenti:

  • window: puntatore alla finestra

  • property: nome della proprietà:

    • current: puntatore alla finestra corrente

    • buffer: puntatore al buffer visualizzato dalla finestra

Valore restituito:

  • valore puntatore della proprietà

Esempio in C:

Script (Python):

3.13.6. weechat_window_set_title

Imposta il titolo per il terminale.

Prototipo:

Argomenti:

  • title: nuovo titolo per il terminale (NULL per resettarlo)

Esempio in C:

Script (Python):

3.14. Lista nick

Funzioni per il buffer nicklist.

3.14.1. weechat_nicklist_add_group

Aggiunge un gruppo in una lista nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • parent_group: puntatore al genitore del gruppo, NULL se il gruppo non ha genitore (lista nick radice)

  • name: nome del gruppo

  • color: nome per l’opzione colore:

    • nome opzione per WeeChat, ad esempio weechat.color.nicklist_group

    • colore con sfondo opzionale, ad esempio yellow o yellow,red

    • nome colore per la barra:

      • bar_fg: colore di primo piando per la barra

      • bar_delim: colore dei delimitatori per la barra

      • bar_bg: colore di sfondo per la barra

  • visible:

    • 1: gruppi e sottogruppi/nick sono visibili

    • 0: gruppi e sottogruppi/nick sono nascosti

Nota
Il nome del gruppo può iniziare con uno o più numeri, seguiti da una pipe, e infine dal nome del gruppo. Quando questa stringa si trova all’inizio, viene utilizzata per ordinare i gruppi nella lista nick. Ad esempio i gruppi "1|test" e "2|abc" verranno visualizzati in quest’ordine: prima "test" poi "abc".

Valore restituito:

  • puntatore al nuovo gruppo, NULL in caso di errore

Esempio in C:

Script (Python):

3.14.2. weechat_nicklist_search_group

Cerca un gruppo in una lista nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • from_group: ricerca solo da questo gruppo, se NULL, allora la cerca in tutta la lista nick

  • name: nome gruppo da cercare

Valore restituito:

  • puntatore al gruppo trovato, NULL se non trovato

Esempio in C:

Script (Python):

3.14.3. weechat_nicklist_add_nick

Aggiunge un nick in un gruppo.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore al gruppo

  • name: nome nick

  • color: nome dell’opzione per il colore:

    • nome opzione per WeeChat (da weechat.color.xxx), ad esempio chat_delimiters

    • colore con sfondo opzionale, ad esempio yellow o yellow,red

    • nome colore per la barra:

      • bar_fg: colore di primo piano per la barra

      • bar_delim: colore dei delimitatori per la barra

      • bar_bg: colore di sfondo per la barra

  • prefix: prefisso visualizzato prima del nick

  • prefix_color: nome dell’opzione per il colore:

    • nome opzione per WeeChat (da weechat.color.xxx), ad esempio chat_delimiters

    • colore con sfondo opzionale, ad esempio yellow o yellow,red

    • nome colore per la barra:

      • bar_fg: colore di primo piano per la barra

      • bar_delim: colore dei delimitatori per la barra

      • bar_bg: colore di sfondo per la barra

  • visible:

    • 1: il nick è visibile

    • 0: il nick è nascosto

Valore restituito:

  • puntatore al nuovo nick, NULL in caso di errore

Esempio in C:

Script (Python):

3.14.4. weechat_nicklist_search_nick

Cerca un nick nella lista nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • from_group: cerca solo da questo gruppo, se NULL, allora cerca nell’intera lista nick

  • name: nick da cercare

Valore restituito:

  • puntatore al nuovo nick, NULL se non trovato

Esempio in C:

Script (Python):

3.14.5. weechat_nicklist_remove_group

Rimuove un gruppo da una lista nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore al gruppo da rimuovere (verranno rimossi anhe i sottogruppi/nick)

Esempio in C:

Script (Python):

3.14.6. weechat_nicklist_remove_nick

Rimuove un nick dalla lista nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • nick: puntatore al nick da rimuovere

Esempio in C:

Script (Python):

3.14.7. weechat_nicklist_remove_all

Rimuove tutti i gruppi/nick da una lista nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

Esempio in C:

Script (Python):

3.14.8. weechat_nicklist_get_next_item

WeeChat ≥ 0.3.7.

Ottiene il prossimo gruppo oppure il nick dalla lista nick (usato principalmente per mostrare la lista nick).

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore sul puntatore al gruppo

  • nick: puntatore sul puntatore al nick

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.14.9. weechat_nicklist_group_get_integer

WeeChat ≥ 0.3.4.

Restituisce un valore intero della proprietà di un gruppo.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore al gruppo

  • property: nome della proprietà:

    • visible: 1 se il gruppo è visibile, altrimenti 0

    • level: livello del gruppo (root è 0)

Valore restituito:

  • valore intero della proprietà

Esempio in C:

Script (Python):

3.14.10. weechat_nicklist_group_get_string

WeeChat ≥ 0.3.4.

Restituisce il valore stringa della proprietà di un gruppo.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore al gruppo

  • property: nome della proprietà:

    • name: nome del gruppo

    • color: colore del gruppo nella lista nick

Valore restituito:

  • valore stringa della proprietà

Esempio in C:

Script (Python):

3.14.11. weechat_nicklist_group_get_pointer

WeeChat ≥ 0.3.4.

Restituisce il valore puntatore della proprietà di un gruppo.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore al gruppo

  • property: nome della proprietà:

    • parent: puntatore al gruppo genitore

Valore restituito:

  • valore puntatore della proprietà

Esempio in C:

Script (Python):

3.14.12. weechat_nicklist_group_set

WeeChat ≥ 0.3.4.

Imposta il valore stringa della proprietà di un gruppo.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • group: puntatore al gruppo

  • property: nome della proprietà (see table below)

  • value: new value for property

Properties:

Nome Valore Descrizione

color

nome per l’opzione del colore per WeeChat

Consultare l’argomento "color" della funzione weechat_nicklist_add_group

visible

"0", "1"

"0" = gruppo nascosto, "1" = gruppo visibile

Esempio in C:

Script (Python):

3.14.13. weechat_nicklist_nick_get_integer

WeeChat ≥ 0.3.4.

Restituisce il valore intero della proprietà di un nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • nick: puntatore al nick

  • property: nome della proprietà:

    • visible: 1 se il nick è visibile, altrimenti 0

Valore restituito:

  • valore intero della proprietà

Esempio in C:

Script (Python):

3.14.14. weechat_nicklist_nick_get_string

WeeChat ≥ 0.3.4.

Restituisce il valore stringa della proprietà di un nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • nick: puntatore al nick

  • property: nome della proprietà:

    • name: nome del nick

    • color: colore del nick nella lista nick

    • prefix: prefisso del nick

    • prefix_color: colore del prefisso nella lista nick

Valore restituito:

  • valore stringa della proprietà

Esempio in C:

Script (Python):

3.14.15. weechat_nicklist_nick_get_pointer

WeeChat ≥ 0.3.4.

Restituisce il valore puntatore della proprietà di un nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • nick: puntatore al nick

  • property: nome proprietà:

    • group: puntatore al gruppo che contiene questo nick

Valore restituito:

  • valore puntatore della proprietà

Esempio in C:

Script (Python):

3.14.16. weechat_nicklist_nick_set

WeeChat ≥ 0.3.4.

Imposta il valore stringa della proprietà di un nick.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer

  • nick: puntatore al nick

  • property: nome della proprietà (see table below)

  • value: new value for property

Properties:

Nome Valore Descrizione

color

nome per l’opzione del colore di WeeChat

Consultare l’argomento "color" della funzione weechat_nicklist_add_nick

prefix

qualsiasi stringa

Prefisso del nick

prefix_color

nome per l’opzione del colore di WeeChat

Consultare l’argomento "prefix_color" della funzione weechat_nicklist_add_nick

visible

"0", "1"

"0" = nick nascosto, "1" = nick visibile

Esempi in C:

Script (Python):

3.15. Barre

Funzioni per le barre.

Cerca un elemento barra.

Prototipo:

Argomenti:

  • name: nome dell’elemento barra

Valore restituito:

  • puntatore all’elemento barra trovato, NULL se non trovato

Esempio in C:

Script (Python):

3.15.2. weechat_bar_item_new

Updated in 0.4.2.

Crea un nuovo elemento barra.

Prototipo:

Argomenti:

  • name: nome dell’elemento barra

  • build_callback: funzione chiamata quando l’elemento barra viene compilato, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_gui_bar_item *item: puntatore all’elemento barra

    • struct t_gui_window *window: puntatore alla finestra (NULL when called for a root bar)

    • struct t_gui_buffer *buffer: buffer displayed in window (if window is NULL, then it is current buffer) or buffer given in bar item with syntax: "@buffer:item" (WeeChat ≥ 0.4.2)

    • struct t_hashtable *extra_info: always NULL (argument is reserved for a future version) (WeeChat ≥ 0.4.2)

    • valore restituito: contenuto dell’elemento barra

  • build_callback_data: puntatore fornito alla callback quando chiamata da WeeChat

Valore restituito:

  • puntatore al nuovo elemento barra, NULL se non trovato

Esempio in C:

Script (Python):

Importante
For compatibility with versions ≤ 0.4.1, the default callback has only 3 arguments: data, item and window (no buffer and extra_info).
To use a callback with all arguments, you must add "(extra)" before the name, see example below (supported only in WeeChat ≥ 0.4.2).

3.15.3. weechat_bar_item_update

Aggiorna il contenuto dell’elemento barra, chiamando la callback che lo ha compilato.

Prototipo:

Argomenti:

  • name: nome dell’elemento barra

Esempio in C:

Script (Python):

3.15.4. weechat_bar_item_remove

Rimuove un elemento barra.

Prototipo:

Argomenti:

  • item: puntatore all’elemento barra

Esempio in C:

Script (Python):

Cerca una barra.

Prototipo:

Argomenti:

  • name: nome della barra

Valore restituito:

  • puntatore alla barra trovata, NULL se non trovata

Esempio in C:

Script (Python):

3.15.6. weechat_bar_new

Crea una nuova barra.

Prototipo:

Argomenti:

  • name: nome della barra

  • hidden:

    • on: la barra è nascosta

    • off: la barra è visibile

  • priority: priorità per la barra (intero)

  • type:

    • root: barra visualizzata una sola volta, al di fuori delle finestre

    • window: barra visualizzata in ogni finestra

  • condition: condizioni per la visualizzazione della barra:

    • active: la barra viene visualizzata solo nella finestra attiva

    • inactive: la barra viene visualizzata solo nelle finestre inattive

    • nicklist: la barra viene visualizzata nelle finestre con liste nick

    • evaluated expression: see chapter about bars in WeeChat User’s guide

  • position: top, bottom, left o right

  • filling_top_bottom:

    • horizontal: gli elementi sono posizionati in orizzontale (spazio dopo ogni elemento)

    • vertical: gli elementi sono posizionati in verticale (nuova riga dopo ogni elemento)

    • columns_horizontal: gli elementi sono posizionati in orizzontale, visualizzati su colonne

    • columns_vertical: gli elementi sono posizionati in verticale, visualizzati su colonne

  • filling_left_right:

    • horizontal: gli elementi sono posizionati in orizzontale (spazio dopo ogni elemento)

    • vertical: gli elementi sono posizionati in verticale (nuova riga dopo ogni elemento)

    • columns_horizontal: gli elementi sono posizionati in orizzontale, visualizzati su colonne

    • columns_vertical: gli elementi sono posizionati in verticale, visualizzati su colonne

  • size: dimensione della barra in caratteri (0 corrisponde a dimensione automatica)

  • size_max: dimensione massima per la barra (0 corrisponde a nessuna dimensione massima)

  • color_fg: colore per il testo nella barra

  • color_delim: colore per i delimitatori nella barra

  • color_bg: colore di sfondo per la barra

  • separator:

    • on: la barra ha una riga di separazione con altre finestre/barre

    • off: nessun separatore

  • items: elenco di elemento nella barra, separati da virgola (spazio tra gli elementi), o "+" (elementi incollati)

Valore restituito:

  • puntatore alla nuova barra, NULL in caso di errore

Esempio in C:

Script (Python):

3.15.7. weechat_bar_set

Imposta un nuovo valore per la proprietà di una barra.

Prototipo:

Argomenti:

  • bar: puntatore alla barra

  • property: name, hidden, priority, conditions, position, filling_top_bottom, filling_left_right, size, size_max, color_fg, color_delim, color_bg, separator, items (consultare weechat_bar_new)

  • value: nuovo valore per la proprietà

Valore restituito:

  • 1 se il nuovo valore è stato impostato, 0 in caso di errore

Esempio in C:

Script (Python):

3.15.8. weechat_bar_update

Aggiorna il contenuto di una barra su schermo.

Prototipo:

Argomenti:

  • name: nome della barra

Esempio in C:

Script (Python):

3.15.9. weechat_bar_remove

Rimuove una barra.

Prototipo:

Argomenti:

  • bar: puntatore alla barra

Esempio in C:

Script (Python):

3.16. Comandi

Funzioni per eseguire comandi di WeeChat.

3.16.1. weechat_command

Updated in 1.1.

Esegue un comando.

Prototipo:

Argomenti:

  • buffer: puntatore al buffer (il comando viene eseguito su questo buffer, utilizzare NULL per il buffer corrente)

  • command: comando da eseguire (se preceduto da "/"), oppure il testo viene inviato sul buffer

Valori restituiti: (WeeChat ≥ 1.1)

  • WEECHAT_RC_OK se l’operazione ha successo

  • WEECHAT_RC_ERROR se c'è un errore

Esempio in C:

Script (Python):

3.17. Network

Funzioni di rete.

3.17.1. weechat_network_pass_proxy

Stabilisce una connessione/autenticazione con un proxy.

Importante
This function is blocking on call to connect(), so it must be called in a forked process only, to not block WeeChat.

Prototipo:

Argomenti:

  • proxy: nome del proxy da utilizzare

  • sock: socket da utilizzare

  • address: indirizzo (nome host o indirizzo IP)

  • port: port

Valore restituito:

  • 1 se la connessione è andata a buon fine, 0 in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.17.2. weechat_network_connect_to

Updated in 0.4.3.

Stabilisce una connessione con un host remoto.

Importante
This function is blocking on call to connect(), so it must be called in a forked process only, to not block WeeChat.

Prototipo:

Argomenti:

  • proxy: nome del proxy da utilizzare

  • address: address to connect to (with port)

  • address_length: length of argument address

Valore restituito:

  • socket number (>= 0) if connection is OK, -1 if an error occurred

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.18. Info

Funzioni per ottenere info.

3.18.1. weechat_info_get

Restituisce la info, come stringa, da WeeChat o da un plugin.

Prototipo:

Argomenti:

  • info_name: nome delle informazioni da leggere (see table below)

  • arguments: argomenti per l’informazione richiesta (opzionake, NULL se non è richiesto alcun argomento)

Valore restituito:

  • stringa con l’informazione richiesta, NULL in caso di errore

Infos:

Plugin Nome Descrizione Argomenti

aspell

aspell_dict

elenco separato da virgole di dizionari usati nel buffer

puntatore al buffer ("0x12345678") o buffer con il nome completo ("irc.freenode.weechat")

fifo

fifo_filename

nome della pipe FIFO

-

irc

irc_buffer

ottiene puntatore al buffer per un server/canale/nick IRC

server,canale,nick (canale e nick sono opzionali)

irc

irc_is_channel

1 se la stringa è il nome di un canale IRC valido per il server

server,canale (server è opzionale)

irc

irc_is_nick

1 se la stringa è un nick IRC valido

nick

irc

irc_nick

ottiene nick corrente su un server

nome server

irc

irc_nick_color

ottiene il codice del colore del nick

nick

irc

irc_nick_color_name

ottiene il nome del colore del nick

nick

irc

irc_nick_from_host

ottiene nick dall’host IRC

host IRC (come :nick!nome@server.com)

irc

irc_server_isupport

1 se il server supporta questa caratteristica (dal messaggio IRC 005)

server,caratteristica

irc

irc_server_isupport_value

valore della caratteristica, se supportata dal servre (dal messaggio IRC 005)

server,caratteristica

python

python2_bin

path per l’interprete python 2.x

-

relay

relay_client_count

number of clients for relay

status name (optional): connecting, waiting_auth, connected, auth_failed, disconnected

weechat

charset_internal

set caratteri interno di WeeChat

-

weechat

charset_terminal

set caratteri terminale

-

weechat

color_ansi_regex

POSIX extended regular expression to search ANSI escape codes

-

weechat

color_rgb2term

RGB color converted to terminal color (0-255)

rgb,limit (limit is optional and is set to 256 by default)

weechat

color_term2rgb

terminal color (0-255) converted to RGB color

color (terminal color: 0-255)

weechat

cursor_mode

1 se la modalità cursore è abilitata

-

weechat

date

data di compilazione di WeeChat

-

weechat

dir_separator

separatore directory

-

weechat

filters_enabled

1 se i filtri sono abilitati

-

weechat

inactivity

inattività della tastiera (secondi)

-

weechat

locale

locale usato per la traduzione dei messaggi

-

weechat

term_height

height of terminal

-

weechat

term_width

width of terminal

-

weechat

version

versione di WeeChat

-

weechat

version_git

Versione git di weechat (output del comando "git describe" solo per la versione di sviluppo, vuoto per una release stabile)

-

weechat

version_number

versione di WeeChat (come numero)

-

weechat

weechat_dir

directory WeeChat

-

weechat

weechat_libdir

directory "lib" di WeeChat

-

weechat

weechat_localedir

directory "locale" di WeeChat

-

weechat

weechat_sharedir

directory "share" di WeeChat

-

weechat

weechat_site

sito di WeeChat

-

weechat

weechat_site_download

sito di WeeChat, pagina di download

-

weechat

weechat_upgrading

1 se si sta aggiornando WeeChat (comando /upgrade)

-

Esempio in C:

Script (Python):

3.18.2. weechat_info_get_hashtable

WeeChat ≥ 0.3.4.

Restituisce una info, come tabella hash, da WeeChat o da un plugin.

Prototipo:

Argomenti:

  • info_name: nome della info da leggere (see table below)

  • hashtable: tabella hash con argomenti (dipende dalla info richiesta)

  • (opzionale, NULL se l’argomento non viene richiesto)

Valore restituito:

  • tabella hash con la info richiesta, NULL in caso di errore

Infos:

Plugin Nome Descrizione Tabella hash (input) Tabella hash (output)

irc

irc_message_parse

controlla un messaggio IRC

"message": messaggio IRC, "server": nome server (opzionale)

"tags": tag, "message_without_tags": messaggio senza tag, "nick": nick, "host": nome host, "command": comando, "channel": canale, "arguments": argomenti (include il canale)

irc

irc_message_split

divide un messaggio IRC (per adattarlo in 512 byte)

"message": messaggio IRC, "server": nome server (opzionale)

"msg1" … "msgN": messaggio da inviare (senza "\r\n" finale), "args1" … "argsN": argomenti dei messaggi, "count": numero di messaggi

Esempio in C:

Script (Python):

3.19. Liste info

Una lista info è una lista di "elementi". Ciascun elemento contiene delle variabili.

Ad esempio, la lista info "irc_server" ha N elementi (N è il numero di server IRC definiti). Per ogni elemento, esistono variabili come "name", "buffer", "is connected",…

Ogni variabile ha un tipo e un valore. I tipi possibili sono:

  • integer: qualunque valore intero

  • string: qualunque valore stringa

  • pointer: qualunque puntatore

  • buffer: buffer di lunghezza fissa, contenente qualunque dato

  • time: valore tempo

3.19.1. weechat_infolist_new

Crea una nuova lista info.

Prototipo:

Valore restituito:

  • puntatore alla nuova lista info

Esempio in C:

Script (Python):

3.19.2. weechat_infolist_new_item

Aggiunge un elemento alla lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

Valore restituito:

  • puntatore al nuovo elemento

Esempio in C:

Script (Python):

3.19.3. weechat_infolist_new_var_integer

Aggiunge una variabile intera ad un elemento della lista info.

Prototipo:

Argomenti:

  • item: puntatore all’elemento della lista info

  • name: nome variabile

  • value: valore intero

Valore restituito:

  • puntatore alla nuova variabile

Esempio in C:

Script (Python):

3.19.4. weechat_infolist_new_var_string

Aggiunge una variabile stringa ad un elemento della lista info.

Prototipo:

Argomenti:

  • item: puntatore all’elemento della lista info

  • name: nome variabile

  • value: valore stringa

Valore restituito:

  • puntatore alla nuova variabile

Esempio in C:

Script (Python):

3.19.5. weechat_infolist_new_var_pointer

Aggiunge una variabile puntatore ad un elemento della lista info.

Prototipo:

Argomenti:

  • item: puntatore all’elemento della lista info

  • name: nome variabile

  • pointer: puntatore

Valore restituito:

  • puntatore alla nuova variabile

Esempio in C:

Script (Python):

3.19.6. weechat_infolist_new_var_buffer

Aggiunge una variabile puntatore ad un elemento della lista info.

Prototipo:

Argomenti:

  • item: puntatore all’elemento della lista info

  • name: nome della variabile

  • pointer: puntatore al buffer

  • size: dimensione del buffer

Valore restituito:

  • puntatore alla nuova variabile

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.19.7. weechat_infolist_new_var_time

Aggiunge una variabile tempo ad un elemento della lista info.

Prototipo:

Argomenti:

  • item: puntatore all’elemento della lista info

  • name: nome della variabile

  • time: valore tempo

Valore restituito:

  • puntatore alla nuova variabile

Esempio in C:

Script (Python):

3.19.8. weechat_infolist_get

Restituisce una lista info da WeeChat o da un plugin.

Importante
Il contenuto della lista info è un duplicato dei dati attuali. Se si sta richiedendo una lista info con molti dati (come "buffer_lines"), WeeChat allocherà memoria per duplicare tutti i dati, e potrebbe essere necessario un po' di tempo.
Invece di usare liste info più grandi, è preferibilie usare hdata (ma le liste info potrebbero avere più info di hdata, che sono dati raw), consultare hdata.

Prototipo:

Argomenti:

  • infolist_name: nome della lista info da leggere (see table below)

  • pointer: puntatore ad un elemento, per ricevere solo questo elemento nella lista info (opzionale, può essere NULL)

  • arguments: argomenti per la lista info richiesta (opzionale, NULL se non è necessario alcun argomento)

Valore restituito:

  • puntatore alla lista info, NULL in caso di errore

Infolists:

Plugin Nome Descrizione Puntatore Argomenti

alias

alias

elenco di alias

puntatore all’alias (opzionale)

alias name (wildcard "*" is allowed) (optional)

guile

guile_script

elenco degli script

puntatore allo script (opzionale)

script name (wildcard "*" is allowed) (optional)

irc

irc_channel

elenco dei canali per un server IRC

puntatore al canale (opzionale)

server,canale (canale è opzionale)

irc

irc_color_weechat

mapping between IRC color codes and WeeChat color names

-

-

irc

irc_ignore

elenco di ignore IRC

puntatore all’ignore (opzionale)

-

irc

irc_nick

elenco dei nick per un canale IRC

puntatore al nick (opzionale)

server,channel,nick (nick is optional)

irc

irc_notify

elenco delle notifiche

puntatore alla notifica (opzionale)

server name (wildcard "*" is allowed) (optional)

irc

irc_server

elenco di server IRC

puntatore al server (opzionale)

server name (wildcard "*" is allowed) (optional)

logger

logger_buffer

elenco dei buffer logger

puntatore al logger (opzionale)

-

lua

lua_script

elenco degli script

puntatore allo script (opzionale)

script name (wildcard "*" is allowed) (optional)

perl

perl_script

elenco degli script

puntatore allo script (opzionale)

script name (wildcard "*" is allowed) (optional)

python

python_script

elenco degli script

puntatore allo script (opzionale)

script name (wildcard "*" is allowed) (optional)

relay

relay

elenco di client relay

puntatore al relay (opzionale)

-

ruby

ruby_script

elenco degli script

puntatore allo script (opzionale)

script name (wildcard "*" is allowed) (optional)

script

script_script

elenco degli script

puntatore allo script (opzionale)

script name with extension (wildcard "*" is allowed) (optional)

tcl

tcl_script

elenco degli script

puntatore allo script (opzionale)

script name (wildcard "*" is allowed) (optional)

weechat

bar

elenco delle barre

puntatore alla barra (opzionale)

bar name (wildcard "*" is allowed) (optional)

weechat

bar_item

elenco degli elementi barra

puntatore all’elemento della barra (opzionale)

bar item name (wildcard "*" is allowed) (optional)

weechat

bar_window

elenco delle finestre barra

puntatore alla finestra della barra (opzionale)

-

weechat

buffer

elenco dei buffer

puntatore al buffer (opzionale)

buffer name (wildcard "*" is allowed) (optional)

weechat

buffer_lines

righe di un buffer

puntatore al buffer

-

weechat

filter

elenco dei filtri

-

filter name (wildcard "*" is allowed) (optional)

weechat

history

cronologia dei comandi

puntatore al buffer (se non impostato, restituisce la cronologia globale) (opzionale)

-

weechat

hook

elenco di hook

puntatore all’hook (opzionale)

type,arguments (type is command/timer/.., arguments to get only some hooks (wildcard "*" is allowed), both are optional)

weechat

hotlist

elenco dei buffer nella hotlist

-

-

weechat

key

elenco di tasti associati

-

contesto ("default", "search", "cursor" o "mouse") (opzionale)

weechat

layout

elenco dei layout

-

-

weechat

nicklist

nick nella lista nick per un buffer

puntatore al buffer

nick_xxx o group_xxx per ottenere solo xxx di nick/group (opzionale)

weechat

option

elenco delle opzioni

-

option name (wildcard "*" is allowed) (optional)

weechat

plugin

elenco dei plugin

puntatore al plugin (opzionale)

plugin name (wildcard "*" is allowed) (optional)

weechat

proxy

elenco dei proxy

puntatore al proxy (opzionale)

proxy name (wildcard "*" is allowed) (optional)

weechat

url_options

opzioni per la URL

-

-

weechat

window

elenco delle finestre

puntatore alla finestra (opzionale)

"current" per la finestra corrente o un numero della finestra (opzionale)

xfer

xfer

elenco di xfer

puntatore a xfer (opzionale)

-

Esempio in C:

Script (Python):

3.19.9. weechat_infolist_next

Sposta "cursor" all’elemento successivo nella lista info. La prima chiamata a questa funzione per una lista info sposta il cursore al primo elemento nella lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

Valore restituito:

  • 1 se il cursore è stato spostato sull’elemento successivo, 0 se è stata raggiunta la fine della lista

Esempio in C:

Script (Python):

3.19.10. weechat_infolist_prev

Sposta "cursor" all’elemento precedente nella lista info. La prima chiamata a questa funzione per una lista info sposta il cursore all’ultimo elemento.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

Valore restituito:

  • 1 se il cursore è stato spostato sull’elemento precedente, 0 se è stato raggiunto l’inizio della lista

Esempio in C:

Script (Python):

3.19.11. weechat_infolist_reset_item_cursor

Ripristina "cursor" per la lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

Esempio in C:

Script (Python):

3.19.12. weechat_infolist_search_var

WeeChat ≥ 0.4.3.

Search a variable in the current infolist item.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

  • name: nome della variabile

Valore restituito:

  • pointer to variable found, NULL if the variable was not found

Esempio in C:

Script (Python):

3.19.13. weechat_infolist_fields

Restituisce una lista di campi per l’elemento della lista info corrente.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

Valore restituito:

  • stringa con una lista di campi per l’elemento della lista info corrente. La lista è separata da virgole, e contiene lettere per tipo, seguite dal nome della variabile. I tipi sono: "i" (intero), "s" (stringa), "p" (puntatore), "b" (buffer), "t" (tempo).

Esempio in C:

Script (Python):

3.19.14. weechat_infolist_integer

Restituisce il valore della variabile intera nell’elemento corrente della lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

  • var: nome della variabile (deve essere di tipo "integer")

Valore restituito:

  • valore intero della variabile

Esempio in C:

Script (Python):

3.19.15. weechat_infolist_string

Restituisce il valore della variabile stringa nell’elemento della lista info corrente.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

  • var: nome della variabile (deve essere di tipo "string")

Valore restituito:

  • valore stringa della variabile

Esempio in C:

Script (Python):

3.19.16. weechat_infolist_pointer

Restituisce il valore della variabile puntatore nell’elemento della lista info corrente.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

  • var: nome della variabile (deve essere di tipo "pointer")

Valore restituito:

  • puntatore al valore della variabile

Esempio in C:

Script (Python):

3.19.17. weechat_infolist_buffer

Restituisce il valore della variabile buffer nell’elemento corrente della lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

  • var: nome della variabile (deve essere di tipo "buffer")

  • size: puntatore ad una variabile intera, verrà impostata con la dimensione del buffer

Valore restituito:

  • puntatore al buffer

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.19.18. weechat_infolist_time

Restituisce il valore della variabile data/ora nell’elemento attivo della lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

  • var: nome della variabile (deve essere di tipo "time")

Valore restituito:

  • valore della variabile nel formato data/ora

Esempio in C:

Script (Python):

3.19.19. weechat_infolist_free

Libera una lista info.

Prototipo:

Argomenti:

  • infolist: puntatore alla lista info

Esempio in C:

Script (Python):

3.20. Hdata

Funzioni per hdata (accesso raw a WeeChat o ai dati dei plugin).

Importante
Hdata fornisce un accesso in sola lettura ai dati. È SEVERAMENTE VIETATO scrivere qualcosa in memoria puntato dalle variabili in hdata.
The only way to update data is to call function weechat_hdata_update.

3.20.1. weechat_hdata_new

WeeChat ≥ 0.3.6, updated in 0.3.9 and 0.4.0.

Crea un nuovo hdata.

Nota
hdata vs infolist

Hdata è un metodo veloce per leggere i dati di WeeChat o dei plugin. È simile alle liste info, ma ci sono alcune differenze:

  • è più veloce ed usa meno memoria: lettura diretta dei dati senza duplicazione

  • può contenere informazioni differenti rispetto alle liste info: esso contiene solo dati raw in strutture (le liste info possono aggiungere alcuni dati extra per convenienza)

Prototipo:

Argomenti:

  • hdata_name: nome di un hdata

  • var_prev: nome della variabile nella struttura che è puntatore all’elemento precedente nella lista (può essere NULL se non è disponibile tale variabile)

  • var_next: nome della variabile nella struttura che è puntatore all’elemento successivo nella lista (può essere NULL se non è disponibile tale variabile)

  • create_allowed: 1 if create of structure is allowed, otherwise 0 (WeeChat ≥ 0.4.0)

  • delete_allowed: 1 if delete of structure is allowed, otherwise 0 (WeeChat ≥ 0.3.9)

  • callback_update: callback to update data in hdata, can be NULL if no update is allowed (WeeChat ≥ 0.3.9), arguments and return value:

    • void *data: pointer

    • struct t_hdata *hdata: pointer to hdata

    • struct t_hashtable *hashtable: hashtable with variables to update (see weechat_hdata_update)

    • return value: number of variables updated

  • callback_update_data: pointer given to update callback when it is called by WeeChat (WeeChat ≥ 0.3.9)

Valore restituito:

  • puntatore al nuovo hdata

Esempio in C: source,C]

struct t_hdata *hdata = weechat_hdata_new ("myplugin_list", "prev", "next", 0, 0, &callback_update, NULL);
Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.20.2. weechat_hdata_new_var

WeeChat ≥ 0.3.6, updated in 0.3.9

Crea una nuova variabile in hdata.

Prototipo:

Argomenti:

  • hdata: puntatore ad hdata

  • name: nome della variabile

  • offset: offset della variabile nella struttura

  • type: tipo variabile, una di:

    • WEECHAT_HDATA_CHAR

    • WEECHAT_HDATA_INTEGER

    • WEECHAT_HDATA_LONG

    • WEECHAT_HDATA_STRING

    • WEECHAT_HDATA_SHARED_STRING

    • WEECHAT_HDATA_POINTER

    • WEECHAT_HDATA_TIME

    • WEECHAT_HDATA_HASHTABLE

    • WEECHAT_HDATA_OTHER

  • update_allowed: 1 if update of variable is allowed, otherwise 0 (WeeChat ≥ 0.3.9)

  • array_size: not NULL only if a variable is an array, and it can be: (WeeChat ≥ 0.3.9)

    • name of variable in hdata: this variable will be used as size of array (dynamic size for array)

    • integer (as string): fixed size for array

    • *: automatic size: the size of array is computed by looking at values, when the first NULL is found (only for type string, pointer or hashtable)

  • hdata_name: nome di un hdata (se è un puntatore ad una struttura con dati)

Esempio in C:

La macro "WEECHAT_HDATA_VAR" può essere usata per accorciare il codice:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.20.3. weechat_hdata_new_list

WeeChat ≥ 0.3.6, updated in 1.0.

Crea una nuovo puntatore alla lista in hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • name: nome delal variabile

  • pointer: puntatore alla lista

  • flags: combination of following values: (WeeChat ≥ 1.0)

    • WEECHAT_HDATA_LIST_CHECK_POINTERS: list used to check pointers

Esempio in C:

La macro "WEECHAT_HDATA_LIST" può essere usata per accorciare il codice:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.20.4. weechat_hdata_get

WeeChat ≥ 0.3.6.

Restituisce hdata per una struttura di WeeChat o di un plugin.

Nota
Hdata non contiene dati, è una tabella hash con la posizione delle variabili nella struttura. Ciò indica che è necessario questo hdata ed un puntatore ad un oggetto di WeeChat/plugin per leggere dei dati.

Prototipo:

Argomenti:

  • hdata_name: nome di un hdata (see list below)

Valore restituito:

  • puntatore ad un hdata, NULL in caso di errore

List of hdata:

  • guile_callback: callback di uno script

    • plugin: guile

    • variables:

      • script (pointer, hdata: "guile_script")

      • function (string)

      • data (string)

      • config_file (pointer, hdata: "config_file")

      • config_section (pointer, hdata: "config_section")

      • config_option (pointer, hdata: "config_option")

      • hook (pointer)

      • buffer (pointer, hdata: "buffer")

      • bar_item (pointer, hdata: "bar_item")

      • upgrade_file (pointer)

      • prev_callback (pointer, hdata: "guile_callback")

      • next_callback (pointer, hdata: "guile_callback")

  • guile_script: elenco degli script

    • plugin: guile

    • variables:

      • filename (string)

      • interpreter (pointer)

      • name (string)

      • author (string)

      • version (string)

      • license (string)

      • description (string)

      • shutdown_func (string)

      • charset (string)

      • callbacks (pointer, hdata: "guile_callback")

      • unloading (integer)

      • prev_script (pointer, hdata: "guile_script")

      • next_script (pointer, hdata: "guile_script")

    • lists:

      • last_script

      • scripts

  • irc_channel: canale irc

    • plugin: irc

    • variables:

      • type (integer)

      • name (string)

      • topic (string)

      • modes (string)

      • limit (integer)

      • key (string)

      • join_msg_received (hashtable)

      • checking_away (integer)

      • away_message (string)

      • has_quit_server (integer)

      • cycle (integer)

      • part (integer)

      • nick_completion_reset (integer)

      • pv_remote_nick_color (string)

      • hook_autorejoin (pointer)

      • nicks_count (integer)

      • nicks (pointer, hdata: "irc_nick")

      • last_nick (pointer, hdata: "irc_nick")

      • nicks_speaking (pointer)

      • nicks_speaking_time (pointer, hdata: "irc_channel_speaking")

      • last_nick_speaking_time (pointer, hdata: "irc_channel_speaking")

      • join_smart_filtered (hashtable)

      • buffer (pointer, hdata: "buffer")

      • buffer_as_string (string)

      • prev_channel (pointer, hdata: "irc_channel")

      • next_channel (pointer, hdata: "irc_channel")

  • irc_channel_speaking: channel_speaking irc

    • plugin: irc

    • variables:

      • nick (string)

      • time_last_message (time)

      • prev_nick (pointer, hdata: "irc_channel_speaking")

      • next_nick (pointer, hdata: "irc_channel_speaking")

  • irc_ignore: ignore irc

    • plugin: irc

    • variables:

      • number (integer)

      • mask (string)

      • regex_mask (pointer)

      • server (string)

      • channel (string)

      • prev_ignore (pointer, hdata: "irc_ignore")

      • next_ignore (pointer, hdata: "irc_ignore")

    • lists:

      • irc_ignore_list

      • last_irc_ignore

  • irc_nick: nick irc

    • plugin: irc

    • variables:

      • name (string)

      • host (string)

      • prefixes (string)

      • prefix (string)

      • away (integer)

      • color (string)

      • prev_nick (pointer, hdata: "irc_nick")

      • next_nick (pointer, hdata: "irc_nick")

  • irc_notify: notify irc

    • plugin: irc

    • variables:

      • server (pointer, hdata: "irc_server")

      • nick (string)

      • check_away (integer)

      • is_on_server (integer)

      • away_message (string)

      • ison_received (integer)

      • prev_notify (pointer, hdata: "irc_notify")

      • next_notify (pointer, hdata: "irc_notify")

  • irc_redirect: redirezione irc

    • plugin: irc

    • variables:

      • server (pointer, hdata: "irc_server")

      • pattern (string)

      • signal (string)

      • count (integer)

      • current_count (integer)

      • string (string)

      • timeout (integer)

      • command (string)

      • assigned_to_command (integer)

      • start_time (time)

      • cmd_start (hashtable)

      • cmd_stop (hashtable)

      • cmd_extra (hashtable)

      • cmd_start_received (integer)

      • cmd_stop_received (integer)

      • cmd_filter (hashtable)

      • output (string)

      • output_size (integer)

      • prev_redirect (pointer, hdata: "irc_redirect")

      • next_redirect (pointer, hdata: "irc_redirect")

  • irc_redirect_pattern: schema per la redirezione irc

    • plugin: irc

    • variables:

      • name (string)

      • temp_pattern (integer)

      • timeout (integer)

      • cmd_start (string)

      • cmd_stop (string)

      • cmd_extra (string)

      • prev_redirect (pointer, hdata: "irc_redirect_pattern")

      • next_redirect (pointer, hdata: "irc_redirect_pattern")

    • lists:

      • irc_redirect_patterns

      • last_irc_redirect_pattern

  • irc_server: server irc

    • plugin: irc

    • variables:

      • name (string)

      • options (pointer)

      • temp_server (integer)

      • reloading_from_config (integer)

      • reloaded_from_config (integer)

      • addresses_count (integer)

      • addresses_array (string, array_size: "addresses_count")

      • ports_array (integer, array_size: "addresses_count")

      • retry_array (integer, array_size: "addresses_count")

      • index_current_address (integer)

      • current_address (string)

      • current_ip (string)

      • current_port (integer)

      • current_retry (integer)

      • sock (integer)

      • hook_connect (pointer, hdata: "hook")

      • hook_fd (pointer, hdata: "hook")

      • hook_timer_connection (pointer, hdata: "hook")

      • hook_timer_sasl (pointer, hdata: "hook")

      • is_connected (integer)

      • ssl_connected (integer)

      • disconnected (integer)

      • gnutls_sess (other)

      • tls_cert (other)

      • tls_cert_key (other)

      • unterminated_message (string)

      • nicks_count (integer)

      • nicks_array (string, array_size: "nicks_count")

      • nick_first_tried (integer)

      • nick_alternate_number (integer)

      • nick (string)

      • nick_modes (string)

      • cap_away_notify (integer)

      • isupport (string)

      • prefix_modes (string)

      • prefix_chars (string)

      • nick_max_length (integer)

      • casemapping (integer)

      • chantypes (string)

      • chanmodes (string)

      • monitor (integer)

      • monitor_time (time)

      • reconnect_delay (integer)

      • reconnect_start (time)

      • command_time (time)

      • reconnect_join (integer)

      • disable_autojoin (integer)

      • is_away (integer)

      • away_message (string)

      • away_time (time)

      • lag (integer)

      • lag_check_time (other)

      • lag_next_check (time)

      • lag_last_refresh (time)

      • cmd_list_regexp (pointer)

      • last_user_message (time)

      • last_away_check (time)

      • last_data_purge (time)

      • outqueue (pointer)

      • last_outqueue (pointer)

      • redirects (pointer, hdata: "irc_redirect")

      • last_redirect (pointer, hdata: "irc_redirect")

      • notify_list (pointer, hdata: "irc_notify")

      • last_notify (pointer, hdata: "irc_notify")

      • notify_count (integer)

      • join_manual (hashtable)

      • join_channel_key (hashtable)

      • join_noswitch (hashtable)

      • buffer (pointer, hdata: "buffer")

      • buffer_as_string (string)

      • channels (pointer, hdata: "irc_channel")

      • last_channel (pointer, hdata: "irc_channel")

      • prev_server (pointer, hdata: "irc_server")

      • next_server (pointer, hdata: "irc_server")

    • lists:

      • irc_servers

      • last_irc_server

  • lua_callback: callback di uno script

    • plugin: lua

    • variables:

      • script (pointer, hdata: "lua_script")

      • function (string)

      • data (string)

      • config_file (pointer, hdata: "config_file")

      • config_section (pointer, hdata: "config_section")

      • config_option (pointer, hdata: "config_option")

      • hook (pointer)

      • buffer (pointer, hdata: "buffer")

      • bar_item (pointer, hdata: "bar_item")

      • upgrade_file (pointer)

      • prev_callback (pointer, hdata: "lua_callback")

      • next_callback (pointer, hdata: "lua_callback")

  • lua_script: elenco degli script

    • plugin: lua

    • variables:

      • filename (string)

      • interpreter (pointer)

      • name (string)

      • author (string)

      • version (string)

      • license (string)

      • description (string)

      • shutdown_func (string)

      • charset (string)

      • callbacks (pointer, hdata: "lua_callback")

      • unloading (integer)

      • prev_script (pointer, hdata: "lua_script")

      • next_script (pointer, hdata: "lua_script")

    • lists:

      • last_script

      • scripts

  • perl_callback: callback di uno script

    • plugin: perl

    • variables:

      • script (pointer, hdata: "perl_script")

      • function (string)

      • data (string)

      • config_file (pointer, hdata: "config_file")

      • config_section (pointer, hdata: "config_section")

      • config_option (pointer, hdata: "config_option")

      • hook (pointer)

      • buffer (pointer, hdata: "buffer")

      • bar_item (pointer, hdata: "bar_item")

      • upgrade_file (pointer)

      • prev_callback (pointer, hdata: "perl_callback")

      • next_callback (pointer, hdata: "perl_callback")

  • perl_script: elenco degli script

    • plugin: perl

    • variables:

      • filename (string)

      • interpreter (pointer)

      • name (string)

      • author (string)

      • version (string)

      • license (string)

      • description (string)

      • shutdown_func (string)

      • charset (string)

      • callbacks (pointer, hdata: "perl_callback")

      • unloading (integer)

      • prev_script (pointer, hdata: "perl_script")

      • next_script (pointer, hdata: "perl_script")

    • lists:

      • last_script

      • scripts

  • python_callback: callback di uno script

    • plugin: python

    • variables:

      • script (pointer, hdata: "python_script")

      • function (string)

      • data (string)

      • config_file (pointer, hdata: "config_file")

      • config_section (pointer, hdata: "config_section")

      • config_option (pointer, hdata: "config_option")

      • hook (pointer)

      • buffer (pointer, hdata: "buffer")

      • bar_item (pointer, hdata: "bar_item")

      • upgrade_file (pointer)

      • prev_callback (pointer, hdata: "python_callback")

      • next_callback (pointer, hdata: "python_callback")

  • python_script: elenco degli script

    • plugin: python

    • variables:

      • filename (string)

      • interpreter (pointer)

      • name (string)

      • author (string)

      • version (string)

      • license (string)

      • description (string)

      • shutdown_func (string)

      • charset (string)

      • callbacks (pointer, hdata: "python_callback")

      • unloading (integer)

      • prev_script (pointer, hdata: "python_script")

      • next_script (pointer, hdata: "python_script")

    • lists:

      • last_script

      • scripts

  • ruby_callback: callback di uno script

    • plugin: ruby

    • variables:

      • script (pointer, hdata: "ruby_script")

      • function (string)

      • data (string)

      • config_file (pointer, hdata: "config_file")

      • config_section (pointer, hdata: "config_section")

      • config_option (pointer, hdata: "config_option")

      • hook (pointer)

      • buffer (pointer, hdata: "buffer")

      • bar_item (pointer, hdata: "bar_item")

      • upgrade_file (pointer)

      • prev_callback (pointer, hdata: "ruby_callback")

      • next_callback (pointer, hdata: "ruby_callback")

  • ruby_script: elenco degli script

    • plugin: ruby

    • variables:

      • filename (string)

      • interpreter (pointer)

      • name (string)

      • author (string)

      • version (string)

      • license (string)

      • description (string)

      • shutdown_func (string)

      • charset (string)

      • callbacks (pointer, hdata: "ruby_callback")

      • unloading (integer)

      • prev_script (pointer, hdata: "ruby_script")

      • next_script (pointer, hdata: "ruby_script")

    • lists:

      • last_script

      • scripts

  • script_script: script dal repository

    • plugin: script

    • variables:

      • name (string)

      • name_with_extension (string)

      • language (integer)

      • author (string)

      • mail (string)

      • version (string)

      • license (string)

      • description (string)

      • tags (string)

      • requirements (string)

      • min_weechat (string)

      • max_weechat (string)

      • md5sum (string)

      • url (string)

      • popularity (integer)

      • date_added (time)

      • date_updated (time)

      • status (integer)

      • version_loaded (string)

      • displayed (integer)

      • install_order (integer)

      • prev_script (pointer, hdata: "script_script")

      • next_script (pointer, hdata: "script_script")

    • lists:

      • last_script_repo

      • scripts_repo

  • tcl_callback: callback di uno script

    • plugin: tcl

    • variables:

      • script (pointer, hdata: "tcl_script")

      • function (string)

      • data (string)

      • config_file (pointer, hdata: "config_file")

      • config_section (pointer, hdata: "config_section")

      • config_option (pointer, hdata: "config_option")

      • hook (pointer)

      • buffer (pointer, hdata: "buffer")

      • bar_item (pointer, hdata: "bar_item")

      • upgrade_file (pointer)

      • prev_callback (pointer, hdata: "tcl_callback")

      • next_callback (pointer, hdata: "tcl_callback")

  • tcl_script: elenco degli script

    • plugin: tcl

    • variables:

      • filename (string)

      • interpreter (pointer)

      • name (string)

      • author (string)

      • version (string)

      • license (string)

      • description (string)

      • shutdown_func (string)

      • charset (string)

      • callbacks (pointer, hdata: "tcl_callback")

      • unloading (integer)

      • prev_script (pointer, hdata: "tcl_script")

      • next_script (pointer, hdata: "tcl_script")

    • lists:

      • last_script

      • scripts

  • bar: barra

    • plugin: weechat

    • variables:

      • name (string)

      • options (pointer)

      • items_count (integer)

      • items_subcount (pointer)

      • items_array (pointer)

      • items_buffer (pointer)

      • items_prefix (pointer)

      • items_name (pointer)

      • items_suffix (pointer)

      • bar_window (pointer, hdata: "bar_window")

      • bar_refresh_needed (integer)

      • prev_bar (pointer, hdata: "bar")

      • next_bar (pointer, hdata: "bar")

    • lists:

      • gui_bars

      • last_gui_bar

  • bar_item: elemento barra

    • plugin: weechat

    • variables:

      • plugin (pointer, hdata: "plugin")

      • name (string)

      • build_callback (pointer)

      • build_callback_data (pointer)

      • prev_item (pointer, hdata: "bar_item")

      • next_item (pointer, hdata: "bar_item")

    • lists:

      • gui_bar_items

      • last_gui_bar_item

  • bar_window: finestra della barra

    • plugin: weechat

    • variables:

      • bar (pointer, hdata: "bar")

      • x (integer)

      • y (integer)

      • width (integer)

      • height (integer)

      • scroll_x (integer)

      • scroll_y (integer)

      • cursor_x (integer)

      • cursor_y (integer)

      • current_size (integer)

      • items_count (integer)

      • items_subcount (pointer)

      • items_content (pointer)

      • items_num_lines (pointer)

      • items_refresh_needed (pointer)

      • screen_col_size (integer)

      • screen_lines (integer)

      • coords_count (integer)

      • coords (pointer)

      • gui_objects (pointer)

      • prev_bar_window (pointer, hdata: "bar_window")

      • next_bar_window (pointer, hdata: "bar_window")

  • buffer: buffer

    • plugin: weechat

    • variables:

      • plugin (pointer, hdata: "plugin")

      • plugin_name_for_upgrade (string)

      • number (integer)

      • layout_number (integer)

      • layout_number_merge_order (integer)

      • name (string)

      • full_name (string)

      • short_name (string)

      • type (integer)

      • notify (integer)

      • num_displayed (integer)

      • active (integer)

      • hidden (integer)

      • zoomed (integer)

      • print_hooks_enabled (integer)

      • day_change (integer)

      • clear (integer)

      • filter (integer)

      • close_callback (pointer)

      • close_callback_data (pointer)

      • closing (integer)

      • title (string)

      • own_lines (pointer, hdata: "lines")

      • mixed_lines (pointer, hdata: "lines")

      • lines (pointer, hdata: "lines")

      • time_for_each_line (integer)

      • chat_refresh_needed (integer)

      • nicklist (integer)

      • nicklist_case_sensitive (integer)

      • nicklist_root (pointer, hdata: "nick_group")

      • nicklist_max_length (integer)

      • nicklist_display_groups (integer)

      • nicklist_count (integer)

      • nicklist_groups_count (integer)

      • nicklist_nicks_count (integer)

      • nicklist_visible_count (integer)

      • nickcmp_callback (pointer)

      • nickcmp_callback_data (pointer)

      • input (integer)

      • input_callback (pointer)

      • input_callback_data (pointer)

      • input_get_unknown_commands (integer)

      • input_buffer (string)

      • input_buffer_alloc (integer)

      • input_buffer_size (integer)

      • input_buffer_length (integer)

      • input_buffer_pos (integer)

      • input_buffer_1st_display (integer)

      • input_undo_snap (pointer, hdata: "input_undo")

      • input_undo (pointer, hdata: "input_undo")

      • last_input_undo (pointer, hdata: "input_undo")

      • ptr_input_undo (pointer, hdata: "input_undo")

      • input_undo_count (integer)

      • completion (pointer, hdata: "completion")

      • history (pointer, hdata: "history")

      • last_history (pointer, hdata: "history")

      • ptr_history (pointer, hdata: "history")

      • num_history (integer)

      • text_search (integer)

      • text_search_exact (integer)

      • text_search_regex (integer)

      • text_search_regex_compiled (pointer)

      • text_search_where (integer)

      • text_search_found (integer)

      • text_search_input (string)

      • highlight_words (string)

      • highlight_regex (string)

      • highlight_regex_compiled (pointer)

      • highlight_tags_restrict (string)

      • highlight_tags_restrict_count (integer)

      • highlight_tags_restrict_array (pointer, array_size: "highlight_tags_restrict_count")

      • highlight_tags (string)

      • highlight_tags_count (integer)

      • highlight_tags_array (pointer, array_size: "highlight_tags_count")

      • hotlist_max_level_nicks (hashtable)

      • keys (pointer, hdata: "key")

      • last_key (pointer, hdata: "key")

      • keys_count (integer)

      • local_variables (hashtable)

      • prev_buffer (pointer, hdata: "buffer")

      • next_buffer (pointer, hdata: "buffer")

    • lists:

      • gui_buffer_last_displayed

      • gui_buffers

      • last_gui_buffer

  • buffer_visited: visited buffer

    • plugin: weechat

    • variables:

      • buffer (pointer, hdata: "buffer")

      • prev_buffer (pointer, hdata: "buffer_visited")

      • next_buffer (pointer, hdata: "buffer_visited")

    • lists:

      • gui_buffers_visited

      • last_gui_buffer_visited

  • completion: struttura con completamento

    • plugin: weechat

    • variables:

      • buffer (pointer, hdata: "buffer")

      • context (integer)

      • base_command (string)

      • base_command_arg_index (integer)

      • base_word (string)

      • base_word_pos (integer)

      • position (integer)

      • args (string)

      • direction (integer)

      • add_space (integer)

      • force_partial_completion (integer)

      • list (pointer)

      • word_found (string)

      • word_found_is_nick (integer)

      • position_replace (integer)

      • diff_size (integer)

      • diff_length (integer)

      • partial_list (pointer)

  • config_file: file di configurazione

    • plugin: weechat

    • variables:

      • plugin (pointer, hdata: "plugin")

      • name (string)

      • filename (string)

      • file (pointer)

      • callback_reload (pointer)

      • callback_reload_data (pointer)

      • sections (pointer, hdata: "config_section")

      • last_section (pointer, hdata: "config_section")

      • prev_config (pointer, hdata: "config_file")

      • next_config (pointer, hdata: "config_file")

    • lists:

      • config_files

      • last_config_file

  • config_option: opzione di configurazione

    • plugin: weechat

    • variables:

      • config_file (pointer, hdata: "config_file")

      • section (pointer, hdata: "config_section")

      • name (string)

      • type (integer)

      • description (string)

      • string_values (string, array_size: "*")

      • min (integer)

      • max (integer)

      • default_value (pointer)

      • value (pointer)

      • null_value_allowed (integer)

      • callback_check_value (pointer)

      • callback_check_value_data (pointer)

      • callback_change (pointer)

      • callback_change_data (pointer)

      • callback_delete (pointer)

      • callback_delete_data (pointer)

      • loaded (integer)

      • prev_option (pointer, hdata: "config_option")

      • next_option (pointer, hdata: "config_option")

  • config_section: sezione di configurazione

    • plugin: weechat

    • variables:

      • config_file (pointer, hdata: "config_file")

      • name (string)

      • user_can_add_options (integer)

      • user_can_delete_options (integer)

      • callback_read (pointer)

      • callback_read_data (pointer)

      • callback_write (pointer)

      • callback_write_data (pointer)

      • callback_write_default (pointer)

      • callback_write_default_data (pointer)

      • callback_create_option (pointer)

      • callback_create_option_data (pointer)

      • callback_delete_option (pointer)

      • callback_delete_option_data (pointer)

      • options (pointer, hdata: "config_option")

      • last_option (pointer, hdata: "config_option")

      • prev_section (pointer, hdata: "config_section")

      • next_section (pointer, hdata: "config_section")

  • filter: filtro

    • plugin: weechat

    • variables:

      • enabled (integer)

      • name (string)

      • buffer_name (string)

      • num_buffers (integer)

      • buffers (pointer)

      • tags (string)

      • tags_count (integer)

      • tags_array (pointer, array_size: "tags_count")

      • regex (string)

      • regex_prefix (pointer)

      • regex_message (pointer)

      • prev_filter (pointer, hdata: "filter")

      • next_filter (pointer, hdata: "filter")

    • lists:

      • gui_filters

      • last_gui_filter

  • history: cronologia dei comandi nel buffer

    • plugin: weechat

    • variables:

      • text (string)

      • next_history (pointer, hdata: "history")

      • prev_history (pointer, hdata: "history")

    • update allowed:

      • __create

      • __delete

    • lists:

      • gui_history

      • last_gui_history

  • hotlist: hotlist

    • plugin: weechat

    • variables:

      • priority (integer)

      • creation_time.tv_sec (time)

      • creation_time.tv_usec (long)

      • buffer (pointer)

      • count (integer, array_size: "4")

      • prev_hotlist (pointer, hdata: "hotlist")

      • next_hotlist (pointer, hdata: "hotlist")

    • lists:

      • gui_hotlist

      • last_gui_hotlist

  • input_undo: struttura con "undo"per la riga di input

    • plugin: weechat

    • variables:

      • data (string)

      • pos (integer)

      • prev_undo (pointer, hdata: "input_undo")

      • next_undo (pointer, hdata: "input_undo")

  • key: un tasto (scorciatoia da tastiera)

    • plugin: weechat

    • variables:

      • key (string)

      • area_type (pointer)

      • area_name (pointer)

      • area_key (string)

      • command (string)

      • score (integer)

      • prev_key (pointer, hdata: "key")

      • next_key (pointer, hdata: "key")

    • lists:

      • gui_default_keys

      • gui_default_keys_cursor

      • gui_default_keys_mouse

      • gui_default_keys_search

      • gui_keys

      • gui_keys_cursor

      • gui_keys_mouse

      • gui_keys_search

      • last_gui_default_key

      • last_gui_default_key_cursor

      • last_gui_default_key_mouse

      • last_gui_default_key_search

      • last_gui_key

      • last_gui_key_cursor

      • last_gui_key_mouse

      • last_gui_key_search

  • layout: layout

    • plugin: weechat

    • variables:

      • name (string)

      • layout_buffers (pointer, hdata: "layout_buffer")

      • last_layout_buffer (pointer, hdata: "layout_buffer")

      • layout_windows (pointer, hdata: "layout_window")

      • internal_id (integer)

      • internal_id_current_window (integer)

      • prev_layout (pointer, hdata: "layout")

      • next_layout (pointer, hdata: "layout")

    • lists:

      • gui_layout_current

      • gui_layouts

      • last_gui_layout

  • layout_buffer: layout del buffer

    • plugin: weechat

    • variables:

      • plugin_name (string)

      • buffer_name (string)

      • number (integer)

      • prev_layout (pointer, hdata: "layout_buffer")

      • next_layout (pointer, hdata: "layout_buffer")

  • layout_window: layout della finestra

    • plugin: weechat

    • variables:

      • internal_id (integer)

      • parent_node (pointer, hdata: "layout_window")

      • split_pct (integer)

      • split_horiz (integer)

      • child1 (pointer, hdata: "layout_window")

      • child2 (pointer, hdata: "layout_window")

      • plugin_name (string)

      • buffer_name (string)

  • line: struttura con una sola riga

    • plugin: weechat

    • variables:

      • data (pointer, hdata: "line_data")

      • prev_line (pointer, hdata: "line")

      • next_line (pointer, hdata: "line")

  • line_data: struttura con una riga di dati

    • plugin: weechat

    • variables:

      • buffer (pointer, hdata: "buffer")

      • y (integer)

      • date (time)

      • date_printed (time)

      • str_time (string)

      • tags_count (integer)

      • tags_array (shared_string, array_size: "tags_count")

      • displayed (char)

      • highlight (char)

      • refresh_needed (char)

      • prefix (shared_string)

      • prefix_length (integer)

      • message (string)

    • update allowed:

      • date (time)

      • date_printed (time)

      • tags_array (shared_string)

      • prefix (shared_string)

      • message (string)

  • lines: struttura con più righe

    • plugin: weechat

    • variables:

      • first_line (pointer, hdata: "line")

      • last_line (pointer, hdata: "line")

      • last_read_line (pointer, hdata: "line")

      • lines_count (integer)

      • first_line_not_read (integer)

      • lines_hidden (integer)

      • buffer_max_length (integer)

      • buffer_max_length_refresh (integer)

      • prefix_max_length (integer)

      • prefix_max_length_refresh (integer)

  • nick: nick nella lista nick

    • plugin: weechat

    • variables:

      • group (pointer, hdata: "nick_group")

      • name (shared_string)

      • color (shared_string)

      • prefix (shared_string)

      • prefix_color (shared_string)

      • visible (integer)

      • prev_nick (pointer, hdata: "nick")

      • next_nick (pointer, hdata: "nick")

  • nick_group: gruppo nella lista nick

    • plugin: weechat

    • variables:

      • name (shared_string)

      • color (shared_string)

      • visible (integer)

      • level (integer)

      • parent (pointer, hdata: "nick_group")

      • children (pointer, hdata: "nick_group")

      • last_child (pointer, hdata: "nick_group")

      • nicks (pointer, hdata: "nick")

      • last_nick (pointer, hdata: "nick")

      • prev_group (pointer, hdata: "nick_group")

      • next_group (pointer, hdata: "nick_group")

  • plugin: plugin

    • plugin: weechat

    • variables:

      • filename (string)

      • handle (pointer)

      • name (string)

      • description (string)

      • author (string)

      • version (string)

      • license (string)

      • charset (string)

      • debug (integer)

      • prev_plugin (pointer, hdata: "plugin")

      • next_plugin (pointer, hdata: "plugin")

    • lists:

      • last_weechat_plugin

      • weechat_plugins

  • proxy: proxy

    • plugin: weechat

    • variables:

      • name (string)

      • options (pointer)

      • prev_proxy (pointer, hdata: "proxy")

      • next_proxy (pointer, hdata: "proxy")

    • lists:

      • last_weechat_proxy

      • weechat_proxies

  • window: finestra

    • plugin: weechat

    • variables:

      • number (integer)

      • win_x (integer)

      • win_y (integer)

      • win_width (integer)

      • win_height (integer)

      • win_width_pct (integer)

      • win_height_pct (integer)

      • win_chat_x (integer)

      • win_chat_y (integer)

      • win_chat_width (integer)

      • win_chat_height (integer)

      • win_chat_cursor_x (integer)

      • win_chat_cursor_y (integer)

      • bar_windows (pointer, hdata: "bar_window")

      • last_bar_window (pointer, hdata: "bar_window")

      • refresh_needed (integer)

      • gui_objects (pointer)

      • buffer (pointer, hdata: "buffer")

      • layout_plugin_name (string)

      • layout_buffer_name (string)

      • scroll (pointer, hdata: "window_scroll")

      • ptr_tree (pointer, hdata: "window_tree")

      • prev_window (pointer, hdata: "window")

      • next_window (pointer, hdata: "window")

    • lists:

      • gui_current_window

      • gui_windows

      • last_gui_window

  • window_scroll: scorrimento delle info nella finestra

    • plugin: weechat

    • variables:

      • buffer (pointer, hdata: "buffer")

      • first_line_displayed (integer)

      • start_line (pointer, hdata: "line")

      • start_line_pos (integer)

      • scrolling (integer)

      • start_col (integer)

      • lines_after (integer)

      • prev_scroll (pointer, hdata: "window_scroll")

      • next_scroll (pointer, hdata: "window_scroll")

  • window_tree: albero delle finestre

    • plugin: weechat

    • variables:

      • parent_node (pointer, hdata: "window_tree")

      • split_pct (integer)

      • split_horizontal (integer)

      • child1 (pointer, hdata: "window_tree")

      • child2 (pointer, hdata: "window_tree")

      • window (pointer, hdata: "window")

    • lists:

      • gui_windows_tree

Esempio in C:

Script (Python):

3.20.5. weechat_hdata_get_var_offset

WeeChat ≥ 0.3.6.

Restituisce l’offset della variabile in hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • name: nome della variabile

Valore restituito:

  • offset della variabile, 0 in caso di errore

Esempio in C:

Script (Python):

3.20.6. weechat_hdata_get_var_type

WeeChat ≥ 0.3.6.

Restituisce il tipo di variabile in hdata (come intero).

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • name: nome della variabile

Valore restituito:

  • tipo della variabile, -1 in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.20.7. weechat_hdata_get_var_type_string

WeeChat ≥ 0.3.6.

Restituisce il tipo di variabile in hdata (come stringa).

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • name: nome della variabile

Valore restituito:

  • tipo della variabile, NULL in caso di errore

Esempio in C:

Script (Python):

3.20.8. weechat_hdata_get_var_array_size

WeeChat ≥ 0.3.9.

Return array size for variable in hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntarore all’oggetto di WeeChat/plugin

  • name: nome della variabile

Valore restituito:

  • array size for variable, -1 if variable is not an array or if an error occurred

Esempio in C:

Script (Python):

3.20.9. weechat_hdata_get_var_array_size_string

WeeChat ≥ 0.3.9.

Return array size for variable in hdata (as string).

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntarore all’oggetto di WeeChat/plugin

  • name: nome della variabile

Valore restituito:

  • array size for variable as string, NULL if variable is not an array or if an error occurred

Esempio in C:

Script (Python):

3.20.10. weechat_hdata_get_var_hdata

WeeChat ≥ 0.3.6.

Restituisce hdata per la variabile in hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • name: nome della variabile

Valore restituito:

  • hdata per la variabile, NULL in caso di nessun hdata presente o di errore

Esempio in C:

Script (Python):

3.20.11. weechat_hdata_get_var

WeeChat ≥ 0.3.6.

Restituisce il puntatore al contenuto della variabile in hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntarore all’oggetto di WeeChat/plugin

  • name: nome della variabile

Valore restituito:

  • puntatore al contenuto della variabile, NULL in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.20.12. weechat_hdata_get_var_at_offset

WeeChat ≥ 0.3.6.

Restituisce il puntatore al contenuto della variabile in hdata, usando un offset.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore ad un oggetto di WeeChat/plugin

  • offset: offset della variabile

Valore restituito:

  • puntatore al contenuto della variabile, NULL in caso di errore

Esempio in C:

Nota
Questa funzione non è disponibile nelle API per lo scripting.

3.20.13. weechat_hdata_get_list

WeeChat ≥ 0.3.6.

Restituisce il puntatore alla lista da hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • name: nome della lista

Valore restituito:

  • puntatore alla lista, NULL in caso di errore

Esempio in C:

Script (Python):

3.20.14. weechat_hdata_check_pointer

WeeChat ≥ 0.3.7, updated in 1.0.

Verifica se un puntatore è valido per un hdata e un puntatore della lista.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • list: puntatore alla lista; if NULL (WeeChat ≥ 1.0), the pointer is checked with the lists in hdata that have flag "check pointers" (see weechat_hdata_new_list), and if no such list exists, the pointer is considered as valid

  • pointer: puntatore da verificare

Valore restituito:

  • 1 se il puntatore è in lista, 0 in caso contrario

Esempio in C:

Script (Python):

3.20.15. weechat_hdata_move

WeeChat ≥ 0.3.6.

Sposta il puntatore ad un altro elemento nella lista.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore ad un oggetto di WeeChat/plugin

  • count: numero di salto(i) da eseguire (intero positivo o negativo, diverso da 0)

Valore restituito:

  • puntatore all’elemento raggiunto, NULL in caso di errore

Esempio in C:

Script (Python):

WeeChat ≥ 0.4.1.

Search element in a list: the expression search is evaluated for each element in list, until element is found (or end of list).

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore ad un oggetto di WeeChat/plugin

  • search: expression to evaluate, default pointer in expression is the name of hdata (and this pointer changes for each element in list); for help on expression, see command /eval in WeeChat User’s guide

  • move: number of jump(s) to execute after unsuccessful search (negative or positive integer, different from 0)

Valore restituito:

  • pointer to element found, NULL if not found

Esempio in C:

Script (Python):

3.20.17. weechat_hdata_char

WeeChat ≥ 0.3.7.

Restituisce il valore di una variabile char in una struttura dati usando hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "char"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore char della variabile

Esempio in C:

Script (Python):

3.20.18. weechat_hdata_integer

WeeChat ≥ 0.3.6.

Restituisce il valore di una variabile integer in una struttura dati usando hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "integer"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore intero della variabile

Esempio in C:

Script (Python):

3.20.19. weechat_hdata_long

WeeChat ≥ 0.3.6.

Restituisce il valore della variabile long della struttura usando hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "long"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore long della variabile

Esempio in C:

Script (Python):

3.20.20. weechat_hdata_string

WeeChat ≥ 0.3.6.

Restituisce il valore della variabile string nella struttura usando hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "string"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore stringa della variabile

Esempio in C:

Script (Python):

3.20.21. weechat_hdata_pointer

WeeChat ≥ 0.3.6.

Restituisce il valore della variabile puntatore nella struttura usando hdata.

Prototipo:

Argomenti:

  • hdata: hdata hdata

  • pointer: pointer all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "pointer"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore puntatore della variabile

Esempio in C:

Script (Python):

3.20.22. weechat_hdata_time

WeeChat ≥ 0.3.6.

Restituisce il valore della variabile time nella struttura usando hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "time"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore time della variabile

Esempio in C:

Script (Python):

3.20.23. weechat_hdata_hashtable

WeeChat ≥ 0.3.7.

Restituisce il valore di una variabile nella tabella hash nella struttura usando hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • pointer: puntatore all’oggetto di WeeChat/plugin

  • name: nome della variabile (deve essere di tipo "hashtable"); for arrays, the name can be "N|name" where N is the index in array (starting at 0), for example: "2|name"

Valore restituito:

  • valore della tabella hash della variabile (puntatore alla tabella hash)

Esempio in C:

Script (Python):

3.20.24. weechat_hdata_set

WeeChat ≥ 0.3.9.

Set new value for variable in a hdata.

Nota
This function can be called only in an update callback (see weechat_hdata_new and weechat_hdata_update), if the variable can be updated.

Prototipo:

Argomenti:

  • hdata: hdata pointer

  • pointer: pointer to WeeChat/plugin object

  • name: variable name (types allowed: char, integer, long, string, pointer, time)

  • value: new value for variable

Valore restituito:

  • 1 if ok, 0 if error

Esempio in C:

Nota
This function is not available in scripting API.

3.20.25. weechat_hdata_update

WeeChat ≥ 0.3.9.

Update data in a hdata.

Prototipo:

Argomenti:

  • hdata: hdata pointer

  • pointer: pointer to WeeChat/plugin object

  • hashtable: variables to update: keys are name of variables, values are new values for variables (keys and values are string), some special keys are allowed:

    • key __create_allowed (with any value): return 1 if create is allowed for structure, otherwise 0 (WeeChat ≥ 0.4.0)

    • key __delete_allowed (with any value): return 1 if delete is allowed for structure, otherwise 0

    • key __update_allowed, value is name of a variable: return 1 if update is allowed for this variable, otherwise 0

    • key __delete (with any value): delete structure (if allowed)

Valore restituito:

  • number of variables updated

Esempio in C:

Script (Python):

3.20.26. weechat_hdata_get_string

WeeChat ≥ 0.3.6.

Restituisce il valore stringa di una proprietà di hdata.

Prototipo:

Argomenti:

  • hdata: puntatore hdata

  • property: nome della proprietà:

    • var_keys: stringa con la lista di chiavi per le variabili in hdata (formato: "key1,key2,key3")

    • var_values: stringa con la lista di valori per le variabili in hdata (formato: "value1,value2,value3")

    • var_keys_values: stringa cona la lista di chiavi e valori per le variabili in hdata (formato: "key1:value1,key2:value2,key3:value3")

    • var_prev: nome della variabile nella struttura che fa da puntatore al precedente elemento nella lista

    • var_next: nome della variabile nella struttura che fa da puntatore al successivo elemento nella lista

    • list_keys: stringa con la lista di chiavi per le liste in hdata (formato: "key1,key2,key3")

    • list_values: stringa con la lista di valori per le liste in hdata (formato: "value1,value2,value3")

    • list_keys_values: stringa con la lista di chiavi e valori per le liste in hdata (formato: "key1:value1,key2:value2,key3:value3")

Valore restituito:

  • valore stringa della proprietà

Esempio in C:

Script (Python):

3.21. Aggiornamento

Funzioni per l’aggiornamento di WeeChat (comando "/upgrade").

3.21.1. weechat_upgrade_new

Crea o legge un file per l’aggiornamento.

Prototipo:

Argomenti:

  • filename: nome del file (l’estensione ".upgrade" verrà aggiunta a questo nome da WeeChat)

  • write:

    • 1: crea il file (in modalità scrittura, prima dell’aggiornamento)

    • 0: legge il file (dopo l’aggiornamento)

Valore restituito:

  • puntatore al file di aggiornamento

Esempio in C:

Script (Python):

3.21.2. weechat_upgrade_write_object

Scrive un oggetto nel file di aggiornamento.

Prototipo:

Argomenti:

  • upgrade_file: puntatore al file di aggiornamento

  • object_id: id per l’oggetto

  • infolist: lista info da scrivere nel file

Valore restituito:

  • 1 se ok, 0 se errore

Esempio in C:

Script (Python):

3.21.3. weechat_upgrade_read

Legge un file di aggiornamento.

Prototipo:

Argomenti:

  • upgrade_file: puntatore al file di aggiornamento

  • callback_read: funzione chiamata per ogni oggetto letto nel file di aggiornamento, argomenti e valore restituito:

    • void *data: puntatore

    • struct t_upgrade_file *upgrade_file: puntatore al file di aggiornamento

    • int object_id: id dell’oggetto

    • struct t_infolist *infolist: lista info con il contenuto dell’oggetto

    • valore restituito:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_read_data: puntatore assegnato per la lettura della chiamata quando chiamata da WeeChat

Valore restituito:

  • 1 se ok, 0 se errore

Esempio in C:

Script (Python):

3.21.4. weechat_upgrade_close

Chiude un file di aggiornamento.

Prototipo:

Argomenti:

  • upgrade_file: puntatore al file di aggiornamento

Esempio in C:

Script (Python):