Превод:

Ово упутство описује WeeChat чет клијент и део је програма WeeChat.

Последња верзија овог документа може да се нађе на следећој страници: https://weechat.org/doc

1. Увод

WeeChat (Wee Enhanced Environment for Chat) је бесплатни чет клијент, једноставан и брз, дизајниран за многе оперативне системе.

Ово упутство документује API додатака програма WeeChat, који за интеракцију са WeeChat језгром користе C додаци.

2. Додаци у програму WeeChat

Додатак је C програм који може да позива функције програма WeeChat дефинисане у интерфејсу.

Овом C програму нису потребни WeeChat изворни фајлови да би се компајлирао и може динамички да се учита у програм WeeChat командом /plugin.

Додатак мора да буде динамичка библиотека, коју оперативни систем динамички учитава. Под GNU/Linux, фајл има „.so” екстензију, а „.dll” под системом Windows.

Додатак мора да укључи фајл „weechat-plugin.h” (који се налази у изворном коду програма WeeChat). Овај фајл дефинише структуре и типове који се користе за комуникацију са програмом WeeChat.

Да бисте позивали функције програма WeeChat у формату који је приказан у API додатака, у функцији weechat_plugin_init морате декларисати и иницијализовати следећи глобални показивач:

struct t_weechat_plugin *weechat_plugin;

2.1. Макрои

Додатак мора да користи неке макрое (за дефиницију неких променљивих):

WEECHAT_PLUGIN_NAME("име")

име додатка

WEECHAT_PLUGIN_DESCRIPTION("опис")

кратак опис додатка

WEECHAT_PLUGIN_VERSION("1.0")

верзија додатка plugin version

WEECHAT_PLUGIN_LICENSE("GPL3")

лиценца додатка

WEECHAT_PLUGIN_PRIORITY(1000)

приоритет додатка (није обавезно, погледајте испод)

2.2. Главне функције

Додатак мора да користи две функције:

  • weechat_plugin_init

  • weechat_plugin_end

2.2.1. weechat_plugin_init

Ова функција се позива када програм WeeChat учита додатак.

Прототип:

int weechat_plugin_init (struct t_weechat_plugin *plugin,
                         int argc, char *argv[]);

Аргументи:

  • plugin: показивач на структуру додатка програма WeeChat, користи се за иницијализацију погодног глобалног показивача weechat_plugin

  • argc: број аргумената за додатак

  • argv: аргументи за додатак (погледајте испод)

Повратна вредност:

  • WEECHAT_RC_OK ако је успешно (додатак ће се учитати)

  • WEECHAT_RC_ERROR ако је дошло до грешке (додатак се НЕЋЕ учитати)

Аргументи додатка

Када програм WeeChat учита додатак, он прима листу аргумената у параметру argv и број аргумената у argc.

Аргументи могу бити:

  • аргументи командне линије када се покреће WeeChat бинарни фајл,

  • аргументи дати команди /plugin load xxx, када корисник ручно учитава додатак.

Када аргументи долазе из командне линије, додатку се прослеђују само следећи аргументи:

-a, --no-connect

Искључује ауто повезивање са серверима током покретања програма WeeChat.

-s, --no-script

Искључује ауто учитавање скрипти.

додатак:опција

Опције за додатак: шаљу се само опције у вези додатка, на пример додатку „irc” се шаљу само опције које почињу на irc:.

Приоритет додатка

Када се додаци аутоматски учитавају (на пример, током покретања), програм WeeChat најпре учитава све додатке, па затим позива init функције, користећи приоритет дефинисан у сваком додатку. Висок приоритет значи да се init функција прва позива.

Подразумевани приоритет је 1000 (са тим приоритетом, додатак се учитава након свих подразумеваних додатака).

Подразумевани додаци програма WeeChat се иницијализују у следећем редоследу:

  1. charset (16000)

  2. logger (15000)

  3. exec (14000)

  4. trigger (13000)

  5. spell (12000)

  6. alias (11000)

  7. buflist (10000)

  8. fifo (9000)

  9. typing (8000)

  10. xfer (7000)

  11. irc (6000)

  12. relay (5000)

  13. guile (4007)

  14. javascript (4006)

  15. lua (4005)

  16. perl (4004)

  17. php (4003)

  18. python (4002)

  19. ruby (4001)

  20. tcl (4000)

  21. script (3000)

  22. fset (2000)

2.2.2. weechat_plugin_end

Ова функција се позива када програм WeeChat уклони додатак из меморије.

Прототип:

int weechat_plugin_end (struct t_weechat_plugin *plugin);

Аргументи:

  • plugin: показивач на структуру додатка програма WeeChat

Повратна вредност:

  • WEECHAT_RC_OK ако је успешно

  • WEECHAT_RC_ERROR ако је дошло до грешке

2.3. Компајлирање додатка

Компајлирање не захтева WeeChat изворне фајлове, неопходан је само фајл weechat-plugin.h.

Да бисте компајлирали додатак који има само један фајл „toto.c” (на систему GNU/Linux):

$ gcc -fPIC -Wall -c toto.c
$ gcc -shared -fPIC -o toto.so toto.o

2.4. Учитавање додатка

Копирајте фајл toto.so у системски директоријум додатака (на пример /usr/local/lib/weechat/plugins) или у корисников директоријум додатака (на пример /home/user/.local/share/weechat/plugins).

У програму WeeChat:

/plugin load toto

2.5. Пример додатка

Комплетан пример додатка који обезбеђује команду /double: приказује аргументе два пута у текућем баферу, или два пута извршава команду (ОК, то и није баш нешто корисно, али ово је само пример!):

#include <stdlib.h>

#include "weechat-plugin.h"

WEECHAT_PLUGIN_NAME("double");
WEECHAT_PLUGIN_DESCRIPTION("Test plugin for WeeChat");
WEECHAT_PLUGIN_AUTHOR("Sébastien Helleu <flashcode@flashtux.org>");
WEECHAT_PLUGIN_VERSION("0.1");
WEECHAT_PLUGIN_LICENSE("GPL3");

struct t_weechat_plugin *weechat_plugin = NULL;


/* функција повратног позива за команду "/double" */

int
command_double_cb (const void *pointer, void *data,
                   struct t_gui_buffer *buffer,
                   int argc, char **argv, char **argv_eol)
{
    /* усрећите C компајлер */
    (void) pointer;
    (void) data;
    (void) buffer;
    (void) argv;

    if (argc > 1)
    {
        weechat_command (NULL, argv_eol[1]);
        weechat_command (NULL, argv_eol[1]);
    }

    return WEECHAT_RC_OK;
}

int
weechat_plugin_init (struct t_weechat_plugin *plugin,
                     int argc, char *argv[])
{
    weechat_plugin = plugin;

    weechat_hook_command ("double",
                          "Display two times a message "
                          "or execute two times a command",
                          "message | command",
                          "message: message to display two times\n"
                          "command: command to execute two times",
                          NULL,
                          &command_double_cb, NULL, NULL);

    return WEECHAT_RC_OK;
}

int
weechat_plugin_end (struct t_weechat_plugin *plugin)
{
    /* усрећите C компајлер */
    (void) plugin;

    return WEECHAT_RC_OK;
}

3. API додатака

Поглавља која следе описују функције у API, сортиране по категорији.

За сваку функцију, дајемо:

  • опис функције,

  • C прототип,

  • детаље аргумената,

  • повратну вредност

  • C пример,

  • пример у Python скрипти (синтакса за остале скрипт језике је слична).

3.1. Регистрација

Функције за регистрацију скрипте: користе се само у API скриптовања, не у C API.

3.1.1. register

Регистрација скрипте.

За више информација, погледајте WeeChat водич за скриптовање.

Скрипта (Python):

# прототип
def register(name: str, author: str, version: str, license: str, description: str, shutdown_function: str, charset: str) -> int: ...
Ова функција не постоји у C API.

3.2. Додаци

Функције које враћају инфо о додацима.

3.2.1. plugin_get_name

Враћа име додатка.

Прототип:

const char *weechat_plugin_get_name (struct t_weechat_plugin *plugin);

Аргументи:

  • plugin: показивач на структуру WeeChat додатка (може бити NULL)

Повратна вредност:

  • име додатка, „core” за језгро програма WeeChat (ако је показивач на додатак NULL)

C пример:

const char *name = weechat_plugin_get_name (plugin);

Скрипта (Python):

# прототип
def plugin_get_name(plugin: str) -> str: ...

# пример
plugin = weechat.buffer_get_pointer(weechat.current_buffer(), "plugin")
name = weechat.plugin_get_name(plugin)

3.3. Стрингови

Многе стринг функције наведене испод су већ доступне кроз стандардне C функције, али се препоручује да користите функције у овом API јер су оне безбедне за UTF-8 и локал.

3.3.1. charset_set

Поставља нови скуп карактера додатка (подразумевани скуп карактера је UTF-8, тако да ако ваш додатак користи UTF-8, нема потребе да позивате ову функцију).

Прототип:

void weechat_charset_set (const char *charset);

Аргументи:

  • charset: нови скуп карактера који желите да користите

C пример:

weechat_charset_set ("iso-8859-1");

Скрипта (Python):

# прототип
def charset_set(charset: str) -> int: ...

# пример
weechat.charset_set("iso-8859-1")

3.3.2. iconv_to_internal

Конвертује стринг у интерни скуп карактера програма WeeChat (UTF-8).

Прототип:

char *weechat_iconv_to_internal (const char *charset, const char *string);

Аргументи:

  • charset: скуп карактера који се конвертује

  • string: стринг који се конвертује

Повратна вредност:

  • конвертовани стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_iconv_to_internal ("iso-8859-1", "iso string: é à");
/* ... */
free (str);

Скрипта (Python):

# прототип
def iconv_to_internal(charset: str, string: str) -> str: ...

# пример
str = weechat.iconv_to_internal("iso-8859-1", "iso string: é à")

3.3.3. iconv_from_internal

Конвертује стринг из интерног скупа карактера програма WeeChat (UTF-8) у неки други.

Прототип:

char *weechat_iconv_from_internal (const char *charset, const char *string);

Аргументи:

  • charset: циљни скуп карактера

  • string: стринг који се конвертује

Повратна вредност:

  • конвертовани стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_iconv_from_internal ("iso-8859-1", "utf-8 string: é à");
/* ... */
free (str);

Скрипта (Python):

# прототип
def iconv_from_internal(charset: str, string: str) -> str: ...

# пример
str = weechat.iconv_from_internal("iso-8859-1", "utf-8 string: é à")

3.3.4. gettext

Враћа преведени стринг (зависно од локалног језика).

Прототип:

const char *weechat_gettext (const char *string);

Аргументи:

  • string: стринг који треба да се преведе

Повратна вредност:

  • преведени стринг или string ако не постоји превод на локални језик

C пример:

char *str = weechat_gettext ("hello");

Скрипта (Python):

# прототип
def gettext(string: str) -> str: ...

# пример
str = weechat.gettext("hello")

3.3.5. ngettext

Враћа преведени стринг користећи једнину или облик множине, зависно од аргумента count.

Прототип:

const char *weechat_ngettext (const char *string, const char *plural,
                              int count);

Аргументи:

  • string: стринг који треба да се преведе, у облику једнине

  • plural: стринг који треба да се преведе, у облику множине

  • count: користи се за избор између једнине и облика множине (избор се врши сагласно са локалним језиком)

Повратна вредност:

  • преведени стринг или string / plural ако се не постоји превод на локални језик

C пример:

char *str = weechat_ngettext ("file", "files", num_files);

Скрипта (Python):

# прототип
def ngettext(string: str, plural: str, count) -> str: ...

# пример
num_files = 2
str = weechat.ngettext("file", "files", num_files)

3.3.6. strndup

Враћа дуплирани стринг, са макс length карактера.

Прототип:

char *weechat_strndup (const char *string, int length);

Аргументи:

  • string: стринг који се дуплира

  • length: макс број карактера који може да се дуплира

Повратна вредност:

  • дуплирани стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_strndup ("abcdef", 3);  /* резултат: „abc” */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.7. string_cut

WeeChat ≥ 3.3.

Одсеца стринг након датог броја карактера и додаје необавезни суфикс на крај остатка стринга.

Прототип:

char *weechat_string_cut (const char *string, int length, int count_suffix, int screen, const char *cut_suffix);

Аргументи:

  • string: стринг које треба да се скрати

  • length: макс дужина

  • count_suffix: ако је 1, дужина суфикса се урачунава у макс дужину

  • screen: ако је 1, одсецање је базирано на ширини приказаних карактера

  • cut_suffix: суфикс који се додаје након што се стринг одсече

Повратна вредност:

  • скраћени стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_cut ("this is a test", 5, 1, 1, "…");  /* result: "this…" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.8. string_tolower

Конвертује UTF-8 стринг у мала слова.

Прототип:

void weechat_string_tolower (char *string);

Аргументи:

  • string: стринг који се конвертује

C пример:

char str[] = "AbCdé";
weechat_string_tolower (str);  /* str је сада: „abcdé” */
Ова функција није доступна у API скриптовања.

3.3.9. string_toupper

Конвертује UTF-8 стринг у велика слова.

Прототип:

void weechat_string_toupper (char *string);

Аргументи:

  • string: стринг који се конвертује

C пример:

char str[] = "AbCdé";
weechat_string_toupper (str);  /* str је сада: „ABCDé” */
Ова функција није доступна у API скриптовања.

3.3.10. strcasecmp

Ажурирано у верзији 1.0.

Поређење стрингова независно од величине слова и локал подешавања.

Прототип:

int weechat_strcasecmp (const char *string1, const char *string2);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_strcasecmp ("aaa", "CCC");  /* == -2 */
Ова функција није доступна у API скриптовања.

3.3.11. strcasecmp_range

WeeChat ≥ 0.3.7, ажурирано у верзији 1.0.

Поређење стрингова независно од величине слова и локал подешавања, употребом опсега за поређење величине слова.

Прототип:

int weechat_strcasecmp_range (const char *string1, const char *string2, int range);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

  • range: број карактера у поређењу по величини слова, на пример:

    • 26: A-Z се постављају на a-z

    • 29: A-Z [ \ ] се постављају на a-z { | }

    • 30: A-Z [ \ ] ^ се постављају на a-z { | } ~

Вредности 29 и 30 користе неки протоколи, као што је IRC.

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_strcasecmp_range ("nick{away}", "NICK[away]", 29);  /* == 0 */
Ова функција није доступна у API скриптовања.

3.3.12. strncasecmp

Ажурирано у верзији 1.0.

Поређење стрингова независно од величине слова и локал подешавања, за max карактера.

Прототип:

int weechat_strncasecmp (const char *string1, const char *string2, int max);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

  • max: максимални број карактера који се пореде

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_strncasecmp ("aabb", "aacc", 2);  /* == 0 */
Ова функција није доступна у API скриптовања.

3.3.13. strncasecmp_range

WeeChat ≥ 0.3.7, ажурирано у верзији 1.0.

Поређење стрингова независно од величине слова и локал подешавања, за max карактера, користећи опсег за поређење величине слова.

Прототип:

int weechat_strncasecmp_range (const char *string1, const char *string2, int max, int range);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

  • max: максимални број карактера који се пореде

  • range: број карактера у поређењу по величини слова, на пример:

    • 26: A-Z се постављају на a-z

    • 29: A-Z [ \ ] се постављају на a-z { | }

    • 30: A-Z [ \ ] ^ се постављају на a-z { | } ~

Вредности 29 и 30 користе неки протоколи, као што је IRC.

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_strncasecmp_range ("nick{away}", "NICK[away]", 6, 29);  /* == 0 */
Ова функција није доступна у API скриптовања.

3.3.14. strcmp_ignore_chars

Ажурирано у верзији 1.0.

Поређење стрингова према локал подешавању (и необавезно независно од величине слова), уз игнорисање неких карактера.

Прототип:

int weechat_strcmp_ignore_chars (const char *string1, const char *string2,
                                 const char *chars_ignored,
                                 int case_sensitive);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

  • chars_ignored: стринг са карактерима који се игноришу

  • case_sensitive: 1 за поређење које прави разлику у величини слова, у супротном 0

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_strcmp_ignore_chars ("a-b", "--a-e", "-", 1);  /* == -3 */
Ова функција није доступна у API скриптовања.

3.3.15. strcasestr

Ажурирано у верзији 1.3.

Претрага стринга независно од величине слова и локал подешавања.

Прототип:

const char *weechat_strcasestr (const char *string, const char *search);

Аргументи:

  • string: стринг

  • search: стринг који се тражи у string

Повратна вредност:

  • показивач на пронађени стринг, или NULL ако се не пронађе (WeeChat ≥ 1.3: показивач се враћа је const char * уместо char *)

C пример:

const char *pos = weechat_strcasestr ("aBcDeF", "de");  /* резултат: показивач на "DeF" */
Ова функција није доступна у API скриптовања.

3.3.16. strlen_screen

WeeChat ≥ 0.4.2.

Враћа број карактера на екрану који су потребни за приказивање UTF-8 стринга. Карактери који не могу да се одштампају имају ширину 1 (ово је разлика у односу на функцију utf8_strlen_screen).

Прототип:

int weechat_strlen_screen (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • број карактера на екрану који су потребни да се испише UTF-8 стринг

C пример:

int length_on_screen = weechat_strlen_screen ("é");  /* == 1 */

Скрипта (Python):

# прототип
def strlen_screen(string: str) -> int: ...

# пример
length = weechat.strlen_screen("é")  # 1

3.3.17. string_match

Ажурирано у верзији 1.0.

Провера да ли стринг задовољава маску.

Прототип:

int weechat_string_match (const char *string, const char *mask,
                          int case_sensitive);

Аргументи:

  • string: стринг

  • mask: маска са џокерима (*), сваки џокер хвата 0 или више карактера у стрингу

  • case_sensitive: 1 за поређење које прави разлику у величини слова, у супротном 0

Почевши од верзије 1.0, у маски се дозвољава употреба џокера (не само на почетку/крају маске).

Повратна вредност:

  • 1 ако стринг задовољава маску, у супротном 0

C пример:

int match1 = weechat_string_match ("abcdef", "abc*", 0);   /* == 1 */
int match2 = weechat_string_match ("abcdef", "*dd*", 0);   /* == 0 */
int match3 = weechat_string_match ("abcdef", "*def", 0);   /* == 1 */
int match4 = weechat_string_match ("abcdef", "*de*", 0);   /* == 1 */
int match5 = weechat_string_match ("abcdef", "*b*d*", 0);  /* == 1 */

Скрипта (Python):

# прототип
def string_match(string: str, mask: str, case_sensitive: int) -> int: ...

# примери
match1 = weechat.string_match("abcdef", "abc*", 0)   # == 1
match2 = weechat.string_match("abcdef", "*dd*", 0)   # == 0
match3 = weechat.string_match("abcdef", "*def", 0)   # == 1
match4 = weechat.string_match("abcdef", "*de*", 0)   # == 1
match5 = weechat.string_match("abcdef", "*b*d*", 0)  # == 1

3.3.18. string_match_list

WeeChat ≥ 2.5.

Проверава да ли стринг задовољава листу маски, при чему је дозвољена употреба негативних маски у формату „!реч”. Негативна маска има виши приоритет у односу на стандардну маску.

Прототип:

int weechat_string_match_list (const char *string, const char **masks,
                               int case_sensitive);

Аргументи:

  • string: стринг

  • masks: листа маски, са NULL након последње маске у листи; свака маска се пореди са стрингом функцијом string_match

  • case_sensitive: 1 за поређење које прави разлику у величини слова, у супротном 0

Повратна вредност:

  • 1 ако стринг задовољава листу маски (барем једна од маски је задовољена и ниједна од негативних маски), у супротном 0

C пример:

const char *masks[3] = { "*", "!abc*", NULL };
int match1 = weechat_string_match_list ("abc", masks, 0);     /* == 0 */
int match2 = weechat_string_match_list ("abcdef", masks, 0);  /* == 0 */
int match3 = weechat_string_match_list ("def", masks, 0);     /* == 1 */

Скрипта (Python):

# прототип
def string_match_list(string: str, masks: str, case_sensitive: int) -> int: ...

# примери
match1 = weechat.string_match("abc", "*,!abc*", 0)     # == 0
match2 = weechat.string_match("abcdef", "*,!abc*", 0)  # == 0
match3 = weechat.string_match("def", "*,!abc*", 0)     # == 1

3.3.19. string_expand_home

WeeChat ≥ 0.3.3.

Замењује водеће ~ стрингом са почетним директоријумом. Ако стринг не почиње са ~, онда се враћа исти стринг.

Прототип:

char *weechat_string_expand_home (const char *path);

Аргументи:

  • path: путања

Повратна вредност:

  • путања са водећим ~ замењеним са почетним директоријумом (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_expand_home ("~/file.txt");
/* резултат: "/home/user/file.txt" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.20. string_eval_path_home

WeeChat ≥ 1.3, ажурирано у верзији 3.2.

Израчунава путање у 3 корака:

  1. замењује водеће %h са почетним директоријумом програма WeeChat (подразумевано data )

  2. замењује водеће ~ са корисниковим почетним директоријумом (позивом string_expand_home),

  3. израчунава променљиве (погледајте string_eval_expression).

Прототип:

char *weechat_string_eval_path_home (const char *path,
                                     struct t_hashtable *pointers,
                                     struct t_hashtable *extra_vars,
                                     struct t_hashtable *options);

Аргументи:

  • path: путања

  • pointers: хеш табела за позив функције string_eval_expression

  • extra_vars: хеш табела за позив функције string_eval_expression

  • options: хеш табела за позив функције string_eval_expression, са једним од подржаних додатних кључева:

    • directory: WeeChat директоријум који се користи када се замењује %h, један од:

      • config

      • data (подразумевано)

      • cache

      • runtime

Повратна вредност:

  • израчуната путања (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_eval_path_home ("${weechat_config_dir}/test.conf", NULL, NULL, NULL);
/* резултат: "/home/user/.config/weechat/test.conf" */
/* ... */
free (str);

Скрипта (Python):

# прототип
def string_eval_path_home(path: str, pointers: Dict[str, str], extra_vars: Dict[str, str], options: Dict[str, str]) -> str: ...

# пример
path = weechat.string_eval_path_home("${weechat_config_dir}/test.conf", {}, {}, {})
# path == "/home/user/.config/weechat/test.conf"

3.3.21. string_remove_quotes

Уклања знаке навода са почетка и краја стринга (ако постоје размаци испред првог знака навода или након последњег, игноришу се).

Прототип:

char *weechat_string_remove_quotes (const char *string, const char *quotes);

Аргументи:

  • string: стринг

  • quotes: стринг са листом знакова навода

Повратна вредност:

  • стринг без знакова навода на почетку/крају (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_remove_quotes (string, " 'I can't' ", "'");
/* result: "I can't" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.22. string_strip

Одсеца карактере на почетку и/или крају стринга.

Прототип:

char *weechat_string_strip (const char *string, int left, int right,
                            const char *chars);

Аргументи:

  • string: стринг

  • left: одсеца карактере с лева ако је различито од 0

  • right: одсеца карактере с десна ако је различито од 0

  • chars: стринг са карактерима који треба да се одсеку

Повратна вредност:

  • одсечени стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_strip (".abc -", 0, 1, "- .");  /* result: ".abc" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.23. string_convert_escaped_chars

WeeChat ≥ 1.0.

Конвертује означене карактере у њихову вредност:

  • \": знак навода

  • \\: обрнута коса црта

  • \a: звучно упозорење (BEL)

  • \b: брисање у лево

  • \e: escape

  • \f: form feed

  • \n: прелом линије

  • \r: carriage return

  • \t: хоризонтални таб

  • \v: вертикални таб

  • \0ooo: карактер као октална вредност (ooo је од 0 до 3 цифре)

  • \xhh: карактер као хексадецимална вредност (hh је од 1 до 2 цифре)

  • \uhhhh: уникод карактер као хексадецимална вредност (hhhh је од 1 до 4 цифре)

  • \Uhhhhhhhh: уникод карактер као хексадецимална вредност (hhhhhhhh је од 1 до 8 цифара)

Прототип:

char *weechat_string_convert_escaped_chars (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • стринг у којем су означени карактери замењени својим вредностима (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_convert_escaped_chars ("snowman: \\u2603");
/* str == "snowman: ☃" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.24. string_mask_to_regex

Враћа регуларни израз изграђен маском, у којем је једини специјални карактер *. Сви остали специјални карактери за регуларни израз се означавају.

Прототип:

char *weechat_string_mask_to_regex (const char *mask);

Аргументи:

  • mask: маска

Повратна вредност:

  • регуларни израз, као стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *str_regex = weechat_string_mask_to_regex ("test*mask");
/* резултат: "test.*mask" */
/* ... */
free (str_regex);

Скрипта (Python):

# прототип
def string_mask_to_regex(mask: str) -> str: ...

# пример
regex = weechat.string_mask_to_regex("test*mask")  # "test.*mask"

3.3.25. string_regex_flags

WeeChat ≥ 0.3.7.

Враћа показивач на стринг након заставица и маску са заставицама за компајлирање регуларног израза.

Прототип:

const char *weechat_string_regex_flags (const char *regex, int default_flags, int *flags)

Аргументи:

  • regex: POSIX проширени регуларни израз

  • default_flags: комбинација следећих вредности (погледајте man regcomp):

    • REG_EXTENDED

    • REG_ICASE

    • REG_NEWLINE

    • REG_NOSUB

  • flags: вредност показивача се поставља заставицама које се користе у регуларном изразу (подразумеване заставице + заставице постављене у регуларном изразу)

Заставице морају да се налазе на почетку регуларног израза. Формат је: „(?eins-eins)стринг”.

Дозвољене су следеће заставице:

  • e: POSIX проширени регуларни израз (REG_EXTENDED)

  • i: не прави се разлика у величини слова (REG_ICASE)

  • n: оператори подударања било ког карактера се не подударају са преломом линије (REG_NEWLINE)

  • s: није потребна подршка за адресирање подударања подстрингова (REG_NOSUB)

Повратна вредност:

  • показивач у regex, иза заставица

C пример:

const char *regex = "(?i)test";
int flags;
const char *ptr_regex = weechat_string_regex_flags (regex, REG_EXTENDED, &flags);
/* ptr_regex == "test", flags == REG_EXTENDED | REG_ICASE */
Ова функција није доступна у API скриптовања.

3.3.26. string_regcomp

WeeChat ≥ 0.3.7.

Компајлира POSIX проширени регуларни израз користећи необавезне заставице на почетку стринга (за формат заставица, погледајте string_regex_flags).

Прототип:

int weechat_string_regcomp (void *preg, const char *regex, int default_flags)

Аргументи:

  • preg: показивач на regex_t структуру

  • regex: POSIX проширени регуларни израз

  • default_flags: комбинација следећих вредности (погледајте man regcomp):

    • REG_EXTENDED

    • REG_ICASE

    • REG_NEWLINE

    • REG_NOSUB

Повратна вредност:

  • исти повратни кôд као и функција regcomp (0 ако је OK, нека друга вредност у случају грешке, погледајте man regcomp)

Након употребе, регуларни израз preg мора да се очисти позивом „regfree”, у случају да је функција вратила 0 (OK).

C пример:

regex_t my_regex;
if (weechat_string_regcomp (&my_regex, "(?i)test", REG_EXTENDED) == 0)
{
    /* OK */
    /* ... */
    regfree (&my_regex);
}
else
{
    /* грешка */
    /* ... */
}
Ова функција није доступна у API скриптовања.

3.3.27. string_has_highlight

Проверава да ли стринг има једно или више истицања, користећи листу речи за истицање.

Прототип:

int weechat_string_has_highlight (const char *string,
                                  const char highlight_words);

Аргументи:

  • string: стринг

  • highlight_words: листа речи за истицање, раздвојених запетама

Повратна вредност:

  • 1 ако стринг има једно или више истицања, у супротном 0

C пример:

int hl = weechat_string_has_highlight ("мој тест стринг", "тест,реч2");  /* == 1 */

Скрипта (Python):

# прототип
def string_has_highlight(string: str, highlight_words: str) -> int: ...

# пример
highlight = weechat.string_has_highlight("my test string", "test,word2")  # 1

3.3.28. string_has_highlight_regex

WeeChat ≥ 0.3.4.

Проверава да ли стринг има једно или више истицања, користећи POSIX проширени регуларни израз.
За бар једно подударање регуларног израза над стрингом, он мора бити уоквирен граничницима (карактери различити од: алфанумерика, -, _ и |).

Прототип:

int weechat_string_has_highlight_regex (const char *string, const char *regex);

Аргументи:

  • string: стринг

  • regex: POSIX проширени регуларни израз

Повратна вредност:

  • 1 ако стринг има једно или више истицања, у супротном 0

C пример:

int hl = weechat_string_has_highlight_regex ("мој тест стринг", "тест|реч2");  /* == 1 */

Скрипта (Python):

# прототип
def string_has_highlight_regex(string: str, regex: str) -> int: ...

# пример
highlight = weechat.string_has_highlight_regex("мој тест стринг", "тест|реч2")  # 1

3.3.29. string_replace

Замењује сва појављивања стринга неким другим стрингом.

Прототип:

char *weechat_string_replace (const char *string, const char *search,
                              const char *replace);

Аргументи:

  • string: стринг

  • search: стринг који треба да се замени

  • replace: замена за стринг search

Повратна вредност:

  • стринг у којем је search замењено са replace (након употребе мора да се ослободи позивом „free”)

C пример:

char *str = weechat_string_replace ("test", "s", "x");  /* резултат: "text" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.30. string_replace_regex

WeeChat ≥ 1.0.

Замењује текст у стрингу помоћу регуларног израза, текста замене и необавезне функције повратног позива.

Прототип:

char *weechat_string_replace_regex (const char *string, void *regex,
                                    const char *replace, const char reference_char,
                                    char *(*callback)(void *data, const char *text),
                                    void *callback_data);

Аргументи:

  • string: стринг

  • regex: показивач на регуларни израз (regex_t структура) компајлираног WeeChat функцијом string_regcomp или regcomp (погледајте man regcomp)

  • replace: текст замене, у коме су дозвољене следеће референце:

    • $0 до $99: подударање 0 до 99 у регуларном изразу (0 је цело подударање, 1 до 99 су групе ухваћене заградама)

    • $+: последње подударање (са највишим бројем)

    • $.*N: подударање N (може бити + или 0 до 99), у коме су сви карактери замењени са * (карактер * може бити било који карактер између размака (32) и ~ (126))

  • reference_char: карактер који се користи за референце на подударања (обично је $)

  • callback: необавезна функција повратног позива која се позива за сваку референцу у replace (осим за подударања која се замењују карактером); функција повратног позива мора да врати:

    • ново алоцирани стринг: он се користи као текст замене (након употребе се ослобађа)

    • NULL: као текст замене се користи текст примљену у функцији повратног позива (без измена)

  • callback_data: показивач прослеђен функцији повратног позива када се позове

Повратна вредност:

  • стринг са замењеним текстом, NULL у случају проблема (након употребе мора да се ослободи позивом „free”)

C пример:

regex_t my_regex;
char *string;
if (weechat_string_regcomp (&my_regex, "([0-9]{4})-([0-9]{2})-([0-9]{2})",
                            REG_EXTENDED) == 0)
{
    string = weechat_string_replace_regex ("date: 2014-02-14", &my_regex,
                                           "$3/$2/$1", '$', NULL, NULL);
    /* string == "date: 14/02/2014" */
    if (string)
        free (string);
    regfree (&my_regex);
}
Ова функција није доступна у API скриптовања.

3.3.31. string_split

Ажурирано у верзијама 2.5, 2.6.

Дели стринг по једном или више граничника.

Прототип:

char **weechat_string_split (const char *string, const char *separators,
                             const char *strip_items, int flags,
                             int num_items_max, int *num_items);

Аргументи:

  • string: стринг који се дели

  • separators: граничници који се користе за поделу

  • strip_items: карактери који се одсецају од ставки које се враћају (лево/десно); није обавезном, може бити NULL

  • flags: комбинација вредности која мења подразумевано понашање; ако је вредност 0, користи се подразумевано понашање (нема одсецања граничника са почетка/краја стринга, вишеструки граничници се остављају какви јесу, па могу да се врате и празни стрингови); прихватају се следеће заставице:

    • WEECHAT_STRING_SPLIT_STRIP_LEFT: граничници се одсецају с лева (почетка стринга)

    • WEECHAT_STRING_SPLIT_STRIP_RIGHT: граничници се одсецају с десна (краја стринга)

    • WEECHAT_STRING_SPLIT_COLLAPSE_SEPS: више узастопних граничника се замењује једним

    • WEECHAT_STRING_SPLIT_KEEP_EOL: крај линије се задржава у свакој вредности

  • num_items_max: максимални број креираних ставки (0 = нема ограничења)

  • num_items: показивач на int који садржи број креираних ставки

У програму WeeChat верзије ≤ 2.4, аргумент flags се звао keep_eol и узимао је другачије вредности, које морају да се конвертују на следећи начин:
keep_eol flags

0

WEECHAT_STRING_SPLIT_STRIP_LEFT | WEECHAT_STRING_SPLIT_STRIP_RIGHT | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS

1

WEECHAT_STRING_SPLIT_STRIP_LEFT | WEECHAT_STRING_SPLIT_STRIP_RIGHT | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS | WEECHAT_STRING_SPLIT_KEEP_EOL

2

WEECHAT_STRING_SPLIT_STRIP_LEFT | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS | WEECHAT_STRING_SPLIT_KEEP_EOL

Повратна вредност:

  • низ стрингова, NULL у случају проблема (након употребе мора да се ослободи позивом string_free_split)

C пример:

char **argv;
int argc;

argv = weechat_string_split ("abc de  fghi ", " ", NULL, 0, 0, &argc);
/* result: argv[0] == "abc"
           argv[1] == "de"
           argv[2] == ""
           argv[3] == "fghi"
           argv[4] = ""
           argv[5] == NULL
           argc == 5
*/
weechat_string_free_split (argv);

argv = weechat_string_split ("abc de  fghi ", " ", NULL,
                             WEECHAT_STRING_SPLIT_STRIP_LEFT
                             | WEECHAT_STRING_SPLIT_STRIP_RIGHT
                             | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS,
                             0, &argc);
/* result: argv[0] == "abc"
           argv[1] == "de"
           argv[2] == "fghi"
           argv[3] == NULL
           argc == 3
*/
weechat_string_free_split (argv);

argv = weechat_string_split ("abc de  fghi ", " ", NULL,
                             WEECHAT_STRING_SPLIT_STRIP_LEFT
                             | WEECHAT_STRING_SPLIT_STRIP_RIGHT
                             | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS
                             | WEECHAT_STRING_SPLIT_KEEP_EOL,
                             0, &argc);
/* result: argv[0] == "abc de  fghi"
           argv[1] == "de  fghi"
           argv[2] == "fghi"
           argv[3] == NULL
           argc == 3
*/
weechat_string_free_split (argv);

argv = weechat_string_split ("abc de  fghi ", " ", NULL,
                             WEECHAT_STRING_SPLIT_STRIP_LEFT
                             | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS
                             | WEECHAT_STRING_SPLIT_KEEP_EOL,
                             0, &argc);
/* result: argv[0] == "abc de  fghi "
           argv[1] == "de  fghi "
           argv[2] == "fghi "
           argv[3] == NULL
           argc == 3
*/
weechat_string_free_split (argv);

argv = weechat_string_split (" abc, de,, fghi ", ",", " ",
                             WEECHAT_STRING_SPLIT_STRIP_LEFT
                             | WEECHAT_STRING_SPLIT_STRIP_RIGHT
                             | WEECHAT_STRING_SPLIT_COLLAPSE_SEPS,
                             0, &argc);
/* result: argv[0] == "abc"
           argv[1] == "de"
           argv[2] == "fghi"
           argv[3] == NULL
           argc == 3
*/
weechat_string_free_split (argv);
Ова функција није доступна у API скриптовања.

3.3.32. string_split_shell

WeeChat ≥ 1.0.

Дели стринг на начин на који командно окружење дели команду са аргументима.

Ова функција је C конверзија Python класе „shlex” (фајл: Lib/shlex.py у Python репозиторијуму), погледајте: https://docs.python.org/3/library/shlex.html.

Прототип:

char **weechat_string_split_shell (const char *string, int *num_items);

Аргументи:

  • string: стринг који се дели

  • num_items: показивач на int који садржи број креираних ставки

Повратна вредност:

  • низ стрингова, NULL у случају проблема (након употребе мора да се ослободи позивом string_free_split)

C пример:

char **argv;
int argc;
argv = weechat_string_split_shell ("test 'first arg'  \"second arg\"", &argc);
/* result: argv[0] == "test"
           argv[1] == "first arg"
           argv[2] == "second arg"
           argv[3] == NULL
           argc == 3
*/
weechat_string_free_split (argv);
Ова функција није доступна у API скриптовања.

3.3.33. string_free_split

Ослобађа меморију коју је употребило дељење стринга.

Прототип:

void weechat_string_free_split (char **split_string);

Аргументи:

  • split_string: стринг подељен функцијом string_split

C пример:

char *argv;
int argc;
argv = weechat_string_split (string, " ", 0, 0, &argc);
/* ... */
weechat_string_free_split (argv);
Ова функција није доступна у API скриптовања.

3.3.34. string_build_with_split_string

Изграђује стринг од подељеног стринга.

Прототип:

char *weechat_string_build_with_split_string (char **split_string,
                                              const char *separator);

Аргументи:

  • split_string: стринг подељен функцијом string_split

  • separator: стринг који се користи за раздвајање стрингова

Повратна вредност:

  • стринг изграђен са (након употребе мора да се ослободи позивом „free”)

C пример:

char **argv;
int argc;
argv = weechat_string_split ("abc def ghi", " ", 0, 0, &argc);
char *str = weechat_string_build_with_split_string (argv, ";");
/* str == "abc;def;ghi" */
/* ... */
free (str);
Ова функција није доступна у API скриптовања.

3.3.35. string_split_command

Дели листу команди раздвојених са separator (које у стрингу могу да се означе са \).

Прототип:

char **weechat_string_split_command (const char *command, char separator);

Аргументи:

  • command: команда која се дели

  • separator: граничник

Повратна вредност:

  • низ стрингова, NULL у случају проблема (након употребе мора да се ослободи позивом free_split_command)

C пример:

char **argv = weechat_string_split_command ("/command1 arg;/command2", ';');
/* result: argv[0] == "/command1 arg"
           argv[1] == "/command2"
           argv[2] == NULL
*/
weechat_free_split_command (argv);
Ова функција није доступна у API скриптовања.

3.3.36. string_free_split_command

Ослобађа меморију коју је употребила команда поделе.

Прототип:

void weechat_string_free_split_command (char **split_command);

Аргументи:

C пример:

char **argv = weechat_string_split_command ("/command1 arg;/command2", ';');
/* ... */
weechat_free_split_command (argv);
Ова функција није доступна у API скриптовања.

3.3.37. string_format_size

Изграђује стринг са форматираном величином фајла и јединицама преведеним на локални језик.

Прототип:

char *weechat_string_format_size (unsigned long long size);

Аргументи:

  • size: величина (у бајтовима)

Повратна вредност:

  • форматирани стринг (након употребе мора да се ослободи позивом „free”)

C примери:

/* примери са енглеским локал подешавањем */

char *str = weechat_string_format_size (0);  /* str == "0 bytes" */
/* ... */
free (str);

char *str = weechat_string_format_size (1);  /* str == "1 byte" */
/* ... */
free (str);

char *str = weechat_string_format_size (200);  /* str == "200 bytes" */
/* ... */
free (str);

char *str = weechat_string_format_size (15200);  /* str == "15.2 KB" */
/* ... */
free (str);

char *str = weechat_string_format_size (2097152);  /* str == "2.10 MB" */
/* ... */
free (str);

Скрипта (Python), WeeChat ≥ 2.2:

# прототип
def string_format_size(size: int) -> str: ...

# пример
str = weechat.string_format_size(15200)  # == "15.2 KB"

3.3.38. string_color_code_size

WeeChat ≥ 3.0.

Враћа величину (у бајтовима) WeeChat кода боје на почетку стринга.

Прототип:

int weechat_string_color_code_size (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • величина (у бајтовима) WeeChat кода боје на почетку стринга; ако је стринг NULL, празан или не почиње кодом боје, враћа се 0; ако стринг почиње са више кодова боје, враћа се само величина првог

C примери:

int size;

size = weechat_string_color_code_size ("test");  /* size == 0 */
size = weechat_string_color_code_size (weechat_color ("bold"));  /* size == 2 */
size = weechat_string_color_code_size (weechat_color ("yellow,red"));  /* size == 7 */

Скрипта (Python):

# прототип
def string_color_code_size(string: str) -> int: ...

# примери
size = weechat.string_color_code_size("test")  # size == 0
size = weechat.string_color_code_size(weechat.color("bold"))  # size == 2
size = weechat.string_color_code_size(weechat.color("yellow,red"))  # size == 7

3.3.39. string_remove_color

Уклања WeeChat боје из стринга.

Прототип:

char *weechat_string_remove_color (const char *string,
                                   const char *replacement);

Аргументи:

  • string: стринг

  • replacement: ако није NULL и није празно, WeeChat кодови боје се замењују првим карактером овог стринга, у супротном се из стринга уклањају WeeChat кодови боја и карактери који следе (ако су у вези боје)

Повратна вредност:

  • стринг без боја (након употребе мора да се ослободи позивом „free”)

C примери:

/* remove color codes */
char *str = weechat_string_remove_color (my_string1, NULL);
/* ... */
free (str);

/* replace color codes by "?" */
char *str = weechat_string_remove_color (my_string2, "?");
/* ... */
free (str);

Скрипта (Python):

# прототип
def string_remove_color(string: str, replacement: str) -> str: ...

# пример
str = weechat.string_remove_color(my_string, "?")

3.3.40. string_base_encode

WeeChat ≥ 2.4.

Кодира стринг као base 16, 32, или 64.

Прототип:

int weechat_string_base_encode (int base, const char *from, int length, char *to);

Аргументи:

  • base: 16, 32, или 64

  • from: стринг који се кодира

  • length: дужина стринга који се кодира (на пример strlen(from))

  • to: показивач на стринг у који се смешта резултат (мора бити довољне дужине, резултат је дужи од почетног стринга)

Повратна вредност:

  • дужина стринга смештеног у *to (не рачунајући завршно \0), -1 у случају грешке

C пример:

char *string = "abcdefgh", result[128];
int length;
length = weechat_string_base_encode (16, string, strlen (string), result);
/* length == 16, result == "6162636465666768" */
length = weechat_string_base_encode (32, string, strlen (string), result);
/* length == 16, result == "MFRGGZDFMZTWQ===" */
length = weechat_string_base_encode (64, string, strlen (string), result);
/* length == 12, result == "YWJjZGVmZ2g=" */
Ова функција није доступна у API скриптовања.

3.3.41. string_base_decode

WeeChat ≥ 2.4.

Декодира стринг кодиран у base 16, 32, или 64.

Прототип:

int weechat_string_base_decode (int base, const char *from, char *to);

Аргументи:

  • base: 16, 32, или 64

  • from: стринг који се декодира

  • to: показивач на стринг у који се смешта резултат (мора бити довољне дужине, резултат је краћи од почетног стринга)

Повратна вредност:

  • дужина стринга смештеног у *to (не рачунајући завршно \0), -1 у случају грешке

C пример:

char result[128];
int length;
length = weechat_string_base_decode (16, "6162636465666768", result);
/* length == 8, result == "abcdefgh" */
length = weechat_string_base_decode (32, "MFRGGZDFMZTWQ===", result);
/* length == 8, result == "abcdefgh" */
length = weechat_string_base_decode (64, "YWJjZGVmZ2g=", result);
/* length == 8, result == "abcdefgh" */
Ова функција није доступна у API скриптовања.

3.3.42. string_hex_dump

WeeChat ≥ 1.4.

Приказује приказ података као хексадецималне и ascii бајтове.

Прототип:

char *string_hex_dump (const char *data, int data_size, int bytes_per_line,
                       const char *prefix, const char *suffix);

Аргументи:

  • data: подаци који се приказују

  • data_size: број бајтова који се приказују у data

  • bytes_per_line: број бајтова који треба да се прикаже у свакој линији

  • prefix: префикс који се приказује на почетку сваке линије (није обавезан, може да буде NULL)

  • suffix: суфикс који се приказује на крају сваке линије (није обавезан, може да буде NULL)

Повратна вредност:

  • стринг са приказом података (након употребе мора да се ослободи позивом „free”)

C пример:

char *string = "abc def-ghi";
char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL);
/* dump == " >> 61 62 63 20 64 65 66 2D   a b c   d e f - \n"
           " >> 67 68 69                  g h i           "  */
Ова функција није доступна у API скриптовања.

3.3.43. string_is_command_char

WeeChat ≥ 0.3.2.

Проверава да ли је први карактер стринга командни карактер (подразумевани командни карактер је /).

Прототип:

int weechat_string_is_command_char (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • 1 ако је први карактер стринга командни карактер, у супротном 0

C примери:

int command_char1 = weechat_string_is_command_char ("/test");  /* == 1 */
int command_char2 = weechat_string_is_command_char ("test");   /* == 0 */

Скрипта (Python):

# прототип
def string_is_command_char(string: str) -> int: ...

# примери
command_char1 = weechat.string_is_command_char("/test")  # == 1
command_char2 = weechat.string_is_command_char("test")   # == 0

3.3.44. string_input_for_buffer

WeeChat ≥ 0.3.2.

Враћа показивач на текст уноса за бафер (показивач унутар „string” аргумента), или NULL ако стринг није команда.

Прототип:

const char *weechat_string_input_for_buffer (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • показивач у „string”, или NULL

C примери:

const char *str1 = weechat_string_input_for_buffer ("test");    /* "test"  */
const char *str2 = weechat_string_input_for_buffer ("/test");   /* NULL    */
const char *str3 = weechat_string_input_for_buffer ("//test");  /* "/test" */

Скрипта (Python):

# прототип
def string_input_for_buffer(string: str) -> str: ...

# примери
str1 = weechat.string_input_for_buffer("test")    # "test"
str2 = weechat.string_input_for_buffer("/test")   # ""
str3 = weechat.string_input_for_buffer("//test")  # "/test"

3.3.45. string_eval_expression

WeeChat ≥ 0.4.0, ажурирано у верзијама 0.4.2, 0.4.3, 1.0, 1.1, 1.2, 1.3, 1.6, 1.8, 2.0, 2.2, 2.3, 2.7, 2.9, 3.1, 3.2, 3.3 и 3.4.

Израчунава израз и враћа вредност као стринг. Специјалне променљиве у формату ${променљива} се развијају (погледајте табелу испод).

Почевши од верзије 1.0, подржава се угњеждавање променљивих, на пример: ${color:${променљива}}.

Прототип:

char *weechat_string_eval_expression (const char *expr,
                                      struct t_hashtable *pointers,
                                      struct t_hashtable *extra_vars,
                                      struct t_hashtable *options);

Аргументи:

  • expr: израз који треба да се израчуна (погледајте услове и променљиве)

  • pointers: хеш табела са показивачима (кључеви моја бити стринг, вредности морају бити показивач); показивачи „window” и „buffer” се аутоматски додају ако се не налазе у хеш табели (са показивачем на текући прозор/бафер) (може да буде NULL):

    • regex: показивач на регуларни израз (regex_t структуру) компајлиран WeeChat функцијом string_regcomp или са regcomp (погледајте man regcomp); ова опција је слична са regex у хеш табели options (испод), али се користи у циљу бољих перформанси

  • extra_vars: додатне променљиве које ће се развити (може да буде NULL)

  • options: хеш табела са неким опцијама (кључеви и вредности морају бити стринг) (може да буде NULL):

    • type: подразумевано понашање је да се само замене вредности у изразу, остали типови који могу да се изаберу су следећи:

      • condition: израз се израчунава као услов: користе се оператори и заграде, резултат је логичка вредност („0” или „1”)

    • prefix: префикс испред променљиве која се замењује (подразумевано: ${)

    • suffix: суфикс након променљиве која се замењује (подразумевано: })

    • extra: подразумевано понашање је да се само замене додатне променљиве (extra_vars), другачије понашање може да се изабере:

      • eval: додатне променљиве (extra_vars) се и саме израчунавају пре замене (WeeChat ≥ 1.6)

    • regex: регуларни израз који се користи за замену текста у expr (који се онда не израчунава)

    • regex_replace: текст за замену који се користи са regex, којим се мења текст у expr (regex_replace се израчунава за свако подударање regex у expr, све док више нема подударања)

    • debug: дибаг ниво (стринг са целим бројем ≥ 1), ако је укључен, у хеш табелу options се додаје кључ „debug_output”:

      • 1: укључује дибаг

      • 2: укључује детаљнији дибаг

Повратна вредност:

  • израчунати израз (након употребе мора да се ослободи позивом „free”), или NULL у случају проблема (неважећи израз или ако нема довољно слободне меморије)

C примери:

/* услови */
struct t_hashtable *options1 = weechat_hashtable_new (8,
                                                      WEECHAT_HASHTABLE_STRING,
                                                      WEECHAT_HASHTABLE_STRING,
                                                      NULL,
                                                      NULL);
weechat_hashtable_set (options1, "type", "condition");
char *str1 = weechat_string_eval_expression ("${window.win_width} > 100", NULL, NULL, options1);  /* "1" */
char *str2 = weechat_string_eval_expression ("abc =~ def", NULL, NULL, options1);                 /* "0" */

/* прост израз */
char *str3 = weechat_string_eval_expression ("${buffer.full_name}", NULL, NULL, NULL);  /* "core.weechat" */

/* замена регуларним изразом */
struct t_hashtable *options2 = weechat_hashtable_new (8,
                                                      WEECHAT_HASHTABLE_STRING,
                                                      WEECHAT_HASHTABLE_STRING,
                                                      NULL,
                                                      NULL);
/* додавање заграда око URL адреса */
weechat_hashtable_set (options2, "regex", "[a-zA-Z0-9_]+://[^ ]+");
weechat_hashtable_set (options2, "regex_replace", "[ ${re:0} ]");
char *str4 = weechat_string_eval_expression ("test: https://weechat.org", NULL, NULL, NULL);  /* "test: [ https://weechat.org ]" */

/* скривање лозинки */
weechat_hashtable_set (options2, "regex", "(password=)([^ ]+)");
weechat_hashtable_set (options2, "regex_replace", "${re:1}${hide:*,${re:2}}");
char *str5 = weechat_string_eval_expression ("password=abc password=def", NULL, NULL, NULL);  /* "password=*** password=***" */

Скрипта (Python):

# прототип
def string_eval_expression(expr: str, pointers: Dict[str, str], extra_vars: Dict[str, str], options: Dict[str, str]) -> str: ...

# примери

# услови
str1 = weechat.string_eval_expression("${window.win_width} > 100", {}, {}, {"type": "condition"})  # "1"
str2 = weechat.string_eval_expression("abc =~ def", {}, {}, {"type": "condition"})                 # "0"

# прост израз
str3 = weechat.string_eval_expression("${buffer.full_name}", {}, {}, {}) # "core.weechat"

# замена регуларним изразом: додавање заграда око URL адреса
options = {
    "regex": "[a-zA-Z0-9_]+://[^ ]+",
    "regex_replace": "[ ${re:0} ]",
}
str4 = weechat.string_eval_expression("test: https://weechat.org", {}, {}, options)  # "test: [ https://weechat.org ]"

# замена са регуларним изразом: скривање лозинки
options = {
    "regex": "(password=)([^ ]+)",
    "regex_replace": "${re:1}${hide:*,${re:2}}",
}
str5 = weechat.string_eval_expression("password=abc password=def", {}, {}, options)  # "password=*** password=***"
Услови

Листа логичких оператора који могу да се користе у условима (по редоследу приоритета, од првог до последњег):

Оператор Опис Примери Резултати

&&

Логичко „и”

25 && 77
25 && 0

1
0

||

Логичко „или”

25 || 0
0 || 0

1
0

Листа оператора поређења који могу да се користе у условима (према редоследу приоритета, од првог до последњег):

Оператор Опис Примери Резултат

=~

Подудара се са POSIX проширеним регуларним изразом (дозвољене су необавезне заставице, погледајте функцију string_regcomp)

abc def =~ ab.*ef
abc def =~ y.*z

1
0

!~

НЕ подудара се са POSIX проширеним регуларним изразом (дозвољене су необавезне заставице, погледајте функцију string_regcomp)

abc def !~ ab.*ef
abc def !~ y.*z

0
1

==*

Подудара се са маском где је дозвољено „*”, разликује величину слова (погледајте функцију string_match)
(WeeChat ≥ 2.9)

abc def ==* a*f
abc def ==* y*z

1
0

!!*

НИЈЕ џокер маска у којој је дозвољено „*”, разликује величину слова (погледајте функцију string_match)
(WeeChat ≥ 2.9)

abc def !!* a*f
abc def !!* y*z

0
1

=*

Подудара се са маском где је дозвољено „*”, не разликује величину слова (погледајте функцију string_match)
(WeeChat ≥ 1.8)

abc def =* A*F
abc def =* Y*Z

1
0

!*

НИЈЕ џокер маска у којој је дозвољено „*”, не разликује величину слова (погледајте функцију string_match)
(WeeChat ≥ 1.8)

abc def !* A*F
abc def !* Y*Z

0
1

==-

Је укључено, разликује величину слова
(WeeChat ≥ 2.9)

abc def ==- bc
abc def ==- xyz

1
0

!!-

НИЈЕ укључено, разликује величину слова
(WeeChat ≥ 2.9)

abc def !!- bc
abc def !!- xyz

0
1

=-

Је укључено, не разликује величину слова
(WeeChat ≥ 2.9)

abc def =- BC
abc def =- XYZ

1
0

!-

НИЈЕ укључено, не разликује величину слова
(WeeChat ≥ 2.9)

abc def !- BC
abc def !- XYZ

0
1

==

Једнако

test == test
test == string

1
0

!=

Није једнако

test != test
test != string

0
1

<=

Мање или једнако

abc <= defghi
abc <= abc
defghi <= abc
15 <= 2

1
1
0
0

<

Мање

abc < defghi
abc < abc
defghi < abc
15 < 2

1
0
0
0

>=

Веће или једнако

defghi >= abc
abc >= abc
abc >= defghi
15 >= 2

1
1
0
1

>

Веће

defghi > abc
abc > abc
abc > defghi
15 > 2

1
0
0
1

У случају да су два израза важећи бројеви, поређење се врши употребом бројева у покретном зарезу, у једном од следећих формата:

  • цео број (примери: 5, -7)

  • број у покретном зарезу (примери: 5.2, -7.5, 2.83e-2) (WeeChat ≥ 2.0)

  • хексадецимални број (пример: 0xA3, -0xA3) (WeeChat ≥ 2.0)

Ако желите да форсирате поређење стрингова, можете сваки израз да уоквирите знацима навода, на пример:

  • 50 > 100 враћа 0 (поређење бројева)

  • "50" > "100" враћа 1 (поређење стрингова)

Променљиве

Листа развијених променљивих у изразу (према редоследу приоритета, од прве развијене, до последње):

Формат Опис Примери Резултати

${raw:xxx}
(WeeChat ≥ 3.1)

Сирови стринг (не израчунава се).

${raw:${info:version}}

${info:version}

${name}
(WeeChat ≥ 3.4)

User variable (defined with ${define:name,value}).

${name}

value

${име}

Променљива name из хеш табеле extra_vars.

${име}

вредност

${weechat_xxx_dir}

WeeChat директоријум: ${weechat_config_dir}, ${weechat_data_dir}, ${weechat_cache_dir} или ${weechat_runtime_dir}.

${weechat_config_dir}
${weechat_data_dir}
${weechat_cache_dir}
${weechat_runtime_dir}

/home/user/.config/weechat
/home/user/.local/share/weechat
/home/user/.cache/weechat
/run/user/1000/weechat

${eval:xxx}
(WeeChat ≥ 1.3)

Стринг који се израчунава.

${eval:${date:${weechat.look.buffer_time_format}}}

19:02:45 (са бојама, ако у опцији weechat.look.buffer_time_format постоје боје)

${eval_cond:xxx}
(WeeChat ≥ 3.1)

Стринг који се израчунава као услов.

${eval_cond:${window.win_width} > 100}

1

${esc:xxx}
${\xxx}
(WeeChat ≥ 1.0)

Стринг са означеним карактерима.

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

prefix<TAB>message
©

${hide:x,стринг}
(WeeChat ≥ 1.1)

Стринг са скривеним карактерима (сви карактери у стринг се замењују са x).

${hide:*,password}

********

${cut:макс,суфикс,стринг}
${cut:+макс,суфикс,стринг}
(WeeChat ≥ 1.8)

Стринг са макс карактера и необавезним суфикс ако се стринг сече.
У формату +макс, суфикс се рачуна у максималну дужину.

${cut:4,…,this is a test}
${cut:+4,…,this is a test}
${cut:2,>>,こんにちは世界}

this…
t…
こん>>

${cutscr:макс,суфикс,стринг}
${cutscr:+макс,суфикс,стринг}
(WeeChat ≥ 1.8)

Стринг са макс карактера приказаних на екрану, и необавезним суфикс ако се стринг сече. У формату +макс, суфикс се рачуна у максималну дужину.

${cutscr:4,…,this is a test}
${cutscr:+4,…,this is a test}
${cutscr:2,>>,こんにちは世界}

this…
thi…
こ>>

${rev:xxx}
(WeeChat ≥ 2.2)

Обрнути стринг (и кодови боја се обрћу, тако да стринг не би требало да садржи кодове боја).

${rev:Hello, world!}
${rev:Hello, ${color:red}world!}

!dlrow ,olleH
!dlrow30F ,olleH (нема боје, кôд боје је обрнут)

${revscr:xxx}
(WeeChat ≥ 2.7)

Обрнути стринг за екран, кодови боја се не обрћу.

${revscr:Hello, world!}
${revscr:Hello, ${color:red}world!}

!dlrow ,olleH
!dlrow ,olleH ( ,olleH у црвеној боји)

${repeat:број,стринг}
(WeeChat ≥ 2.3)

Поновљени стринг.

${repeat:5,-}

-----

${length:xxx}
(WeeChat ≥ 2.7)

Дужина стринга (број UTF-8 карактера), кодови боја се игноришу.

${length:test}
${length:こんにちは世界}

4
7

${lengthscr:xxx}
(WeeChat ≥ 2.7)

Дужина стринга приказаног на екрану, кодови боја се игноришу.

${lengthscr:test}
${lengthscr:こんにちは世界}

4
14

${split:number,seps,flags,xxx}
(WeeChat ≥ 3.3)

Дели стринг и враћа сагласно са number:
- count: број ставки након поделе
- random: произвољну ставку
- цео број ≥ 1: ставку са индексом (1 = прва ставка)
- цео број ≤ -1: ставку са индеком од краја (-1 = последња ставка, -2 = претпоследња ставка, итд.),
seps је листа карактера који се користе као граничници (ако је празно, користи се запета),
flags је листа заставица раздвојена са +:
- strip_left: уклања граничнике са леве стране (почетка стринга)
- strip_right: уклања граничнике са десне стране (краја стринга)
- collapse_seps: стапа више узастопних граничника у један
- keep_eol: задржава прелом линије за сваку вредност
- strip_items=xyz: уклања карактере x, y и z са почетка/краја ставки
- max_items=N: враћа максимално N ставки

${split:1,,,abc,def,ghi}
${split:-1,,,abc,def,ghi}
${split:count,,,abc,def,ghi}
${split:random,,,abc,def,ghi}
${split:3,,collapse_seps,abc,,,def,,,ghi}
${split:3,,strip_items=-_,_-abc-_,_-def-_,_-ghi-_}
${split:2, ,,this is a test}
${split:2, ,strip_left+strip_right, this is a test }
${split:2, ,keep_eol,this is a test}

abc
ghi
3
def
ghi
ghi
is
is
is a test

${split_shell:number,xxx}
(WeeChat ≥ 3.3)

Дели аргументе љуске и враћа сагласно са number:
- count: број аргумената након поделе
- random: произвољни аргумент
- цео број ≥ 1: аргумент по индексу (1 = први аргумент)
- цео број ≤ -1: аргумент по индексу од краја (-1 = последњи аргумент, -2 = претпоследњи аргумент, итд.)

${split_shell:1,"first arg" arg2}
${split_shell:-1,"first arg" arg2}
${split_shell:count,"first arg" arg2}
${split_shell:random,"first arg" arg2}

first arg
arg2
2
arg2

${re:xxx}
(WeeChat ≥ 1.1)

Подаци регуларног израза:
0 = цео подударени стринг,
1 до 99 = ухваћена група,
+ = последња ухваћена група,
# = индекс последње ухваћене групе (WeeChat ≥ 1.8),
repl_index = индекс замене која се врши (почиње од 1) (WeeChat ≥ 3.3).

${re:0}
${re:1}
${re:2}
${re:+}
${re:#}
${re:repl_index}

test1 test2
test1
test2
test2
2
1

${color:име}
(WeeChat ≥ 0.4.2)

Кôд WeeChat боје (име боје има и необавезне атрибуте), погледајте функцију color у вези подржаних формата.

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

red text (у црвеној)
bold orange text (подебљано наранџасто)

${modifier:име,подаци,стринг}
(WeeChat ≥ 2.7)

Резултат модификатора, погледајте функцију hook_modifier_exec.

${modifier:eval_path_home,,~}
${modifier:eval_path_home,directory=config,%h/weechat.conf}

/home/user
/home/user/.config/weechat/weechat.conf

${info:име}
${info:име,аргументи}
(WeeChat ≥ 0.4.3)

Инфо из програма WeeChat или додатка, погледајте функцију info_get.

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

1.0
lightblue

${base_encode:base,xxx}
(WeeChat ≥ 2.9)

Стринг кодиран у base 16, 32 или 64.

${base_encode:16,test string}
${base_encode:32,test string}
${base_encode:64,test string}

7465737420737472696E67
ORSXG5BAON2HE2LOM4======
dGVzdCBzdHJpbmc=

${base_decode:base,xxx}
(WeeChat ≥ 2.9)

Декодиран стринг из base 16, 32 или 64.

${base_decode:16,7465737420737472696E67}
${base_decode:32,ORSXG5BAON2HE2LOM4======}
${base_decode:64,dGVzdCBzdHJpbmc=}

test string
test string
test string

${date}
${date:xxx}
(WeeChat ≥ 1.3)

Текући датум/време, у прилагођеном формату (погледајте man strftime), подразумевани формат је %F %T.

${date}
${date:%H:%M:%S}

2015-06-30 19:02:45
19:02:45

${env:ИМЕ}
(WeeChat ≥ 1.2)

Име променљиве окружења ИМЕ.

${env:HOME}

/home/user

${if:condition}
${if:condition?true} ${if:condition?true:false} (WeeChat ≥ 1.8)

Тернарни оператор са условом, вредност када је услов истинит (није обавезна) и друга вредност када је услов неистинит (није обавезна). Ако се вредности не задају, враћа се „1” или „0”, у зависности од резултата услова.

${if:${info:term_width}>80?big:small}

big

${calc:xxx}
(WeeChat ≥ 2.7)

Резултат израза, у коме су подржане заграде и следећи оператори:
+: сабирање
-: одузимање
*: множење
/: дељење
//: резултат дељења без разломљеног дела
%: остатак при дељењу
**: степен.

${calc:5+2*3}
${calc:(5+2)*3}
${calc:10/4}
${calc:10//4}
${calc:9.2%3}
${calc:2**16}

11
21
2.5
2
0.2
65536

${random:min,max}
(WeeChat ≥ 3.3)

Случајни цео број из опсега min до max (укључујући и њих).

${random:0,10}

3

${translate:xxx}
(WeeChat ≥ 3.2)

Преведени стринг (зависи од језика који програм WeeChat користи за приказ порука).

${translate:Plugin}

Extension (пример из француског)

${define:name,value}
(WeeChat ≥ 3.4)

Define a variable name set to value, which can then be used in the same evaluated expression with ${name}.

${define:len,${calc:5+3}}${len}x${len}

8x8

${sec.data.име}

Вредност обезбеђених података име.

${sec.data.libera_pass}

my_password

${фајл.одељак.опција}

Вредност опције.

${weechat.look.buffer_time_format}

%H:%M:%S

${име}

Вредност локалне променљиве име у баферу.

${nick}

FlashCode

${pointer}

Променљива pointer из хеш табеле pointers.

${buffer}

0x1234abcd

${hdata.пром1.пром2...}
${hdata[листа].пром1.пром2...}

Hdata вредност (показивачи window и buffer се подразумевано постављају на текући прозор/бафер), листа може бити име листе (пример: „gui_buffers”), показивач (пример: „0x1234abcd”) или име показивача (пример: „my_pointer”).

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

core.weechat
1

3.3.46. string_dyn_alloc

WeeChat ≥ 1.8.

Алоцира динамички стринг, са променљивом дужином.
Интерно, структура се алоцира показивачем на стринг, алоцирану величину и текућу дужину стринга.

У свим string_dyn_* функцијама се користи само показивач показивача на стринг (**string).

Прототип:

char **weechat_string_dyn_alloc (int size_alloc);

Аргументи:

  • size_alloc: почетна алоцирана величина (мора бити већа од нуле)

Повратна вредност:

  • показивач на динамички стринг

C пример:

char **string = weechat_string_dyn_alloc (256);
Ова функција није доступна у API скриптовања.

3.3.47. string_dyn_copy

WeeChat ≥ 1.8.

Копира стринг у динамички стринг.

Показивач *string може д асе промени ако се стринг реалоцира (у случају да нема довољно слободног простора за копирање стринга).

Прототип:

int weechat_string_dyn_copy (char **string, const char *new_string);

Аргументи:

  • string: показивач на динамички стринг

  • new_string: стринг који се копира

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

char **string = weechat_string_dyn_alloc (256);
if (weechat_string_dyn_copy (string, "test"))
{
    /* OK */
}
else
{
    /* грешка */
}
Ова функција није доступна у API скриптовања.

3.3.48. string_dyn_concat

WeeChat ≥ 1.8, ажурирано у верзији 3.0.

Надовезује стринг на динамички стринг.

Показивач на стринг *string може да се промени ако се стринг реалоцира (у случају да нема довољно простора за надовезивање стринга).

Прототип:

int weechat_string_dyn_concat (char **string, const char *add, int bytes);

Аргументи:

  • string: показивач на динамички стринг

  • add: стринг који се додаје

  • bytes: максимални број бајтова у add који могу да се надовежу, мора бити мање или једнако дужини add (-1 = аутоматски: надовезује се комплетан стринг add) (WeeChat ≥ 3.0)

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

char **string = weechat_string_dyn_alloc (256);
if (weechat_string_dyn_copy (string, "test"))
{
    if (weechat_string_dyn_concat (string, "abc", -1))
    {
        /* ... */
    }
}
Ова функција није доступна у API скриптовања.

3.3.49. string_dyn_free

WeeChat ≥ 1.8.

Ослобађа динамички стринг.

Прототип:

char *weechat_string_dyn_free (char **string, int free_string);

Аргументи:

  • string: показивач на динамички стринг

  • free_string: ослобађање самог стринга; ако је 0, онда садржај *string остаје важећи и након позива ове функције

Повратна вредност:

  • показивач на стринг ако је free_string 0, у супротном NULL

C пример:

char **string = weechat_string_dyn_alloc (256);
if (weechat_string_dyn_concat (string, "test"))
{
    /* OK */
}
else
{
    /* грешка */
}
/* ... */
weechat_string_dyn_free (string, 1);
Ова функција није доступна у API скриптовања.

3.4. UTF-8

Неке UTF-8 стринг функције.

3.4.1. utf8_has_8bits

Проверава да ли стринг има 8-битне карактере.

Прототип:

int weechat_utf8_has_8bits (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • 1 ако стринг има 8-битне карактере, 0 ако има само 7-битне карактере

C пример:

if (weechat_utf8_has_8bits (string))
{
    /* ... */
}
Ова функција није доступна у API скриптовања.

3.4.2. utf8_is_valid

Ажурирано у верзији 1.4.

Проверава да ли је стринг важећи UTF-8.

Прототип:

int weechat_utf8_is_valid (const char *string, int length, char **error);

Аргументи:

  • string: стринг

  • length: максимални број UTF-8 карактера који може да се провери; ако је ≤ 0, проверава се цео стринг (WeeChat ≥ 1.4)

  • error: ако није NULL, *error се поставља на показивач на први неважећи UTF-8 карактер у стрингу, ако такав постоји

Повратна вредност:

  • 1 ако је UTF-8 стринг исправан, у супротном 0

C пример:

char *error;
if (weechat_utf8_is_valid (string, -1, &error))
{
    /* ... */
}
else
{
    /* "error" показује на при неважећи карактер */
}
Ова функција није доступна у API скриптовања.

3.4.3. utf8_normalize

Нормализује UTF-8 стринг: уклања све карактере који нису UTF-8 и замењује их карактером.

Прототип:

void weechat_utf8_normalize (char *string, char replacement);

Аргументи:

  • string: стринг

  • replacement: карактер којим се замењују неисправни карактери

C пример:

weechat_utf8_normalize (string, '?');
Ова функција није доступна у API скриптовања.

3.4.4. utf8_prev_char

Ажурирано у верзији 1.3.

Враћа показивач на претходни UTF-8 карактер у стрингу.

Прототип:

const char *weechat_utf8_prev_char (const char *string_start,
                                    const char *string);

Аргументи:

  • string_start: почетак стринга (функција неће вратити карактер пре овог показивача)

  • string: показивач на стринг (мора бити ≥ string_start)

Повратна вредност:

  • показивач на претходни UTF-8 карактер, NULL у случају да се не пронађе (достигнут је почетак стринга) (WeeChat ≥ 1.3: враћени показивач је const char * уместо char *)

C пример:

const char *prev_char = weechat_utf8_prev_char (string, ptr_in_string);
Ова функција није доступна у API скриптовања.

3.4.5. utf8_next_char

Ажурирано у верзији 1.3.

Враћа показивач на наредни UTF-8 карактер у стрингу.

Прототип:

const char *weechat_utf8_next_char (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • показивач на наредни UTF-8 карактер, NULL ако се не пронађе (достигнут је крај стринга) (WeeChat ≥ 1.3: враћени показивач је const char * уместо char *)

C пример:

const char *next_char = weechat_utf8_next_char (string);
Ова функција није доступна у API скриптовања.

3.4.6. utf8_char_int

Враћа UTF-8 карактер као цео број.

Прототип:

int weechat_utf8_char_int (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • UTF-8 карактер као цео број

C пример:

int char_int = weechat_utf8_char_int ("être");  /* "ê" као цео број */
Ова функција није доступна у API скриптовања.

3.4.7. utf8_char_size

Враћа величину UTF-8 карактера (у бајтовима).

Прототип:

int weechat_utf8_char_size (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • величина UTF-8 карактера (у бајтовима)

C пример:

int char_size = weechat_utf8_char_size ("être");  /* == 2 */
Ова функција није доступна у API скриптовања.

3.4.8. utf8_strlen

Враћа дужину UTF-8 стринга (у UTF-8 карактерима).

Прототип:

int weechat_utf8_strlen (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • дужина UTF-8 стринга (број UTF-8 карактера)

C пример:

int length = weechat_utf8_strlen ("chêne");  /* == 5 */
Ова функција није доступна у API скриптовања.

3.4.9. utf8_strnlen

Враћа дужину UTF-8 стринга (у UTF-8 карактерима), за максимално bytes у стрингу.

Прототип:

int weechat_utf8_strnlen (const char *string, int bytes);

Аргументи:

  • string: стринг

  • bytes: максимални број бајтова

Повратна вредност:

  • дужина UTF-8 стринга (број UTF-8 карактера)

C пример:

int length = weechat_utf8_strnlen ("chêne", 4);  /* == 3 */
Ова функција није доступна у API скриптовања.

3.4.10. utf8_strlen_screen

Враћа број карактера потребних на екрану да се прикаже UTF-8 стринг.

Прототип:

int weechat_utf8_strlen_screen (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • број карактера на екрану који су потребни да се испише UTF-8 стринг

C пример:

int length_on_screen = weechat_utf8_strlen_screen ("é");  /* == 1 */
Ова функција није доступна у API скриптовања.

3.4.11. utf8_charcmp

Ажурирано у верзији 1.0.

Пореди два UTF-8 карактера.

Прототип:

int weechat_utf8_charcmp (const char *string1, const char *string2);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_utf8_charcmp ("aaa", "ccc");  /* == -2 */
Ова функција није доступна у API скриптовања.

3.4.12. utf8_charcasecmp

Ажурирано у верзији 1.0.

Пореди два UTF-8 карактера, уз игнорисање разлике у величини слова.

Прототип:

int weechat_utf8_charcasecmp (const char *string1, const char *string2);

Аргументи:

  • string1: први стринг за поређење

  • string2: други стринг за поређење

Повратна вредност:

  • -1 ако је string1 < string2

  • 0 ако је string1 == string2

  • 1 ако је string1 > string2

C пример:

int diff = weechat_utf8_charcasecmp ("aaa", "CCC");  /* == -2 */
Ова функција није доступна у API скриптовања.

3.4.13. utf8_char_size_screen

Враћа број карактера потребних на екрану за испис UTF-8 карактера.

Прототип:

int weechat_utf8_char_size_screen (const char *string);

Аргументи:

  • string: стринг

Повратна вредност:

  • број карактера на екрану потребних за испис UTF-8 карактера

C пример:

int length_on_screen = weechat_utf8_char_size_screen ("é");  /* == 1 */
Ова функција није доступна у API скриптовања.

3.4.14. utf8_add_offset

Ажурирано у верзији 1.3.

Помера унапред N карактера у UTF-8 стрингу.

Прототип:

const char *weechat_utf8_add_offset (const char *string, int offset);

Аргументи:

  • string: стринг

  • offset: број карактера

Повратна вредност:

  • показивач на стринг, N карактера иза (NULL ако не може да се достигне) (WeeChat ≥ 1.3: враћени показивач је const char * уместо char *)

C пример:

const char *str = "chêne";
const char *str2 = weechat_utf8_add_offset (str, 3);  /* показује на "ne" */
Ова функција није доступна у API скриптовања.

3.4.15. utf8_real_pos

Враћа реалну позицију у UTF-8 стрингу.

Прототип:

int weechat_utf8_real_pos (const char *string, int pos);

Аргументи:

  • string: стринг

  • pos: позиција (број карактера)

Повратна вредност:

  • реална позиција (у бајтовима)

C пример:

int pos = weechat_utf8_real_pos ("chêne", 3);  /* == 4 */
Ова функција није доступна у API скриптовања.

3.4.16. utf8_pos

Враћа позицију у UTF-8 стрингу.

Прототип:

int weechat_utf8_pos (const char *string, int real_pos);

Аргументи:

  • string: стринг

  • real_pos: позиција (бајтови)

Повратна вредност:

  • позиција (број карактера)

C пример:

int pos = weechat_utf8_pos ("chêne", 4);  /* == 3 */
Ова функција није доступна у API скриптовања.

3.4.17. utf8_strndup

Враћа дупликат стринга, са максимално length карактера.

Прототип:

char *weechat_utf8_strndup (const char *string, int length);

Аргументи:

  • string: стринг

  • length: макс број карактера који може да се дуплира

Повратна вредност:

  • дуплирани стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *string = weechat_utf8_strndup ("chêne", 3);  /* враћа "chê" */
/* ... */
free (string);
Ова функција није доступна у API скриптовања.

3.5. Криптографија

Неке криптографске функције.

3.5.1. crypto_hash

WeeChat ≥ 2.8.

Израчунава хеш података.

Прототип:

int weechat_crypto_hash (const void *data, int data_size, const char *hash_algo,
                         void *hash, int *hash_size);

Аргументи:

  • data: подаци који треба да се хеширају

  • data_size: број бајтова у data који се хешира

  • hash_algo: хеш алгоритам, погледајте табелу испод

  • hash: показивач на хеш променљиву која се користи за чување резултата хеширања (бафер мора бити довољне величине која зависи од алгоритма, погледајте табелу испод)

  • hash_size: показивач на променљиву која се користи за чување величине израчунатог хеша (у бајтовима) (може да буде NULL)

Подржани хеш алгоритми:

Вредност Алгоритам Величина хеша Напомене

crc32

CRC32

4 бајта (32 бита)

Није хеш алгоритам у криптографском смислу.

md5

MD5

16 бајтова (128 бита)

Слаб, не препоручује се за криптографску употребу.

sha1

SHA-1

20 бајтова (160 бита)

Слаб, не препоручује се за криптографску употребу.

sha224

SHA-224

28 бајтова (224 бита)

sha256

SHA-256

32 бајта (256 бита)

sha384

SHA-384

48 бајтова (384 бита)

sha512

SHA-512

64 бајта (512 бита)

sha3-224

SHA3-224

28 бајтова (224 бита)

Алгоритам је доступан у libgcrypt ≥ 1.7.0.

sha3-256

SHA3-256

32 бајта (256 бита)

Алгоритам је доступан у libgcrypt ≥ 1.7.0.

sha3-384

SHA3-384

48 бајтова (384 бита)

Алгоритам је доступан у libgcrypt ≥ 1.7.0.

sha3-512

SHA3-512

64 бајта (512 бита)

Алгоритам је доступан у libgcrypt ≥ 1.7.0.

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

const char *data = "abcdefghijklmnopqrstuvwxyz";
char hash[256 / 8];
int rc, hash_size;
rc = weechat_crypto_hash (data, strlen (data), "sha256", hash, &hash_size);
/* rc == 1, hash_size == 32 и хеш је бафер са:
   71 c4 80 df 93 d6 ae 2f 1e fa d1 44 7c 66 c9 52 5e 31 62 18 cf 51 fc 8d 9e d8 32 f2 da f1 8b 73 */
Ова функција није доступна у API скриптовања.

3.5.2. crypto_hash_pbkdf2

WeeChat ≥ 2.8.

Израчунава PKCS#5 Passphrase Based Key Derivation Function број 2 (PBKDF2) хеш података.

Прототип:

int weechat_crypto_hash_pbkdf2 (const void *data, int data_size,
                                const char *hash_algo,
                                const void *salt, int salt_size,
                                int iterations,
                                void *hash, int *hash_size);

Аргументи:

  • data: подаци који треба да се хеширају

  • data_size: број бајтова у data који се хешира

  • hash_algo: хеш алгоритам који се користи у функцији за извођење кључа, погледајте табелу у функцији crypto_hash

  • salt: со

  • salt_size: број бајтова у salt

  • iterations: број итерација

  • hash: показивач на хеш променљиву која се користи за чување резултата (бафер мора бити довољне величине која зависи од алгоритма, погледајте табелу у функцији crypto_hash)

  • hash_size: показивач на променљиву која се користи за чување величине израчунатог хеша (у бајтовима) (може да буде NULL)

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

const char *data = "abcdefghijklmnopqrstuvwxyz";
const char *salt = "12345678901234567890123456789012";  /* 32 bytes */
char hash[256 / 8];
int rc, hash_size;
rc = weechat_crypto_hash_pbkdf2 (data, strlen (data), "sha256", salt, strlen (salt), 100000,
                                 hash, &hash_size);
/* rc == 1, hash_size == 32 и хеш је бафер са:
   99 b3 5e 42 53 d1 a7 a8 49 c1 dc 2c e2 53 c2 b6 6d a1 8b dc 6e 78 a7 06 e0 ef 34 db 0a 7a a2 bb */
Ова функција није доступна у API скриптовања.

3.5.3. crypto_hmac

WeeChat ≥ 3.2.

Израчунава keyed-hash message authentication code (HMAC).

Прототип:

int weechat_crypto_hmac (const void *key, int key_size, const void *message, int message_size,
                         int hash_algo, void *hash, int *hash_size);

Аргументи:

  • key: кључ

  • key_size: број бајтова у key

  • message: порука

  • message_size: број бајтова у message

  • hash_algo: хеш алгоритам, погледајте табелу у функцији crypto_hash

  • hash: показивач на хеш променљиву која се користи за чување резултата (бафер мора бити довољне величине која зависи од алгоритма, погледајте табелу у функцији crypto_hash)

  • hash_size: показивач на променљиву која се користи за чување величине израчунатог хеша (у бајтовима) (може да буде NULL)

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

const char *key = "the key";
const char *message = "the message";
char hash[256 / 8];
int rc, hash_size;
rc = weechat_crypto_hmac (key, strlen (key), message, strlen (message), "sha256", hash, &hash_size);
/* rc == 1, hash_size == 32 и хеш је бафер са:
   47 36 67 02 fc bc b1 97 a4 25 e6 7a b9 52 92 bd 15 9a 66 91 9c fb 94 b0 b4 9a 39 cb c0 24 2d 7b */
Ова функција није доступна у API скриптовања.

3.6. Директоријуми

Неке функције у вези директоријума.

3.6.1. mkdir_home

Ажурирано у верзији 3.2.

Креира директоријум у WeeChat почетном директоријуму.

Прототип:

int weechat_mkdir_home (char *directory, int mode);

Аргументи:

  • directory: име директоријума који трба да се креира; може почети једним од следећих стрингова чиме се форсира одређени WeeChat директоријум (WeeChat ≥ 3.2):

    • ${weechat_config_dir}

    • ${weechat_data_dir} (подразумевано)

    • ${weechat_cache_dir}

    • ${weechat_runtime_dir}

  • mode: режим за директоријум

Повратна вредност:

  • 1 ако је директоријум успешно креиран, 0 ако је дошло до грешке

C пример:

if (!weechat_mkdir_home ("${weechat_cache_dir}/temp", 0755))
{
    /* грешка */
}

Скрипта (Python):

# прототип
def mkdir_home(directory: str, mode: int) -> int: ...

# пример
weechat.mkdir_home("${weechat_cache_dir}/temp", 0755)

3.6.2. mkdir

Креира директоријум.

Прототип:

int weechat_mkdir (char *directory, int mode);

Аргументи:

  • directory: име директоријума који се креира

  • mode: режим за директоријум

Повратна вредност:

  • 1 ако је директоријум успешно креиран, 0 ако је дошло до грешке

C пример:

if (!weechat_mkdir ("/tmp/mydir", 0755))
{
    /* грешка */
}

Скрипта (Python):

# прототип
def mkdir(directory: str, mode: int) -> int: ...

# пример
weechat.mkdir("/tmp/mydir", 0755)

3.6.3. mkdir_parents

Креира директоријум и ако је потребно, и родитељ директоријуме.

Прототип:

int weechat_mkdir_parents (char *directory, int mode);

Аргументи:

  • directory: име директоријума који се креира

  • mode: режим за директоријум

Повратна вредност:

  • 1 ако је директоријум успешно креиран, 0 ако је дошло до грешке

C пример:

if (!weechat_mkdir_parents ("/tmp/my/dir", 0755))
{
    /* грешка */
}

Скрипта (Python):

# прототип
def mkdir_parents(directory: str, mode: int) -> int: ...

# пример
weechat.mkdir_parents("/tmp/my/dir", 0755)

3.6.4. exec_on_files

Ажурирано у верзијама 1.5, 2.0.

Проналази фајлове у директоријуму и извршава функцију повратног позива за сваки фајл.

Прототип:

void weechat_exec_on_files (const char *directory,
                            int recurse_subdirs,
                            int hidden_files,
                            void (*callback)(void *data,
                                             const char *filename),
                            void *callback_data);

Аргументи:

  • directory: директоријум за претрагу фајлова

  • recurse_subdirs: 1 да се спушта у поддиректоријуме (WeeChat ≥ 2.0)

  • hidden_files: 1 да се укључе и скривени фајлови, у супротном 0

  • callback: функција која се позива за сваки пронађени фајл, аргументи:

    • void *data: показивач

    • const char *filename: пронађено име фајла

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

C пример:

void callback (void *data, const char *filename)
{
    /* ... */
}
...
weechat_exec_on_files ("/tmp", 0, 0, &callback, NULL);
Ова функција није доступна у API скриптовања.

3.6.5. file_get_content

WeeChat ≥ 0.3.1.

Враћа садржај текст фајла у стрингу.

Прототип:

char *weechat_file_get_content (const char *filename);

Аргументи:

  • filename: путања и име фајла

Повратна вредност:

  • садржај фајла као стринг (након употребе мора да се ослободи позивом „free”)

C пример:

char *content;

content = weechat_file_get_content ("/tmp/test.txt");
/* ... */
free (content);
Ова функција није доступна у API скриптовања.

3.6.6. file_copy

WeeChat ≥ 3.3.

Копира фајл на другу локацију.

Прототип:

int weechat_file_copy (const char *from, const char *to);

Аргументи:

  • from: изворишни фајл

  • to: одредишни фајл

Повратна вредност:

  • 1 ако је копирање OK, 0 у случају грешке

C пример:

if (weechat_file_copy ("/tmp/test.txt", "/path/to/test2.txt"))
{
    /* OK */
}
Ова функција није доступна у API скриптовања.

3.7. Алати

Неке корисне функције.

3.7.1. util_timeval_cmp

Пореди две „timeval” структуре.

Прототип:

int weechat_util_timeval_cmp (struct timeval *tv1, struct timeval *tv2);

Аргументи:

  • tv1: прва „timeval” структура

  • tv2: друга „timeval” структура

Повратна вредност:

  • -1 ако је tv1 < tv2

  • нула ако је tv1 == tv2

  • +1 ако је tv1 > tv2

C пример:

if (weechat_util_timeval_cmp (&tv1, &tv2) > 0)
{
    /* tv1 > tv2 */
}
Ова функција није доступна у API скриптовања.

3.7.2. util_timeval_diff

Ажурирано у верзији 1.1.

Враћа разлику (у микросекундама) између две „timeval” структуре.

Прототип:

long long weechat_util_timeval_diff (struct timeval *tv1, struct timeval *tv2);

Аргументи:

  • tv1: прва „timeval” структура

  • tv2: друга „timeval” структура

Повратна вредност:

  • разлика у микросекундама

У програму WeeChat верзије ≤ 1.0, враћена вредност је била у милисекундама.

C пример:

long long diff = weechat_util_timeval_diff (&tv1, &tv2);
Ова функција није доступна у API скриптовања.

3.7.3. util_timeval_add

Ажурирано у верзији 1.1.

Додаје timeval структури интервал (у микросекундама).

Прототип:

void weechat_util_timeval_add (struct timeval *tv, long long interval);

Аргументи:

  • tv: timeval структура

  • interval: интервал (у микросекундама)

У програму WeeChat верзије ≤ 1.0, интервал је изражаван у милисекундама.

C пример:

weechat_util_timeval_add (&tv, 2000000);  /* додаје 2 секунде */
Ова функција није доступна у API скриптовања.

3.7.4. util_get_time_string

WeeChat ≥ 0.3.2, ажурирано у верзији 1.3.

Враћа датум/време као стринг изграђен помоћу „strftime” у формату дефинисаном у опцији weechat.look.time_format.

Прототип:

const char *weechat_util_get_time_string (const time_t *date);

Аргументи:

  • date: показивач на датум

Повратна вредност:

  • показивач на стринг са датумом/временом

C пример:

time_t date = time (NULL);
weechat_printf (NULL, "date: %s",
                weechat_util_get_time_string (&date));
Ова функција није доступна у API скриптовања.

3.7.5. util_version_number

WeeChat ≥ 0.3.9.

Конвертује стринг са верзијом програма WeeChat у број.

Прототип:

int weechat_util_version_number (const char *version);

Аргументи:

  • version: верзија програма WeeChat као стринг (пример: „0.3.9” или „0.3.9-dev”)

C пример:

version_number = weechat_util_version_number ("0.3.8");      /* == 0x00030800 */
version_number = weechat_util_version_number ("0.3.9-dev");  /* == 0x00030900 */
version_number = weechat_util_version_number ("0.3.9-rc1");  /* == 0x00030900 */
version_number = weechat_util_version_number ("0.3.9");      /* == 0x00030900 */
Ова функција није доступна у API скриптовања.

3.8. Сортиране листе

Функције сортираних листи.

3.8.1. list_new

Креира нову листу.

Прототип:

struct t_weelist *weechat_list_new ();

Повратна вредност:

  • показивач на нову листу

C пример:

struct t_weelist *list = weechat_list_new ();

Скрипта (Python):

# прототип
def list_new() -> str: ...

# пример
list = weechat.list_new()

3.8.2. list_add

Додаје ставку у листу.

Прототип:

struct t_weelist_item *weechat_list_add (struct t_weelist *weelist,
                                         const char *data,
                                         const char *where,
                                         void *user_data);

Аргументи:

  • weelist: показивач на листу

  • data: подаци који се умећу у листу

  • where: позиција у листи:

    • WEECHAT_LIST_POS_SORT: додавање у листу, уз одржање уређености

    • WEECHAT_LIST_POS_BEGINNING: додавање на почетак листе

    • WEECHAT_LIST_POS_END: додавање на крај листе

  • user_data: било који показивач

Повратна вредност:

  • показивач на нову ставку

C пример:

struct t_weelist_item *my_item =
    weechat_list_add (list, "my data", WEECHAT_LIST_POS_SORT, NULL);

Скрипта (Python):

# прототип
def list_add(list: str, data: str, where: str, user_data: str) -> str: ...

# пример
item = weechat.list_add(list, "my data", weechat.WEECHAT_LIST_POS_SORT, "")

Претражује ставку у листи.

Прототип:

struct t_weelist_item *weechat_list_search (struct t_weelist *weelist,
                                            const char *data);

Аргументи:

  • weelist: показивач на листу

  • data: подаци који се траже у листи

Повратна вредност:

  • показивач на пронађену ставку, NULL у случају да се ставка не пронађе

C пример:

struct t_weelist_item *item = weechat_list_search (list, "my data");

Скрипта (Python):

# прототип
def list_search(list: str, data: str) -> str: ...

# пример
item = weechat.list_search(list, "my data")

3.8.4. list_search_pos

WeeChat ≥ 0.3.4.

Тражи позицију ставке у листи.

Прототип:

int weechat_list_search_pos (struct t_weelist *weelist,
                             const char *data);

Аргументи:

  • weelist: показивач на листу

  • data: подаци који се траже у листи

Повратна вредност:

  • позиција пронађене ставке, -1 у случају да се ставка не пронађе

C пример:

int pos_item = weechat_list_search_pos (list, "my data");

Скрипта (Python):

# прототип
def list_search_pos(list: str, data: str) -> int: ...

# пример
pos_item = weechat.list_search_pos(list, "my data")

3.8.5. list_casesearch

Тражи ставку у листи, без разликовања величине слова.

Прототип:

struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist,
                                                const char *data);

Аргументи:

  • weelist: показивач на листу

  • data: подаци који се траже у листи

Повратна вредност:

  • показивач на пронађену ставку, NULL у случају да се ставка не пронађе

C пример:

struct t_weelist_item *item = weechat_list_casesearch (list, "my data");

Скрипта (Python):

# прототип
def list_casesearch(list: str, data: str) -> str: ...

# пример
item = weechat.list_casesearch(list, "my data")

3.8.6. list_casesearch_pos

WeeChat ≥ 0.3.4.

Тражи позицију ставке у листи, без разликовања величине слова.

Прототип:

int weechat_list_casesearch_pos (struct t_weelist *weelist,
                                 const char *data);

Аргументи:

  • weelist: показивач на листу

  • data: подаци који се траже у листи

Повратна вредност:

  • позиција пронађене ставке, -1 у случају да се ставка не пронађе

C пример:

int pos_item = weechat_list_casesearch_pos (list, "my data");

Скрипта (Python):

# прототип
def list_casesearch_pos(list: str, data: str) -> int: ...

# пример
pos_item = weechat.list_casesearch_pos(list, "my data")

3.8.7. list_get

Враћа ставку са одређене позиције у листи.

Прототип:

struct t_weelist_item *weechat_list_get (struct t_weelist *weelist,
                                         int position);

Аргументи:

  • weelist: показивач на листу

  • position: позиција у листи (прва ставка је 0)

Повратна вредност:

  • показивач на пронађену ставку, NULL у случају да се ставка не пронађе

C пример:

struct t_weelist_item *item = weechat_list_get (list, 0);  /* прва ставка */

Скрипта (Python):

# прототип
def list_get(list: str, position: int) -> str: ...

# пример
item = weechat.list_get(list, 0)

3.8.8. list_set

Поставља ставку на нову вредност.

Прототип:

void weechat_list_set (struct t_weelist_item *item, const char *value);

Аргументи:

  • item: показивач на ставку

  • value: нова вредност ставке

C пример:

weechat_list_set (item, "new data");

Скрипта (Python):

# прототип
def list_set(item: str, value: str) -> int: ...

# пример
weechat.list_set(item, "new data")

3.8.9. list_next

Враћа наредну ставку у листи.

Прототип:

struct t_weelist_item *weechat_list_next (struct t_weelist_item *item);

Аргументи:

  • item: показивач на ставку

Повратна вредност:

  • показивач на наредну ставку, NULL у случају да је показивач био на последњој ставки листе

C пример:

struct t_weelist_item *next_item = weechat_list_next (item);

Скрипта (Python):

# прототип
def list_next(item: str) -> str: ...

# пример
item = weechat.list_next(item)

3.8.10. list_prev

Враћа претходну ставку у листи.

Прототип:

struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item);

Аргументи:

  • item: показивач на ставку

Повратна вредност:

  • показивач на претходну ставку, NULL у случају да је показивач био на првој ставки листе

C пример:

struct t_weelist_item *prev_item = weechat_list_prev (item);

Скрипта (Python):

# прототип
def list_prev(item: str) -> str: ...

# пример
item = weechat.list_prev(item)

3.8.11. list_string

Враћа стринг вредност ставке.

Прототип:

const char *weechat_list_string (struct t_weelist_item *item);

Аргументи:

  • item: показивач на ставку

Повратна вредност:

  • стринг вредност ставке

C пример:

weechat_printf (NULL, "вредност ставке: %s", weechat_list_string (item));

Скрипта (Python):

# прототип
def list_string(item: str) -> str: ...

# пример
weechat.prnt("", "вредност ставке: %s" % weechat.list_string(item))

3.8.12. list_user_data

WeeChat ≥ 2.6.

Враћа показивач на корисничке податке ставке.

Прототип:

void *weechat_list_user_data (struct t_weelist_item *item);

Аргументи:

  • item: показивач на ставку

Повратна вредност:

  • показивач на корисничке податке ставке

C пример:

weechat_printf (NULL, "кориснички подаци ставке: 0x%lx", weechat_list_user_data (item));
Ова функција није доступна у API скриптовања.

3.8.13. list_size

Враћа величину листе (број ставки).

Прототип:

char *weechat_list_size (struct t_weelist *weelist);

Аргументи:

  • weelist: показивач на листу

Повратна вредност:

  • величина листе (број ставки), 0 у случају да је листа празна

C пример:

weechat_printf (NULL, "величина листе: %d", weechat_list_size (list));

Скрипта (Python):

# прототип
def list_size(list: str) -> int: ...

# пример
weechat.prnt("", "величина листе: %d" % weechat.list_size(list))

3.8.14. list_remove

Уклања ставку из листе.

Прототип:

void weechat_list_remove (struct t_weelist *weelist,
                          struct t_weelist_item *item);

Аргументи:

  • weelist: показивач на листу

  • item: показивач на ставку

C пример:

weechat_list_remove (list, item);

Скрипта (Python):

# прототип
def list_remove(list: str, item: str) -> int: ...

# пример
weechat.list_remove(list, item)

3.8.15. list_remove_all

Уклања све ставке из листе.

Прототип:

void weechat_list_remove_all (struct t_weelist *weelist);

Аргументи:

  • weelist: показивач на листу

C пример:

weechat_list_remove_all (list);

Скрипта (Python):

# прототип
def list_remove_all(list: str) -> int: ...

# пример
weechat.list_remove_all(list)

3.8.16. list_free

Ослобађа меморију коју заузима листа.

Прототип:

void weechat_list_free (struct t_weelist *weelist);

Аргументи:

  • weelist: показивач на листу

C пример:

weechat_list_free (list);

Скрипта (Python):

# прототип
def list_free(list: str) -> int: ...

# пример
weechat.list_free(list)

3.9. Низ листи

Функције низа листи.

Низ листи је листа показивача са динамичком величином и необавезним сортирањем.

3.9.1. arraylist_new

WeeChat ≥ 1.8.

Креира нови низ листи.

Прототип:

struct t_arraylist *weechat_arraylist_new (int initial_size,
                                           int sorted,
                                           int allow_duplicates,
                                           int (*callback_cmp)(void *data,
                                                               struct t_arraylist *arraylist,
                                                               void *pointer1,
                                                               void *pointer2),
                                           void *callback_cmp_data,
                                           void (*callback_free)(void *data,
                                                                 struct t_arraylist *arraylist,
                                                                 void *pointer),
                                           void *callback_free_data);

Аргументи:

  • initial_size: почетна величина низа листи (не број ставки)

  • sorted: 1 ако низ листи треба да се сортира, 0 ако се не ради сортирање

  • allow_duplicates: 1 ако су дозвољене дупликат ставке, 0 ако се спречава поновно додавање исте ставке

  • callback_cmp: функција повратног позива која се користи за поређење две ставке (није обавезна), аргументи и повратна вредност су:

    • void *data: показивач

    • struct t_arraylist *arraylist: показивач на низ листи

    • void *pointer1: показивач на прву ставку

    • void *pointer2: показивач на другу ставку

    • повратна вредност:

      • негативни број ако је прва ставка мања од друге ставке

      • 0 ако су прва и друга ставка једнаке

      • позитивни број ако је прва ставка већа од друге ставке

  • callback_cmp_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_free: функција повратног позива која се користи да ослободи меморију коју заузима ставка (није обавезна), аргументи су:

    • void *data: показивач

    • struct t_arraylist *arraylist: показивач на низ листи

    • void *pointer: показивач на ставку

  • callback_free_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

Повратна вредност:

  • показивач на нови низ листи

C пример:

int
cmp_cb (void *data, struct t_arraylist *arraylist,
        void *pointer1, void *pointer2)
{
    if (...)
        return -1;
    else if (...)
        return 1;
    else
        return 0;
}

struct t_arraylist *list = weechat_arraylist_new (32, 1, 1,
                                                  &cmp_cb, NULL, NULL, NULL);
Ова функција није доступна у API скриптовања.

3.9.2. arraylist_size

WeeChat ≥ 1.8.

Враћа величину низа листи (број ставки са показивачима).

Прототип:

int weechat_list_size (struct t_arraylist *arraylist);

Аргументи:

  • arraylist: показивач на низ листи

Повратна вредност:

  • величина низа листи (број ставки), 0 у случају да је низ листи празан

C пример:

weechat_printf (NULL, "величина низа листи: %d", weechat_arraylist_size (arraylist));
Ова функција није доступна у API скриптовања.

3.9.3. arraylist_get

WeeChat ≥ 1.8.

Враћа показивач на ставку на одређеној позицији.

Прототип:

void *weechat_arraylist_get (struct t_arraylist *arraylist, int index);

Аргументи:

  • arraylist: показивач на низ листи

  • index: индекс у листи (први показивач је 0)

Повратна вредност:

  • пронађени показивач, NULL ако показивач није могао да се пронађе

C пример:

void *pointer = weechat_arraylist_get (arraylist, 0);  /* прва ставка */
Ова функција није доступна у API скриптовања.

WeeChat ≥ 1.8.

Тражи ставку у низу листи.

Прототип:

void *weechat_arraylist_search (struct t_arraylist *arraylist, void *pointer,
                                int *index, int *index_insert);

Аргументи:

  • arraylist: показивач на низ листи

  • pointer: показивач на ставку која се тражи у низу листи

  • index: показивач на цео број који ће се поставити на пронађени индекс, или -1 ако се индекс не пронађе (није обавезно)

  • index_insert: показивач на цео број које ће се поставити на индекс који мора да се употреби за уметање елемента у низ листи (како би низ листи остао уређен) (није обавезно)

Повратна вредност:

  • показивач на пронађену ставку, NULL у случају да се ставка не пронађе

C пример:

int index, index_insert;
void *item = weechat_arraylist_search (arraylist, pointer, &index, &index_insert);
Ова функција није доступна у API скриптовања.

3.9.5. arraylist_insert

WeeChat ≥ 1.8.

Умеће ставку у низ листи.

Прототип:

int weechat_arraylist_insert (struct t_arraylist *arraylist, int index, void *pointer);

Аргументи:

  • arraylist: показивач на низ листи

  • index: позиција ставке у низу листи или -1 ако треба да се дода на крај (овај аргумент се користи само у случају да низ листи није сортиран, игнорише се у случају када је низ листи сортиран)

  • pointer: показивач на ставку која треба да се уметне

Повратна вредност:

  • индекс нове ставке (>= 0), -1 у случају грешке.

C пример:

int index = weechat_arraylist_insert (arraylist, -1, pointer);  /* умеће на крај ако низ није сортиран */
Ова функција није доступна у API скриптовања.

3.9.6. arraylist_add

WeeChat ≥ 1.8.

Додаје ставку у низ листи.

Прототип:

int weechat_arraylist_add (struct t_arraylist *arraylist, void *pointer);

Аргументи:

  • arraylist: показивач на низ листи

  • pointer: показивач на ставку која се додаје

Повратна вредност:

  • индекс нове ставке (>= 0), -1 у случају грешке.

C пример:

int index = weechat_arraylist_add (arraylist, pointer);
Ова функција није доступна у API скриптовања.

3.9.7. arraylist_remove

WeeChat ≥ 1.8.

Уклања ставку из низа листи.

Прототип:

int weechat_arraylist_remove (struct t_arraylist *arraylist, int index);

Аргументи:

  • arraylist: показивач на низ листи

  • index: индекс ставке која треба да се уклони

Повратна вредност:

  • индекс уклоњене ставке, -1 у случају грешке.

C пример:

int index_removed = weechat_arraylist_remove (arraylist, index);
Ова функција није доступна у API скриптовања.

3.9.8. arraylist_clear

WeeChat ≥ 1.8.

Уклања све ставке из низа листи.

Прототип:

int weechat_arraylist_clear (struct t_arraylist *arraylist);

Аргументи:

  • arraylist: показивач на низ листи

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

if (weechat_arraylist_clear (arraylist))
{
    /* OK */
}
Ова функција није доступна у API скриптовања.

3.9.9. arraylist_free

WeeChat ≥ 1.8.

Ослобађа меморију коју заузима низ листи.

Прототип:

void weechat_arraylist_free (struct t_arraylist *arraylist);

Аргументи:

  • arraylist: показивач на низ листи

C пример:

weechat_arraylist_free (arraylist);
Ова функција није доступна у API скриптовања.

3.10. Хеш табеле

Функције хеш табели.

3.10.1. hashtable_new

WeeChat ≥ 0.3.3.

Креира нову хеш табелу.

Прототип:

struct t_hashtable *weechat_hashtable_new (int size,
                                           const char *type_keys,
                                           const char *type_values,
                                           unsigned long long (*callback_hash_key)(struct t_hashtable *hashtable,
                                                                                   const void *key),
                                           int (*callback_keycmp)(struct t_hashtable *hashtable,
                                                                  const void *key1,
                                                                  const void *key2));

Аргументи:

  • size: величина интерног низа који чува хеш кључеве, већа вредност користи више меморије, али су перформансе боље (ово није ограничење броја ставки у хеш табели)

  • type_keys: тип кључева у хеш табели:

    • WEECHAT_HASHTABLE_INTEGER

    • WEECHAT_HASHTABLE_STRING

    • WEECHAT_HASHTABLE_POINTER

    • WEECHAT_HASHTABLE_BUFFER

    • WEECHAT_HASHTABLE_TIME

  • type_values: тип вредности у хеш табели:

    • WEECHAT_HASHTABLE_INTEGER

    • WEECHAT_HASHTABLE_STRING

    • WEECHAT_HASHTABLE_POINTER

    • WEECHAT_HASHTABLE_BUFFER

    • WEECHAT_HASHTABLE_TIME

  • callback_hash_key: функција повратног позива која се користи за „хеширање” кључа (кључ у облику целог броја), може да буде NULL ако тип кључа није „buffer” (користи се подразумевана хеш функција), аргументи и повратна вредност су:

    • struct t_hashtable *hashtable: показивач на хеш табелу

    • const void *key: кључ

    • return value: хеш кључа

  • callback_keycmp: функција повратног позива која се користи за поређење два кључа, може да буде NULL ако тип кључа није „buffer” (користи се подразумевана функција за поређење), аргументи и повратна вредност су:

    • struct t_hashtable *hashtable: показивач на хеш табелу

    • const void *key1: први кључ

    • const void *key2: други кључ

    • повратна вредност:

      • негативни број ако је key1 мањи од key2

      • 0 ако су key1 и key2 једнаки

      • позитивни број ако је key1 већи од key2

Повратна вредност:

  • показивач на нову хеш табелу, NULL у случају грешке

C пример:

struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       NULL,
                                                       NULL);
Ова функција није доступна у API скриптовања.

3.10.2. hashtable_set_with_size

WeeChat ≥ 0.3.3, ажурирано у верзији 0.4.2.

Додаје или ажурира ставку у хеш табели са величином за кључ и вредност.

Прототип:

struct t_hashtable_item *weechat_hashtable_set_with_size (struct t_hashtable *hashtable,
                                                          const void *key, int key_size,
                                                          const void *value, int value_size);

Аргументи:

  • hashtable: показивач на хеш табелу

  • key: показивач на кључ

  • key_size: величина кључа (у бајтовима), користи се само ако је тип кључева у хеш табели „buffer”

  • value: показивач на вредност

  • value_size: величина вредности (у бајтовима), користи се само ако је тип вредности у хеш табели „buffer”

Повратна вредност:

  • показивач на креирану/ажурирану ставку, NULL у случају грешке

C пример:

weechat_hashtable_set_with_size (hashtable, "my_key", 0,
                                 my_buffer, sizeof (my_buffer_struct));
Ова функција није доступна у API скриптовања.

3.10.3. hashtable_set

WeeChat ≥ 0.3.3, ажурирано у верзији 0.4.2.

Додаје или ажурира ставку у хеш табели.

Прототип:

struct t_hashtable_item *weechat_hashtable_set (struct t_hashtable *hashtable,
                                                const void *key, const void *value);

Аргументи:

  • hashtable: показивач на хеш табелу

  • key: показивач на кључ

  • value: показивач на вредност

Повратна вредност:

  • показивач на креирану/ажурирану ставку, NULL у случају грешке

C пример:

weechat_hashtable_set (hashtable, "my_key", "my_value");
Ова функција није доступна у API скриптовања.

3.10.4. hashtable_get

WeeChat ≥ 0.3.3.

Враћа вредност придружену кључу у хеш табели.

Прототип:

void *weechat_hashtable_get (struct t_hashtable *hashtable, void *key);

Аргументи:

  • hashtable: показивач на хеш табелу

  • key: показивач на кључ

Повратна вредност:

  • вредност за кључ, NULL ако кључ не може да се пронађе

C пример:

void *value = weechat_hashtable_get (hashtable, "my_key");
Ова функција није доступна у API скриптовања.

3.10.5. hashtable_has_key

WeeChat ≥ 0.3.4.

Проверава да ли се кључ налази у хеш табели.

Прототип:

int weechat_hashtable_has_key (struct t_hashtable *hashtable, void *key);

Аргументи:

  • hashtable: показивач на хеш табелу

  • key: показивач на кључ

Повратна вредност:

  • 1 ако се кључ налази у хеш табели, 0 ако се кључ не налази у хеш табели

C пример:

if (weechat_hashtable_has_key (hashtable, "my_key"))
{
    /* кључ се налази у хеш табели */
    /* ... */
}
Ова функција није доступна у API скриптовања.

3.10.6. hashtable_map

WeeChat ≥ 0.3.3.

Позива функцију над свим ставкама хеш табеле, по редоследу уметања у хештабелу (од најстарије до најновије).

Прототип:

void weechat_hashtable_map (struct t_hashtable *hashtable,
                            void (*callback_map)(void *data,
                                                 struct t_hashtable *hashtable,
                                                 const void *key,
                                                 const void *value),
                            void *callback_map_data);

Аргументи:

  • hashtable: показивач на хеш табелу

  • callback_map: функција која се позива за сваку ставку у хеш табели

  • callback_map_data: показивач који се прослеђује функцији повратног позива мапирања када се позове

C пример:

void
map_cb (void *data, struct t_hashtable *hashtable,
        const void *key, const void *value)
{
    /* приказује кључ и вредност (овде су оба стрингови) */
    weechat_printf (NULL, "кључ: '%s', вредност: '%s'",
                    (const char *)key,
                    (const char *)value);
}
/* ... */
weechat_hashtable_map (hashtable, &map_cb, NULL);
Ова функција није доступна у API скриптовања.

3.10.7. hashtable_map_string

WeeChat ≥ 0.3.7.

Позива функцију над свим ставкама хеш табеле, по редоследу у којем су уметнуте у хеш табелу (од најстарије до најновије), шаљући књучеве и вредности као стрингове.

Прототип:

void weechat_hashtable_map_string (struct t_hashtable *hashtable,
                                   void (*callback_map)(void *data,
                                                        struct t_hashtable *hashtable,
                                                        const char *key,
                                                        const char *value),
                                   void *callback_map_data);

Аргументи:

  • hashtable: показивач на хеш табелу

  • callback_map: функција која се позива за сваку ставку у хеш табели

  • callback_map_data: показивач који се прослеђује функцији повратног позива мапирања када се позове

Стрингови key и value који се шаљу функцији повратног позива су привремени стрингови, они се бришу након позива функције повратног позива.

C пример:

void
map_cb (void *data, struct t_hashtable *hashtable,
        const char *key, const char *value)
{
    /* приказ кључа и вредности */
    weechat_printf (NULL, "кључ: '%s', вредност: '%s'",
                    key, value);
}
/* ... */
weechat_hashtable_map_string (hashtable, &map_cb, NULL);
Ова функција није доступна у API скриптовања.

3.10.8. hashtable_dup

WeeChat ≥ 1.0.

Прави дупликат хеш табеле.

Прототип:

struct t_hashtable *weechat_hashtable_dup (struct t_hashtable *hashtable);

Аргументи:

  • hashtable: показивач на хеш табелу

Повратна вредност:

  • дулпирана хеш табела

C пример:

struct t_hashtable *new_hashtable = weechat_hashtable_dup (hashtable);
Ова функција није доступна у API скриптовања.

3.10.9. hashtable_get_integer

WeeChat ≥ 0.3.3.

Враћа целобројну вредност особине хеш табеле.

Прототип:

int weechat_hashtable_get_integer (struct t_hashtable *hashtable,
                                   void *property);

Аргументи:

  • hashtable: показивач на хеш табелу

  • property: име особине:

    • size: величина интерног низа „htable” у хеш табели

    • items_count: број ставки у хеш табели

Повратна вредност:

  • целобројна вредност особине

C пример:

int items_count = weechat_hashtable_get_integer (hashtable, "items_count");
Ова функција није доступна у API скриптовања.

3.10.10. hashtable_get_string

WeeChat ≥ 0.3.4.

Враћа стринг вредност особине хеш табеле.

Прототип:

const char *weechat_hashtable_get_string (struct t_hashtable *hashtable,
                                          const char *property);

Аргументи:

  • hashtable: показивач на хеш табелу

  • property: име особине:

    • type_keys: тип кључева:

      • integer: цео број

      • string: стринг

      • pointer: показивач

      • buffer: бафер

      • time: време

    • type_values: тип вредности:

      • integer: цео број

      • string: стринг

      • pointer: показивач

      • buffer: бафер

      • time: време

    • keys: стринг са листом кључева (у формату: „кључ1,кључ2,кључ3”)

    • keys_sorted: стринг са листом сортираних кључева (у формату: „кључ1,кључ2,кључ3”)

    • values: стринг са листом вредности

    • keys_values: стринг са листом кључева и вредности (у формату: „кључ1:вредност1,кључ2:вредност2,кључ3:вредност3”)

    • keys_values_sorted: стринг са листом кључева и вредности (сортиран по кључевима) (у формату: „кључ1:вредност1,кључ2:вредност2,кључ3:вредност3”)

Повратна вредност:

  • стринг вредност особине

C примери:

weechat_printf (NULL, "keys are type: %s",
                weechat_hashtable_get_string (hashtable, "type_keys"));
weechat_printf (NULL, "list of keys: %s",
                weechat_hashtable_get_string (hashtable, "keys"));
Ова функција није доступна у API скриптовања.

3.10.11. hashtable_set_pointer

WeeChat ≥ 0.3.4.

Поставља вредност показивача на особину хеш табеле.

Прототип:

void weechat_hashtable_set_pointer (struct t_hashtable *hashtable,
                                    const char *property, void *pointer);

Аргументи:

  • hashtable: показивач на хеш табелу

  • property: име особине:

    • callback_free_key: поставља функцију повратног позива која се користи за ослобађање меморије коју заузимају кључеви у хеш табели (WeeChat ≥ 0.4.2)

    • callback_free_value: поставља функцију повратног позива која се користи за ослобађање меморије коју користе вредности у хеш табели

  • pointer: нова вредност показивача за особину

C пример:

void
my_free_value_cb (struct t_hashtable *hashtable, const void *key, void *value)
{
    /* ... */
}

void
my_free_key_cb (struct t_hashtable *hashtable, void *key)
{
    /* ... */
}

weechat_hashtable_set_pointer (hashtable, "callback_free_value", &my_free_value_cb);
weechat_hashtable_set_pointer (hashtable, "callback_free_key", &my_free_key_cb);
Ова функција није доступна у API скриптовања.

3.10.12. hashtable_add_to_infolist

WeeChat ≥ 0.3.3.

Додаје ставе хеш табеле у ставку инфо листе, по редоследу у којем су уметнуте у хеш табелу (од најстарије до најновије).

Прототип:

int weechat_hashtable_add_to_infolist (struct t_hashtable *hashtable,
                                       struct t_infolist_item *infolist_item,
                                       const char *prefix);

Аргументи:

  • hashtable: показивач на хеш табелу

  • infolist_item: показивач на ставку инфо листе

  • prefix: стринг који се користи као префикс за имена у инфо листи

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

weechat_hashtable_add_to_infolist (hashtable, infolist_item, "testhash");

/* ако хеш табела садржи:
     "кључ1" => "вредност 1"
     "кључ2" => "вредност 2"
   онда ће се у ставку инфо листе додати следеће променљиве:
     "testhash_name_00000"  = "кључ1"
     "testhash_value_00000" = "вредност 1"
     "testhash_name_00001"  = "кључ2"
     "testhash_value_00001" = "вредност 2"
*/
Ова функција није доступна у API скриптовања.

3.10.13. hashtable_add_from_infolist

WeeChat ≥ 2.2.

Додаје ставке инфо листе у хеш табелу.

Прототип:

int weechat_hashtable_add_from_infolist (struct t_hashtable *hashtable,
                                         struct t_infolist *infolist,
                                         const char *prefix);

Аргументи:

  • hashtable: показивач на хеш табелу

  • infolist: показивач на инфо листу

  • prefix: стринг који се користи као префикс за имена у инфо листи

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

weechat_hashtable_add_from_infolist (hashtable, infolist, "testhash");

/* ако инфо листа садржи:
     "testhash_name_00000"  = "кључ1"
     "testhash_value_00000" = "вредност 1"
     "testhash_name_00001"  = "кључ2"
     "testhash_value_00001" = "вредност 2"
   онда ће се у хеш табелу додати следеће променљиве:
     "кључ1" => "вредност 1"
     "кључ2" => "вредност 2"
*/
Ова функција није доступна у API скриптовања.

3.10.14. hashtable_remove

WeeChat ≥ 0.3.3.

Уклања ставку из хеш табеле.

Прототип:

void weechat_hashtable_remove (struct t_hashtable *hashtable, const void *key);

Аргументи:

  • hashtable: показивач на хеш табелу

  • key: показивач на кључ

C пример:

weechat_hashtable_remove (hashtable, "my_key");
Ова функција није доступна у API скриптовања.

3.10.15. hashtable_remove_all

WeeChat ≥ 0.3.3.

Уклања све ставке из хеш табеле.

Прототип:

void weechat_hashtable_remove_all (struct t_hashtable *hashtable);

Аргументи:

  • hashtable: показивач на хеш табелу

C пример:

weechat_hashtable_remove_all (hashtable);
Ова функција није доступна у API скриптовања.

3.10.16. hashtable_free

WeeChat ≥ 0.3.3.

Ослобађа меморију коју заузима хеш табела.

Прототип:

void weechat_hashtable_free (struct t_hashtable *hashtable);

Аргументи:

  • hashtable: показивач на хеш табелу

C пример:

weechat_hashtable_free (hashtable);
Ова функција није доступна у API скриптовања.

3.11. Конфигурациони фајлови

Функције за конфигурационе фајлове.

3.11.1. config_new

Ажурирано у верзији 1.5.

Креира нови конфигурациони фајл.

Прототип:

struct t_config_file *weechat_config_new (const char *name,
                                          int (*callback_reload)(const void *pointer,
                                                                 void *data,
                                                                 struct t_config_file *config_file),
                                          const void *callback_reload_pointer,
                                          void *callback_reload_data);

Аргументи:

  • name: име конфигурационог фајла (без путање или екстензије)

  • callback_reload: функција која се позива када се командом /reload поново учита конфигурациони фајл (није обавезна, може да буде NULL, погледајте испод), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_file *config_file: показивач на конфигурациони фајл

    • повратна вредност:

      • WEECHAT_CONFIG_READ_OK

      • WEECHAT_CONFIG_READ_MEMORY_ERROR

      • WEECHAT_CONFIG_READ_FILE_NOT_FOUND

  • callback_reload_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_reload_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, онда је алоциран са malloc (или неком сличном функцијом) и аутоматски се ослобађа када се ослободи конфигурациони фајл

Функција повратног позива код поновног учитавања:

  • Функција повратног позива сме само да позове функцију config_reload, не сме да уклања конфигурациони фајл.

  • Функција повратног позива је потребна само ако треба да се обаве неке ствари пре и/или након позива функције config_reload.
    Ако се не наведе функција повратног позива, програм WeeChat ће позвати своју интерну функцију за поновно учитавање, тако да ће се конфигурациони фајл поново учитати у свим случајевима.

Повратна вредност:

  • показивач на нови конфигурациони фајл, NULL у случају грешке

Ова функција НЕ креира фајл на диску. Фајл ће се креирати позивом функције config_write. Ово функцију би требало да позовете само након додавања неких одељака (са config_new_section) и опција (са config_new_option).

C пример:

int
my_config_reload_cb (const void *pointer, void *data,
                     struct t_config_file *config_file)
{
    /* ... */

    return WEECHAT_RC_OK;
}

struct t_config_file *config_file = weechat_config_new ("test",
                                                        &my_config_reload_cb,
                                                        NULL, NULL);

Скрипта (Python):

# прототип
def config_new(name: str, callback_reload: str, callback_reload_data: str) -> str: ...

# пример
def my_config_reload_cb(data, config_file):
    # ...
    return weechat.WEECHAT_RC_OK

config_file = weechat.config_new("test", "my_config_reload_cb", "")

3.11.2. config_new_section

Ажурирано у верзији 1.5.

Креира нови одељак у конфигурационом фајлу.

Прототип:

struct t_config_section *weechat_config_new_section (
    struct t_config_file *config_file,
    const char *name,
    int user_can_add_options,
    int user_can_delete_options,
    int (*callback_read)(const void *pointer,
                         void *data,
                         struct t_config_file *config_file,
                         struct t_config_section *section,
                         const char *option_name,
                         const char *value),
    const void *callback_read_pointer,
    void *callback_read_data,
    int (*callback_write)(const void *pointer,
                          void *data,
                          struct t_config_file *config_file,
                          const char *section_name),
    const void *callback_write_pointer,
    void *callback_write_data,
    int (*callback_write_default)(const void *pointer,
                                  void *data,
                                  struct t_config_file *config_file,
                                  const char *section_name),
    const void *callback_write_default_pointer,
    void *callback_write_default_data,
    int (*callback_create_option)(const void *pointer,
                                  void *data,
                                  struct t_config_file *config_file,
                                  struct t_config_section *section,
                                  const char *option_name,
                                  const char *value),
    const void *callback_create_option_pointer,
    void *callback_create_option_data,
    int (*callback_delete_option)(const void *pointer,
                                  void *data,
                                  struct t_config_file *config_file,
                                  struct t_config_section *section,
                                  struct t_config_option *option),
    const void *callback_delete_option_pointer,
    void *callback_delete_option_data);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • name: име одељка

  • user_can_add_options: 1 ако корисник у одељку може да креира нове опције, или 0 ако је то забрањено

  • user_can_delete_options: 1 ако корисник може да брише опције у одељку, или 0 ако је то забрањено

  • callback_read: функција која се позива када се опција у одељку прочита са диска (у већини случајева би требало да буде NULL, осим ако опције у одељку захтевају прилагођену функцију), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_file *config_file: показивач на конфигурациони фајл

    • struct t_config_section *section: показивач на одељак

    • const char *option_name: име опције

    • const char *value: вредност

    • повратна вредност:

      • WEECHAT_CONFIG_READ_OK

      • WEECHAT_CONFIG_READ_MEMORY_ERROR

      • WEECHAT_CONFIG_READ_FILE_NOT_FOUND

  • callback_read_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_read_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се ослободи одељак

  • callback_write: функција која се позива када се одељак уписује у фајл (у већини случајева би требало да буде NULL, осим ако је потребно да се одељак упише прилагођеном функцијом), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_file *config_file: показивач на конфигурациони фајл

    • struct t_config_section *section: показивач на одељак

    • const char *section_name: име одељка

    • повратна вредност:

      • WEECHAT_CONFIG_WRITE_OK

      • WEECHAT_CONFIG_WRITE_ERROR

      • WEECHAT_CONFIG_WRITE_MEMORY_ERROR

  • callback_write_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_write_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се ослободи одељак

  • callback_write_default: функција која се позива када у фајл мора да се упишу подразумеване опције за одељак, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_file *config_file: показивач на конфигурациони фајл

    • const char *section_name: име одељка

    • повратна вредност:

      • WEECHAT_CONFIG_WRITE_OK

      • WEECHAT_CONFIG_WRITE_ERROR

      • WEECHAT_CONFIG_WRITE_MEMORY_ERROR

  • callback_write_default_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_write_default_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се одељак ослободи

  • callback_create_option: функција која се позива када се у одељку креира нова опција (NULL ако одељак не дозвољава креирање нових опција), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_file *config_file: показивач на конфигурациони фајл

    • struct t_config_section *section: показивач на одељак

    • const char *option_name: име опције

    • const char *value: вредност

    • повратна вредност:

      • 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_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_create_option_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се ослободи одељак

  • callback_delete_option: функција која се позива када се у одељку обрише опција (NULL ако одељак не дозвољава брисање опција), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_file *config_file: показивач на конфигурациони фајл

    • struct t_config_section *section: показивач на одељак

    • struct t_config_option *option: показивач на опцију

    • повратна вредност:

      • 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_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_delete_option_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или слична функција) и аутоматски се ослобађа када се ослободи одељак

Повратна вредност:

  • показивач на нови одељак у конфигурационом фајлу, NULL у случају грешке

C пример:

int
my_section_read_cb (const void *pointer, void *data,
                    struct t_config_file *config_file,
                    struct t_config_section *section,
                    const char *option_name,
                    const char *value)
{
    /* ... */

    return WEECHAT_CONFIG_READ_OK;
    /* return WEECHAT_CONFIG_READ_MEMORY_ERROR; */
    /* return WEECHAT_CONFIG_READ_FILE_NOT_FOUND; */
}

int
my_section_write_cb (const void *pointer, void *data,
                     struct t_config_file *config_file,
                     const char *section_name)
{
    /* ... */

    return WEECHAT_CONFIG_WRITE_OK;
    /* return WEECHAT_CONFIG_WRITE_ERROR; */
    /* return WEECHAT_CONFIG_WRITE_MEMORY_ERROR; */
}

int
my_section_write_default_cb (const void *pointer, void *data,
                             struct t_config_file *config_file,
                             const char *section_name)
{
    /* ... */

    return WEECHAT_CONFIG_WRITE_OK;
    /* return WEECHAT_CONFIG_WRITE_ERROR; */
    /* return WEECHAT_CONFIG_WRITE_MEMORY_ERROR; */
}

int
my_section_create_option_cb (const void *pointer, void *data,
                             struct t_config_file *config_file,
                             struct t_config_section *section,
                             const char *option_name,
                             const char *value)
{
    /* ... */

    return WEECHAT_CONFIG_OPTION_SET_OK_CHANGED;
    /* return WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE; */
    /* return WEECHAT_CONFIG_OPTION_SET_ERROR; */
    /* return WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND; */
}

int
my_section_delete_option_cb (const void *pointer, void *data,
                             struct t_config_file *config_file,
                             struct t_config_section *section,
                             struct t_config_option *option)
{
    /* ... */

    return WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED;
    /* return WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET; */
    /* return WEECHAT_CONFIG_OPTION_UNSET_OK_RESET; */
    /* return WEECHAT_CONFIG_OPTION_UNSET_ERROR; */
}

/* стандардни одељак, корисник не може да додаје/брише опције */
struct t_config_section *new_section1 =
    weechat_config_new_section (config_file, "section1", 0, 0,
                                NULL, NULL, NULL,
                                NULL, NULL, NULL,
                                NULL, NULL, NULL,
                                NULL, NULL, NULL,
                                NULL, NULL, NULL);

/* специјални одељак, корисник може да додаје/брише опције и за упис/читање
   опција је потребна функција повратног позива */
struct t_config_section *new_section2 =
    weechat_config_new_section (config_file, "section2", 1, 1,
                                &my_section_read_cb, NULL, NULL,
                                &my_section_write_cb, NULL, NULL,
                                &my_section_write_default_cb, NULL, NULL,
                                &my_section_create_option_cb, NULL, NULL,
                                &my_section_delete_option_cb, NULL, NULL);

Скрипта (Python):

# прототип
def config_new_section(config_file: str, name: str,
                       user_can_add_options: int, user_can_delete_options: int,
                       callback_read: str, callback_read_data: str,
                       callback_write: str, callback_write_data: str,
                       callback_create_option: str, callback_create_option_data: str,
                       callback_delete_option: str, callback_delete_option_data: str) -> str: ...

# пример
def my_section_read_cb(data, config_file, section, option_name, value):
    # ...
    return weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED
    # return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE
    # return weechat.WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND
    # return weechat.WEECHAT_CONFIG_OPTION_SET_ERROR

def my_section_write_cb(data, config_file, section_name):
    # ...
    return weechat.WEECHAT_CONFIG_WRITE_OK

def my_section_write_default_cb(data, config_file, section_name):
    # ...
    return weechat.WEECHAT_CONFIG_WRITE_OK

def my_section_create_option_cb(data, config_file, section, option_name, value):
    # ...
    return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE

def my_section_delete_option_cb(data, config_file, section, option):
    # ...
    return weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED

section = weechat.config_new_section(config_file, "section1", 1, 1,
    "my_section_read_cb", "",
    "my_section_write_cb", "",
    "my_section_write_default_cb", "",
    "my_section_create_option_cb", "",
    "my_section_delete_option_cb", "")

3.11.3. config_search_section

Тражи одељак у конфигурационом фајлу.

Прототип:

struct t_config_section *weechat_config_search_section (
    struct t_config_file *config_file,
    const char *section_name);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • section_name: име одељка који се тражи

Повратна вредност:

  • показивач на пронађени одељак, NULL у случају да се одељак не пронађе

C пример:

struct t_config_section *section = weechat_config_search_section (config_file,
                                                                  "section");

Скрипта (Python):

# прототип
def config_search_section(config_file: str, section_name: str) -> str: ...

# пример
section = weechat.config_search_section(config_file, "section")

3.11.4. config_new_option

Ажурирано у верзији 1.5.

Креира нову опцију у одељку конфигурационог фајла.

Прототип:

struct t_config_option *weechat_config_new_option (
    struct t_config_file *config_file,
    struct t_config_section *section,
    const char *name,
    const char *type,
    const char *description,
    const char *string_values,
    int min,
    int max,
    const char *default_value,
    const char *value,
    int null_value_allowed,
    int (*callback_check_value)(const void *pointer,
                                void *data,
                                struct t_config_option *option,
                                const char *value),
    const void *callback_check_value_pointer,
    void *callback_check_value_data,
    void (*callback_change)(const void *pointer,
                            void *data,
                            struct t_config_option *option),
    const void *callback_change_pointer,
    void *callback_change_data,
    void (*callback_delete)(const void *pointer,
                            void *data,
                            struct t_config_option *option),
    const void *callback_delete_pointer,
    void *callback_delete_data);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • section: показивач на одељак

  • name: име опције; у програм у WeeChat верзије ≥ 1.4, име може да укључи и име родитељске опције (у случају да је ова опција „null”, вредност родитељске опције ће се приказати у излазу команде /set), тада је синтакса: „име << фајл.одељак.опција”

  • type: тип опције:

    • boolean: логичка вредност (on/off)

    • integer: целобројна вредност (са стринговима за вредности који нису обавезни)

    • string: стринг вредност

    • color: боја

  • description: опис опције

  • string_values: вредности као стринг (раздвојене са |), користе се за integer тип (није обавезно)

  • min: минимална вредност (за integer тип)

  • max: максимална вредност (за integer тип)

  • default_value: подразумевана вредност опције (користи се када се опција ресетује)

  • value: вредност за опцију

  • null_value_allowed: 1 ако се за опцију дозвољава null (недефинисана вредност), у супротном 0

  • callback_check_value: функција која се позива за проверу нове вредности опције (није обавезна), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_option *option: показивач на опцију

    • const char *value: нова вредност опције

    • повратна вредност:

      • 1 ако је вредност ОК

      • 0 ако је вредност неважећа

  • callback_check_value_pointer: показивач који се прослеђује check_value функцији повратног позива када је позове програм WeeChat

  • callback_check_value_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се ослободи опција

  • callback_change: функција која се позива када се промени вредност опције (није обавезна), аргументи су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_option *option: показивач на опцију

  • callback_change_pointer: показивач који се прослеђује change функцији повратног позива када је позове програм WeeChat

  • callback_change_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се ослободи опција

  • callback_delete: функција која се позива када се опција брише (није обавезна), аргументи су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_config_option *option: показивач на опцију

  • callback_delete_pointer: показивач који се прослеђује delete функцији повратног позива када је позове програм WeeChat

  • callback_delete_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или слична функција) и аутоматски се ослобађа када се ослободи опција

Повратна вредност:

  • показивач на нову опцију у одељку, NULL у случају грешке

C пример:

/* логичка */
struct t_config_option *option1 =
    weechat_config_new_option (config_file, section, "option1", "boolean",
                               "My option, type boolean",
                               NULL,
                               0, 0,
                               "on",
                               "on",
                               0,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL);

/* целобројна */
struct t_config_option *option2 =
    weechat_config_new_option (config_file, section, "option2", "integer",
                               "My option, type integer",
                               NULL,
                               0, 100,
                               "15",
                               "15",
                               0,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL);

/* целобројна (са стринг вредностима) */
struct t_config_option *option3 =
    weechat_config_new_option (config_file, section, "option3", "integer",
                               "My option, type integer (with string values)",
                               "top|bottom|left|right",
                               0, 0,
                               "bottom",
                               "bottom",
                               0,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL);

/* стринг */
struct t_config_option *option4 =
    weechat_config_new_option (config_file, section, "option4", "string",
                               "My option, type string",
                               NULL,
                               0, 0,
                               "test",
                               "test",
                               1,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL);

/* боја */
struct t_config_option *option5 =
    weechat_config_new_option (config_file, section, "option5", "color",
                               "My option, type color",
                               NULL,
                               0, 0,
                               "lightblue",
                               "lightblue",
                               0,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL,
                               NULL, NULL, NULL);

Скрипта (Python):

# прототип
def config_new_option(config_file: str, section: str, name: str, type: str, description: str,
                      string_values: str, min: int, max: int,
                      default_value: str, value: str, null_value_allowed: int,
                      callback_check_value: str, callback_check_value_data: str,
                      callback_change: str, callback_change_data: str,
                      callback_delete: str, callback_delete_data: str) -> str: ...

# пример
def option4_check_value_cb(data, option, value):
    # ...
    return 1
    # return 0

def option4_change_cb(data, option):
    # ...

def option4_delete_cb(data, option):
    # ...

option1 = weechat.config_new_option(config_file, section, "option1", "boolean",
    "My option, type boolean",
    "", 0, 0, "on", "on", 0,
    "", "",
    "", "",
    "", "")

option2 = weechat.config_new_option(config_file, section, "option2", "integer",
    "My option, type integer",
    "", 0, 100, "15", "15", 0,
    "", "",
    "", "",
    "", "")

option3 = weechat.config_new_option(config_file, section, "option3", "integer",
    "My option, type integer (with string values)",
    "top|bottom|left|right",
    0, 0, "bottom", "bottom", 0,
    "", "",
    "", "",
    "", "")

option4 = weechat.config_new_option(config_file, section, "option4", "string",
    "My option, type string",
    "", 0, 0, "test", "test", 1,
    "option4_check_value_cb", "",
    "option4_change_cb", "",
    "option4_delete_cb", "")

option5 = weechat.config_new_option(config_file, section, "option5", "color",
    "My option, type color",
    "", 0, 0, "lightblue", "lightblue", 0,
    "", "",
    "", "",
    "", "")
У језику Ruby, 3 функције повратног позива + подаци (6 стрингова) морају да се наведу у низу од 6 стрингова (услед Ruby ограничења од 15 аргумената по функцији), за више информација, погледајте WeeChat водич за скриптовање (исправљено у верзији 0.4.1).

3.11.5. config_search_option

Тражи опцију у одељку конфигурационог фајла.

Прототип:

struct t_config_option *weechat_config_search_option (
    struct t_config_file *config_file,
    struct t_config_section *section,
    const char *option_name);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • section: показивач на одељак

  • name: име опције која се тражи

Повратна вредност:

  • показивач на нађену опцију, NULL у случају да се опција не нађе

C пример:

struct t_config_option *option =
    weechat_config_search_option (config_file, section, "option");

Скрипта (Python):

# прототип
def config_search_option(config_file: str, section: str, option_name: str) -> str: ...

# пример
option = weechat.config_search_option(config_file, section, "option")

3.11.6. config_search_section_option

Тражи одељак и опцију у конфигурационом фајлу или одељку.

Прототип:

void weechat_config_search_section_option (struct t_config_file *config_file,
                                           struct t_config_section *section,
                                           const char *option_name,
                                           struct t_config_section **section_found,
                                           struct t_config_option **option_found);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • section: показивач на одељак

  • option_name: име опције

  • section_found: показивач на показивач одељка, ако се пронађе, поставиће се на одељак опције

  • option_found: показивач на показивач опције, ако се пронађе, поставићесе на показивач опције

C пример:

struct t_config_section *ptr_section;
struct t_config_option *ptr_option;

weechat_config_search_section_option(config_file,
                                     section,
                                     "option",
                                     &ptr_section,
                                     &ptr_option);
if (ptr_option)
{
    /* опција је пронађена */
}
else
{
    /* опција није пронађена */
}
Ова функција није доступна у API скриптовања.

3.11.7. config_search_with_string

Враћа инфо о фајлу/одељку/опцији опције са пуним именом.

Прототип:

void weechat_config_search_with_string (const char *option_name,
                                        struct t_config_file **config_file,
                                        struct t_config_section **section,
                                        struct t_config_option **option,
                                        char **pos_option_name);

Аргументи:

  • option_name: пуно име опције (у формату: „фајл.одељак.опција”)

  • config_file: показивач на показивач конфигурационог фајла, ако се опција пронађе, поставиће се на показивач конфигурационог фајла

  • section: показивач на показивач одељка, ако се пронађе, поставиће се на одељак у коме је опција

  • option: показивач на показивач опције, ако се пронађе, поставиће се на показивач опције

  • pos_option_name: показивач на показивач стринга, ако се пронађе, поставиће се на показивач имена опције

C пример:

struct t_config_file *ptr_config_file;
struct t_config_section *ptr_section;
struct t_config_option *ptr_option;
char *option_name;

weechat_config_search_with_string ("file.section.option",
                                   &ptr_config_file,
                                   &ptr_section,
                                   &ptr_option,
                                   &option_name);
if (ptr_option)
{
    /* опција је пронађена */
}
else
{
    /* опција није пронађена */
}
Ова функција није доступна у API скриптовања.

3.11.8. config_string_to_boolean

Проверава да ли је текст „true” или „false”, као логичка вредност.

Прототип:

int weechat_config_string_to_boolean (const char *text);

Аргументи:

  • text: текст који се анализира

Повратна вредност:

  • 1 ако је текст „true” („on”, „yes”, „y”, „true”, „t”, „1”)

  • 0 ако је текст „false” („off”, „no”, „n”, „false”, „f”, „0”)

C пример:

if (weechat_config_string_to_boolean (option_value))
{
    /* вредност је "true" */
}
else
{
    /* вредност је "false" */
}

Скрипта (Python):

# прототип
def config_string_to_boolean(text: str) -> int: ...

# пример
if weechat.config_string_to_boolean(text):
    # ...

3.11.9. config_option_reset

Ресетује опцију на њену подразумевану вредности.

Прототип:

int weechat_config_option_reset (struct t_config_option *option,
                                 int run_callback);

Аргументи:

  • option: показивач на опцију

  • run_callback: 1 за позив функције повратног позива ако је вредност опције промењена, у супротном 0

Повратна вредност:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED ако је вредност опције ресетована

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE ако вредност није измењена

  • WEECHAT_CONFIG_OPTION_SET_ERROR ако је дошло до грешке

C пример:

switch (weechat_config_option_reset (option, 1))
{
    case WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_ERROR:
        /* .... */
        break;
}

Скрипта (Python):

# прототип
def config_option_reset(option: str, run_callback: int) -> int: ...

# пример
rc = weechat.config_option_reset(option, 1)
if rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR:
    # ...

3.11.10. config_option_set

Поставља нову вредност опције.

Прототип:

int weechat_config_option_set (struct t_config_option *option,
                               const char *value, int run_callback);

Аргументи:

  • option: показивач на опцију

  • value: нова вредност опције, могуће су и специјалне вредности које зависе од типа опције:

    • boolean:

      • toggle: пребацује текућу вредност

    • integer или color:

      • ++N: додаје N (било који цео број) на текућу вредност

      • --N: одузима N (било који цео број) од текуће вредности

  • run_callback: 1 за позив change функције повратног позива ако је вредност измењена, у супротном 0

Повратна вредност:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED ако је вредност опције измењена

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE ако вредност није измењена

  • WEECHAT_CONFIG_OPTION_SET_ERROR ако је дошло до грешке

C пример:

switch (weechat_config_option_set (option, "new_value", 1))
{
    case WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_ERROR:
        /* .... */
        break;
}

Скрипта (Python):

# прототип
def config_option_set(option: str, value: str, run_callback: int) -> int: ...

# пример
rc = weechat.config_option_set(option, "new_value", 1)
if rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR:
    # ...

3.11.11. config_option_set_null

Поставља опцију на null (недефинисану вредност).

Прототип:

int weechat_config_option_set_null (struct t_config_option *option,
                                    int run_callback);

Аргументи:

  • option: показивач на опцију

  • run_callback: 1 за позив change функције повратног позива ако је вредност опције измењена, у супротном 0

Вредност можете да поставите на null само ако је то дозвољено за опцију (погледајте config_new_option).

Повратна вредност:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED ако је вредност опције измењена

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE ако вредност није измењена

  • WEECHAT_CONFIG_OPTION_SET_ERROR ако је дошло до грешке

C пример:

switch (weechat_config_option_set_null (option, 1))
{
    case WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_ERROR:
        /* .... */
        break;
}

Скрипта (Python):

# прототип
def config_option_set_null(option: str, run_callback: int) -> int: ...

# пример
rc = weechat.config_option_set_null(option, 1)
if rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR:
    # ...

3.11.12. config_option_unset

Уклања/ресетује опцију.

Прототип:

int weechat_config_option_unset (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност:

  • WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET ако вредност опције није ресетована

  • WEECHAT_CONFIG_OPTION_UNSET_OK_RESET ако је вредност опције ресетована

  • WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED ако је опција уклоњена

  • WEECHAT_CONFIG_OPTION_UNSET_ERROR ако је дошло до грешке

C пример:

switch (weechat_config_option_unset (option))
{
    case WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_UNSET_OK_RESET:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED:
        /* .... */
        break;
    case WEECHAT_CONFIG_OPTION_UNSET_ERROR:
        /* .... */
        break;
}

Скрипта (Python):

# прототип
def config_option_unset(option: str) -> int: ...

# пример
rc = weechat.config_option_unset(option)
if rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_RESET:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_ERROR:
    # ...

3.11.13. config_option_rename

Мења име опције.

Прототип:

void weechat_config_option_rename (struct t_config_option *option,
                                   const char *new_name);

Аргументи:

  • option: показивач на опцију

  • new_name: ново име опције

C пример:

weechat_config_option_rename (option, "new_name");

Скрипта (Python):

# прототип
def config_option_rename(option: str, new_name: str) -> int: ...

# пример
weechat.config_option_rename(option, "new_name")

3.11.14. config_option_get_string

WeeChat ≥ 1.9.

Враћа стринг вредност особине опције.

Прототип:

const char *weechat_config_option_get_string (struct t_config_option *option,
                                              const char *property);

Аргументи:

  • option: показивач на опцију

  • property: име особине:

    • config_name: име фајла

    • section_name: име одељка

    • name: име опције

    • parent_name: име родитељске опције

    • type: тип опције, једно од:

      • boolean

      • integer

      • string

      • color

    • description: опис опције

Повратна вредност:

  • стринг вредност особине

C пример:

const char *type = weechat_config_option_get_string (option, "type");
Ова функција није доступна у API скриптовања.

3.11.15. config_option_get_pointer

Враћа показивач на особину опције.

Прототип:

void *weechat_config_option_get_pointer (struct t_config_option *option,
                                         const char *property);

Аргументи:

  • option: показивач на опцију

  • property: име особине:

    • config_file: показивач на конфигурациони фајл (struct t_config_file *)

    • section: показивач на одељак (struct t_config_section *)

    • name: име опције (char *)

    • parent_name: име родитељске опције (char *) (WeeChat ≥ 1.4)

    • type: тип опције (int *)

    • description: опис опције (char *)

    • string_values: стринг вредности (char *)

    • min: минимална вредност (int *)

    • max: максимална вредност (int *)

    • default_value: подразумевана вредност (зависи од типа)

    • value: текућа вредност (зависи од типа)

    • prev_option: показивач на претходну опцију (struct t_config_option *)

    • next_option: показивач на наредну опцију (struct t_config_option *)

Повратна вредност:

  • показивач на тражену опцију

C пример:

char *description = weechat_config_option_get_pointer (option, "description");
Ова функција није доступна у API скриптовања.

3.11.16. config_option_is_null

Проверава да ли је опција „null” (недефинисана вредност).

Прототип:

int weechat_config_option_is_null (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност:

  • 1 ако је вредност опције „null”

  • 0 ако вредност опције није „null”

C пример:

if (weechat_config_option_is_null (option))
{
    /* вредност је "null" */
}
else
{
    /* вредност није "null" */
}

Скрипта (Python):

# пример
def config_option_is_null(option: str) -> int: ...
    # ...

# пример
if weechat.config_option_is_null(option):
    # ...

3.11.17. config_option_default_is_null

Проверава да ли је подразумевана вредност опције „null” (недефинисана вредност).

Прототип:

int weechat_config_option_default_is_null (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност:

  • 1 ако је подразумевана вредност опције „null”

  • 0 ако подразумевана вредност опције није „null”

C пример:

if (weechat_config_option_default_is_null (option))
{
    /* подразумевана вредност је "null" */
}
else
{
    /* подразумевана вредност није "null" */
}

Скрипта (Python):

# пример
def config_option_default_is_null(option: str) -> int: ...

# пример
if weechat.config_option_default_is_null(option):
    # ...

3.11.18. config_boolean

Враћа логичку вредност опције.

Прототип:

int weechat_config_boolean (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: логичка вредност опције (0 или 1)

  • integer: 0

  • string: 0

  • color: 0

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean (option))
{
    /* вредност је "true" */
}
else
{
    /* вредност је "false" */
}

Скрипта (Python):

# прототип
def config_boolean(option: str) -> int: ...

# пример
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean(option):
    # ...

3.11.19. config_boolean_default

Враћа подразумевану логичку вредност опције.

Прототип:

int weechat_config_boolean_default (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: подразумевана логичка вредност опције (0 или 1)

  • integer: 0

  • string: 0

  • color: 0

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
if (weechat_config_boolean_default (option))
{
    /* вредност је "true" */
}
else
{
    /* вредност је "false" */
}

Скрипта (Python):

# прототип
def config_boolean_default(option: str) -> int: ...

# пример
option = weechat.config_get("plugin.section.option")
if weechat.config_boolean_default(option):
    # ...

3.11.20. config_integer

Враћа целобројну вредност опције.

Прототип:

int weechat_config_integer (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: логичка вредност опције (0 или 1)

  • integer: целобројна вредност опције

  • string: 0

  • color: индекс боје

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer (option);

Скрипта (Python):

# прототип
def config_integer(option: str) -> int: ...

# пример
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer(option)

3.11.21. config_integer_default

Враћа подразумевану целобројну вредност опције.

Прототип:

int weechat_config_integer_default (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: подразумевана логичка вредност опције (0 или 1)

  • integer: подразумевана целобројна вредност опције

  • string: 0

  • color: подразумевани индекс боје

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
int value = weechat_config_integer_default (option);

Скрипта (Python):

# прототип
def config_integer_default(option: str) -> int: ...

# пример
option = weechat.config_get("plugin.section.option")
value = weechat.config_integer_default(option)

3.11.22. config_string

Враћа стринг вредност опције.

Прототип:

const char *weechat_config_string (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: „on” ако је вредност истинита, у супротном „off”

  • integer: стринг вредност опције је цео број са стринг вредностима, у супротном је NULL

  • string: стринг вредност опције

  • color: име боје

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string (option);

Скрипта (Python):

# прототип
def config_string(option: str) -> str: ...

# пример
option = weechat.config_get("plugin.section.option")
value = weechat.config_string(option)

3.11.23. config_string_default

Враћа подразумевану стринг вредност опције.

Прототип:

const char *weechat_config_string_default (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: „on” ако је подразумевана вредност истинита, у супротном „off”

  • integer: подразумевана стринг вредност опције је цео број са стринг вредностима, у супротном је NULL

  • string: подразумевана стринг вредност опције

  • color: име подразумеване боје

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *value = weechat_config_string_default (option);

Скрипта (Python):

# прототип
def config_string_default(option: str) -> str: ...

# пример
option = weechat.config_get("plugin.section.option")
value = weechat.config_string_default(option)

3.11.24. config_color

Враћа вредност опције као боју.

Прототип:

const char *weechat_config_color (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: NULL

  • integer: NULL

  • string: NULL

  • color: име боје

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color (option);

Скрипта (Python):

# прототип
def config_color(option: str) -> str: ...

# пример
option = weechat.config_get("plugin.section.option")
value = weechat.config_color(option)

3.11.25. config_color_default

Враћа подразумевану вредност опције као боју.

Прототип:

const char *weechat_config_color_default (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

Повратна вредност, зависи од типа опције:

  • boolean: NULL

  • integer: NULL

  • string: NULL

  • color: име подразумеване боје

C пример:

struct t_config_option *option = weechat_config_get ("plugin.section.option");
const char *color = weechat_config_color_default (option);

Скрипта (Python):

# прототип
def config_color_default(option: str) -> str: ...

# пример
option = weechat.config_get("plugin.section.option")
value = weechat.config_color_default(option)

3.11.26. config_write_option

Уписује линију у конфигурациони фајл са опцијом и њеном вредности (ова функција би требало да се позове само у „write” или „write_default” функцијама повратног позива за одељак).

Прототип:

void weechat_config_write_option (struct t_config_file *config_file,
                                  struct t_config_option *option);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • option: показивач на опцију

C пример:

int
my_section_write_cb (const void *pointer, void *data,
                     struct t_config_file *config_file,
                     const char *section_name)
{
    weechat_config_write_line (config_file, "my_section", NULL);

    weechat_config_write_option (config_file, option);

    return WEECHAT_RC_OK;
}

Скрипта (Python):

# прототип
def config_write_option(config_file: str, option: str) -> int: ...

# пример
def my_section_write_cb(data, config_file, section_name):
    weechat.config_write_line(config_file, "my_section", "")
    weechat.config_write_option(config_file, option)
    return weechat.WEECHAT_RC_OK

3.11.27. config_write_line

Уписује линију у конфигурациони фајл (ова функција би требало да се позива само у „write” или „write_default” функцијама повратног позива за одељак).

Прототип:

void weechat_config_write_line (struct t_config_file *config_file,
                                const char *option_name,
                                const char *value, ...);

Аргументи:

  • config_file: показивач на конфигурациони фајл

  • option_name: име опције

  • value: вредност (ако је NULL, онда се уписује линија са именом одељка, на пример: "[section]")

C пример:

int
my_section_write_cb (const void *pointer, void *data,
                     struct t_config_file *config_file,
                     const char *section_name)
{
    weechat_config_write_line (config_file, "my_section", NULL);

    weechat_config_write_line (config_file, "option", "%s;%d",
                               "value", 123);

    return WEECHAT_RC_OK;
}

Скрипта (Python):

# прототип
def config_write_line(config_file: str, option_name: str, value: str) -> int: ...

# пример
def my_section_write_cb(data, config_file, section_name):
    weechat.config_write_line(config_file, "my_section", "")
    weechat.config_write_line(config_file, "option", "value")
    return weechat.WEECHAT_RC_OK

3.11.28. config_write

Уписује конфигурациони фајл на диск.

Прототип:

int weechat_config_write (struct t_config_file *config_file);

Аргументи:

  • config_file: показивач на конфигурациони фајл

Повратна вредност:

  • WEECHAT_CONFIG_WRITE_OK ако је конфигурација уписана

  • WEECHAT_CONFIG_WRITE_MEMORY_ERROR ако није било довољно слободне меморије

  • WEECHAT_CONFIG_WRITE_ERROR ако је дошло до неке друге грешке

C пример:

switch (weechat_config_write (config_file))
{
    case WEECHAT_CONFIG_WRITE_OK:
        /* ... */
        break;
    case WEECHAT_CONFIG_WRITE_MEMORY_ERROR:
        /* ... */
        break;
    case WEECHAT_CONFIG_WRITE_ERROR:
        /* ... */
        break;
}

Скрипта (Python):

# прототип
def config_write(config_file: str) -> int: ...

# пример
rc = weechat.config_write(config_file)
if rc == weechat.WEECHAT_CONFIG_WRITE_OK:
    # ...
elif rc == weechat.WEECHAT_CONFIG_WRITE_MEMORY_ERROR:
    # ...
elif rc == weechat.WEECHAT_CONFIG_WRITE_ERROR:
    # ...

3.11.29. config_read

Чита конфигурациони фајл са диска.

Прототип:

int weechat_config_read (struct t_config_file *config_file);

Аргументи:

  • config_file: показивач на конфигурациони фајл

Повратна вредност:

  • WEECHAT_CONFIG_READ_OK ако је конфигурација учитана

  • WEECHAT_CONFIG_READ_MEMORY_ERROR ако није било довољно слободне меморије

  • WEECHAT_CONFIG_READ_FILE_NOT_FOUND ако фајл није пронађен

C пример:

switch (weechat_config_read (config_file))
{
    case WEECHAT_CONFIG_READ_OK:
        /* ... */
        break;
    case WEECHAT_CONFIG_READ_MEMORY_ERROR:
        /* ... */
        break;
    case WEECHAT_CONFIG_READ_FILE_NOT_FOUND:
        /* ... */
        break;
}

Скрипта (Python):

# прототип
def config_read(config_file: str) -> int: ...

# пример
rc = weechat.config_read(config_file)
if rc == weechat.WEECHAT_CONFIG_READ_OK:
    # ...
elif rc == weechat.WEECHAT_CONFIG_READ_MEMORY_ERROR:
    # ...
elif rc == weechat.WEECHAT_CONFIG_READ_FILE_NOT_FOUND:
    # ...

3.11.30. config_reload

Поново учитава конфигурацију са диска.

Прототип:

int weechat_config_reload (struct t_config_file *config_file);

Аргументи:

  • config_file: показивач на конфигурациони фајл

Повратна вредност:

  • WEECHAT_CONFIG_READ_OK ако је конфигурација поново учитана

  • WEECHAT_CONFIG_READ_MEMORY_ERROR ако није било довољно слободне меморије

  • WEECHAT_CONFIG_READ_FILE_NOT_FOUND ако фајл није пронађен

C пример:

switch (weechat_config_reload (config_file))
{
    case WEECHAT_CONFIG_READ_OK:
        /* ... */
        break;
    case WEECHAT_CONFIG_READ_MEMORY_ERROR:
        /* ... */
        break;
    case WEECHAT_CONFIG_READ_FILE_NOT_FOUND:
        /* ... */
        break;
}

Скрипта (Python):

# прототип
def config_reload(config_file: str) -> int: ...

# пример
rc = weechat.config_reload(config_file)
if rc == weechat.WEECHAT_CONFIG_READ_OK:
    # ...
elif rc == weechat.WEECHAT_CONFIG_READ_MEMORY_ERROR:
    # ...
elif rc == weechat.WEECHAT_CONFIG_READ_FILE_NOT_FOUND:
    # ...

3.11.31. config_option_free

Ослобађа меморију коју заузима опција.

Прототип:

void weechat_config_option_free (struct t_config_option *option);

Аргументи:

  • option: показивач на опцију

C пример:

weechat_config_option_free (option);

Скрипта (Python):

# прототип
def config_option_free(option: str) -> int: ...

# пример
weechat.config_option_free(option)

3.11.32. config_section_free_options

Ослобађа меморију коју заузимају све опцију у одељку.

Прототип:

void weechat_config_section_free_options (struct t_config_section *section);

Аргументи:

  • section: показивач на одељак

C пример:

weechat_config_section_free_options (section);

Скрипта (Python):

# прототип
def config_section_free_options(section: str) -> int: ...

# пример
weechat.config_section_free_options(section)

3.11.33. config_section_free

Ослобађа меморију коју заузима одељак.

Прототип:

void weechat_config_section_free (struct t_config_section *section);

Аргументи:

  • section: показивач на одељак

C пример:

weechat_config_section_free (section);

Скрипта (Python):

# прототип
def config_section_free(section: str) -> int: ...

# пример
weechat.config_section_free(section)

3.11.34. config_free

Ослобађа меморију коју заузима конфигурациони фајл.

Прототип:

void weechat_config_free (struct t_config_file *config_file);

Аргументи:

  • config_file: показивач на конфигурациони фајл

C пример:

weechat_config_free (config_file);

Скрипта (Python):

# прототип
def config_free(config_file: str) -> int: ...

# пример
weechat.config_free(config_file)

3.11.35. config_get

Тражи опцију према пуном имену.

Прототип:

struct t_config_option *weechat_config_get (const char *option_name);

Аргументи:

  • option_name: пуно име опције (у формату: „фајл.одељак.опција”)

Повратна вредност:

  • показивач на нађену опцију, NULL у случају да се опција не нађе

C пример:

struct t_config_option *option = weechat_config_get ("weechat.look.item_time_format");

Скрипта (Python):

# прототип
def config_get(option_name: str) -> str: ...

# пример
option = weechat.config_get("weechat.look.item_time_format")

3.11.36. config_get_plugin

Тражи опцију у конфигурационом фајлу додатака (plugins.conf).

Прототип:

const char *weechat_config_get_plugin (const char *option_name);

Аргументи:

  • option_name: име опције, програм WeeChat ће додати префикс „plugins.var.xxx.”(где је „xxx” име текућег додатка)

Повратна вредност:

  • вредност пронађене опције, NULL у случају да се опција не пронађе

C пример:

/* ако је текући додатак „test”, онда се у фајлу plugins.conf
   тражи вредност опције „plugins.var.test.option” */
char *value = weechat_config_get_plugin ("option");

Скрипта (Python):

# прототип
def config_get_plugin(option_name: str) -> str: ...

# пример
value = weechat.config_get_plugin("option")

3.11.37. config_is_set_plugin

Проверава да ли је опција постављена у конфигурационом фајлу додатака (plugins.conf).

Прототип:

int weechat_config_is_set_plugin (const char *option_name);

Аргументи:

  • option_name: име опције, програм WeeChat ће додати префикс „plugins.var.xxx.”(где је „xxx” име текућег додатка)

Повратна вредност:

  • 1 ако је опција постављена, 0 ако опција не постоји

C пример:

if (weechat_config_is_set_plugin ("option"))
{
    /* опција је постављена */
}
else
{
    /* опција не постоји */
}

Скрипта (Python):

# прототип
def config_is_set_plugin(option_name: str) -> int: ...

# пример
if weechat.config_is_set_plugin("option"):
    # опција је постављена
    # ...
else:
    # опција не постоји
    # ...

3.11.38. config_set_plugin

Поставља нову вредност опције у конфигурационом фајлу додатака (plugins.conf).

Прототип:

int weechat_config_set_plugin (const char *option_name, const char *value);

Аргументи:

  • option_name: име опције, програм WeeChat ће додати префикс „plugins.var.xxx.”(где је „xxx” име текућег додатка)

  • value: нова вредност опције

Повратна вредност:

  • WEECHAT_CONFIG_OPTION_SET_OK_CHANGED ако је вредност опције измењена

  • WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE ако вредност није измењена

  • WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND ако опција није пронађена

  • WEECHAT_CONFIG_OPTION_SET_ERROR ако је дошло до неке друге грешке

C пример:

switch (weechat_config_set_plugin ("option", "test_value"))
{
    case WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
        /* ... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
        /* ... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND:
        /* ... */
        break;
    case WEECHAT_CONFIG_OPTION_SET_ERROR:
        /* ... */
        break;
}

Скрипта (Python):

# прототип
def config_set_plugin(option_name: str, value: str) -> int: ...

# пример
rc = weechat.config_set_plugin("option", "test_value")
if rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_OPTION_NOT_FOUND:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_SET_ERROR:
    # ...

3.11.39. config_set_desc_plugin

WeeChat ≥ 0.3.5.

Поставља опис за опцију у конфигурационом фајлу додатака (plugins.conf).

Прототип:

void weechat_config_set_desc_plugin (const char *option_name,
                                     const char *description);

Аргументи:

  • option_name: име опције, програм WeeChat ће додати префикс „plugins.desc.xxx.”(где је „xxx” име текућег додатка)

  • description: опис опције

Ако опција (plugins.var.xxx.име_опције) не постоји, то не представља проблем. Будуће креирање опције под овим именом ће употребити овај опис.

C пример:

weechat_config_set_desc_plugin ("option", "description of option");

Скрипта (Python):

# прототип
def config_set_desc_plugin(option_name: str, description: str) -> int: ...

# пример
version = weechat.info_get("version_number", "") or 0
if int(version) >= 0x00030500:
    weechat.config_set_desc_plugin("option", "description of option")

3.11.40. config_unset_plugin

Брише опцију из конфигурационог фајла додатака (plugins.conf).

Прототип:

int weechat_config_unset_plugin (const char *option_name);

Аргументи:

  • option_name: име опције, програм WeeChat ће додати префикс „plugins.var.xxx.”(где је „xxx” име текућег додатка)

Повратна вредност:

  • WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET ако вредност опције није ресетована

  • WEECHAT_CONFIG_OPTION_UNSET_OK_RESET ако је вредност опције ресетована

  • WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED ако је опција уклоњена

  • WEECHAT_CONFIG_OPTION_UNSET_ERROR ако је дошло до грешке

C пример:

switch (weechat_config_unset_plugin ("option"))
{
    case WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET:
        /* ... */
        break;
    case WEECHAT_CONFIG_OPTION_UNSET_OK_RESET:
        /* ... */
        break;
    case WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED:
        /* ... */
        break;
    case WEECHAT_CONFIG_OPTION_UNSET_ERROR:
        /* ... */
        break;
}

Скрипта (Python):

# прототип
def config_unset_plugin(option_name: str) -> int: ...

# пример
rc = weechat.config_unset_plugin("option")
if rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_RESET:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED:
    # ...
elif rc == weechat.WEECHAT_CONFIG_OPTION_UNSET_ERROR:
    # ...

3.12. Тастерске пречице

Функције за тастерске пречице.

3.12.1. key_bind

WeeChat ≥ 0.3.6, ажурирано у верзији 1.8.

Додаје нове тастерске пречице.

За разлику од команде /key bind, ова функција никада неће изменити постојећу тастерску пречицу, може само да креира нове. Ако желите да уклоните тастерску пречицу, употребите key_unbind.

Прототип:

int weechat_key_bind (const char *context, struct t_hashtable *keys);

Аргументи:

  • context: контекст за тастере:

    • default: подразумевани контекст (уобичајене акције)

    • search: контекст претраге (када се тражи текст у баферу)

    • cursor: слободно померање курсора по екрану

    • mouse: тастери за догађаје миша

  • keys: хеш табела са тастерским пречицама; може да садржи следеће специјалне кључеве:

    • __quiet: не приказују се пречице додате у core бафер (WeeChat ≥ 1.8)

Повратна вредност:

  • број додатих тастерских пречица

C пример:

struct t_hashtable *keys = weechat_hashtable_new (8,
                                                  WEECHAT_HASHTABLE_STRING,
                                                  WEECHAT_HASHTABLE_STRING,
                                                  NULL,
                                                  NULL);
if (keys)
{
    weechat_hashtable_set (keys, "@chat(plugin.buffer):button1", "hsignal:test_mouse");
    weechat_hashtable_set (keys, "@chat(plugin.buffer):wheelup", "/mycommand up");
    weechat_hashtable_set (keys, "@chat(plugin.buffer):wheeldown", "/mycommand down");
    weechat_key_bind ("mouse", keys);
    weechat_hashtable_free (keys);
}

Скрипта (Python):

# прототип
def key_bind(context: str, keys: Dict[str, str]) -> int: ...

# пример
keys = {"@chat(python.test):button1": "hsignal:test_mouse",
        "@chat(python.test):wheelup": "/mycommand up",
        "@chat(python.test):wheeldown": "/mycommand down"}
weechat.key_bind("mouse", keys)

3.12.2. key_unbind

WeeChat ≥ 0.3.6, ажурирано у верзији 2.0.

Уклања тастерску пречицу (или више њих).

Када се ова функција позива, обезбедите да не уклоните корисникове тастерске пречице.

Прототип:

int weechat_key_unbind (const char *context, const char *key);

Аргументи:

  • context: контекст за тастере (погледајте key_bind)

  • key: тастер који се уклања или специјална вредност „area:XXX” којом се уклањају све пречице које имају XXX као први или други део; ако тастер почиње са „quiet:”, тастери који се уклањају се неће приказати у core баферу (WeeChat ≥ 2.0).

Повратна вредност:

  • број уклоњених тастерских пречица

C примери:

/* уклања једну тастерску пречицу */
weechat_key_unbind ("mouse", "@chat(plugin.buffer):button1");

/* уклања све тастере са делом "chat(plugin.buffer)" */
weechat_key_unbind ("mouse", "area:chat(plugin.buffer)");

Скрипта (Python):

# прототип
def key_unbind(context: str, key: str) -> int: ...

# примери

# уклања једну тастерску пречицу
weechat.key_unbind("mouse", "@chat(plugin.buffer):button1")

# уклања све тастере са делом "chat(python.test)"
weechat.key_unbind("mouse", "area:chat(python.test)")

3.13. Приказ

Функције које приказују текст у баферима.

3.13.1. prefix

Враћа префикс.

Прототип:

const char *weechat_prefix (const char *prefix);

Аргументи:

  • prefix: име префикса (погледајте табелу испод)

Повратна вредност:

  • вредност префикса (стринг са префиксом и кодовима боја), празан стринг ако се префикс не пронађе

Листа префикса:

Префикс Вредност Боја Опис

error

=!=

yellow

Порука о грешки.

network

--

magenta

Порука са мреже.

action

*

white

Сопствена акција.

join

-->

lightgreen

Неко се придружио текућем разговору.

quit

<--

lightred

Неко напушта текући разговор.

Командом /set могу да се прилагоде вредности и боје.

C пример:

weechat_printf (NULL, "%sОво је грешка...", weechat_prefix ("error"));

Скрипта (Python):

# прототип
def prefix(prefix: str) -> str: ...

# пример
weechat.prnt("", "%sОво је грешка..." % weechat.prefix("error"))

3.13.2. color

Враћа стринг кода боје за приказ.

Прототип:

const char *weechat_color (const char *color_name);

Аргументи:

  • color_name: име боје, једно од::

    • Име опције WeeChat боје (из weechat.color.xxx), на пример chat_delimiters

    • име опције (у формату: фајл.одељак.опција), на пример irc.color.message_quit (WeeChat ≥ 1.2)

    • боја са необавезним атрибутима/позадином (погледајте испод)

    • атрибут:

      • bold: поставља подебљан испис

      • -bold: уклања подебљан испис

      • reverse: поставља обрнути приказ

      • -reverse: уклања обрнути приказ

      • italic: поставља испис у курзиву

      • -italic: уклања испис у курзиву

      • underline: поставља подвучени испис

      • -underline: уклања подвучени испис

      • emphasis: пребацује активност наглашавања текста (напомена: ово би требало да се користи само у тракама, јер програм WeeChat користи наглашавање текста када претражује текст у баферу) (WeeChat ≥ 0.4.2)

    • име боје траке:

      • bar_fg: боја предњег плана траке

      • bar_delim: боја граничника за траку

      • bar_bg: боја позадине за траку

    • ресет:

      • reset: ресетује боје и атрибуте

      • resetcolor: ресетује боју (задржава атрибуте) (WeeChat ≥ 0.3.6)

Формат боје је: атрибути (није обавезно) + име боје + ",позадина" (није обавезно). Могући су следећи атрибути:

  • *: подебљани текст

  • !: обрнути видео

  • /: курзив

  • _: подвучен текст

  • |: задржава атрибуте: када се мења боја, не ресетују се подебљано/обрнуто/курзив/подвучено (WeeChat ≥ 0.3.6)

Примери:

  • yellow: жуто

  • _green: подвучено зелено

  • *214: подебљано наранџасто

  • yellow,red: жуто на црвеном

  • |cyan: цијан (и задржава било које атрибуте постављена раније)

Повратна вредност:

  • стринг са кодом боје, или празан стринг ако се боја не пронађе

C пример:

weechat_printf (NULL, "Color: %sblue %sdefault color %syellow on red",
                weechat_color ("blue"),
                weechat_color ("chat"),
                weechat_color ("yellow,red"));

Скрипта (Python):

# прототип
def color(color_name: str) -> str: ...

# пример
weechat.prnt("", "Color: %sblue %sdefault color %syellow on red"
    % (weechat.color("blue"), weechat.color("chat"), weechat.color("yellow,red")))

3.13.3. printf

Приказује поруку у баферу.

Прототип:

void weechat_printf (struct t_gui_buffer *buffer, const char *message, ...);

Ова функција је пречица за функцију printf_date_tags. Следећа два позива дају потпуно исти резултат:

weechat_printf (buffer, "message");
weechat_printf_date_tags (buffer, 0, NULL, "message");

Аргументи:

  • buffer: показивач на бафер, ако је NULL, порука се приказује у WeeChat баферу

  • message: порука која треба да се прикаже

Први табулатор у поруци („\t”) се користи за раздвајање префикса од поруке.
Ако ваша порука садржи табове и не желите префикс, онда користите размак, па таб, па онда поруку (погледајте пример испод): ово ће да искључи префикс (размак пре таба се неће приказивати).
Ако постоје два таба („\t”) на почетку поруке, време се неће приказивати и порука неће имати поравнање. Уз то, датум у поруци ће се поставити на 0.

C пример:

weechat_printf (NULL, "Hello on WeeChat buffer");
weechat_printf (buffer, "Hello on this buffer");
weechat_printf (buffer, "%sThis is an error!", weechat_prefix ("error"));
weechat_printf (buffer, " \tMessage without prefix but with \t some \t tabs");
weechat_printf (buffer, "\t\tMessage without time/alignment");
weechat_printf (buffer, "\t\t");  /* empty line (without time) */

Скрипта (Python):

# прототип
def prnt(buffer: str, message: str) -> int: ...

# пример
weechat.prnt("", "Здраво на WeeChat баферу")
weechat.prnt(buffer, "Здраво на овом баферу")
weechat.prnt(buffer, "%sОво је грешка!" % weechat.prefix("error"))
weechat.prnt(buffer, " \tПорука без префикса, али са \t мало \t табова")
weechat.prnt(buffer, "\t\tПорука без времена/поравнања")
weechat.prnt(buffer, "\t\t")  # празна линија (без времена)
У скриптама се функција зове „print” („prnt” у језику Python).

3.13.4. printf_date_tags

Приказује поруку у баферу, уз употребу прилагођеног датума и ознака.

Прототип:

void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date,
                               const char *tags, const char *message, ...);

Аргументи:

  • buffer: показивач на бафер, ако је NULL, порука се приказује у WeeChat баферу

  • date: датум за поруку (0 значи текући датум/време)

  • tags: листа ознака раздвојених запетама (NULL значи да нема ознака)

  • message: порука која треба да се прикаже

За листу ознака које се уобичјаено користе у програму WeeChat, погледајте Корисничко упутство / Ознаке линија.

C пример:

weechat_printf_date_tags (NULL, time (NULL) - 120, "notify_message",
                          "Message 2 minutes ago, with a tag 'notify_message'");

Скрипта (Python):

# прототип
def prnt_date_tags(buffer: str, date: str, tags: str, message: str) -> int: ...

# пример
time = int(time.time())
weechat.prnt_date_tags("", time - 120, "notify_message",
    "Message 2 minutes ago, with a tag 'notify_message'")
Функција се у скриптама зове „print_date_tags” („prnt_date_tags” у језику Python).

3.13.5. printf_y

Приказује поруку на линији бафера са слободним садржајем.

Прототип:

void weechat_printf_y (struct t_gui_buffer *buffer, int y,
                       const char *message, ...);

Аргументи:

  • buffer: показивач на бафер

  • y: број линије (прва линија је 0); негативна вредност додаје линију иза последње приказане линије: апсолутна вредност y је број линија након последње линије (на пример -1 је непосредно након последње линије, -2 је 2 линије након последње линије) (WeeChat ≥ 1.0)

  • message: порука која треба да се прикаже

C пример:

weechat_printf_y (buffer, 2, "My message on third line");

Скрипта (Python):

# прототип
def prnt_y(buffer: str, y: int, message: str) -> int: ...

# пример
weechat.prnt_y("", 2, "My message on third line")
У скриптама се функција зове „print_y” („prnt_y” у језику Python).

3.13.6. log_printf

Уписује поруку у WeeChat лог фајл (weechat.log).

Прототип:

void weechat_log_printf (const char *message, ...);

Аргументи:

  • message: порука која треба да се упише

C пример:

weechat_log_printf ("Моја порука у лог фајлу");

Скрипта (Python):

# прототип
def log_print(message: str) -> int: ...

# пример
weechat.log_print("Моја порука у лог фајлу")
Функција се у скриптама зове „log_print”.

3.14. Куке

Приоритет куке

WeeChat ≥ 0.3.4.

У неким кукама можете да поставите приоритет. Кука са вишим приоритетом се налази при почетку листе кука, тако да ће се пронаћи и извршити пре осталих кука. Корисно је за модификаторе, јер је за њих битан редослед извршавања.

Да бисте поставили приоритет, морате да користите следећу синтаксу за аргумент за који је дозвољен приоритет: „nnn|име” где је „nnn” позитиван цео број са приоритетом, а „име” је име аргумента (приоритет се не појављује у имену, он се аутоматски уклања из стринга).

Подразумевани приоритет је 1000.

C пример:

/* модификатор кука са приоритетом = 2000 */
weechat_hook_modifier ("2000|input_text_display", &modifier_cb, NULL, NULL);

Приоритет дозвољавају следећи типови кука: command, command_run, signal, hsignal, config, completion, modifier, info, info_hashtable, infolist, hdata, focus.

3.14.1. hook_command

Ажурирано у верзијама 1.5, 1.7.

Качи се на команду.

Прототип:

struct t_hook *weechat_hook_command (const char *command,
                                     const char *description,
                                     const char *args,
                                     const char *args_description,
                                     const char *completion,
                                     int (*callback)(const void *pointer,
                                                     void *data,
                                                     struct t_gui_buffer *buffer,
                                                     int argc,
                                                     char **argv,
                                                     char **argv_eol),
                                     const void *callback_pointer,
                                     void *callback_data);

Аргументи:

  • command: име команде (приоритет је дозвољен, погледајте напомену о приоритету)

  • description: опис команде (приказује се са /help команда)

  • args: аргументи за команду (приказује се са /help команда)

  • args_description: опис аргумената (приказује се са /help команда)

  • completion: шаблон довршавања за команду (погледајте формат испод)

  • callback: функција која се позива када се употреби команда, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_gui_buffer *buffer: бафер у коме се извршава команда

    • int argc: број аргумената дат уз команду

    • char **argv: аргументи дати уз команду

    • char **argv_eol: аргументи дати за команду (све до краја линије за сваки аргумент)

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

completion шаблон је листа довршавања за сваки аргумент, раздвојен размацима. За један аргумент је могуће више довршавања која се раздвајају са |. За исту команду може да постоји више шаблона који се раздвајају са ||.

Формат довршавања може да буде:

  • %(име): довршавање име

  • %(име:аргументи): довршавање име са аргументи који се шаљу функцији повратног позива (WeeChat ≥ 1.7)

  • било који стринг: користи се у довршавању без икаквих измена

На пример, шаблон list || add %(filters_names) || del %(filters_names)|-all ће у аргументима команде да довршава са следећим вредностима:

  • први аргумент: list, add и del

  • други аргумент, зависно од првог аргумента:

    • list: ништа

    • add: имена филтера

    • del: имена филтера и -all

Подразумевани кодови довршавања су:

Додатак Име Опис

alias

alias

листа алијаса

alias

alias_value

вредност алијаса

exec

exec_commands_ids

ids (бројеви и имена) извршених команди

fset

fset_options

конфигурациони фајлови, одељци, опције и речи опција

guile

guile_script

листа скрипти

irc

irc_channel

текући IRC канал

irc

irc_channel_nicks_hosts

надимци и имена хостова текућег IRC канала

irc

irc_channel_topic

тема текућег IRC канала

irc

irc_channels

канали на свим IRC серверима

irc

irc_ignores_numbers

бројеви за дефинисана игнорисања

irc

irc_modelist_masks

modelist маске текућег IRC канала; обавезни аргумент: modelist режим

irc

irc_modelist_numbers

modelist бројеви текућег IRC канала; обавезни аргумент: modelist режим

irc

irc_msg_kick

подразумевана порука о избацивању

irc

irc_msg_part

подразумевана поздравна порука за IRC канал

irc

irc_notify_nicks

надимци у листи за обавештавање

irc

irc_privates

приватни разговори на свим IRC серверима

irc

irc_raw_filters

филтери за сирови irc бафер

irc

irc_server

текући IRC сервер

irc

irc_server_channels

канали на текућем IRC серверу

irc

irc_server_nick

надимак на текућем IRC серверу

irc

irc_server_nicks

надимци на свим каналима текућег IRC сервера

irc

irc_server_privates

приватни разговори на текућем IRC серверу

irc

irc_servers

IRC сервери (интерна имена)

irc

nick

надимци текућег IRC канала

javascript

javascript_script

листа скрипти

lua

lua_script

листа скрипти

perl

perl_script

листа скрипти

php

php_script

листа скрипти

python

python_script

листа скрипти

relay

relay_free_port

први слободни порт за relay додатак

relay

relay_protocol_name

сви могући протокол.име за relay додатак

relay

relay_relays

протокол.име текућих релеја за relay додатак

ruby

ruby_script

листа скрипти

script

script_extensions

листа скрипт екстензија

script

script_files

фајлови у скрипт директоријумима

script

script_languages

листа скрипт језика

script

script_scripts

листа скрипти у репозиторијуму

script

script_scripts_installed

листа инсталираних скрипти (из репозиторијума)

script

script_tags

ознаке скрипти у репозиторијуму

spell

spell_dicts

листа инсталираних речника

spell

spell_langs

листа свих подржаних језика

tcl

tcl_script

листа скрипти

trigger

trigger_hook_arguments

подразумевани аргументи за куку

trigger

trigger_hook_command

подразумевана команда за куку

trigger

trigger_hook_conditions

подразумевани услови за куку

trigger

trigger_hook_rc

подразумевани повратни кодови за функцију повратног позива куке

trigger

trigger_hook_regex

подразумевани регуларни израз за куку

trigger

trigger_hooks

куке за окидаче

trigger

trigger_hooks_filter

куке за окидаче (за филтере у монитор баферу)

trigger

trigger_names

окидачи

trigger

trigger_names_default

подразумевани окидачи

trigger

trigger_option_value

вредност опције окидача

trigger

trigger_options

опције за окидаче

trigger

trigger_post_action

пост акције окидача

weechat

bars_names

имена трака

weechat

bars_options

опције за траке

weechat

buffer_local_variable_value

вредност бафер локалне променљиве

weechat

buffer_local_variables

бафер локалне променљиве

weechat

buffer_properties_get

особине које могу да се читају за бафер

weechat

buffer_properties_set

особине које могу да се поставе за бафер

weechat

buffers_names

имена бафера

weechat

buffers_numbers

бројеви бафера

weechat

buffers_plugins_names

имена бафера (укључујући имена додатака)

weechat

colors

имена боја

weechat

commands

команде (weechat и додаци); необавезни аргумент: префикс који се додаје испред команди

weechat

config_files

конфигурациони фајлови

weechat

config_option_values

вредности за опцију конфигурације

weechat

config_options

конфигурационе опције

weechat

cursor_areas

површине („chat” или име траке) за слободно померање курсора

weechat

env_value

вредност променљиве окружења

weechat

env_vars

променљиве окружења

weechat

filename

имефајла; необавезни аргумент: подразумевана путања (израчунато, погледајте /help eval)

weechat

filters_names

имена филтера

weechat

infolists

имена прикачених инфолисти

weechat

infos

имена прикачених infos

weechat

keys_codes

кодови тастера

weechat

keys_codes_for_reset

кодови тастера који могу да се ресетују (додати, редефинисани или уклоњени тастери)

weechat

keys_contexts

контексти тастера

weechat

layouts_names

имена распореда

weechat

nicks

надимци у листи надимака текућег бафера

weechat

palette_colors

палета боја

weechat

plugins_commands

команде које су дефинисали додаци; необавезни аргумент: префикс који се додаје испред команди

weechat

plugins_installed

имена инсталираних додатака

weechat

plugins_names

имена додатака

weechat

proxies_names

имена проксија

weechat

proxies_options

опције за проксије

weechat

secured_data

имена обезбеђених података (фајл sec.conf, одељак data)

weechat

weechat_commands

weechat команде; необавезни аргумент: префикс који се додаје испред команди

weechat

windows_numbers

бројеви прозора

xfer

nick

надимци за DCC разговор

Специјални кодови:

  • %%команда: поновна употреба шаблона довршавања из команде команда

  • %-: заустављање довршавања

  • %*: понављање последњег довршавања

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

int
my_command_cb (const void *pointer, void *data, struct t_gui_buffer *buffer,
               int argc, char **argv, char **argv_eol)
{
    /* ... */
    return WEECHAT_RC_OK;
}

/* овај пример је инспирисан командом /filter */
struct t_hook *my_command_hook =
    weechat_hook_command ("мојфилтер",
                          "опис за myfilter",
                          "[list] | [enable|disable|toggle [име]] | "
                          "[add име plugin.buffer tags regex] | "
                          "[del име|-all]",
                          "опис аргумената...",
                          "list"
                          " || enable %(filters_names)"
                          " || disable %(filters_names)"
                          " || toggle %(filters_names)"
                          " || add %(filters_names) %(buffers_plugins_names)|*"
                          " || del %(filters_names)|-all",
                          &my_command_cb, NULL, NULL);

На пример, ако је команда која се позива /command abc def ghi, онда argv и argv_eol имају следеће вредности:

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

У скриптама, args има вредност "abc def ghi".

Скрипта (Python):

# прототип
def hook_command(command: str, description: str, args: str, args_description: str,
                 completion: str, callback: str, callback_data: str) -> str: ...

# пример
def my_command_cb(data, buffer, args):
    # ...
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_command("мојфилтер", "опис за мојфилтер",
    "[list] | [enable|disable|toggle [име]] | [add име plugin.buffer tags regex] | [del име|-all]",
    "опис аргумената...",
    "list"
    " || enable %(filters_names)"
    " || disable %(filters_names)"
    " || toggle %(filters_names)"
    " || add %(filters_names) %(buffers_plugins_names)|*"
    " || del %(filters_names)|-all",
    "my_command_cb", "")

3.14.2. hook_completion

Ажурирано у верзијама 1.5, 1.7.

Качи се на довршавање.

Прототип:

struct t_hook *weechat_hook_completion (const char *completion_item,
                                        const char *description,
                                        int (*callback)(const void *pointer,
                                                        void *data,
                                                        const char *completion_item,
                                                        struct t_gui_buffer *buffer,
                                                        struct t_gui_completion *completion),
                                        const void *callback_pointer,
                                        void *callback_data);

Аргументи:

  • completion_item: име ставке довршавања, након ње у закаченој команди (аргумент completion) можете да користите %(име) (или %(име:аргументи) у WeeChat ≥ 1.7) (дозвољава се приоритет, погледајте напомену о приоритетима)

  • description: опис довршавања

  • callback: функција се позива када се употреби ставка довршавања (корисник нешто довршава употребом ове ставке), аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *completion_item: име ставке довршавања (у WeeChat ≥ 1.7 може да укључи и аргументе у формату: име:аргументи)

    • struct t_gui_buffer *buffer: бафер у коме се врши довршавање

    • struct t_gui_completion *completion: структура која се користи за додавање речи довршавања (погледајте completion_list_add)

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Имена довршавања су глобална (програм WeeChat и додаци их заједнички користе). Тако да се препоручује да изаберете име са јединственим префиксом, као што је „plugin_xxx” (где је „xxx” име ваше ставке).
Функција повратног позива сме да се позива само функције довршавања као што је completion_list_add и НЕ сме да ажурира командну линију.
Да бисте ажурирали командну линију када се притисне Tab, употребите функцију hook_command_run са командом: /input complete_next (а ако ваша функција повратног позива успешно ажурира командну линију, морате да вратите WEECHAT_RC_OK_EAT, тако да програм WeeChat не изврши довршавање).

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

int
my_completion_cb (const void *pointer, void *data, const char *completion_item,
                  struct t_gui_buffer *buffer,
                  struct t_gui_completion *completion)
{
    weechat_completion_list_add (completion, "реч1", 0, WEECHAT_LIST_POS_SORT);
    weechat_completion_list_add (completion, "тест_реч2", 0, WEECHAT_LIST_POS_SORT);
    return WEECHAT_RC_OK;
}

struct t_hook *my_completion_hook = weechat_hook_completion ("plugin_ставка",
                                                             "моје лично довршавање!",
                                                             &my_completion_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_completion(completion_item: str, description: str, callback: str, callback_data: str) -> str: ...

# пример
def my_completion_cb(data, completion_item, buffer, completion):
    weechat.completion_list_add(completion, "реч1", 0, weechat.WEECHAT_LIST_POS_SORT)
    weechat.completion_list_add(completion, "тест_реч2", 0, weechat.WEECHAT_LIST_POS_SORT)
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_completion("plugin_ставка", "моје лично довршавање!",
                               "my_completion_cb", "")

3.14.3. hook_completion_get_string

WeeChat ≥ 0.3.4.

Застарело од WeeChat верзије 2.9 (још увек постоји из разлога компатибилности).
Ову функцију је заменила completion_get_string.

3.14.4. hook_completion_list_add

Застарело од WeeChat верзије 2.9 (још увек постоји из разлога компатибилности).
Ову функцију је заменила completion_list_add.

3.14.5. hook_command_run

Ажурирано у верзији 1.5.

Закачи се на команду када је програм WeeChat покрене.

Прототип:

struct t_hook *weechat_hook_command_run (const char *command,
                                         int (*callback)(const void *pointer,
                                                         void *data,
                                                         struct t_gui_buffer *buffer,
                                                         const char *command),
                                         const void *callback_pointer,
                                         void *callback_data);

Аргументи:

  • command: команда која се качи (дозвољен је џокер *) (дозвољава се приоритет, погледајте напомену о приоритетима)

  • callback: функција која се позива када се команда покрене, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_gui_buffer *buffer: бафер у коме се извршава команда

    • const char *command: команда која се извршава, са својим аргументима

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_OK_EAT: након функције повратног позива, програм WeeChat неће извршити команду

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

int
my_command_run_cb (const void *pointer, void *data,
                   struct t_gui_buffer *buffer, const char *command)
{
    weechat_printf (NULL, "Трошим довршавање!");
    return WEECHAT_RC_OK_EAT;
}

struct t_hook *my_command_run_hook =
    weechat_hook_command_run ("/input complete*",
                              &my_command_run_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_command_run(command: str, callback: str, callback_data: str) -> str: ...

# пример
def my_command_run_cb(data, buffer, command):
    weechat.prnt("", "Трошим довршавање!")
    return weechat.WEECHAT_RC_OK_EAT

hook = weechat.hook_command_run("/input complete*", "my_command_run_cb", "")

3.14.6. hook_timer

Ажурирано у верзији 1.5.

Качи се на тајмер.

Прототип:

struct t_hook *weechat_hook_timer (long interval,
                                   int align_second,
                                   int max_calls,
                                   int (*callback)(const void *pointer,
                                                   void *data,
                                                   int remaining_calls),
                                   const void *callback_pointer,
                                   void *callback_data);

Аргументи:

  • interval: интервал између два позива (у милисекундама, па је 1000 = 1 секунда)

  • align_second: поравнање на секундама. На пример, ако је текуће време 09:00, а интервал = 60000 (60 секунди) и align_second = 60, онда се тајмер позива сваког минута у 0 секунди

  • max_calls: колико пута ће се позвати тајмер (ако је 0, онда тајмер не стаје)

  • callback: функција која се позива када се достигне време, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • int remaining_calls: број преосталих позива (-1 ако тајмер не стаје)

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

int
my_timer_cb (const void *pointer, void *data, int remaining_calls)
{
    /* ... */
    return WEECHAT_RC_OK;
}

/* тајмер се позива сваких 20 секунди */
struct t_hook *my_timer_hook =
    weechat_hook_timer (20 * 1000, 0, 0, &my_timer_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_timer(interval: int, align_second: int, max_calls: int, callback: str, callback_data: str) -> str: ...

# пример
def my_timer_cb(data, remaining_calls):
    # ...
    return weechat.WEECHAT_RC_OK

# тајмер се позива сваких 20 секунди
hook = weechat.hook_timer(20 * 1000, 0, 0, "my_timer_cb", "")

3.14.7. hook_fd

Ажурирано у верзијама 1.3, 1.5, 2.0.

Качи се на фајл дескриптор (фајла или сокета).

Прототип:

struct t_hook *weechat_hook_fd (int fd,
                                int flag_read,
                                int flag_write,
                                int flag_exception,
                                int (*callback)(const void *pointer,
                                                void *data,
                                                int fd),
                                const void *callback_pointer,
                                void *callback_data);

Аргументи:

  • fd: фајл дескриптор

  • flag_read: 1 = хвата се догађај читања, 0 = игнорише се

  • flag_write: 1 = хвата се догађај уписа, 0 = игнорише се

  • flag_exception: 1 = хвата се догађај изузетка, 0 = игнорише се (WeeChat ≥ 1.3: овај аргумент се игнорише и више се не користи)

  • callback: функција која се позива када се за фајл (или сокет) догоди изабрани догађај, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • int fd: фајл дескриптор

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

У скриптама, са програмом WeeChat ≥ 2.0, аргумент функције повратног позива fd је цео број (у WeeChat ≤ 1.9, био је стринг).
Да би постојала компатибилност са свим верзијама, препоручује се да пре употребе конвертујете аргумент у цео број, на пример у језику Python: int(fd).

C пример:

int
my_fd_cb (const void *pointer, void *data, int fd)
{
    /* ... */
    return WEECHAT_RC_OK;
}

int sock = socket (AF_INET, SOCK_STREAM, 0);
/* set socket options */
/* ... */
struct t_hook *my_fd_hook = weechat_hook_fd (sock, 1, 0, 0, &my_fd_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_fd(fd: int, flag_read: int, flag_write: int, flag_exception: int, callback: str, callback_data: str) -> str: ...

# пример
def my_fd_cb(data, fd):
    # ...
    return weechat.WEECHAT_RC_OK

sock = ...
hook = weechat.hook_fd(sock, 1, 0, 0, "my_fd_cb", "")

3.14.8. hook_process

Ажурирано у верзији 1.5.

Качи се на процес (покренут рачвањем), и хвата његов излаз.

Почевши од верзије 0.3.9.2, за извршавање команде се више не користи командно окружење. Програм WeeChat аутоматски раздваја команду и њене аргументе (на исти начин на који то ради командно окружење).
Ако подела није исправна (у зависности од знакова навода у вашој команди), или ако желите да користите командно окружење, употребите функцију hook_process_hashtable са аргументима у хеш табели options (WeeChat ≥ 0.4.0).

Прототип:

struct t_hook *weechat_hook_process (const char *command,
                                     int timeout,
                                     int (*callback)(const void *pointer,
                                                     void *data,
                                                     const char *command,
                                                     int return_code,
                                                     const char *out,
                                                     const char *err),
                                     const void *callback_pointer,
                                     void *callback_data);

Аргументи:

  • command: команда која се покреће у дете процесу, URL (WeeChat ≥ 0.3.7) или функција (WeeChat ≥ 1.5) (погледајте испод)

  • timeout: тајмаут за команду (у милисекундама): када овај тајмаут истекне, дете процес се убија (0 значи да нема тајмаута)

  • callback: функција која се позива када су доступни подаци из дете процеса, или када се дете процес заврши, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *command: команда коју извршава дете

    • int return_code: повратни кôд:

      • >= 0: повратни кôд детета за команду, а за URL су могуће следеће вредности:

        • 0: трансфер OK

        • 1: неважећи URL

        • 2: грешка трансфера

        • 3: нема довољно слободне меморије

        • 4: грешка са фајлом

      • < 0:

        • WEECHAT_HOOK_PROCESS_RUNNING: подаци су доступни, али се дете још увек извршава)

        • WEECHAT_HOOK_PROCESS_ERROR: грешка приликом покретања команде

        • WEECHAT_HOOK_PROCESS_CHILD: у дете процесу је позвана функција повратног позива

    • out: стандардни излаз команде (stdout)

    • err: излаз грешака команде (stderr)

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

      • повратни кôд дете процеса (у случају функције са „func:” у команди)

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

Када се команда заврши, или ако истекне тајмаут, програм WeeChat ће аутоматски да откачи куку (и убити процес ако се још увек иззвршава).

Команда може да буде URL у следећем формату: „url:https://www.example.com”, за преузимање садржаја URL адресе (WeeChat ≥ 0.3.7). За URL могу да се користе опције функцијом hook_process_hashtable.

Команда такође може да буде и име функције у формату: „func:име”, чиме се извршава функција „име” (WeeChat ≥ 1.5). Ова функција прихвата један аргумент (data) и мора да врати стринг, који се прослеђује функцији повратног позива.
У C API, функција повратног позива се позива са повратним кодом постављеним на WEECHAT_HOOK_PROCESS_CHILD, што значи да се функција повратног позива извршава у дете процесу (након рачвања).
У API скриптовања, функција име се директно позива и њен резултат (стринг) се прослеђује функцији повратног позива (као и излаз спољне команде.)

Ако желите да сазнате инфо у вези програма WeeChat (као што је тренутна стабилна верзија, последњи git комит, итд.), можете да употребите URL адресе на страници https://weechat.org/dev/info
Величина бафера за слање података је 64KB (постоји 2 бафера: један за stdout и једна за stderr). Ако је излаз из дете процеса (stdout или stderr) дужи од 64KB, функција повратног позива ће се позивати више пута.
Чак и ако се у највећем броју случајева ваша функција повратног позива зове само једном, у свом коду морате обезбедити да нема проблема са вишеструким позивањем: морате да спајате податке примљене у више позива и да податке употребљавате само када повратни кôд није негативан.

C пример:

/* пример са спољном командом */
int
my_process_cb (const void *pointer, void *data, const char *command,
               int return_code, const char *out, const char *err)
{
    if (return_code == WEECHAT_HOOK_PROCESS_ERROR)
    {
        weechat_printf (NULL, "Грешка у команди ’%s’", command);
        return WEECHAT_RC_OK;
    }

    if (return_code >= 0)
    {
        weechat_printf (NULL, "return_code = %d", return_code);
    }

    if (out)
    {
        weechat_printf (NULL, "stdout: %s", out);
    }

    if (err)
    {
        weechat_printf (NULL, "stderr: %s", err);
    }

    return WEECHAT_RC_OK;
}

struct t_hook *my_process_hook = weechat_hook_process ("ls", 5000,
                                                       &my_process_cb, NULL, NULL);

/* пример са функцијом повратног позива која се зове у дете процесу */
int
my_process_func_cb (const void *pointer, void *data, const char *command,
                    int return_code, const char *out, const char *err)
{
    if (return_code == WEECHAT_HOOK_PROCESS_CHILD)
    {
        /* одради нешто блокирајуће... */
        /* ... */

        /* stdout ће се послати као "out" и функцији повратног позива родитеља */
        printf ("ово је резултат");

        /* повратни кôд процеса */
        return 0;
    }
    else
    {
        if (return_code == WEECHAT_HOOK_PROCESS_ERROR)
        {
            weechat_printf (NULL, "Грешка у команди ’%s’", command);
            return WEECHAT_RC_OK;
        }

        if (return_code >= 0)
        {
            weechat_printf (NULL, "return_code = %d", return_code);
        }

        if (out)
        {
            weechat_printf (NULL, "stdout: %s", out);
        }

        if (err)
        {
            weechat_printf (NULL, "stderr: %s", err);
        }

        return WEECHAT_RC_OK;
    }
}

struct t_hook *my_process_hook = weechat_hook_process ("func:get_status", 5000,
                                                       &my_process_func_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_process(command: str, timeout: int, callback: str, callback_data: str) -> str: ...

# пример са спољном командом
def my_process_cb(data, command, return_code, out, err):
    if return_code == weechat.WEECHAT_HOOK_PROCESS_ERROR:
        weechat.prnt("", "Грешка у команди ’%s’" % command)
        return weechat.WEECHAT_RC_OK
    if return_code >= 0:
        weechat.prnt("", "return_code = %d" % return_code)
    if out != "":
        weechat.prnt("", "stdout: %s" % out)
    if err != "":
        weechat.prnt("", "stderr: %s" % err)
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_process("ls", 5000, "my_process_cb", "")

# пример са скрипт функцијом
def get_status(data):
    # одради нешто блокирајуће...
    # ...
    return "ово је резултат"

def my_process_cb(data, command, return_code, out, err):
    if return_code == weechat.WEECHAT_HOOK_PROCESS_ERROR:
        weechat.prnt("", "Грешка у команди ’%s’" % command)
        return weechat.WEECHAT_RC_OK
    if return_code >= 0:
        weechat.prnt("", "return_code = %d" % return_code)
    if out != "":
        weechat.prnt("", "stdout: %s" % out)
    if err != "":
        weechat.prnt("", "stderr: %s" % err)
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_process("func:get_status", 5000, "my_process_cb", "")

3.14.9. hook_process_hashtable

WeeChat ≥ 0.3.7, ажурирано у верзији 1.5.

Качи се на процес (покренут рачвањем) користећи опције у хеш табели и хвата излаз.

Прототип:

struct t_hook *weechat_hook_process_hashtable (const char *command,
                                               struct t_hashtable *options,
                                               int timeout,
                                               int (*callback)(const void *pointer,
                                                               void *data,
                                                               const char *command,
                                                               int return_code,
                                                               const char *out,
                                                               const char *err),
                                               const void *callback_pointer,
                                               void *callback_data);

Аргументи су исти као за функцију hook_process, уз један додатни аргумент:

  • options: опције за команду која се извршава; хеш табела се дуплира у функцији, тако да након овог позива безбедно можете да ослободите меморију коју заузима

За стандардну команду (која не почиње са „url:”), можете користите следеће опције:

Опција Мин WeeChat Вредност Подразумевана Опис

argN (N ≥ 1)

0.4.0

било који стринг

без аргумената

Аргументи команде; ако се овим опцијама не наведе ниједан аргумент, команда се аутоматски дели на начин на који то ради командно окружење (па се онда аргументи команде учитавају у command аргумент).

stdin

0.4.3

(не користи се)

без stdin

Креира пајп за упис података на стандардни улаз (stdin) дете процеса (погледајте функцију hook_set).

buffer_flush

1.0

број бајтова

65536

Минимални број бајтова након којег се испира stdout/stderr (да се излаз пошаље функцији повратног позива), између 1 и 65536. Ако је вредност 1, излаз се тренутно шаље функцији повратног позива.

detached

1.0

(не користи се)

нема одвајања

Процес се покреће у одвојеном режиму: stdout и stderr се преусмеравају на /dev/null.

За команду „url:…​” су доступне следеће опције (за опис сваке опције погледајте man curl_easy_setopt):

Опција Тип (1) Константе (2)

verbose

long

header

long

noprogress

long

nosignal

long

wildcardmatch

long

failonerror

long

keep_sending_on_error

long

proxy

string

proxyport

long

port

long

pre_proxy

string

httpproxytunnel

long

interface

string

dns_cache_timeout

long

proxytype

long

http, socks4, socks5, socks4a, socks5_hostname, http_1_0, https

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, smb, smbs

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, smb, smbs

noproxy

string

socks5_gssapi_nec

long

tcp_keepalive

long

tcp_keepidle

long

tcp_keepintvl

long

unix_socket_path

string

abstract_unix_socket

string

path_as_is

long

proxy_service_name

string

service_name

string

default_protocol

string

tcp_fastopen

long

socks5_auth

long

haproxyprotocol

long

doh_url

string

netrc

long

ignored, optional, required

userpwd

string

proxyuserpwd

string

httpauth

mask

none, basic, digest, ntlm, any, anysafe, digest_ie, only, ntlm_wb, negotiate, gssapi, bearer

proxyauth

mask

none, basic, digest, ntlm, any, anysafe, digest_ie, only, ntlm_wb, negotiate, gssapi, bearer

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

disallow_username_in_url

long

autoreferer

long

followlocation

long

put

long

post

long

postfields

string

referer

string

useragent

string

httpheader

list

cookie

string

cookiefile

string

postfieldsize

long

maxredirs

long

httpget

long

cookiejar

string

http_version

long

none, 1_0, 1_1, 2_0, 2, 2tls, 2_prior_knowledge

cookiesession

long

http200aliases

list

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

proxyheader

list

pipewait

long

stream_weight

long

request_target

string

mail_from

string

mail_rcpt

list

mail_auth

string

tftp_blksize

long

tftp_no_options

long

ftpport

string

quote

list

postquote

list

ftp_use_epsv

long

prequote

list

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

timevalue_large

long long

upload_buffersize

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

resolve

list

dns_servers

string

accepttimeout_ms

long

dns_interface

string

dns_local_ip4

string

dns_local_ip6

string

connect_to

list

happy_eyeballs_timeout_ms

long

dns_shuffle_addresses

long

upkeep_interval_ms

long

sslcert

string

sslversion

long

default, tlsv1, sslv2, sslv3, tlsv1_0, tlsv1_1, tlsv1_2, tlsv1_3, max_default, max_none, max_tlsv1_0, max_tlsv1_1, max_tlsv1_2, max_tlsv1_3

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, no_revoke, no_backends, ok, too_late, unknown_backend

ssl_enable_alpn

long

ssl_enable_npn

long

pinnedpublickey

string

ssl_verifystatus

long

ssl_falsestart

long

proxy_cainfo

string

proxy_capath

string

proxy_crlfile

string

proxy_keypasswd

string

proxy_pinnedpublickey

string

proxy_sslcert

string

proxy_sslcerttype

string

proxy_sslkey

string

proxy_sslkeytype

string

proxy_sslversion

long

default, tlsv1, sslv2, sslv3, tlsv1_0, tlsv1_1, tlsv1_2, tlsv1_3, max_default, max_none, max_tlsv1_0, max_tlsv1_1, max_tlsv1_2, max_tlsv1_3

proxy_ssl_cipher_list

list

proxy_ssl_options

long

allow_beast, no_revoke, no_backends, ok, too_late, unknown_backend

proxy_ssl_verifyhost

long

proxy_ssl_verifypeer

long

proxy_tlsauth_password

string

proxy_tlsauth_type

string

proxy_tlsauth_username

string

tls13_ciphers

list

proxy_tls13_ciphers

list

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

ssh_compression

long

new_file_perms

long

new_directory_perms

long

telnetoptions

list

(1) За опције типа „mask”, формат је: „вредност1+вредност2+вредност3”; за опције типа „list”, ставке листе морају да се раздвоје преломом линије (\n).
(2) Ако су доступне константе, оне морају да се користе као вредност опције.

За URL су дозвољене две додатне опције (стрингови) за улазни/излазни фајл:

  • file_in: фајл који се чита и шаље URL адресама (post фајл)

  • file_out: преузети URL/фајл се уписује у овај фајл (уместо на стандардни излаз)

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

int
my_process_cb (const void *pointer, void *data, const char *command,
               int return_code, const char *out, const char *err)
{
    if (return_code == WEECHAT_HOOK_PROCESS_ERROR)
    {
        weechat_printf (NULL, "Грешка у команди ’%s’", command);
        return WEECHAT_RC_OK;
    }

    if (return_code >= 0)
    {
        weechat_printf (NULL, "return_code = %d", return_code);
    }

    if (out)
    {
        weechat_printf (NULL, "stdout: %s", out);
    }

    if (err)
    {
        weechat_printf (NULL, "stderr: %s", err);
    }

    return WEECHAT_RC_OK;
}

/* пример 1: преузимање URL */
struct t_hashtable *options_url1 = weechat_hashtable_new (8,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          NULL,
                                                          NULL);
if (options_url1)
{
    weechat_hashtable_set (options_url1, "file_out", "/tmp/weechat.org.html");
    struct t_hook *my_process_hook = weechat_hook_process_hashtable ("url:https://weechat.org/",
                                                                     options_url1,
                                                                     20000,
                                                                     &my_process_cb, NULL, NULL);
    weechat_hashtable_free (options_url1);
}

/* пример 2: отварање URL са прилагођеним HTTP заглављима */
struct t_hashtable *options_url2 = weechat_hashtable_new (8,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          NULL,
                                                          NULL);
if (options_url2)
{
    weechat_hashtable_set (options_url2, "httpheader",
                           "Header1: value1\n"
                           "Header2: value2");
    struct t_hook *my_process_hook = weechat_hook_process_hashtable ("url:http://localhost:8080/",
                                                                     options_url2,
                                                                     20000,
                                                                     &my_process_cb, NULL, NULL);
    weechat_hashtable_free (options_url2);
}

/* пример 3: извршавање обавештавања програма са поруком која је пристигла од некога */
struct t_hashtable *options_cmd1 = weechat_hashtable_new (8,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          NULL,
                                                          NULL);
if (options_cmd1)
{
    weechat_hashtable_set (options_cmd1, "arg1", "-from");
    weechat_hashtable_set (options_cmd1, "arg2", nick);
    weechat_hashtable_set (options_cmd1, "arg3", "-msg");
    weechat_hashtable_set (options_cmd1, "arg4", message);  /* аргумент којем се не верује */
    struct t_hook *my_process_hook = weechat_hook_process_hashtable ("my-notify-command",
                                                                     options_cmd1,
                                                                     20000,
                                                                     &my_process_cb, NULL, NULL);
    weechat_hashtable_free (options_cmd1);
}

/* пример 4: позив командног окружења да изврши команду (команда мора бити БЕЗБЕДНА) */
struct t_hashtable *options_cmd2 = weechat_hashtable_new (8,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          WEECHAT_HASHTABLE_STRING,
                                                          NULL,
                                                          NULL);
if (options_cmd2)
{
    weechat_hashtable_set (options_cmd2, "arg1", "-c");
    weechat_hashtable_set (options_cmd2, "arg2", "ls -l /tmp | grep something");
    struct t_hook *my_process_hook = weechat_hook_process_hashtable ("sh",
                                                                     options_cmd2,
                                                                     20000,
                                                                     &my_process_cb, NULL, NULL);
    weechat_hashtable_free (options_cmd2);
}

Скрипта (Python):

# прототип
def hook_process_hashtable(command: str, options: Dict[str, str], timeout: int, callback: str, callback_data: str) -> str: ...

# пример
def my_process_cb(data, command, return_code, out, err):
    if return_code == weechat.WEECHAT_HOOK_PROCESS_ERROR:
        weechat.prnt("", "Грешка у команди ’%s’" % command)
        return weechat.WEECHAT_RC_OK
    if return_code >= 0:
        weechat.prnt("", "return_code = %d" % return_code)
    if out != "":
        weechat.prnt("", "stdout: %s" % out)
    if err != "":
        weechat.prnt("", "stderr: %s" % err)
    return weechat.WEECHAT_RC_OK

# пример 1: преузимање URL
hook1 = weechat.hook_process_hashtable("url:https://weechat.org/",
                                       {"file_out": "/tmp/weechat.org.html"},
                                       20000, "my_process_cb", "")

# пример 2: отварање URL са прилагођеним HTTP заглављима
options = {
    "httpheader": "\n".join([
        "Header1: value1",
        "Header2: value2",
    ]),
}
hook2 = weechat.hook_process_hashtable("url:http://localhost:8080/",
                                       options,
                                       20000, "my_process_cb", "")

# пример 3: извршавање обавештавања програма са поруком која је пристигла од некога
hook3 = weechat.hook_process_hashtable("my-notify-command",
                                       {"arg1": "-from",
                                        "arg2": nick,
                                        "arg3": "-msg",
                                        "arg4": message},  # аргумент којем се не верује
                                       20000, "my_process_cb", "")

# пример 4: позив командног окружења да изврши команду (команда мора бити БЕЗБЕДНА)
hook4 = weechat.hook_process_hashtable("sh",
                                       {"arg1": "-c",
                                        "arg2": "ls -l /tmp | grep something"},
                                       20000, "my_process_cb", "")

3.14.10. hook_connect

Ажурирано у верзијама 1.5, 2.0.

Качи се на везу (везу у позадини са удаљеним хостом).

Прототип:

struct t_hook *weechat_hook_connect (const char *proxy,
                                     const char *address,
                                     int port,
                                     int ipv6,
                                     int retry,
                                     void *gnutls_sess,
                                     void *gnutls_cb,
                                     int gnutls_dhkey_size,
                                     const char *gnutls_priorities,
                                     const char *local_hostname,
                                     int (*callback)(const void *pointer,
                                                     void *data,
                                                     int status,
                                                     int gnutls_rc,
                                                     int sock,
                                                     const char *error,
                                                     const char *ip_address),
                                     const void *callback_pointer,
                                     void *callback_data);

Аргументи:

  • proxy: име проксија који се користи за везу (није обавезно, NULL значи да је веза без проксија)

  • address: име или IP адреса са којом се повезује

  • port: број порта

  • ipv6: 1 да се користи IPv6 (или IPv4 у случају да не може), 0 да се користи само IPv4

  • retry: број поновних покушаја, користи се за прелаз на IPv4 хостове ако се IPv6 хостови успостављају везу али онда не прихватају клијента

  • gnutls_sess: GnuTLS сесија (није обавезна)

  • gnutls_cb: GnuTLS функција повратног позива (није обавезна)

  • gnutls_dhkey_size: величина кључа који се користи током Дифи-Хелман размене кључева (GnuTLS)

  • gnutls_priorities: приоритети за gnutls (у вези синтаксе, погледајте документацију функције gnutls_priority_init у gnutls упутству), основне вредности су следеће:

    • PERFORMANCE

    • NORMAL (подразумевано)

    • SECURE128

    • SECURE256

    • EXPORT

    • NONE

  • local_hostname: име локалног хоста које ће се користити за везу (није обавезно)

  • callback: функција која се позива када је веза OK или не успе да се успостави, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • int status: статус везе:

      • WEECHAT_HOOK_CONNECT_OK: веза је OK

      • WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND: адреса није пронађена

      • WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND: IP адреса није пронађена

      • WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED: повезивање је одбијено

      • WEECHAT_HOOK_CONNECT_PROXY_ERROR: грешка са проксијем

      • WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR: грешка са именом локалног хоста

      • WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR: GnuTLS init грешка

      • WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR: грешка код GnuTLS руковања

      • WEECHAT_HOOK_CONNECT_MEMORY_ERROR: нема довољно слободне меморије

      • WEECHAT_HOOK_CONNECT_TIMEOUT: тајмаут

      • WEECHAT_HOOK_CONNECT_SOCKET_ERROR: сокет није могао да се креира

    • gnutls_rc: повратна вредност функције gnutls_handshake()

    • sock: сокет који се употребљен за везу

    • const char *error: повратна вредност gnutls_strerror(gnutls_rc)

    • const char *ip_address: IP адреса није нађена

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

У скриптама и програмом WeeChat ≥ 2.0, аргументи функције повратног позива status, gnutls_rc и sock су цели бројеви (у програму WeeChat ≤ 1.9, били су стрингови).
Да би се одржала компатибилност са свим верзијама, препоручује се да аргумент пре употребе конвертујете у цео број, на пример у језику Python: int(sock).

C пример:

int
my_connect_cb (const void *pointer, void *data, int status, int gnutls_rc,
               int sock, const char *error, const char *ip_address)
{
    switch (status)
    {
        case WEECHAT_HOOK_CONNECT_OK:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_PROXY_ERROR:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_MEMORY_ERROR:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_TIMEOUT:
            /* ... */
            break;
        case WEECHAT_HOOK_CONNECT_SOCKET_ERROR:
            /* ... */
            break;
    }
    return WEECHAT_RC_OK;
}

struct t_hook *my_connect_hook = weechat_hook_connect (NULL,
                                                       "my.server.org", 1234,
                                                       1, 0,
                                                       NULL, NULL, 0,  /* GnuTLS */
                                                       NULL,
                                                       &my_connect_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_connect(proxy: str, address: str, port: int, ipv6: int, retry: int, local_hostname: str,
                 callback: str, callback_data: str) -> str: ...

# пример
def my_connect_cb(data, status, gnutls_rc, sock, error, ip_address):
    if status == WEECHAT_HOOK_CONNECT_OK:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_PROXY_ERROR:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_MEMORY_ERROR:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_TIMEOUT:
        # ...
    elif status == WEECHAT_HOOK_CONNECT_SOCKET_ERROR:
        # ...
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_connect("", "my.server.org", 1234, 1, 0, "",
                            "my_connect_cb", "")

3.14.11. hook_line

WeeChat ≥ 2.3.

Качи се на линију која треба да се испише у бафер.

Када линија треба да се испише у бафер, куке се позивају у следећем редоследу:

  • кука линије (ова кука): може да промени бафер, префикс, поруку, ознаке, ниво обавештавања, … (погледајте испод)

  • кука модификатораweechat_print”: може да промени префикс и поруку у баферу са форматираним садржајем.

  • кука исписа: позива се када се у бафер са форматираним садржајем дода линија (овом куком ништа директно не може да се измени).

„line” (кука линије) је једина од ове три куке која може да ради над баферима са слободним садржајем.

Прототип:

struct t_hook *weechat_hook_line (const char *buffer_type,
                                  const char *buffer_name,
                                  const char *tags,
                                  struct t_hashtable *(*callback)(const void *pointer,
                                                                  void *data,
                                                                  struct t_hashtable *line),
                                  const void *callback_pointer,
                                  void *callback_data);

Аргументи:

  • buffer_type: хвата линије у наведеном типу бафера (ако је NULL или празан стринг, подразумева се formatted):

    • formatted: хвата линије само у форматираним баферима (подразумевано)

    • free: хвата линије само у баферима са слободним садржајем

    • *: хвата линије у баферима свих типова

  • buffer_name: листа маски бафера раздвојених запетама (погледајте buffer_match_list); NULL, празан стринг или „*” се подудара са било којим бафером

  • tags: хвата само поруке које имају наведене ознаке (није обавезно): листа ознака раздвојених запетама које морају да се налазе у поруци (логичко „или”); можете да комбинујете више ознака у релацији логичко „и” граничником +; у ознакама је дозвољена употреба џокера *

  • callback: функција која се позива када се линија дода у бафер, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_hashtable *line: хеш табела са инфо о линији, кључеви и вредности су стрингови (погледајте табелу испод)

    • return value: хеш табела са новим вредностима (погледајте табелу испод)

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

Подаци линије се прослеђују функцији повратног позива у хеш табели која има следеће вредности (кључеви и вредности су стрингови):

Кључ Вредност (форматирани бафер) Вредност (слободни бафер) Примери

buffer

Показивач на бафер.

Показивач на бафер.

0x1234abcd

buffer_name

Име бафера.

Име бафера.

core.weechat
irc.server.libera
irc.libera.#weechat

buffer_type

"formatted"

"free"

formatted
free

y

Нема ("-1").

Број линије (≥ "0").

-1
8

date

Датум линије (временска ознака).

Нема ("0").

1533792000

date_printed

Датум када је линија била приказана (временска ознака).

Нема ("0").

1533792012

str_time

Датум за приказ (са могућим кодовима боја у себи).

Нема (празан стринг).

09:07:20

tags_count

Број ознака у линији (≥ "0").

Нема ("0").

2

tags

Листа ознака раздвојених запетама.

Нема (празан стринг).

irc_join,nick_test

displayed

"0" = линија је филтрирана (скривена је)
"1" = линија није филтрирана (приказана је).

"0" = линија је филтрирана (скривена је)
"1" = линија није филтрирана (приказана је).

0
1

notify_level

"-1" = без обавештавања
"0" = низак ниво
"1" = порука
"2" = приватна порука
"3" = истицање

Нема ("0").

2

highlight

"0" = без истицања
"1" = линија има истицање.

Нема ("0").

0
1

prefix

Префикс линије.

Нема (празан стринг).

-->

message

Порука у линији.

Порука у линији.

test (~test@example.com) је приступио у #channel

Функција повратног позива може да врати хеш табелу са неким измењеним пољима како би се линија ажурирала. Програм WeeChat било коју неважећу вредност у пољу игнорише без упозорења.

У хеш табелу могу да се поставе следећи кључеви (кључеви и вредности у овој хеш табели су стрингови):

Кључ Дозвољена вредност (форматирани бафер) Дозвољена вредност (слободни бафер) Резултат

buffer

Показивач на бафер са форматираним садржајем.

Показивач на бафер са слободним садржајем.

Линија се приказује у овом баферу.
Ако је вредност празна, линија се брише (тада се све остало у хеш табели игнорише); наредне куке типа „line” се не позивају.

buffer_name

Име бафера са форматираним садржајем.

Име бафера са слободним садржајем.

Линија се приказује у овом баферу.
Ако је и buffer постављено, вредност buffer_name има виши приоритет и она се користи.
Ако је вредност празна, линија се брише (тада се све остало у хеш табели игнорише); наредне куке типа „line” се не позивају.

y

Нема.

Цео број (≥ „0”).

Број линије се поставља на ову вредност.

date

Временска ознака.

Нема.

Датум се поставља на ову вредност.
Сагласно овоме се поставља и вредност str_time.

date_printed

Временска ознака.

Нема.

Датум се поставља на ову временску ознаку (не приказује се).

str_time

Стринг.

Нема.

Овај стринг се користи за приказ датума линије.
Ако је и date постављено, вредност str_time има виши приоритет и она се користи.

tags

Стринг.

Нема.

Ознаке линије се замењују овом листом ознака раздвојених запетама.
Сагласно њој се ажурирају notify_level и highlight.

notify_level

Цео број („-1” до „3”).

Нема.

Ниво обавештавања се поставља на ову вредност. Када се линија дода у бафер, сагласно овој вредности се ажурира врућа листа.
Вредност highlight се ажурира сагласно са овом вредности.
Ако је и tags постављено, вредност notify_level има виши приоритет и она се користи.

highlight

Цео број („0” или „1”).

Нема.

„0” искључује истицање у линији, „1” форсира истицање у линији.
Ако су постављени tags или notify_level, вредност highlight има виши приоритет и она се користи.

prefix

Стринг.

N/A.

Префикс линије се поставља на ову вредност.

message

Стринг.

Стринг.

Порука линије се поставља на ову вредност.

C пример:

int
my_line_cb (const void *pointer, void *data, struct t_hasbtable *line)
{
    struct t_hashtable *hashtable;

    hashtable = weechat_hashtable_new (8,
                                       WEECHAT_HASHTABLE_STRING,
                                       WEECHAT_HASHTABLE_STRING,
                                       NULL,
                                       NULL);
    /* force a highlight on the line */
    weechat_hashtable_set (hashtable, "highlight", "1");
    return hashtable;
}

/* хвата линије са ознаком „irc_join” */
struct t_hook *my_line_hook =
    weechat_hook_line ("", "", "irc_join", &my_line_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_line(buffer_type: str, buffer_name: str, tags: str, callback: str, callback_data: str) -> str: ...

# пример
def my_line_cb(data, line):
    # force a highlight on the line
    return {"highlight": "1"}

# хвата линије са ознаком „irc_join”
hook = weechat.hook_line("", "", "irc_join", "my_line_cb", "")

3.14.12. hook_print

Ажурирано у верзијама 0.4.3, 1.0, 1.5.

Качи се на поруку која се исписује. Позива се када се у бафер са форматираним садржајем дода линија.

За више информација о кукама које се позивају када се линија исписује, погледајте hook_line.

Прототип:

struct t_hook *weechat_hook_print (struct t_gui_buffer *buffer,
                                   const char *tags,
                                   const char *message,
                                   int strip_colors,
                                   int (*callback)(const void *pointer,
                                                   void *data,
                                                   struct t_gui_buffer *buffer,
                                                   time_t date,
                                                   int tags_count,
                                                   const char **tags,
                                                   int displayed,
                                                   int highlight,
                                                   const char *prefix,
                                                   const char *message),
                                   const void *callback_pointer,
                                   void *callback_data);

Аргументи:

  • buffer: показивач на бафер, ако је NULL, хватају се поруке из било ког бафера

  • tags: хватају се само поруке са наведеним ознакама (није обавезно):

    • у WeeChat ≥ 0.4.3: листа ознака раздвојених запетама које морају да се налазе у поруци (логичко „или”); више ознака могу да се комбинују у релацији логичко „и” граничником +; у ознакама је дозвољен џокер *

    • у WeeChat ≤ 0.4.2: листа ознака раздвојених запетама које морају све да се налазе у поруци (логичко „и”)

  • message: хватају се само поруке са овим стрингом (није обавезно, не прави се разлика у величини слова)

  • strip_colors: ако је 1, пре позива функције повратног позива, из поруке се уклањају боје

  • callback: функција која се позива када се порука исписује, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_gui_buffer *buffer: показивач на бафер

    • time_t date: датум

    • int tags_count: број ознака за линију

    • const char **tags: низ са ознакама за линију

    • int displayed: 1 ако се линија приказује, 0 ако је филтрирана (скривена)

    • int highlight: 1 ако линија има истицање, у супротном 0

    • const char *prefix: префикс

    • const char *message: порука

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

У скриптама, са програмом WeeChat ≥ 1.0, аргументи функције повратног позива displayed и highlight су цели бројеви (у WeeChat ≤ 0.4.3, били су стрингови).
Да би се обезбедила компатибилност са свим верзијама, препоручује се да пре употребе аргумент конвертујете у цео број, на пример у језику Python: if int(highlight):.

C пример:

int
my_print_cb (const void *pointer, void *data, struct t_gui_buffer *buffer,
             time_t date, int tags_count, const char **tags,
             int displayed, int highlight,
             const char *prefix, const char *message)
{
    /* ... */
    return WEECHAT_RC_OK;
}

/* хвата све поруке у свим баферима, без боје */
struct t_hook *my_print_hook =
    weechat_hook_print (NULL, NULL, NULL, 1, &my_print_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_print(buffer: str, tags: str, message: str, strip_colors: int, callback: str, callback_data: str) -> str: ...

# пример
def my_print_cb(data, buffer, date, tags, displayed, highlight, prefix, message):
    if int(highlight):
        # ...
    return weechat.WEECHAT_RC_OK

# хвата све поруке у свим баферима, без боје
hook = weechat.hook_print("", "", "", 1, "my_print_cb", "")

3.14.13. hook_signal

Ажурирано у верзији 1.5.

Качи се на сигнал.

Прототип:

struct t_hook *weechat_hook_signal (const char *signal,
                                    int (*callback)(const void *pointer,
                                                    void *data,
                                                    const char *signal,
                                                    const char *type_data,
                                                    void *signal_data),
                                    const void *callback_pointer,
                                    void *callback_data);

Аргументи:

  • signal: сигнал који се хвата, дозвољава се џокер * (дозвољен је приоритет, погледајте напомену о приоритетима) (погледајте табелу испод)

  • callback: функција која се позива када се прими сигнал, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *signal: примљени сигнал

    • const char *type_data: туп података који су послати уз сигнал:

      • WEECHAT_HOOK_SIGNAL_STRING: стринг

      • WEECHAT_HOOK_SIGNAL_INT: цео број

      • WEECHAT_HOOK_SIGNAL_POINTER: показивач

    • void *signal_data: подаци послати уз сигнал

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_OK_EAT (тренутно прекида слање сигнала) (WeeChat ≥ 0.4.0)

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

Листа сигнала који шаљу програм WeeChat и додаци:

Додатак Сигнал Мин WeeChat Аргументи Опис

guile

guile_script_loaded

0.3.9

Стринг: путања до скрипте.

Учитана је Scheme скрипта.

guile

guile_script_unloaded

0.3.9

Стринг: путања до скрипте.

Scheme скрипта је уклоњена из меморије.

guile

guile_script_installed

0.3.9

Стринг: листа путања инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) Scheme скрипт(а/е).

guile

guile_script_removed

0.3.9

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) Scheme скрипт(а/е).

irc

xxx,irc_in_yyy (1)

Стринг: порука.

IRC порука од сервера (пре него што је употреби irc додатак, сигнал се шаље само ако се порука не игнорише).
Почевши од верзије 2.2, шаље се комплетна IRC порука, заједно са ознакама.
Ако је повратни код функције повратног позива WEECHAT_RC_OK_EAT, онда се IRC порука одмах брише и не обрађује се (WeeChat ≥ 3.3).

irc

xxx,irc_in2_yyy (1)

Стринг: порука.

IRC порука од сервера (након што је употреби irc додатак, сигнал се шаље само ако се порука не игнорише).
Почевши од верзије 2.2, шаље се комплетна IRC порука, заједно са ознакама.

irc

xxx,irc_raw_in_yyy (1)

0.3.2

Стринг: порука.

IRC порука од сервера (пре него што је употреби irc додатак, сигнал се шаље чак и када се порука игнорише).
Почевши од верзије 2.2, шаље се комплетна IRC порука, заједно са ознакама.
Ако је повратни кôд функције повратног позива WEECHAT_RC_OK_EAT, онда се IRC порука одмах брише и обрађује се (WeeChat ≥ 3.3).

irc

xxx,irc_raw_in2_yyy (1)

0.3.2

Стринг: порука.

IRC порука од сервера (након што је употреби irc додатак, сигнал се шаље чак и када се порука игнорише).
Почевши од верзије 2.2, шаље се комплетна IRC порука, заједно са ознакама.

irc

xxx,irc_out1_yyy (1)

0.3.7

Стринг: порука.

IRC порука која се шаље серверу пре аутоматске поделе (да стане у 512 бајтова, подразумевано).

irc

xxx,irc_out_yyy (1)

Стринг: порука.

IRC порука која се шаље серверу након аутоматске поделе (да стане у 512 бајтова, подразумевано). Упозорење: стринг може да садржи неважеће UTF-8 податке. Уместо овог, препоручује се употреба сигнала „xxx,irc_out1_yyy”.

irc

xxx,irc_outtags_yyy (1)

0.3.4

Стринг: ознаке + „;” + порука.

Ознаке + IRC порука која се шаље серверу.
Упозорење: стринг може да садржи неважеће UTF-8 податке. Уместо овог, препоручује се употреба сигнала „xxx,irc_out1_yyy”.

irc

irc_ctcp

Стринг: порука.

Примљена је CTCP.

irc

irc_dcc

Стринг: порука.

Нови DCC.

irc

irc_pv

Стринг: порука.

Примљена је приватна порука.

irc

irc_channel_opened

Показивач: бафер.

Отворен је канал.

irc

irc_pv_opened

Показивач: бафер.

Отворен је приватни бафер.

irc

irc_server_opened

0.3.7

Показивач: бафер.

Отворен је серверски бафер.

irc

irc_server_connecting

Стринг: име сервера.

Повезивање са сервером.

irc

irc_server_connected

Стринг: име сервера.

Успостављена је веза са сервером.

irc

irc_server_disconnected

Стринг: име сервера.

Прекинута је веза са сервером.

irc

irc_server_lag_changed

1.8

Стринг: име сервера.

Променило се кашњење у комуникацији са сервером.

irc

irc_ignore_removing

Показивач: игнорисање.

Уклања се игнорисање.

irc

irc_ignore_removed

-

Уклоњено је игнорисање.

irc

irc_notify_join

0.3.8

Стринг: име сервера + „,” + надимак.

Надимак из листе обавештавања се прикључио серверу.

irc

irc_notify_quit

0.3.8

Стринг: име сервера + „,” + надимак.

Надимак из листе обавештавања је напустио сервер.

irc

irc_notify_away

0.3.8

Стринг: име сервера + „,” + надимак + „,” + порука о одсутности.

Надимак из листе обавештавања је сада одсутан са сервера.

irc

irc_notify_still_away

0.3.8

Стринг: име сервера + „,” + надимак + „,” + порука о одсутности.

Надимак из листе обавештавања је још увек одсутан са сервера (промењена је порука о одсутности).

irc

irc_notify_back

0.3.8

Стринг: име сервера + „,” + надимак.

Надимак из листе обавештавања се вратио (уклоњен је статус одсутности).

javascript

javascript_script_loaded

1.2

Стринг: путања до скрипте.

Учитана је JavaScript скрипта.

javascript

javascript_script_unloaded

1.2

String: path to script.

JavaScript скрипта је уклоњена из меморије.

javascript

javascript_script_installed

1.2

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) JavaScript скрипт(а/е).

javascript

javascript_script_removed

1.2

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) JavaScript скрипт(а/е).

logger

logger_start

Показивач: бафер.

Почиње логовање бафера.

logger

logger_stop

Показивач: бафер.

Престаје логовање бафера.

logger

logger_backlog

Показивач: бафер.

Приказивање ранијих линија из бафера.

lua

lua_script_loaded

0.3.9

Стринг: путања до скрипте.

Учитана је Lua скрипта.

lua

lua_script_unloaded

0.3.9

Стринг: путања до скрипте.

Lua скрипта је уклоњена из меморије.

lua

lua_script_installed

0.3.9

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) Lua скрипт(а/е).

lua

lua_script_removed

0.3.9

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) Lua скрипт(а/е).

perl

perl_script_loaded

0.3.9

Стринг: путања до скрипте.

Учитана је Perl скрипта.

perl

perl_script_unloaded

0.3.9

Стринг: путања до скрипте.

Perl скрипта је уклоњена из меморије.

perl

perl_script_installed

0.3.9

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) Perl скрипт(а/е).

perl

perl_script_removed

0.3.9

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) Perl скрипт(а/е).

php

php_script_loaded

2.0

Стринг: путања до скрипте.

Учитана је PHP скрипта.

php

php_script_unloaded

2.0

Стринг: путања до скрипте.

PHP скрипта је уклоњена из меморије.

php

php_script_installed

2.0

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) PHP скрипт(а/е).

php

php_script_removed

2.0

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) PHP скрипт(а/е).

python

python_script_loaded

0.3.9

Стринг: путања до скрипте.

Учитана је Python скрипта.

python

python_script_unloaded

0.3.9

Стринг: путања до скрипте.

Python скрипта је уклоњена из меморије.

python

python_script_installed

0.3.9

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) Python скрипт(а/е).

python

python_script_removed

0.3.9

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) Python скрипт(а/е).

relay

relay_client_connecting

1.0

Показивач: релеј клијент.

Релеј клијент се повезује.

relay

relay_client_waiting_auth

1.0

Показивач: релеј клијент.

Чека се на аутентификацију релеј клијента.

relay

relay_client_auth_ok

1.0

Показивач: релеј клијент.

Успешна аутентификација релеј клијента.

relay

relay_client_connected

1.0

Показивач: релеј клијент.

Релеј клијент се повезао.

relay

relay_client_auth_failed

1.0

Показивач: релеј клијент.

Аутентификација релеј клијента није успела.

relay

relay_client_disconnected

1.0

Показивач: релеј клијент.

Прекинута је веза релеј клијентом.

ruby

ruby_script_loaded

0.3.9

Стринг: путања до скрипте.

Учитана је Ruby скрипта.

ruby

ruby_script_unloaded

0.3.9

Стринг: путања до скрипте.

Ruby скрипта је уклоњена из меморије.

ruby

ruby_script_installed

0.3.9

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталиран(а/е) Ruby скрипт(а/е).

ruby

ruby_script_removed

0.3.9

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) Ruby скрипт(а/е).

spell

spell_suggest

2.4

Показивач: бафер.

Нови предлог за погрешно написану реч.

tcl

tcl_script_loaded

0.3.9

Стринг: путања до скрипте.

Учитана је Tcl скрипта.

tcl

tcl_script_unloaded

0.3.9

Стринг: путања до скрипте.

Tcl скрипта је уклоњена из меморије.

tcl

tcl_script_installed

0.3.9

Стринг: листа путања до инсталираних скрипти раздвојених запетама.

Инсталран(а/е) Tcl скрипт(а/е).

tcl

tcl_script_removed

0.3.9

Стринг: листа уклоњених скрипти раздвојених запетама.

Уклоњен(а/е) Tcl скрипт(а/е).

typing

typing_self_typing

3.3

Показивач: бафер.

Корисник куца поруку (шаље typing додатак, користи irc додатак).

typing

typing_self_paused

3.3

Показивач: бафер.

Корисник је застао током куцања поруке (шаље typing додатак, користи irc додатак).

typing

typing_self_cleared

3.3

Показивач: бафер.

Корисник је обрисао унос и није послао поруку (шаље typing додатак, користи irc додатак).

typing

typing_self_sent

3.3

Показивач: бафер.

Порука (не команда) је послата баферу (шаље typing додатак, користи irc додатак).

typing

typing_set_nick

3.3

Стринг: показивач на бафер + ";" + стање (једно од: "off", "typing", "paused", "cleared") + ";" + надимак.

Поставља стање куцања за надимак у баферу (шаље irc додатак, обрађује typing додатак).

typing

typing_reset_buffer

3.3

Показивач: бафер.

Уклања стање куцања за све надимке у баферу (шаље irc додатак, обрађује typing додатак).

weechat

buffer_opened

Показивач: бафер.

Отворен је бафер.

weechat

buffer_closing

Показивач: бафер.

Бафер се затвара.

weechat

buffer_closed

Показивач: бафер.

Бафер је затворен.

weechat

buffer_cleared

Показивач: бафер.

Бафер је очишћен.

weechat

buffer_filters_enabled

2.0

Показивач: бафер.

У баферу су укључени филтери.

weechat

buffer_filters_disabled

2.0

Показивач: бафер.

У баферу су искључени филтери.

weechat

buffer_hidden

Показивач: бафер.

Бафер је скривен.

weechat

buffer_unhidden

Показивач: бафер.

Бафер је откривен.

weechat

buffer_line_added

0.3.7

Показивач: линија.

У бафер је додата линија.

weechat

buffer_lines_hidden

Показивач: бафер.

У баферу су сакривене линије.

weechat

buffer_localvar_added

Показивач: бафер.

Додата је локална променљива.

weechat

buffer_localvar_changed

Показивач: бафер.

Измењена је локална променљива.

weechat

buffer_localvar_removed

Показивач: бафер.

Уклоњена је локална променљива.

weechat

buffer_merged

Показивач: бафер.

Бафер је спојен.

weechat

buffer_unmerged

Показивач: бафер.

Бафер је раздвојен.

weechat

buffer_moved

Показивач: бафер.

Бафер је померен.

weechat

buffer_renamed

Показивач: бафер.

Баферу је промењено име.

weechat

buffer_switch

Показивач: бафер.

Прелази се на други бафер.

weechat

buffer_title_changed

Показивач: бафер.

Промењен је наслов бафера.

weechat

buffer_type_changed

Показивач: бафер.

Промењен је тип бафера.

weechat

buffer_zoomed

0.4.3

Показивач: бафер.

Зумиран је спојени бафер.

weechat

buffer_unzoomed

0.4.3

Показивач: бафер.

Одзумиран је спојени бафер.

weechat

cursor_start

3.2

-

Почетак режима померања курсора.

weechat

cursor_end

3.2

-

Крај режима померања курсора.

weechat

day_changed

0.3.2

Стринг: нови датум, формат је: "2010-01-31".

Променио се системски датум.

weechat

debug_dump

Стринг: име додатка.

Захтев за испис.

weechat

debug_libs

-

Приказује спољне библиотеке које се користе.

weechat

filter_added

Показивач: филтер.

Додат је филтер.

weechat

filter_removing

Показивач: филтер.

Уклањање филтера.

weechat

filter_removed

-

Филтер је уклоњен.

weechat

filters_enabled

-

Укључени су филтери.

weechat

filters_disabled

-

Искључени су филтери.

weechat

hotlist_changed

Показивач: бафер (може да буде NULL).

Променила се врућа листа.

weechat

input_paste_pending

-

Чека се на налепљивање.

weechat

input_search

Показивач: бафер.

Претрага текста у баферу.

weechat

input_text_changed

Показивач: бафер.

Променио се текст уноса.

weechat

input_text_cursor_moved

Показивач: бафер.

Померио се курсор текста уноса.

weechat

key_bind

Стринг: тастер.

Додата је пречица.

weechat

key_unbind

Стринг: тастер.

Уклоњена је пречица.

weechat

key_pressed

Стринг: притиснути тастер.

Притиснут је тастер.

weechat

key_combo_default

1.0

Стринг: комбинација тастера.

Комбинација тастера у default контексту.

weechat

key_combo_search

1.0

Стринг: комбинација тастера.

Комбинација тастера у search контексту.

weechat

key_combo_cursor

1.0

Стринг: комбинација тастера.

Комбинација тастера у cursor контексту.

weechat

mouse_enabled

1.1

-

Укључен је миш.

weechat

mouse_disabled

1.1

-

Искључен је миш.

weechat

nicklist_group_added

0.3.2

Стринг: показивач на бафер + „,” + име групе.

У листу надимака је додата група.

weechat

nicklist_group_changed

0.3.4

Стринг: показивач на бафер + „,” + име групе.

У листи надимака је измењена група.

weechat

nicklist_group_removing

0.4.1

Стринг: показивач на бафер + „,” + име надимка.

Уклања се група из листе надимака.

weechat

nicklist_group_removed

0.3.2

Стринг: показивач на бафер + „,” + име надимка.

Група је уклоњена из листе надимака.

weechat

nicklist_nick_added

0.3.2

Стринг: показивач на бафер + „,” + име надимка.

Додат је надимак у листу надимака.

weechat

nicklist_nick_changed

0.3.4

Стринг: показивач на бафер + „,” + име надимка.

У листи надимака је промењен надимак.

weechat

nicklist_nick_removing

0.4.1

Стринг: показивач на бафер + „,” + име надимка.

Уклањање надимка из листе надимака.

weechat

nicklist_nick_removed

0.3.2

Стринг: показивач на бафер + „,” + име надимка.

Надимак је уклоњен из листе надимака.

weechat

partial_completion

-

Догодило се делимично довршавање.

weechat

plugin_loaded

0.3.9

Стринг: путања до учитаног додатка.

Учитан је додатак.

weechat

plugin_unloaded

0.3.9

Стринг: име додатка који се уклања из меморије (пример: „irc”).

Додатак је уклоњен из меморије.

weechat

quit

Стринг: аргументи за /quit.

Корисник је задао команду /quit.

weechat

signal_sighup

1.3

-

Примљен је сигнал SIGHUP.

weechat

signal_sigquit

1.2

-

Примљен је сигнал SIGQUIT (захтев за излаз са core исписом).

weechat

signal_sigterm

1.2

-

Примљен је сигнал SIGTERM (складно прекидање WeeChat процеса).

weechat

signal_sigwinch

0.4.3

-

Примљен је сигнал SIGWINCH (промењена је величина терминала).

weechat

upgrade

Стринг: "quit" ако је за /upgrade наведен аргумент „-quit”, у супротном NULL.

Корисник је задао команду /upgrade.

weechat

upgrade_ended

0.3.4

-

Завршетак процеса ажурирања (команда /upgrade).

weechat

weechat_highlight

Стринг: порука са префиксом.

Догодило се истицање.

weechat

weechat_pv

Стринг: порука са префиксом.

Приказана је приватна порука.

weechat

window_closing

0.3.6

Показивач: прозор.

Затварање прозора.

weechat

window_closed

0.3.6

Показивач: прозор.

Прозор је затворен.

weechat

window_opened

0.4.1

Показивач: прозор.

Прозор је отворен.

weechat

window_scrolled

Показивач: прозор.

Скроловање у прозору.

weechat

window_switch

0.3.7

Показивач: прозор.

Прелазак на други прозор.

weechat

window_zoom

Показивач: текући прозор.

Зумирање прозора.

weechat

window_zoomed

Показивач: текући прозор.

Прозор је зумиран.

weechat

window_unzoom

Показивач: текући прозор.

Одзумирање прозора.

weechat

window_unzoomed

Показивач: текући прозор.

Прозор је одзумиран.

xfer

xfer_add

Показивач: инфолиста са xfer информацијама.

Нови xfer.

xfer

xfer_send_ready

Показивач: инфолиста са xfer информацијама.

Xfer је спреман.

xfer

xfer_accept_resume

Показивач: инфолиста са xfer информацијама.

Прихватање наставка xfer.

xfer

xfer_send_accept_resume

Показивач: инфолиста са xfer информацијама.

Xfer је настављен.

xfer

xfer_start_resume

Показивач: инфолиста са xfer информацијама.

Почетак наставка.

xfer

xfer_resume_ready

Показивач: инфолиста са xfer информацијама.

Xfer наставак је спреман.

xfer

xfer_ended

0.3.2

Показивач: инфолиста са xfer информацијама.

Xfer се завршио.

(1) xxx је име IRC сервера, yyy је име IRC команде.

C пример:

int
my_signal_cb (const void *pointer, void *data, const char *signal,
              const char *type_data, void *signal_data)
{
    /* ... */
    return WEECHAT_RC_OK;
}

/* хвата сигнал "quit" */
struct t_hook *my_signal_hook = weechat_hook_signal ("quit",
                                                     &my_signal_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_signal(signal: str, callback: str, callback_data: str) -> str: ...

# пример
def my_signal_cb(data, signal, signal_data):
    # ...
    return weechat.WEECHAT_RC_OK

# хвата сигнал "quit"
hook = weechat.hook_signal("quit", "my_signal_cb", "")

3.14.14. hook_signal_send

Ажурирано у верзији 1.0.

Шаље сигнал.

Прототип:

int weechat_hook_signal_send (const char *signal, const char *type_data,
                              void *signal_data);

Аргументи:

  • signal: сигнал који се шаље

  • type_data: тип података који се шаљу уз сигнал (погледајте hook_signal)

  • signal_data: подаци који се шаљу уз сигнал

Повратна вредност (WeeChat ≥ 1.0):

  • повратни кôд последње извршене функције повратног позива (WEECHAT_RC_OK ако ниједна функција повратног позива није била извршена):

    • WEECHAT_RC_OK

    • WEECHAT_RC_OK_EAT

    • WEECHAT_RC_ERROR

C пример:

int rc = weechat_hook_signal_send ("my_signal", WEECHAT_HOOK_SIGNAL_STRING, my_string);

Скрипта (Python):

# прототип
def hook_signal_send(signal: str, type_data: str, signal_data: str) -> int: ...

# пример
rc = weechat.hook_signal_send("my_signal", weechat.WEECHAT_HOOK_SIGNAL_STRING, my_string)
Сигнал logger_backlog

Сигнал „logger_backlog” може да се пошаље ако желите да се прикажу раније линије (историја разговора) из бафера (на пример, ако отворите сопствени бафер у вашем додатку/скрипти).

Аргумент је показивач на бафер.

C пример:

weechat_hook_signal_send ("logger_backlog", WEECHAT_HOOK_SIGNAL_POINTER, buffer);

Скрипта (Python):

weechat.hook_signal_send("logger_backlog", weechat.WEECHAT_HOOK_SIGNAL_POINTER, buffer)
Сигнали xxx_script_install

За инсталацију скрипте може да се пошаље један од осам сигнала, у зависности од језика:

  • perl_script_install

  • python_script_install

  • ruby_script_install

  • lua_script_install

  • tcl_script_install

  • guile_script_install

  • javascript_script_install

  • php_script_install

Када прими сигнал, функција повратног позива ће одрадити следеће акције:

  1. Учитавање и уклањање из меморије инсталиране скрипте.

  2. Померање нове скрипте у директоријум ~/.local/share/weechat/xxx/ (где је xxx језик).

  3. Креирање линка на нову скрипту у директоријуму ~/.local/share/weechat/xxx/autoload/ (само ако је скрипта веђ била аутоучитана, или ако је за нову скрипту укључена опција script.scripts.autoload).

  4. Учитавање нове скрипте (ако је скрипта била учитана).

Ове сигнале користи script додатак приликом инсталације скрипти.

Аргумент је стринг са путањом до скрипте која се инсталира.

C пример:

weechat_hook_signal_send ("python_script_install", WEECHAT_HOOK_SIGNAL_STRING, "/путања/до/test.py");

Скрипта (Python):

weechat.hook_signal_send("python_script_install", WEECHAT_HOOK_SIGNAL_STRING, "/путања/до/test.py")
Сигнали xxx_script_remove

За уклањање листе скрипти може да се пошаље један од осам сигнала, у зависности од језика:

  • perl_script_remove

  • python_script_remove

  • ruby_script_remove

  • lua_script_remove

  • tcl_script_remove

  • guile_script_remove

  • javascript_script_remove

  • php_script_remove

За сваку скрипту из листе, функција повратног позива ће скрипту прво уклонити из меморије, па ће је затим обрисати

Додатак script користи ове сигнале за уклањање скрипти.

Аргумент је стринг са листом скрипти за уклањање раздвојених запетама (скрипта је име без путање, на пример script.py).

C пример:

/* уклањање из меморије и брисање скрипти test.py и script.py */
weechat_hook_signal_send ("python_script_remove", WEECHAT_HOOK_SIGNAL_STRING,
                          "test.py,script.py");

Скрипта (Python):

# уклањање из меморије и брисање скрипти test.py и script.py
weechat.hook_signal_send("python_script_remove", WEECHAT_HOOK_SIGNAL_STRING,
                         "test.py,script.py")
Сигнал irc_input_send

WeeChat ≥ 0.3.4, ажурирано у верзији 1.5.

Сигнал „irc_input_send” може да се пошаље да би се симулирао унос у irc бафер (сервера, канала или приватни).

Аргумент је стринг у следећем формату:

  • интерно име сервера (обавезно)

  • тачка зарез

  • име канала (није обавезно)

  • тачка зарез

  • листа опција раздвојених запетама (није обавезна):

    • priority_high: ред са високим приоритетом (као што су корисничке поруке); ово је подразумевани приоритет

    • priority_low: ред са ниским приоритетом (као што су поруке које аутоматски шаље програм WeeChat)

    • user_message: форсира корисничку поруку (не извршава команду)

  • тачка зарез

  • листа ознака које се користе када се шаље порука раздвојених запетама (није обавезна)

  • тачка зарез

  • текст или команда (обавезан)

C примери:

/* реци "Здраво!" на libera серверу, #weechat каналу */
weechat_hook_signal_send ("irc_input_send", WEECHAT_HOOK_SIGNAL_STRING,
                          "libera;#weechat;priority_high,user_message;;Здраво!");

/* шаље команду "/whois FlashCode" на libera сервер, са ниским приоритетом */
weechat_hook_signal_send ("irc_input_send", WEECHAT_HOOK_SIGNAL_STRING,
                          "libera;;priority_low;;/whois FlashCode");

Скрипта (Python):

# реци "Здраво!" на libera серверу, #weechat каналу
weechat.hook_signal_send("irc_input_send", weechat.WEECHAT_HOOK_SIGNAL_STRING,
                         "libera;#weechat;priority_high,user_message;;Здраво!")

# шаље команду "/whois FlashCode" на libera сервер, са ниским приоритетом
weechat.hook_signal_send("irc_input_send", weechat.WEECHAT_HOOK_SIGNAL_STRING,
                         "libera;;priority_low;;/whois FlashCode")

3.14.15. hook_hsignal

WeeChat ≥ 0.3.4, ажурирано у верзији 1.5.

Качи се на hsignal (сигнал са хеш табелом).

Прототип:

struct t_hook *weechat_hook_hsignal (const char *signal,
                                     int (*callback)(const void *pointer,
                                                     void *data,
                                                     const char *signal,
                                                     struct t_hashtable *hashtable),
                                     const void *callback_pointer,
                                     void *callback_data);

Аргументи:

  • signal: сигнал који се хвата, дозвољава се џокер * (дозвољен је приоритет, погледајте напомену о приоритетима) (погледајте табелу испод)

  • callback: функција која се позива када се прими сигнал, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *signal: примљени сигнал

    • struct t_hashtable *hashtable: хеш табела

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_OK_EAT (тренутно прекида слање сигнала) (WeeChat ≥ 0.4.0)

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

Листа hsignalа:

Додатак Сигнал Мин WeeChat Аргументи Опис

irc

irc_redirection_xxx_yyy (1)

0.3.4

Погледајте hsignal_irc_redirect_command

Преусмеравање излаза.

weechat

nicklist_group_added

0.4.1

buffer (struct t_gui_buffer *): бафер
parent_group (struct t_gui_nick_group *): родитељ група
group (struct t_gui_nick_group *): група

У листу надимака је додата група.

weechat

nicklist_nick_added

0.4.1

buffer (struct t_gui_buffer *): бафер
parent_group (struct t_gui_nick_group *): родитељ група
nick (struct t_gui_nick *): надимак

Надимак је додат у листу надимака.

weechat

nicklist_group_removing

0.4.1

buffer (struct t_gui_buffer *): бафер
parent_group (struct t_gui_nick_group *): родитељ група
group (struct t_gui_nick_group *): група

Уклањање групе из листе надимака.

weechat

nicklist_nick_removing

0.4.1

buffer (struct t_gui_buffer *): бафер
parent_group (struct t_gui_nick_group *): родитељ група
nick (struct t_gui_nick *): надимак

Уклањање надимка из листе надимака.

weechat

nicklist_group_changed

0.4.1

buffer (struct t_gui_buffer *): бафер
parent_group (struct t_gui_nick_group *): родитељ група
group (struct t_gui_nick_group *): група

У листи надимака је измењена група.

weechat

nicklist_nick_changed

0.4.1

buffer (struct t_gui_buffer *): бафер
parent_group (struct t_gui_nick_group *): родитељ група
nick (struct t_gui_nick *): надимак

Надимак је промењен у листи надимака.

(1) xxx је аргумент сигнала који се користи у преусмеравању, yyy је шаблон преусмеравања.

C пример:

int
my_hsignal_cb (const void *pointer, void *data, const char *signal,
               struct t_hashtable *hashtable)
{
    /* ... */
    return WEECHAT_RC_OK;
}

struct t_hook *my_hsignal_hook = weechat_hook_hsignal ("test",
                                                       &my_hsignal_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_hsignal(signal: str, callback: str, callback_data: str) -> str: ...

# пример
def my_hsignal_cb(data, signal, hashtable):
    # ...
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_hsignal("test", "my_hsignal_cb", "")

3.14.16. hook_hsignal_send

WeeChat ≥ 0.3.4, ажурирано у верзији 1.0.

Шаље hsignal (сигнал са хеш табелом).

Прототип:

int weechat_hook_hsignal_send (const char *signal, struct t_hashtable *hashtable);

Аргументи:

  • signal: сигнал који се шаље

  • hashtable: хеш табела

Повратна вредност (WeeChat ≥ 1.0):

  • повратни кôд последње извршене функције повратног позива (WEECHAT_RC_OK ако ниједна функција повратног позива није била извршена):

    • WEECHAT_RC_OK

    • WEECHAT_RC_OK_EAT

    • WEECHAT_RC_ERROR

C пример:

int rc;
struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       NULL,
                                                       NULL);
if (hashtable)
{
    weechat_hashtable_set (hashtable, "key", "value");
    rc = weechat_hook_hsignal_send ("my_hsignal", hashtable);
    weechat_hashtable_free (hashtable);
}

Скрипта (Python):

# прототип
def hook_hsignal_send(signal: str, hashtable: Dict[str, str]) -> int: ...

# пример
rc = weechat.hook_hsignal_send("my_hsignal", {"key": "value"})
Hsignal irc_redirect_command

WeeChat ≥ 0.3.4.

„irc_redirect_command” hsignal се шаље када желите да излаз irc команде преусмерите у функцију повратног позива.

Аргумент је хеш табела са следећим ставкама (кључеви и вредности су стрингови):

  • server: интерно име сервера (обавезно)

  • pattern: шаблон за преусмеравање који треба да се користи (обавезан), или подразумевани (који дефинише irc додатак), или кориснички шаблон (погледајте Hsignal irc_redirect_pattern), подразумевани шаблони су:

    • 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: име сигнала (обавезно)

  • count: колико пута ће преусмеравање радити (није обавезно, подразумевано је 1)

  • string: стринг који мора бити у примљеној irc поруци (није обавезно, али се препоручује, ако поруке могу да се идентификују стрингом)

  • timeout: тајмаут за преусмеравање, у секундама (није обавезан, подразумевано је 60)

  • cmd_filter: листа irc команди које се филтирају, раздвојене запетама (само ове команде ће се слати функцијама повратног позива, остале ће се игнорисати) (није обавезно)

Чим пошаљете овај hsignal, морате послати команду irc серверу и преусмеравање ће се употребити за ту команду.

Када се прими комплетан одговор на вашу команду, послаће се hsignal. Овај hsignal има име irc_redirection_xxx_yyy где је xxx signal, а_yyy_ употребљени pattern.

Хеш табела која се шаље у hsignal има следећи садржај (кључеви и вредности су стрингови):

  • output: излаз команде (поруке се раздвајају са „\n”)

  • output_size: број бајтова у output (као стринг)

  • error: стринг грешке (у случају да је дошло до грешке):

    • timeout: преусмеравање је прекинуто након истека тајмаута

  • server: интерно име сервера

  • pattern: шаблон преусмеравања

  • signal: име сигнала

  • command: преусмерена команда

C пример:

int
test_whois_cb (const void *pointer, void *data, const char *signal,
               struct t_hashtable *hashtable)
{
    weechat_printf (NULL, "error = %s", weechat_hashtable_get (hashtable, "error"));
    weechat_printf (NULL, "output = %s", weechat_hashtable_get (hashtable, "output"));
    return WEECHAT_RC_OK;
}

weechat_hook_hsignal ("irc_redirection_test_whois", &test_whois_cb, NULL, NULL);
struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       NULL,
                                                       NULL);
if (hashtable)
{
    weechat_hashtable_set (hashtable, "server", "libera");
    weechat_hashtable_set (hashtable, "pattern", "whois");
    weechat_hashtable_set (hashtable, "signal", "test");
    weechat_hashtable_set (hashtable, "string", "FlashCode");
    weechat_hook_hsignal_send ("irc_redirect_command", hashtable);
    weechat_hook_signal_send ("irc_input_send", WEECHAT_HOOK_SIGNAL_STRING,
                              "libera;;2;;/whois FlashCode");
    weechat_hashtable_free (hashtable);
}

Скрипта (Python):

def test_whois_cb(data, signal, hashtable):
    weechat.prnt("", "error = %s" % hashtable["error"])
    weechat.prnt("", "output = %s" % hashtable["output"])
    return weechat.WEECHAT_RC_OK

weechat.hook_hsignal("irc_redirection_test_whois", "test_whois_cb", "")
weechat.hook_hsignal_send("irc_redirect_command",
                          {"server": "libera", "pattern": "whois", "signal": "test",
                           "string": "FlashCode"})
weechat.hook_signal_send("irc_input_send", weechat.WEECHAT_HOOK_SIGNAL_STRING,
                         "libera;;2;;/whois FlashCode")
Hsignal irc_redirect_pattern

WeeChat ≥ 0.3.4.

Hsignal „irc_redirect_pattern” може да се пошаље када желите да креирате шаблон за irc преусмеравање (погледајте Hsignal irc_redirect_command).

Аргумент је хеш табела са следећим ставкама (кључеви и вредности су стрингови):

  • pattern: име шаблона (обавезно)

  • timeout: подразумевани тајмаут за шаблон, у секундама (није обавезан, подразумевано је 60)

  • cmd_start: листа команди које покрећу преусмеравање раздвојених запетама (није обавезна)

  • cmd_stop: листа команди које заустављају преусмеравање раздвојених запетама (обавезна)

  • cmd_extra: листа команди које могу да се приме након команди заустављања раздвојених запетама (није обавезна)

За сваку команду у cmd_start, cmd_stop и cmd_extra може да се зада цео број са позицијом „стринга” који мора да се нађе у примљеној поруци, на пример:

352:1,354,401:1

За команде 352 и 401, „string” мора да се пронађе у примљеној поруци као први аргумент.

Када се употреби за преусмеравање, шаблон се уништава. Ако вам је потребан шаблон за више преусмеравања, морате да га креирате пре сваког преусмеравања.

C пример:

struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       NULL,
                                                       NULL);
if (hashtable)
{
    weechat_hashtable_set (hashtable, "pattern", "my_whois");
    weechat_hashtable_set (hashtable, "timeout", "30");
    weechat_hashtable_set (hashtable, "cmd_start", "311:1");
    weechat_hashtable_set (hashtable, "cmd_stop", "318:1,401:1,402:1,431:1,461");
    weechat_hashtable_set (hashtable, "cmd_extra", "318:1");
    weechat_hook_hsignal_send ("irc_redirect_pattern", hashtable);
    /*
     * now redirect irc whois command with hsignal irc_redirect_command,
     * using pattern "my_whois"
     */
    /* ... */
    weechat_hashtable_free (hashtable);
}

Скрипта (Python):

weechat.hook_hsignal_send("irc_redirect_pattern",
                          {"pattern": "my_whois", "timeout": "30",
                           "cmd_start": "311:1",
                           "cmd_stop": "318:1,401:1,402:1,431:1,461",
                           "cmd_extra": "318:1"})
# сада преусмерите irc whois команду са hsignal irc_redirect_command
# користећи шаблон "my_whois"
# ...

3.14.17. hook_config

Ажурирано у верзији 1.5.

Качи се на опцију конфигурације.

Прототип:

struct t_hook *weechat_hook_config (const char *option,
                                    int (*callback)(const void *pointer,
                                                    void *data,
                                                    const char *option,
                                                    const char *value),
                                    const void *callback_pointer,
                                    void *callback_data);

Аргументи:

  • option: опција, формат је пуно име, као што се користи у команди /set на пример: weechat.look.item_time_format), дозвољава се џокер * (дозвољена је употреба приоритета, погледајте напомену о приоритетима)

  • callback: функција која се позива када се измени опција конфигурације, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *option: име опције

    • const char *value: нова вредност опције

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

int
my_config_cb (const void *pointer, void *data, const char *option,
              const char *value)
{
    /* ... */
    return WEECHAT_RC_OK;
}

/* хвата измене опције „weechat.look.item_time_format” */
struct t_hook *my_config_hook = weechat_hook_config ("weechat.look.item_time_format",
                                                     &my_config_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_config(option: str, callback: str, callback_data: str) -> str: ...

# пример
def my_config_cb(data, option, value):
    # ...
    return weechat.WEECHAT_RC_OK

# хвата измене опције „weechat.look.item_time_format”
hook = weechat.hook_config("weechat.look.item_time_format", "my_config_cb", "")

3.14.18. hook_modifier

Ажурирано у верзији 1.5.

Качи се на модификатор.

Прототип:

struct t_hook *weechat_hook_modifier (const char *modifier,
                                      char *(*callback)(const void *pointer,
                                                        void *data,
                                                        const char *modifier,
                                                        const char *modifier_data,
                                                        const char *string),
                                      const void *callback_pointer,
                                      void *callback_data);

Аргументи:

  • modifier: име модификатора, листа модификатора које користе програм WeeChat или додаци (дозвољава се приоритет, погледајте напомену о приоритетима) (погледајте табелу испод)

  • callback: функција која се позива када се употреби модификатор, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *modifier: име модификатора

    • const char *modifier_data: подаци за модификатор

    • const char *string: стринг који се модификује

    • return value: нови стринг

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

Листа модификатора које користе програм WeeChat и додаци:

Модификатор Мин WeeChat Подаци модификатора Стринг Излаз

irc_in_xxx (1)

Име сервера

Садржај поруке примљене са IRC сервера (пре декодирања скупа карактера).
Упозорење: стринг може да садржи неважеће UTF-8 податке; користите га само за сирове операције над поруком. Уместо њега се препоручује употреба irc_in2_xxx.

Нови садржај поруке.

irc_in2_xxx (1)

0.3.5

Име сервера

Садржај поруке примљене са IRC сервера (након декодирања скупа карактера).

Нови садржај поруке.

irc_out1_xxx (1)

0.3.7

Име сервера

Садржај поруке које треба да се пошаље IRC серверу пре аутоматске поделе (да стане у 512 подразумевано).

Нови садржај поруке.

irc_out_xxx (1)

Име сервера

Садржај поруке које треба да се пошаље IRC серверу након аутоматске поделе (да стане у 512 подразумевано).

Нови садржај поруке.

bar_condition_yyy (2)

Стринг са показивачем на прозор (нпр: "0x1234abcd")

Празан стринг.

"1" да се прикаже трака, "0" да се сакрије.

history_add

0.3.2

Стринг са показивачем на бафер (нпр: "0x1234abcd")

Садржај командне линије која треба да се дода у историју команди (бафера и глобалну).

Стринг који се додаје у историју команди.

input_text_content

Стринг са показивачем на бафер (нпр: "0x1234abcd")

Садржај командне линије.

Нови садржај командне линије.

input_text_display

Стринг са показивачем на бафер (нпр: "0x1234abcd")

Садржај командне линије, без ознаке курсора.

Нови стринг, само за приказ (командна линија се не мења).

input_text_display_with_cursor

Стринг са показивачем на бафер (нпр: "0x1234abcd")

Садржај командне линије, са ознаком курсора.

Нови стринг, само за приказ (командна линија се не мења).

input_text_for_buffer

0.3.7

Стринг са показивачем на бафер (нпр: "0x1234abcd")

Садржај командне линије која се шаље у бафер (текст или команда).

Нови садржај командне линије који се шаље у бафер.

weechat_print

показивач на бафер (нпр: "0x1234abcd") + ";" + ознаке (3)

Порука која се исписује.

Нова порука која се исписује.
За више информација о кукама које се позивају када се линија исписује, погледајте hook_line.

(1) xxx је име IRC команде.
(2) yyy је име траке.
(3) У верзијама програма WeeChat ≤ 2.8, формат је био: додатак + ";" + buffer_name + ";" + ознаке.

C пример:

char *
my_modifier_cb (const void *pointer, void *data, const char *modifier,
                const char *modifier_data,
                const char *string)
{
    char *result;
    int length;

    if (!string)
        return NULL;

    length = strlen (string) + 5;
    result = malloc (length);
    if (result)
    {
        /* додаје „xxx” у било коју поруку која се исписује */
        snprintf (result, length, "%s xxx", string);
    }

    return result;
}

struct t_hook *my_modifier_hook = weechat_hook_modifier ("weechat_print",
                                                         &my_modifier_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_modifier(modifier: str, callback: str, callback_data: str) -> str: ...

# пример
def my_modifier_cb(data, modifier, modifier_data, string):
    return "%s xxx" % string

hook = weechat.hook_modifier("weechat_print", "my_modifier_cb", "")

3.14.19. hook_modifier_exec

Извршава модификатор(е)

Прототип:

char *weechat_hook_modifier_exec (const char *modifier,
                                  const char *modifier_data,
                                  const char *string);

Аргументи:

  • modifier: име модификатора

  • modifier_data: подаци модификатора

  • string: стринг који треба да се измени

Повратна вредност:

  • измењени стринг, NULL у случају грешке

Листа модификатора за употребу које дефинишу програм WeeChat и додаци:

Модификатор Мин WeeChat Подаци модификатора Стринг Излаз

charset_decode

plugin.buffer_name

Било који стринг.

Стринг декодиран из скупа карактера пронађеног за додатак/бафер у UTF-8.

charset_encode

plugin.buffer_name

Било који стринг.

Стринг кодиран из UTF-8 у скуп карактера пронађен за додатак/бафер.

irc_color_decode

"1" да се боје задрже, "0" да се боје уклоне

Било који стринг.

Стринг у којем су IRC боје конвертоване у WeeChat боје (или су уклоњене IRC боје).

irc_color_encode

"1" да се боје задрже, "0" да се боје уклоне

Било који стринг.

Стринг са IRC бојама (или са уклоњеним IRC бојама).

irc_color_decode_ansi

1.0

"1" да се боје задрже, "0" да се боје уклоне

Било који стринг.

Стринг у којем су ANSI боје конвертоване у IRC боје (или су уклоњене ANSI боје).

irc_command_auth

0.4.1

Име сервера

Команда аутентификације (на пример: /msg nickserv identify лозинка).

Команда са скривеном лозинком (на пример: /msg nickserv identify ********).

irc_message_auth

0.4.1

Име сервера

Порука која се приказује након што се /msg пошаље nickserv боту.

Порука са скривеном лозинком.

irc_tag_escape_value

3.3

-

Било који стринг.

Стринг са означеном вредности IRC ознаке, погледајте: https://ircv3.net/specs/extensions/message-tags#escaping-values.

irc_tag_unescape_value

3.3

-

Било који стринг.

Стринг са неозначеном вредности IRC ознаке, погледајте: https://ircv3.net/specs/extensions/message-tags#escaping-values.

color_decode_ansi

1.0

"1" да се боје задрже, "0" да се боје уклоне

Било који стринг.

Стринг у којем су ANSI боје конвертоване у WeeChat боје (или су уклоњене WeeChat боје).

color_encode_ansi

2.7

-

Било који стринг.

Стринг са WeeChat бојама конвертованим у ANSI боје.

eval_path_home

2.7

Није обавезно: directory=xxx где xxx може бити: config, data, cache, runtime

Било који стринг.

Израчуната путања, резултат функције string_eval_path_home.

C пример:

char *new_string = weechat_hook_modifier_exec ("my_modifier",
                                               my_data, my_string);

Скрипта (Python):

# прототип
def hook_modifier_exec(modifier: str, modifier_data: str, string: str) -> str: ...

# пример
weechat.hook_modifier_exec("my_modifier", my_data, my_string)

3.14.20. hook_info

Ажурирано у верзијама 1.5, 2.5.

Качи се на информацију (функција поратног позива узима и враћа стринг).

Прототип:

struct t_hook *weechat_hook_info (const char *info_name,
                                  const char *description,
                                  const char *args_description,
                                  char *(*callback)(const void *pointer,
                                                    void *data,
                                                    const char *info_name,
                                                    const char *arguments),
                                  const void *callback_pointer,
                                  void *callback_data);

Аргументи:

  • info_name: име инфо (дозвољава се приоритет, погледајте напомену о приоритетима)

  • description: опис

  • args_description: опис аргумената (није обавезан, може да буде NULL)

  • callback: функција која се позива када се затражи инфо, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *info_name: име инфо

    • const char *arguments: додатни аргументи, у зависности од инфо

    • return value: вредност тражене инфо

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

У програму WeeChat ≥ 2.5, функција повратног позива враћа алоцирани стринг (у WeeChat ≤ 2.4 је то био показивач на статички стринг).

C пример:

char *
my_info_cb (const void *pointer, void *data, const char *info_name,
            const char *arguments)
{
    /* ... */
    return strdup ("some_info");
}

/* додаје инфо „my_info” */
struct t_hook *my_info_hook = weechat_hook_info ("my_info",
                                                 "Нека инфо",
                                                 "Инфо о аргументима",
                                                 &my_info_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_info(info_name: str, description: str, args_description: str,
              callback: str, callback_data: str) -> str: ...

# пример
def my_info_cb(data, info_name, arguments):
    return „some_info”

hook = weechat.hook_info("my_info", "Нека инфо", "Инфо о аргументима",
                         "my_info_cb", "")

3.14.21. hook_info_hashtable

WeeChat ≥ 0.3.4, ажурирано у верзији 1.5.

Качи се на информацију (функција повратног позива узима и враћа хеш табелу).

Прототип:

struct t_hook *weechat_hook_info_hashtable (const char *info_name,
                                            const char *description,
                                            const char *args_description,
                                            const char *output_description,
                                            struct t_hashtable *(*callback)(const void *pointer,
                                                                            void *data,
                                                                            const char *info_name,
                                                                            struct t_hashtable *hashtable),
                                            const void *callback_pointer,
                                            void *callback_data);

Аргументи:

  • info_name: име инфо (дозвољава се приоритет, погледајте напомену о приоритетима)

  • description: опис

  • args_description: опис очекиване хеш табеле (није обавезан, може да буде NULL)

  • output_description: опис хеш табеле коју враћа функција повратног позива (није обавезно, може да буде NULL)

  • callback: функција која се позива када се затражи инфо, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *info_name: име инфо

    • struct t_hashtable *hashtable: хеш табела, зависно од информација

    • повратна вредност: тражена хеш табела

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

struct t_hashtable *
my_info_hashtable_cb (const void *pointer, void *data, const char *info_name,
                      struct t_hashtable *hashtable)
{
    /* ... */
    return pointer_to_new_hashtable;
}

/* додаје инфо "my_info_hashtable" */
struct t_hook *my_info_hook = weechat_hook_info_hashtable ("my_info_hashtable",
                                                           "Нека инфо",
                                                           "Инфо о улазној хеш табели",
                                                           "Инфо о излазној хеш табели",
                                                           &my_info_hashtable_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_info_hashtable(info_name: str, description: str, args_description: str,
                        output_description: str, callback: str, callback_data: str) -> str: ...

# пример
def my_info_hashtable_cb(data, info_name, hashtable):
    return {"test_key": "test_value"}

hook = weechat.hook_info_hashtable("my_info_hashtable", "Нека инфо",
                                   "Инфо о улазној хеш табели",
                                   "Инфо о излазној хеш табели",
                                   "my_info_hashtable_cb", "")

3.14.22. hook_infolist

Ажурирано у верзији 1.5.

Качи се на инфолисту: функција повратног позива ће вратити показивач на тражену инфолисту.

Прототип:

struct t_hook *weechat_hook_infolist (const char *infolist_name,
                                      const char *description,
                                      const char *pointer_description,
                                      const char *args_description,
                                      struct t_infolist *(*callback)(const void *pointer,
                                                                     void *data,
                                                                     const char *infolist_name,
                                                                     void *obj_pointer,
                                                                     const char *arguments),
                                      const void *callback_pointer,
                                      void *callback_data);

Аргументи:

  • infolist_name: име инфолисте (дозвољава се приоритет, погледајте напомену о приоритетима)

  • description: опис

  • pointer_description: опис показивача (није обавезно, може да буде NULL)

  • args_description: опис аргумената (није обавезан, може да буде NULL)

  • callback: функција која се позива када се затражи инфолиста, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *infolist_name: име инфолисте

    • void *pointer: показивач на објекат који инфолиста мора да врати (да би се добила само једна ставка у инфолисти)

    • const char *arguments: додатни аргументи, зависно од инфолисте

    • повратна вредност: тражена инфолиста

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

struct t_infolist *
my_infolist_cb (const void *pointer, void *data, const char *infolist_name,
                void *obj_pointer, const char *arguments)
{
    struct t_infolist *my_infolist;

    /* изградња инфолисте */
    /* ... */

    return my_infolist;
}

/* додаје инфолисту "my_infolist" */
struct t_hook *my_infolist = weechat_hook_infolist ("my_infolist",
                                                    "Инфолиста са неким подацима",
                                                    "Инфо о показивачу",
                                                    "Инфо о аргументима",
                                                    &my_infolist_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_infolist(infolist_name: str, description: str, pointer_description: str,
                  args_description: str, callback: str, callback_data: str) -> str: ...

# пример
def my_infolist_cb(data, infolist_name, pointer, arguments):
    # изградња инфолисте
    # ...
    return my_infolist

hook = weechat.hook_infolist("my_infolist", "Инфолиста са неким подацима",
                             "Инфо о показивачу", "Инфо о аргументима",
                             "my_infolist_cb", "")

3.14.23. hook_hdata

Ажурирано у верзији 1.5.

Качи се на hdata: функција повратног позива ће вратити показивач на тражени.

Прототип:

struct t_hook *weechat_hook_hdata (const char *hdata_name,
                                   const char *description,
                                   struct t_hdata *(*callback)(const void *pointer,
                                                               void *data,
                                                               const char *hdata_name),
                                   const void *callback_pointer,
                                   void *callback_data);

Аргументи:

  • hdata_name: име hdata (дозвољавају се приоритети, погледајте напомену о приоритетима)

  • description: опис

  • callback: функција која се позива када се затражи hdata, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • const char *hdata_name: име hdata

    • повратна вредност: тражени hdata

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

struct t_hdata *
my_hdata_cb (const void *pointer, void *data, const char *hdata_name)
{
    struct t_hdata *my_hdata;

    /* изградња hdata */
    /* ... */

    return my_hdata;
}

/* додаје hdata "my_hdata" */
struct t_hook *my_hdata = weechat_hook_hdata ("my_hdata",
                                              "Hdata за моју структуру",
                                              &my_hdata_cb, NULL, NULL);
Ова функција није доступна у API скриптовања.

3.14.24. hook_focus

Ажурирано у верзији 1.5.

Качи се на фокус: догађај миша или тастер притиснут у режиму померања курсора.

Прототип:

struct t_hook *weechat_hook_focus (const char *area,
                                   struct t_hashtable *(*callback)(const void *pointer,
                                                                   void *data,
                                                                   struct t_hashtable *info),
                                   const void *callback_pointer,
                                   void *callback_data);

Аргументи:

  • area: „chat” за површину чета (разговора), или име ставке траке (дозвољава се приоритет, погледајте напомену о приоритетима)

  • callback: функција која се позива када се направи фокус, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_hashtable *info: хеш табела са инфо о фокусу у стрингови које су вратили остали позиви фокус функција повратног позива (са вишим приоритетом) (погледате табелу испод)

    • повратна вредност: или показивач на „info” (завршену хеш табелу), или показивач на нову хеш табелу (коју је креирала функција повратног позива, са кључевима и вредностима типа „стринг”), садржај ове нове хеш табеле ће се додати у info за остале позиве фокус функције повратног позива

  • callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се кука обрише

У случају гестикулације мишем, ваша функција повратног позива ће се позвати два пута: први пута када се тастер притисне (овде се површина увек подудара са вашом површином), а други пут када се тастер отпусти, па тада је могуће да се површина не подудара са вашом површином: зато у својој функцији повратног позива увек морате да тестирате да ли се површина подудара пре него што употребите инфо из хеш табеле.

Садржај хеш табеле која се шаље функцији повратног позива (кључеви и вредности су типа „стринг”):

Кључ (1) Опис Примери вредности Вредност ако нема

_x

Колона на екрану.

"0" …​ "n"

_y

Линија на екрану.

"0" …​ "n"

_key

Догађај тастера или миша.

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

_window

Показивач на прозор.

"0x1234abcd"

""

_window_number

Број прозора.

"1" …​ "n"

"*"

_buffer

Показивач на бафер.

"0x1234abcd"

""

_buffer_number

Број бафера.

"1" …​ "n"

"-1"

_buffer_plugin

Име додатка бафера.

"core", "irc", …​

""

_buffer_name

Име бафера.

"weechat", "libera.#weechat", …​

""

_buffer_full_name

Пуно име бафера.

"core.weechat", "irc.libera.#weechat", …​

""

_buffer_localvar_XXX (2)

Локалне променљиве бафера.

any value

not set

_chat

Индикатор површине разговора.

"0" or "1"

"0"

_chat_line

Показивач на линију (WeeChat ≥ 1.2).

"0x1234abcd"

""

_chat_line_x

Колона у линији (3).

"0" …​ "n"

"-1"

_chat_line_y

Број линије (3).

"0" …​ "n"

"-1"

_chat_line_date

Датум/време линије.

"1313237175"

"0"

_chat_line_date_printed

Датум/време линије (4).

"1313237175"

"0"

_chat_line_time

Приказано време.

"14:06:15"

""

_chat_line_tags

Ознаке линије.

"irc_privmsg,nick_flashy,log1"

""

_chat_line_nick

Надимак линије.

"FlashCode"

""

_chat_line_prefix

Префикс линије.

"@FlashCode"

""

_chat_line_message

Порука линије.

"Hello world!"

""

_chat_word

Реч на (x,y).

"Здраво"

""

_chat_bol

Текст од почетка линије до (x-1, y).

"Зд"

""

_chat_eol

Тест од (x, y) до краја линије.

"раво свете!"

""

_bar_name

Име траке.

"title", "nicklist", …​

""

_bar_filling

Испуна траке.

"horizontal", "vertical", …​

""

_bar_item_name

Име ставке траке.

"buffer_nicklist", "hotlist", …​

""

_bar_item_line

Линија у ставки траке.

"0" …​ "n"

"-1"

_bar_item_col

Колона у ставки траке.

"0" …​ "n"

"-1"

_bar_window

Показивач на прозор траке (WeeChat ≥ 2.9).

"0x1234abcd"

""

(1) Постоје исти кључеви са суфиксом „2” (тј: „_x2”, „_y2”, „_window2”, …​) са инфо о другој тачки (корисно је само за гестикулације мишем, како бисте знали где је отпуштен тастер миша).
(2) XXX је име локалне променљиве у баферу.
(3) Поставља се само за бафере са слободним садржајем.
(4) То је датум када је програм WeeChat додао линију у бафер (веће или једнако од „_chat_line_date”).

Додатне инфо за ставку траке „buffer_nicklist”:

Додатак (1) Кључ Опис

irc

irc_nick

Показивач на IRC надимак (WeeChat ≥ 3.0).

irc

irc_host

Хост за надимак (ако се зна).

weechat

nick

Име надимка.

weechat

prefix

Префикс за надимак.

weechat

group

Име групе.

(1) Име додатка које дефинише hook_focus за враћање инфо о овој ставки траке (на пример, ако је додатак „irc”, инфо о томе ће бити доступна само за irc бафере).

Повратна вредност:

  • показивач на нову куку, NULL у случају грешке

C пример:

struct t_hashtable *
my_focus_nicklist_cb (const void *pointer, void *data, struct t_hashtable *info)
{
    /* додавање стрингова у хеш табелу */
    /* ... */

    return info;
}

/* додаје фокус на nicklist */
struct t_hook *my_focus = weechat_hook_focus ("buffer_nicklist",
                                              &my_focus_nicklist_cb, NULL, NULL);

Скрипта (Python):

# прототип
def hook_focus(area: str, callback: str, callback_data: str) -> str: ...

# пример
def my_focus_nicklist_cb(data, info):
    # изградња dict
    # ...
    return my_dict

hook = weechat.hook_focus("buffer_nicklist", "my_focus_nicklist_cb", "")

3.14.25. hook_set

WeeChat ≥ 0.3.9 (скрипте: WeeChat ≥ 0.4.3).

Поставља стринг вредност особине куке.

Прототип:

void weechat_hook_set (struct t_hook *hook, const char *property,
                       const char *value);

Аргументи:

  • hook: нешто за шта се прикачила „weechat_hook_xxx()”

  • property: име особине (погледајте табелу испод)

  • value: нова вредност за особину

Особине:

Име Мин WeeChat Тип куке Вредност Опис

subplugin

било који тип

било који стринг

Име под додатка (обично је то име скрипте које се приказује у /help команда за куку типа command).

stdin

0.4.3

process, process_hashtable

било који стринг

Шаље податке на стандардни улаз (stdin) дете процеса.

stdin_close

0.4.3

process, process_hashtable

(не користи се)

Затвара пајп који се користи за слање података на стандардни улаз (stdin) дете процеса.

signal

1.0

process, process_hashtable

број сигнала или једно од следећих имена: hup, int, quit, kill, term, usr1, usr2

Шаље сигнал дете процесу.

C пример:

struct t_hook *my_command_hook =
    weechat_hook_command ("abcd", "опис",
                          "args", "опис аргумената",
                          "", &my_command_cb, NULL, NULL);
weechat_hook_set (my_command_hook, "subplugin", "test");

Скрипта (Python):

# прототип
def hook_set(hook: str, property: str, value: str) -> int: ...

# пример
def my_process_cb(data, command, return_code, out, err):
    # ...
    return weechat.WEECHAT_RC_OK

hook = weechat.hook_process_hashtable("/путања/до/команде", {"stdin": "1"},
                                      20000, "my_process_cb", "")
weechat.hook_set(hook, "stdin", "подаци који се шаљу на stdin дете процеса")
weechat.hook_set(hook, "stdin_close", "")  # није обавезно

3.14.26. unhook

Откачи се са нечега на шта је прикачено.

Прототип:

void weechat_unhook (struct t_hook *hook);

Аргументи:

  • hook: нешто за шта се прикачила „weechat_hook_xxx()”

C пример:

struct t_hook *my_hook = weechat_hook_command ( /* ... */ );
/* ... */
weechat_unhook (my_hook);

Скрипта (Python):

# прототип
def unhook(hook: str) -> int: ...

# пример
weechat.unhook(my_hook)

3.14.27. unhook_all

Ажурирано у верзији 1.5.

Откачи се са свега на шта се закачио текући додатак.

Прототип:

void weechat_unhook_all (const char *subplugin);

Аргументи:

  • subplugin: ако није NULL, откаче се само куке које имају постављен овај „subplugin” (овај аргумент није доступан у API скриптовања)

C пример:

weechat_unhook_all (NULL);

Скрипта (Python):

# прототип
def unhook_all() -> int: ...

# пример
weechat.unhook_all()

3.15. Бафери

Функције за креирање/упит/затварање бафера.

3.15.1. buffer_new

Ажурирано у верзији 1.5.

Отвара нови бафер.

Прототип:

struct t_gui_buffer *weechat_buffer_new (const char *name,
                                         int (*input_callback)(const void *pointer,
                                                               void *data,
                                                               struct t_gui_buffer *buffer,
                                                               const char *input_data),
                                         const void *input_callback_pointer,
                                         void *input_callback_data,
                                         int (*close_callback)(const void *pointer,
                                                               void *data,
                                                               struct t_gui_buffer *buffer),
                                         const void *close_callback_pointer,
                                         void *close_callback_data);

Аргументи:

  • name: име бафера (мора бити јединствено за додатак)

  • input_callback: функција која се позива када се унесе текст уноса за бафер, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_gui_buffer *buffer: показивач на бафер

    • const char *input_data: подаци уноса

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • input_callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • input_callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се бафер затвори

  • close_callback: функција која се позива када се затвори бафер, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_gui_buffer *buffer: показивач на бафер

    • повратна вредност:

      • WEECHAT_RC_OK

      • WEECHAT_RC_ERROR

  • close_callback_pointer: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat

  • close_callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се затвори бафер

Повратна вредност:

  • показивач на нови бафер, NULL у случају грешке

C пример:

int
my_input_cb (const void *pointer, void *data,
             struct t_gui_buffer *buffer, const char *input_data)
{
    weechat_printf (buffer, "Текст: %s", input_data);
    return WEECHAT_RC_OK;
}

int
my_close_cb (const void *pointer, void *data, struct t_gui_buffer *buffer)
{
    weechat_printf (NULL, "Затвориће се бафер ’%s’!",
                    weechat_buffer_get_string (buffer, "name"));
    return WEECHAT_RC_OK;
}

struct t_gui_buffer *my_buffer = weechat_buffer_new ("my_buffer",
                                                     &my_input_cb, NULL, NULL,
                                                     &my_close_cb, NULL, NULL);

Скрипта (Python):

# прототип
def buffer_new(name: str, input_callback: str, input_callback_data: str,
               close_callback: str, close_callback_data: str) -> str: ...

# пример
def my_input_cb(data, buffer, input_data):
    weechat.prnt(buffer, "Текст: %s" % input_data)
    return weechat.WEECHAT_RC_OK

def my_close_cb(data, buffer):
    weechat.prnt("", "Затвориће се бафер ’%s’!" % weechat.buffer_get_string(buffer, "name"))
    return weechat.WEECHAT_RC_OK

buffer = weechat.buffer_new("my_buffer", "my_input_cb", "", "my_close_cb", "")

3.15.2. current_buffer

Враћа показивач на текући бафер (бафер који се приказује у текућем прозору).

Прототип:

struct t_gui_buffer *weechat_current_buffer ();

Повратна вредност:

  • показивач на текући бафер

C пример:

weechat_printf (weechat_current_buffer (), "Текст у текућем баферу");

Скрипта (Python):

# прототип
def current_buffer() -> str: ...

# пример
weechat.prnt(weechat.current_buffer(), "Текст у текућем баферу")

Ажурирано у верзији 1.0.

Тражи бафер по додатку и/или имену.

Прототип:

struct t_gui_buffer *weechat_buffer_search (const char *plugin,
                                            const char *name);

Аргументи:

  • plugin: име додатка, дозвољене су следеће специјалне вредности:

    • ==: име које се користи је пуно име бафера (на пример: irc.libera.#weechat уместо libera.#weechat) (WeeChat ≥ 1.0)

  • name: име бафера, ако је NULL или празан стринг, враћа се текући бафер (бафер који се приказује у текућем прозору); ако име почиње са (?i), претрага не прави разлику у величини слова (WeeChat ≥ 1.0)

Повратна вредност:

  • показивач на пронађени бафер, или NULL ако се бафер не пронађе

C примери:

struct t_gui_buffer *buffer1 = weechat_buffer_search ("irc", "libera.#weechat");
struct t_gui_buffer *buffer2 = weechat_buffer_search ("==", "irc.libera.#test");  /* WeeChat ≥ 1.0 */

Скрипта (Python):

# прототип
def buffer_search(plugin: str, name: str) -> str: ...

# пример
buffer = weechat.buffer_search("my_plugin", "my_buffer")

3.15.4. buffer_search_main

Тражи главни бафер програма WeeChat (core бафер, први бафер који се прикаже када се покреће програм WeeChat).

Прототип:

struct t_gui_buffer *weechat_buffer_search_main ();

Повратна вредност:

  • показивач на главни бафер програма WeeChat (core бафер)

C пример:

struct t_gui_buffer *weechat_buffer = weechat_buffer_search_main ();

Скрипта (Python):

# прототип
def buffer_search_main() -> str: ...

# пример
buffer = weechat.buffer_search_main()

3.15.5. buffer_clear

Чисти садржај бафера.

Прототип:

void weechat_buffer_clear (struct t_gui_buffer *buffer);

Аргументи:

  • buffer: показивач на бафер

C пример:

struct t_gui_buffer *my_buffer = weechat_buffer_search ("my_plugin",
                                                        "my_buffer");
if (my_buffer)
{
    weechat_buffer_clear (my_buffer);
}

Скрипта (Python):

# прототип
def buffer_clear(buffer: str) -> int: ...

# пример
buffer = weechat.buffer_search("my_plugin", "my_buffer")
if buffer != "":
    weechat.buffer_clear(buffer)

3.15.6. buffer_close

Затвара бафер.

Прототип:

void weechat_buffer_close (struct t_gui_buffer *buffer);

Аргументи:

  • buffer: показивач на бафер

C пример:

struct t_gui_buffer *my_buffer = weechat_buffer_new ("my_buffer",
                                                     &my_input_cb, NULL,
                                                     &my_close_cb, NULL);
/* ... */
weechat_buffer_close (my_buffer);

Скрипта (Python):

# прототип
def buffer_close(buffer: str) -> int: ...

# пример
buffer = weechat.buffer_new("my_buffer", "my_input_cb", "", "my_close_cb", "")
# ...
weechat.buffer_close(buffer)

3.15.7. buffer_merge

Спаја бафер у неки други бафер: оба бафера и даље постоје одвојено, али под истим бројем и програм WeeChat ће исписивати линије из оба бафера (мешане линије).

Прототип:

void weechat_buffer_merge (struct t_gui_buffer *buffer,
                           struct t_gui_buffer *target_buffer);

Аргументи:

  • buffer: показивач на бафер

  • target_buffer: циљни бафер, онај са којим се бафер спаја

C пример:

/* merge current buffer with weechat "core" buffer */
weechat_buffer_merge (weechat_current_buffer (),
                      weechat_buffer_search_main ());

Скрипта (Python):

# прототип
def buffer_merge(buffer: str, target_buffer: str) -> int: ...

# пример
# спаја текући бафер са WeeChat „core” бафером
weechat.buffer_merge(weechat.current_buffer(), weechat.buffer_search_main())

3.15.8. buffer_unmerge

Издваја бафер из групе спојених бафера.

Прототип:

void weechat_buffer_unmerge (struct t_gui_buffer *buffer,
                             int number);

Аргументи:

  • buffer: показивач на бафер

  • number: циљни број за издвојени бафер, ако је < 1, онда ће се бафер померити на број buffer + 1

C пример:

weechat_buffer_unmerge (weechat_current_buffer (), 1);

Скрипта (Python):

# прототип
def buffer_unmerge(buffer: str, number: int) -> int: ...

# пример
weechat.buffer_unmerge(weechat.current_buffer(), 1)

3.15.9. buffer_get_integer

Враћа целобројну вредност особине бафера.

Прототип:

int weechat_buffer_get_integer (struct t_gui_buffer *buffer,
                                const char *property);

Аргументи:

  • buffer: показивач на бафер

  • property: име особине:

    • number: број бафера (почиње се од 1)

    • layout_number: број бафера сачуван у распореду

    • layout_number_merge_order: редослед у спајању за распоред

    • short_name_is_set: 1 ако је постављено кратко име, 0 ако није

    • type: тип бафера (0: форматиран, 1: слободни садржај)

    • notify: ниво обавештавања за бафер

    • num_displayed: број прозора који приказују бафер

    • active: 2 ако је то једини активни бафер (спојен), 1 ако је бафер активан, 0 ако је бафер спојен и није изабран

    • hidden: 1 ако је бафер скривен, у супротном 0 (WeeChat ≥ 1.0)

    • zoomed: 1 ако је бафер спојен и зумиран, у супротном 0 (WeeChat ≥ 1.0)

    • print_hooks_enabled: 1 ако су укључене print куке, у супротном 0

    • day_change: 1 ако су приказују поруке о промени дана, у супротном 0 (WeeChat ≥ 0.4.3)

    • clear: 1 ако бафер може да се очисти командом /buffer clear, у супротном 0 (WeeChat ≥ 1.0)

    • filter: 1 ако су у баферу укључени филтери, у успротном 0 (WeeChat ≥ 1.0)

    • lines_hidden: 1 ако је у баферу скривена бар једна линија (филтрирана), или 0 ако се приказују све линије

    • prefix_max_length: максимална дужина префикса у овом баферу

    • time_for_each_line: 1 ако се време приказује са сваку линију у баферу (подразумевано), у супротном 0

    • nicklist: 1 ако је укључена листа надимака, у супротном 0

    • nicklist_case_sensitive: 1 ако се у надимцима прави разлика у величини слова, у супротном 0

    • nicklist_max_length: максимална дужина надимка

    • nicklist_display_groups: 1 ако се приказују групе, у супротном 0

    • nicklist_count: број надимака и група у листи надимака

    • nicklist_visible_count: број приказаних надимака/група

    • nicklist_groups_count: број група у листи надимака

    • nicklist_visible_groups_count: број приказаних група

    • nicklist_nicks_count: број надимака у листи надимака

    • nicklist_visible_nicks_count: број приказаних надимака

    • input: 1 ако је укључен унос, у супротном 0

    • input_get_unknown_commands: 1 ако се непознате команде шаљу функцији повратног позива уноса, у супротном 0

    • input_get_empty: 1 ако се функцији повратног позива уноса шаље празан унос, у супротном 0

    • input_multiline: 1 ако се више линија шаље као једна порука функцији повратног позива уноса, у супротном 0

    • input_size: величина уноса (у бајтовима)

    • input_length: дужина уноса (број карактера)

    • input_pos: позиција курсора у баферу уноса

    • input_1st_display: први карактер приказан на екрану

    • num_history: број команди у историји

    • text_search: тип претраге текста:

      • 0: у овом тренутку нема претраге

      • 1: претрага уназад (смер: ка најстаријим порукама)

      • 2: претрага унапред (смер: ка најновијим порукама)

    • text_search_exact: 1 ако претрага текста прави разлику у величини слова

    • text_search_found: 1 ако се текст пронађе, у супротном 0

Повратна вредност:

  • целобројна вредност особине

C пример:

weechat_printf (NULL, "број мог бафера је: %d",
                weechat_buffer_get_integer (my_buffer, "number"));

Скрипта (Python):

# прототип
def buffer_get_integer(buffer: str, property: str) -> int: ...

# пример
weechat.prnt("", "број мог бафера је: %d" % weechat.buffer_get_integer(my_buffer, "number"))

3.15.10. buffer_get_string

Враћа стринг вредност особине бафера.

Прототип:

const char *weechat_buffer_get_string (struct t_gui_buffer *buffer,
                                       const char *property);

Аргументи:

  • buffer: показивач на бафер

  • property: име особине:

    • plugin: име додатка који је креирао овај бафер („core” за главни бафер програма WeeChat)

    • name: име бафера

    • full_name: пуно име бафера („додатак.име”) (WeeChat ≥ 0.3.7)

    • short_name: кратко име бафера (напомена: користи се само за приказ и корисник може да га промени, ово не сме да се употребљава за проналажење имена бафера, уместо њега употребите name, full_name или локалну променљиву channel)

    • title: наслов бафера

    • input: текст уноса

    • text_search_input: сачувани унос пре претраге текста

    • highlight_words: листа речи које се истичу

    • highlight_regex: POSIX проширени регуларни израз за истицање

    • highlight_tags_restrict: ограничава истицање само на поруке са наведеним ознакама

    • highlight_tags: истицање се форсира за поруке са наведеним ознакама

    • hotlist_max_level_nicks: максимални ниво вруће листе за неке надимке

    • localvar_xxx: враћа садржај локалне променљиве „xxx” (замените „xxx” са именом локалне променљиве коју желите да прочитате)

Повратна вредност:

  • стринг вредност особине

C пример:

weechat_printf (NULL, "име / кратко име бафера су: %s / %s",
                weechat_buffer_get_string (my_buffer, "name"),
                weechat_buffer_get_string (my_buffer, "short_name"));

Скрипта (Python):

# прототип
def buffer_get_string(buffer: str, property: str) -> str: ...

# пример
weechat.prnt("", "име / кратко име бафера су: %s / %s"
    % (weechat.buffer_get_string(my_buffer, "name"),
    weechat.buffer_get_string(my_buffer, "short_name")))

3.15.11. buffer_get_pointer

Враћа вредност показивача на особину бафера.

Прототип:

void *weechat_buffer_pointer (struct t_gui_buffer *buffer,
                              const char *property);

Аргументи:

  • buffer: показивач на бафер

  • property: име особине:

    • plugin: показивач на додатак који је креирао овај бафер (NULL за главни бафер програма WeeChat)

    • highlight_regex_compiled: компајлиран регуларни израз highlight_regex

Повратна вредност:

  • вредност показивача на особину

C пример:

weechat_printf (NULL, "показивач на додатак мог бафера: %lx",
                weechat_buffer_get_pointer (my_buffer, "plugin"));

Скрипта (Python):

# прототип
def buffer_get_pointer(buffer: str, property: str) -> str: ...

# пример
weechat.prnt("", "показивач на додатак мог бафера: %s" % weechat.buffer_get_pointer(my_buffer, "plugin"))

3.15.12. buffer_set

Поставља стринг вредност особине бафера.

Прототип:

void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property,
                         const char *value);

Аргументи:

  • buffer: показивач на бафер

  • property: име особине (погледајте табелу испод)

  • value: нова вредност за особину

Особине:

Име Мин WeeChat Вредност Опис

hotlist

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

"+": укључује врућу листу (глобално подешавање, не користи се показивач на бафер)
"-": искључује врућу листу (глобално подешавање, не користи се показивач на бафер)
приоритет: бафер се на врућу листу додаје са овим приоритетом
"-1": уклања бафер из вруће листе (WeeChat ≥ 1.0).

completion_freeze

"0" или "1"

"0": нема замрзавања довршавања (подразумевана вредност) (глобално подешавање, не користи се показивач на бафер)
"1": довршавање се не зауставља када се ажурира командна линија (глобално подешавање, не користи се показивач на бафер).

unread

-

Поставља маркер непрочитаних линија након последње линије бафера.

display

"1" или "auto"

"1": прелазак на овај бафер у текућем прозору
"auto": прелазак на овај бафер у текућем прозору, не ресетује се маркер прочитаних линија.

hidden

1.0

"0" или "1"

"0": бафер се открива
"1": бафер се скрива.

number

број

Помера бафер на наведени број.

name

било који стринг

Поставља ново име бафера.

short_name

било који стринг

Поставља ново кратко име бафера.

type

"formatted" или "free"

Поставља тип бафера: "formatted" (за приказ порука разговора), или "free" (за слободни садржај); када је вредност "free", особина clear се форсира на "0" (WeeChat ≥ 1.0).

notify

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

Поставља ниво обавештавања за овај бафер: "0" = никада се не додаје на врућу листу, "1" = додаје само за истицања, "2" = додаје за истицања и поруке, "3" = додаје за све поруке.

print_hooks_enabled

"0" или "1"

"0" да се искључе print куке, "1" да се укључе (подразумевано за нови бафер).

day_change

0.4.3

"0" или "1"

"0" да се скривају поруке о измени дана, "1" да се приказују (подразумевано за нови бафер).

clear

1.0

"0" или "1"

"0" да се спречи могућност да корисник очисти бафер командом /buffer clear, "1" да се дозволи кориснику да очисти бафер (подразумевано за нови бафер) (напомена: чак и када се постави на "0", бафер још увек може да се очисти функцијом buffer_clear).

filter

1.0

"0" или "1"

"0": искључује филтере у баферу
"1": укључује филтере у баферу.

title

било који стринг

Поставља нови наслов бафера.

time_for_each_line

"0" или "1"

"0" да се скрива време у свим линијама бафера, "1" да се приказује у свим линијама (подразумевано за нови бафер).

nicklist

"0" или "1"

"0" да се листа надимака уклони из бафера, "1" да се у бафер дода листа надимака.

nicklist_case_sensitive

"0" или "1"

"0" да листа надимака не прави разлику у величини слова, "1" да листа надимака прави разлику у величини слова.

nicklist_display_groups

"0" или "1"

"0" да се сакрију групе у листи надимака, "1" да се приказују групе у листи надимака.

highlight_words

"-" или листа речи раздвојених запетама

"-" је специјална вредност која искључује било какво истицање у овом баферу, или листа речи за истицање у баферу раздвојених запетама, на пример: "abc,def,ghi".

highlight_words_add

листа речи раздвојених запетама

Лист речи раздвојених запетама које се истичу у овом баферу, ове речи се додају на постојеће речи које се истичу у баферу.

highlight_words_del

листа речи раздвојених запетама

Лист речи раздвојених запетама које треба да се уклоне из речи које се истичу у овом баферу.

highlight_regex

било који стринг

POSIX проширени регуларни израз за истицање.

highlight_tags_restrict

листа речи или ознака раздвојених запетама

Ограничава истицање порука у овом баферу само на поруке са наведеним ознакама (граничником „+” је могуће комбиновање више ознака у релацији логичко „и”, на пример: "nick_toto+irc_action").

highlight_tags

листа речи или ознака раздвојених запетама

Форсира истицање порука са наведеним ознакама у овом баферу ( (граничником „+” је могуће комбиновање више ознака у релацији логичко „и”, на пример: "nick_toto+irc_action").

hotlist_max_level_nicks

листа „надимак:ниво” раздвојена запетама

Листа надимака са максималним нивоом вруће листе раздвојених запетама за овај бафер (ниво може бити: -1: никада у врућој листи, 0: низак, 1: порука, 2: приватна, 3: истицање), на пример: „joe:2,mike:-1,robert:-1” (joe никада неће изазвати истицање у баферу, mike и robert никада неће изменити врућу листу).

hotlist_max_level_nicks_add

листа „надимак:ниво” раздвојена запетама

Листа надимака са максималним нивоом вруће листе раздвојених запетама, ови надимци се додају на постојеће надимке у баферу.

hotlist_max_level_nicks_del

листа надимака раздвојених запетама

Листа надимака раздвојених запетама који треба да се уклоне из максималних нивоа вруће листе.

key_bind_xxx

било који стринг

Прави нову тастерску пречицу xxx, специфичну за овај бафер, вредност је команда која се извршава за тај тастер.

key_unbind_xxx

-

Уклања тастерску пречицу xxx за овај бафер.

input

било који стринг

Поставља нову вредност за унос у бафер.

input_pos

позиција

Поставља позицију курсора у уносу бафера.

input_get_unknown_commands

"0" или "1"

"0" да се за овај бафер искључе непознате команде (подразумевано понашање), "1" да се прихвате непознате команде, на пример ако корисник откуца „/unknowncmd”, бафер ће то да прихвати (без исписа грешке о непознатој команди).

input_get_empty

"0" или "1"

"0" да се искључи празан унос у овај бафер (подразумевано понашање), "1" да се прихвати празан унос.

input_multiline

"0" или "1"

"0" да се овом баферу свака линија шаље одвојено (подразумевано понашање), "1" да се више линија пошаље као једна порука.

localvar_set_xxx

било који стринг

Поставља нову вредност локалне променљиве xxx (променљива се креира ако не постоји).

localvar_del_xxx

-

Уклања локалну променљиву xxx.

C пример:

/* искључивање вруће листе (за све бафере) */
weechat_buffer_set (NULL, "hotlist", "-");

/* поновно укључивање вруће листе */
weechat_buffer_set (NULL, "hotlist", "+");

/* промена имена бафера
weechat_buffer_set (my_buffer, "name", "my_new_name");

/* додавање нове локалне променљиве „toto” са вредности „abc” */
weechat_buffer_set (my_buffer, "localvar_set_toto", "abc");

/* уклањање локалне променљиве „toto” */
weechat_buffer_set (my_buffer, "localvar_del_toto", "");

Скрипта (Python):

# прототип
def buffer_set(buffer: str, property: str, value: str) -> int: ...

# примери

# искључује врућу листу (за све бафере)
weechat.buffer_set("", "hotlist", "-")

# поново укључује врућу листу
weechat.buffer_set("", "hotlist", "+")

# промена имена бафера
weechat.buffer_set(my_buffer, "name", "my_new_name")

# додаје нову локалну променљиву „toto” са вредношћу „abc”
weechat.buffer_set(my_buffer, "localvar_set_toto", "abc")

# уклања локалну променљиву „toto”
weechat.buffer_set(my_buffer, "localvar_del_toto", "")

3.15.13. buffer_set_pointer

Поставља вредност показивача на особину бафера.

Прототип:

void weechat_buffer_set_pointer (struct t_gui_buffer *buffer, const char *property,
                                 void *pointer);

Аргументи:

  • buffer: показивач на бафер

  • property: име особине:

    • close_callback: поставља функцију повратног позива затварања

    • close_callback_data: поставља податке за функцију повратног позива затварања

    • input_callback: поставља функцију повратног позива уноса

    • input_callback_data: поставља податке за функцију повратног позива уноса

    • nickcmp_callback: поставља функцију повратног позива за поређење надимака (ова функција повратног позива се зове када се у листи надимака тражи надимак) (WeeChat ≥ 0.3.9)

    • nickcmp_callback_data: поставља податке за функцију повратног позива за поређење надимака (WeeChat ≥ 0.3.9)

  • pointer: нова вредност показивача за особину

Прототипи за функције повратног позива:

int close_callback (const void *pointer, void *data,
                    struct t_gui_buffer *buffer);

int input_callback (const void *pointer, void *data,
                    struct t_gui_buffer *buffer, const char *input_data);

int nickcmp_callback (const void *pointer, void *data,
                      struct t_gui_buffer *buffer,
                      const char *nick1, const char *nick2);

C пример:

int
my_close_cb (const void *pointer, void *data, struct t_gui_buffer *buffer)
{
    /* ... */
    return WEECHAT_RC_OK;
}

weechat_buffer_set_pointer (my_buffer, "close_callback", &my_close_cb);
Ова функција није доступна у API скриптовања.

3.15.14. buffer_string_replace_local_var

Замењује локалне променљиве у стрингу својим вредностима, користећи бафер локалне променљиве.

Прототип:

char *weechat_buffer_string_replace_local_var (struct t_gui_buffer *buffer,
                                               const char *string);

Аргументи:

  • buffer: показивач на бафер

  • string: стринг са текстом и локалним променљивама у формату „$пром”

Повратна вредност:

  • стринг са вредностима локалних променљивих

C пример:

weechat_buffer_set (my_buffer, "localvar_set_toto", "abc");

char *str = weechat_buffer_string_replace_local_var (my_buffer,
                                                     "тест са $toto");
/* str садржи „тест са abc” */

Скрипта (Python):

# прототип
def buffer_string_replace_local_var(buffer: str, string: str) -> str: ...

# пример
weechat.buffer_set(my_buffer, "localvar_set_toto", "abc")
str = weechat.buffer_string_replace_local_var(my_buffer, "тест са $toto")
# str садржи „тест са abc”

3.15.15. buffer_match_list

WeeChat ≥ 0.3.5.

Проверава да ли се бафер подудара са листом бафера.

Прототип:

int weechat_buffer_match_list (struct t_gui_buffer *buffer, const char *string);

Аргументи:

  • buffer: показивач на бафер

  • string: листа бафера раздвојених запетама:

    • * значи сви бафери

    • име које почиње са ! се не узима у обзир

    • у имену је дозвољен џокер *

Повратна вредност:

  • 1 ако се бафер подудара са листом бафера, 0 у супротном

C пример:

struct t_gui_buffer *buffer = weechat_buffer_search ("irc", "libera.#weechat");
if (buffer)
{
    weechat_printf (NULL, "%d", weechat_buffer_match_list (buffer, "*"));                    /* 1 */
    weechat_printf (NULL, "%d", weechat_buffer_match_list (buffer, "*,!*#weechat*"));        /* 0 */
    weechat_printf (NULL, "%d", weechat_buffer_match_list (buffer, "irc.libera.*"));       /* 1 */
    weechat_printf (NULL, "%d", weechat_buffer_match_list (buffer, "irc.oftc.*,python.*"));  /* 0 */
}

Скрипта (Python):

# прототип
def buffer_match_list(buffer: str, string: str) -> int: ...

# пример
buffer = weechat.buffer_search("irc", "libera.#weechat")
if buffer:
    weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "*"))                    # 1
    weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "*,!*#weechat*"))        # 0
    weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "irc.libera.*"))       # 1
    weechat.prnt("", "%d" % weechat.buffer_match_list(buffer, "irc.oftc.*,python.*"))  # 0

3.16. Прозори

Функције за упите о прозорима.

3.16.1. current_window

Враћа показивач на текући прозор.

Прототип:

struct t_gui_window *weechat_current_window ();

Повратна вредност:

  • показивач на текући прозор

C пример:

struct t_gui_window *current_window = weechat_current_window ();

Скрипта (Python):

# прототип
def current_window() -> str: ...

# пример
current_window = weechat.current_window()

3.16.2. window_search_with_buffer

WeeChat ≥ 0.3.5.

Враћа показивач на прозор који приказује бафер.

Прототип:

struct t_gui_window *weechat_window_search_with_buffer (struct t_gui_buffer *buffer);

Аргументи:

  • buffer: показивач на бафер

Повратна вредност:

  • показивач на прозор који приказује бафер (NULL ако ниједан прозор не приказује бафер)

C пример:

weechat_printf (NULL,
                "прозор који приказује core бафер: %lx",
                weechat_window_search_with_buffer (weechat_buffer_search_main ()));

Скрипта (Python):

# прототип
def window_search_with_buffer(buffer: str) -> str: ...

# пример
weechat.prnt("", "прозор који приказује core бафер: %s"
    % weechat.window_search_with_buffer(weechat.buffer_search_main()))

3.16.3. window_get_integer

Враћа целобројну вредност особине прозора.

Прототип:

int weechat_window_get_integer (struct t_gui_window *window,
                                const char *property);

Аргументи:

  • window: показивач на прозор

  • property: име особине:

    • number: број прозора (почиње од 1)

    • win_x: X позиција прозора у терминалу (прва колона је 0)

    • win_y: Y позиција прозора у терминалу (прва линија је 0)

    • win_width: ширина прозора у карактерима

    • win_height: висина прозора у карактерима

    • win_width_pct: процентуална величина, у односу на родитељски прозор (на пример, 50 значи половина величине)

    • win_height_pct: процентуална величина, у односу на родитељски прозор (на пример, 50 значи половина величине)

    • win_chat_x: X позиција прозора разговора у терминалу (прва колона је 0)

    • win_chat_y: Y позиција прозора разговора у терминалу (прва линија је 0)

    • win_chat_width: ширина прозора за разговор у карактерима

    • win_chat_height: висина прозора за разговор у карактерима

    • first_line_displayed: 1 ако је на екрану приказана прва линија бафера, у супротном 0

    • scrolling: 1 ако је у прозору активно скроловање (не приказује се последња линија)

    • lines_after: број линија које се не приказују након последње приказане (када се скролује)

Повратна вредност:

  • целобројна вредност особине

C пример:

weechat_printf (NULL, "current window is at position (x,y): (%d,%d)",
                weechat_window_get_integer (weechat_current_window (), "win_x"),
                weechat_window_get_integer (weechat_current_window (), "win_y"));

Скрипта (Python):

# прототип
def window_get_integer(window: str, property: str) -> int: ...

# пример
weechat.prnt("", "текући прозор је на позицији (x,y): (%d,%d)"
    % (weechat.window_get_integer(weechat.current_window(), "win_x"),
    weechat.window_get_integer(weechat.current_window(), "win_y")))

3.16.4. window_get_string

Враћа стринг вредност особине прозора.

Ова функција се сада не користи, резервисана је будућу верзију.

Прототип:

const char *weechat_window_get_string (struct t_gui_window *window,
                                       const char *property);

Аргументи:

  • window: показивач на прозор

  • property: име особине

Повратна вредност:

  • стринг вредност особине

Скрипта (Python):

# прототип
def window_get_string(window: str, property: str) -> str: ...

3.16.5. window_get_pointer

Враћа вредност показивача на особину прозора.

Прототип:

void *weechat_window_get_pointer (struct t_gui_window *window,
                                  const char *property);

Аргументи:

  • window: показивач на прозор

  • property: име особине:

    • current: показивач на текући прозор

    • buffer: показивач на бафер који се приказује у прозору

Повратна вредност:

  • вредност показивача на особину

C пример:

weechat_printf (NULL,
                "бафер који се приказује у текућем прозору: %lx",
                weechat_window_get_pointer (weechat_current_window (), "buffer"));

Скрипта (Python):

# прототип
def window_get_pointer(window: str, property: str) -> str: ...

# пример
weechat.prnt("", "бафер који се приказује у текућем прозору: %s"
    % weechat.window_get_pointer(weechat.current_window(), "buffer"))

3.16.6. window_set_title

Поставља наслов за терминал.

Прототип:

void weechat_window_set_title (const char *title);

Аргументи:

  • title: нови наслов за терминал (NULL ако желите да ресетујете наслов); стринг се израчунава, тако да је могуће коришћење променљивих као што је ${info:version} (погледајте string_eval_expression)

C пример:

weechat_window_set_title ("овде иде нови наслов");

Скрипта (Python):

# прототип
def window_set_title(title: str) -> int: ...

# пример
weechat.window_set_title("овде иде нови наслов")

3.17. Листа надимака

Функције за листу надимака бафера.

3.17.1. nicklist_add_group

Додаје групу у листу надимака.

Прототип:

struct t_gui_nick_group *weechat_nicklist_add_group (struct t_gui_buffer *buffer,
                                                     struct t_gui_nick_group *parent_group,
                                                     const char *name,
                                                     const char *color,
                                                     int visible);

Аргументи:

  • buffer: показивач на бафер

  • parent_group: показивач на родитеља групе, NULL ако група нема родитеља (корен листе надимака)

  • name: име групе

  • color: име опције боја:

    • Име WeeChat опције, на пример weechat.color.nicklist_group

    • поја са необавезном позадином, на пример yellow или yellow,red

    • име боје траке:

      • bar_fg: боја предњег плана траке

      • bar_delim: боја граничника за траку

      • bar_bg: боја позадине за траку

  • visible:

    • 1: групе и подгрупе/надимци су видљиви

    • 0: групе и подгрупе/надимци су скривени

Име групе може да почне једном или две цифре, иза којих долази вертикална црта, па име групе. Када се на почетку наиђе на овакав стринг, он се користи за сортирање група у листи надимака. На пример, групе „1|test” и „2|abc” ће се приказати у том редоследу: прво „test”, па „abc”.

Повратна вредност:

  • показивач на нову групу, NULL у случају грешке

C пример:

struct t_gui_nick_group *my_group =
    weechat_nicklist_add_group (my_buffer,
                                my_parent_group,
                                "test_group",
                                "weechat.color.nicklist_group",
                                1);

Скрипта (Python):

# прототип
def nicklist_add_group(buffer: str, parent_group: str, name: str, color: str, visible: int) -> str: ...

# пример
group = weechat.nicklist_add_group(my_buffer, my_parent_group, "test_group",
    "weechat.color.nicklist_group", 1)

3.17.2. nicklist_search_group

Тражи групу у листи надимака.

Прототип:

struct t_gui_nick_group *weechat_nicklist_search_group (struct t_gui_buffer *buffer,
                                                        struct t_gui_nick_group *from_group,
                                                        const char *name);

Аргументи:

  • buffer: показивач на бафер

  • from_group: тражи само од ове групе, ако је NULL, онда се претражује цела листа надимака

  • name: име групе која се тражи

Повратна вредност:

  • показивач на пронађену групу, NULL ако се не пронађе

C пример:

struct t_gui_nick_group *ptr_group = weechat_nicklist_search_group (my_buffer,
                                                                    NULL, "test_group");

Скрипта (Python):

# прототип
def nicklist_search_group(buffer: str, from_group: str, name: str) -> str: ...

# пример
group = weechat.nicklist_search_group(my_buffer, "", "test_group")

3.17.3. nicklist_add_nick

Додаје надимак у групу.

Прототип:

struct t_gui_nick_group *weechat_nicklist_add_nick (struct t_gui_buffer *buffer,
                                                    struct t_gui_nick_group *group,
                                                    const char *name,
                                                    const char *color,
                                                    const char *prefix,
                                                    const char *prefix_color,
                                                    int visible);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на групу

  • name: име надимка

  • color: име опције боја:

    • Име WeeChat опције (из weechat.color.xxx), на пример chat_delimiters

    • поја са необавезном позадином, на пример yellow или yellow,red

    • име боје траке:

      • bar_fg: боја предњег плана траке

      • bar_delim: боја граничника за траку

      • bar_bg: боја позадине за траку

  • prefix: префикс који се приказује испред надимка

  • prefix_color: име опције боја:

    • Име WeeChat опције (из weechat.color.xxx), на пример chat_delimiters

    • поја са необавезном позадином, на пример yellow или yellow,red

    • име боје траке:

      • bar_fg: боја предњег плана траке

      • bar_delim: боја граничника за траку

      • bar_bg: боја позадине за траку

  • visible:

    • 1: надимак је видљив

    • 0: надимак је скривен

Повратна вредност:

  • показивач на нови надимак, NULL у случају грешке

C пример:

struct t_gui_nick *my_nick =
    weechat_nicklist_add_nick (my_buffer, my_group,
                               "test_nick",
                               (nick_away) ? "weechat.color.nicklist_away" : "bar_fg",
                               "@", "lightgreen",
                               1);

Скрипта (Python):

# прототип
def nicklist_add_nick(buffer: str, group: str, name: str, color: str, prefix: str, prefix_color: str, visible: int) -> str: ...

# пример
if nick_away:
    color = "weechat.color.nicklist_away"
else:
    color = "bar_fg"
nick = weechat.nicklist_add_nick(my_buffer, my_group, "test_nick", color, "@", "lightgreen", 1)

3.17.4. nicklist_search_nick

Тражи надимак у листи надимака.

Прототип:

struct t_gui_nick *weechat_nicklist_search_nick (struct t_gui_buffer *buffer,
                                                 struct t_gui_nick_group *from_group,
                                                 const char *name);

Аргументи:

  • buffer: показивач на бафер

  • from_group: тражи само од ове групе, ако је NULL, онда се претражује цела листа надимака

  • name: име надимка који се тражи

Повратна вредност:

  • показивач на пронађени надимак, NULL ако се не пронађе

C пример:

struct t_gui_nick *ptr_nick = weechat_nicklist_search_nick (my_buffer,
                                                            NULL, "test_nick");

Скрипта (Python):

# прототип
def nicklist_search_nick(buffer: str, from_group: str, name: str) -> str: ...

# пример
nick = weechat.nicklist_search_nick(my_buffer, "", "test_nick")

3.17.5. nicklist_remove_group

Уклања групу из листе надимака.

Прототип:

void weechat_nicklist_remove_group (struct t_gui_buffer *buffer,
                                    struct t_gui_nick_group *group);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на групу која треба да се уклони (уклониће се и све подгрупе/надимци)

C пример:

weechat_nicklist_remove_group (my_buffer, my_group);

Скрипта (Python):

# прототип
def nicklist_remove_group(buffer: str, group: str) -> int: ...

# пример
weechat.nicklist_remove_group(my_buffer, my_group)

3.17.6. nicklist_remove_nick

Уклања надимак из листе надимака.

Прототип:

void weechat_nicklist_remove_nick (struct t_gui_buffer *buffer,
                                   struct t_gui_nick *nick);

Аргументи:

  • buffer: показивач на бафер

  • nick: показивач на надимак који треба да се уклони

C пример:

weechat_nicklist_remove_nick (my_buffer, my_nick);

Скрипта (Python):

# прототип
def nicklist_remove_nick(buffer: str, nick: str) -> int: ...

# пример
weechat.nicklist_remove_nick(my_buffer, my_nick)

3.17.7. nicklist_remove_all

Уклања све групе/надимке из листе надимака.

Прототип:

void weechat_nicklist_remove_all (struct t_gui_buffer *buffer);

Аргументи:

  • buffer: показивач на бафер

C пример:

weechat_nicklist_remove_all (my_buffer);

Скрипта (Python):

# прототип
def nicklist_remove_all(buffer: str) -> int: ...

# пример
weechat.nicklist_remove_all(my_buffer)

3.17.8. nicklist_get_next_item

WeeChat ≥ 0.3.7.

Враћа наредну групу или надимак из листе надимака (углавном се користи код приказа листе надимака).

Прототип:

void weechat_nicklist_get_next_item (struct t_gui_buffer *buffer,
                                     struct t_gui_nick_group **group,
                                     struct t_gui_nick **nick);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на показивач групе

  • nick: показивач на показивач надимка

C пример:

struct t_gui_nick_group *ptr_group;
struct t_gui_nick *ptr_nick;

ptr_group = NULL;
ptr_nick = NULL;
weechat_nicklist_get_next_item (buffer, &ptr_group, &ptr_nick);
while (ptr_group || ptr_nick)
{
    if (ptr_nick)
    {
        /* надимак */
        /* ... */
    }
    else
    {
        /* група */
        /* ... */
    }
    weechat_nicklist_get_next_item (buffer, &ptr_group, &ptr_nick);
}
Ова функција није доступна у API скриптовања.

3.17.9. nicklist_group_get_integer

WeeChat ≥ 0.3.4.

Враћа целобројну вредност особине групе.

Прототип:

int weechat_nicklist_group_get_integer (struct t_gui_buffer *buffer,
                                        struct t_gui_nick_group *group,
                                        const char *property);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на групу

  • property: име особине:

    • visible: 1 ако је група видљива, у супротном 0

    • level: ниво групе (корен је 0)

Повратна вредност:

  • целобројна вредност особине

C пример:

int visible = weechat_nicklist_group_get_integer (buffer, group, "visible");

Скрипта (Python):

# прототип
def nicklist_group_get_integer(buffer: str, group: str, property: str) -> int: ...

# пример
visible = weechat.nicklist_group_get_integer(buffer, group, "visible")

3.17.10. nicklist_group_get_string

WeeChat ≥ 0.3.4.

Враћа стринг вредност особине групе.

Прототип:

const char *weechat_nicklist_group_get_string (struct t_gui_buffer *buffer,
                                               struct t_gui_nick_group *group,
                                               const char *property);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на групу

  • property: име особине:

    • name: име групе

    • color: боја групе у листи надимака

Повратна вредност:

  • стринг вредност особине

C пример:

const char *color = weechat_nicklist_group_get_string (buffer, group, "color");

Скрипта (Python):

# прототип
def nicklist_group_get_string(buffer: str, group: str, property: str) -> str: ...

# пример
color = weechat.nicklist_group_get_string(buffer, group, "color")

3.17.11. nicklist_group_get_pointer

WeeChat ≥ 0.3.4.

Враћа вредност показивача на особину групе.

Прототип:

void *weechat_nicklist_group_get_pointer (struct t_gui_buffer *buffer,
                                          struct t_gui_nick_group *group,
                                          const char *property);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на групу

  • property: име особине:

    • parent: показивач на родитељску групу

Повратна вредност:

  • вредност показивача на особину

C пример:

struct t_gui_nick_group *parent = weechat_nicklist_group_get_pointer (buffer, group, "parent");

Скрипта (Python):

# прототип
def nicklist_group_get_pointer(buffer: str, group: str, property: str) -> str: ...

# пример
parent = weechat.nicklist_group_get_pointer(buffer, group, "parent")

3.17.12. nicklist_group_set

WeeChat ≥ 0.3.4.

Поставља стринг вредност особине групе.

Прототип:

void weechat_nicklist_group_set (struct t_gui_buffer *buffer,
                                 struct t_gui_nick_group *group,
                                 const char *property,
                                 const char *value);

Аргументи:

  • buffer: показивач на бафер

  • group: показивач на групу

  • property: име особине (погледајте табелу испод)

  • value: нова вредност за особину

Особине:

Име Вредност Опис

color

Име опције WeeChat боје

Погледајте аргумент „color” функције nicklist_add_group.

visible

"0", "1"

"0" = скривена група, "1" = видљива група.

C примери:

/* мења боју групе на "bar_fg" */
weechat_nicklist_group_set (buffer, group, "color", "bar_fg");

/* мења боју групе на жуту */
weechat_nicklist_group_set (buffer, group, "color", "yellow");

/* скрива групу у листи надимака */
weechat_nicklist_group_set (buffer, group, "visible", "0");

Скрипта (Python):

# прототип
def nicklist_group_set(buffer: str, group: str, property: str, value: str) -> int: ...

# примери

# мења боју групе на "bar_fg"
weechat.nicklist_group_set(buffer, group, "color", "bar_fg")

# мења боју групе на жуту
weechat.nicklist_group_set(buffer, group, "color", "yellow")

# скрива групу у листи надимака
weechat.nicklist_group_set(buffer, group, "visible", "0")

3.17.13. nicklist_nick_get_integer

WeeChat ≥ 0.3.4.

Враћа целобројну вредност особине надимка.

Прототип:

int weechat_nicklist_nick_get_integer (struct t_gui_buffer *buffer,
                                       struct t_gui_nick *nick,
                                       const char *property);

Аргументи:

  • buffer: показивач на бафер

  • nick: показивач на надимак

  • property: име особине:

    • visible: 1 ако је надимак видљив, у супротном 0

Повратна вредност:

  • целобројна вредност особине

C пример:

int visible = weechat_nicklist_nick_get_integer (buffer, nick, "visible");

Скрипта (Python):

# прототип
def nicklist_nick_get_integer(buffer: str, nick: str, property: str) -> int: ...

# пример
visible = weechat.nicklist_nick_get_integer(buffer, nick, "visible")

3.17.14. nicklist_nick_get_string

WeeChat ≥ 0.3.4.

Враћа стринг вредност особине надимка.

Прототип:

const char *weechat_nicklist_nick_get_string (struct t_gui_buffer *buffer,
                                              struct t_gui_nick *nick,
                                              const char *property);

Аргументи:

  • buffer: показивач на бафер

  • nick: показивач на надимак

  • property: име особине:

    • name: име надимка

    • color: боја надимка у листи надимака

    • prefix: префикс надимка

    • prefix_color: боја префикса у листи надимака

Повратна вредност:

  • стринг вредност особине

C пример:

const char *color = weechat_nicklist_nick_get_string (buffer, nick, "color");

Скрипта (Python):

# прототип
def nicklist_nick_get_string(buffer: str, nick: str, property: str) -> str: ...

# пример
color = weechat.nicklist_nick_get_string(buffer, nick, "color")

3.17.15. nicklist_nick_get_pointer

WeeChat ≥ 0.3.4.

Враћа вредност показивача на особину надимка.

Прототип:

void *weechat_nicklist_nick_get_pointer (struct t_gui_buffer *buffer,
                                         struct t_gui_nick *nick,
                                         const char *property);

Аргументи:

  • buffer: показивач на бафер

  • nick: показивач на надимак

  • property: име особине:

    • group: показивач на групу у којој се налази овај надимак

Повратна вредност:

  • вредност показивача на особину

C пример:

struct t_gui_nick_group *group = weechat_nicklist_nick_get_pointer (buffer, nick, "group");

Скрипта (Python):

# прототип
def nicklist_nick_get_pointer(buffer: str, nick: str, property: str) -> str: ...

# пример
group = weechat.nicklist_nick_get_pointer(buffer, nick, "group")

3.17.16. nicklist_nick_set

WeeChat ≥ 0.3.4.

Поставља стринг вредност особине надимка.

Прототип:

void weechat_nicklist_nick_set (struct t_gui_buffer *buffer,
                                struct t_gui_nick *nick,
                                const char *property,
                                const char *value);

Аргументи:

  • buffer: показивач на бафер

  • nick: показивач на надимак

  • property: име особине (погледајте табелу испод)

  • value: нова вредност за особину

Особине:

Име Вредност Опис

color

име опције WeeChat боје

Погледајте аргумент „color” функције nicklist_add_nick.

prefix

било који стринг

Префикс надимка.

prefix_color

име опције WeeChat боје

Погледајте аргумент „prefix_color” функције nicklist_add_nick.

visible

"0", "1"

"0" = скривени надимак, "1" = видљиви надимак.

C примери:

/* мења боју надимка у цијан */
weechat_nicklist_nick_set (buffer, nick, "color", "cyan");

/* мења префикс на „+” */
weechat_nicklist_nick_set (buffer, nick, "prefix", "+");

/* мења боју префикса у жуту */
weechat_nicklist_nick_set (buffer, nick, "prefix_color", "yellow");

/* скрива надимак у листи надимака */
weechat_nicklist_nick_set (buffer, nick, "visible", "0");

Скрипта (Python):

# прототип
def nicklist_nick_set(buffer: str, nick: str, property: str, value: str) -> int: ...

# примери

# мења боју надимка у цијан
weechat.nicklist_nick_set(buffer, nick, "color", "cyan")

# мења префикс у „+”
weechat.nicklist_nick_set(buffer, nick, "prefix", "+")

# мења боју префикса у жуту
weechat.nicklist_nick_set(buffer, nick, "prefix_color", "yellow")

# скрива надимак у листи надимака
weechat.nicklist_nick_set(buffer, nick, "visible", "0")

3.18. Траке

Функције за траке.

Тражи ставку траке.

Прототип:

struct t_gui_bar_item *weechat_bar_item_search (const char *name);

Аргументи:

  • name: име ставке траке

Повратна вредност:

  • показивач на пронађену ставку траке, NULL ако се ставка траке не пронађе

C пример:

struct t_gui_bar_item *bar_item = weechat_bar_item_search ("myitem");

Скрипта (Python):

# прототип
def bar_item_search(name: str) -> str: ...

# пример
bar_item = weechat.bar_item_search("myitem")

3.18.2. bar_item_new

Ажурирано у верзијама 0.4.2, 1.5.

Креира нову ставку траке.

Прототип:

struct t_gui_bar_item *weechat_bar_item_new (const char *name,
                                             char *(*build_callback)(const void *pointer,
                                                                     void *data,
                                                                     struct t_gui_bar_item *item,
                                                                     struct t_gui_window *window,
                                                                     struct t_gui_buffer *buffer,
                                                                     struct t_hashtable *extra_info),
                                             const void *build_callback_pointer,
                                             void *build_callback_data);

Аргументи:

  • name: име ставке траке

  • build_callback: функција која се позива када се изгради нова ставка траке, аргументи и повратна вредност су:

    • const void *pointer: показивач

    • void *data: показивач

    • struct t_gui_bar_item *item: показивач на ставку

    • struct t_gui_window *window: показивач на прозор (NULL када се позове за корену траку)

    • struct t_gui_buffer *buffer: бафер који се приказује у прозору (ако је прозор NULL, онда је то текући бафер) или бафер наведен у ставки траке према синтакси: „@бафер:ставка” (WeeChat ≥ 0.4.2)

    • struct t_hashtable *extra_info: увек је NULL (аргумент је резервисан за будуће верзије) (WeeChat ≥ 0.4.2)

    • повратна вредност: садржај ставке траке

  • build_callback_pointer: показивач који се прослеђује функцији повратног позива изградње, када је позове програм WeeChat

  • build_callback_data: показивач који се прослеђује функцији повратног позива када је позове програм WeeChat; ако није NULL, алоцирала га је malloc (или нека слична функција) и аутоматски се ослобађа када се уклони ставка траке

Повратна вредност:

  • показивач на нову ставку траке, NULL ако је дошло до грешке

C пример:

char *
my_build_callback (const void *pointer, void *data,
                   struct t_gui_bar_item *item,
                   struct t_gui_window *window,
                   struct t_gui_buffer *buffer,
                   struct t_hashtable *extra_info)
{
    return strdup ("my content");
}

struct t_gui_bar_item *my_item = weechat_bar_item_new ("myitem",
                                                       &my_build_callback,
                                                       NULL, NULL);

Скрипта (Python):

Из разлога компатибилности за верзијама ≤ 0.4.1, подразумевана функција повратног позива има само 3 аргумента: data, item и window (нема buffer и extra_info).
Ако желите да користите функцију повратног позива са свим аргументима, морате додати „(extra)” испред имена, погледајте пример испод (подржано је само у WeeChat ≥ 0.4.2).
# прототип
def bar_item_new(name: str, build_callback: str, build_callback_data: str) -> str: ...

# пример (функција повратног позива без „buffer” и „extra_info”)
def my_build_callback(data, item, window):
    return "my content"

bar_item = weechat.bar_item_new("myitem", "my_build_callback", "")

# пример (функција повратног позива са свим аргументима, за WeeChat ≥ 0.4.2)
def my_build_callback2(data, item, window, buffer, extra_info):
    return "my content"

bar_item2 = weechat.bar_item_new("(extra)myitem2", "my_build_callback2", "")  # WeeChat ≥ 0.4.2

3.18.3. bar_item_update

Ажурира садржај ставке траке, позивањем њене функције повратног позива изградње.

Прототип:

void weechat_bar_item_update (const char *name);

Аргументи:

  • name: име ставке траке

C пример:

weechat_bar_item_update ("myitem");

Скрипта (Python):

# прототип
def bar_item_update(name: str) -> int: ...

# пример
weechat.bar_item_update("myitem")

3.18.4. bar_item_remove

Уклања ставку траке.

Прототип:

void weechat_bar_item_remove (struct t_gui_bar_item *item);

Аргументи:

  • item: показивач на ставку траке

C пример:

weechat_bar_item_remove (&my_item);

Скрипта (Python):

# прототип
def bar_item_remove(item: str) -> int: ...

# пример
weechat.bar_item_remove(myitem)

Тражи траку.

Прототип:

struct t_gui_bar *weechat_bar_search (const char *name);

Аргументи:

  • name: име траке

Повратна вредност:

  • показивач на пронађену траку, NULL ако се трака не пронађе

C пример:

struct t_gui_bar *bar = weechat_bar_search ("mybar");

Скрипта (Python):

# прототип
def bar_search(name: str) -> str: ...

# пример
bar = weechat.bar_search("mybar")

3.18.6. bar_new

Ажурирано у верзији 2.9.

Креира нову траку.

Прототип:

struct t_gui_bar *weechat_bar_new (const char *name,
                                   const char *hidden,
                                   const char *priority,
                                   const char *type,
                                   const char *condition,
                                   const char *position,
                                   const char *filling_top_bottom,
                                   const char *filling_left_right,
                                   const char *size,
                                   const char *size_max,
                                   const char *color_fg,
                                   const char *color_delim,
                                   const char *color_bg,
                                   const char *color_bg_inactive,
                                   const char *separator,
                                   const char *items);

Аргументи:

  • name: име траке

  • hidden:

    • on: трака је скривена

    • off: трака је видљива

  • priority: приоритет траке (цео број)

  • type:

    • root: трака је приказана једном, ван прозора

    • window: трака се приказује у сваком прозору

  • condition: услов за приказивање траке:

    • active: трака се приказује само у активном прозору

    • inactive: трака се приказује само у неактивним прозорима

    • nicklist: трака се приказује у прозорима са листом надимака

    • израчунати услови: погледајте WeeChat Корисничко упутство / Услови трака.

  • position: top, bottom, left или right

  • filling_top_bottom:

    • horizontal: ставке се попуњавају хоризонтално (размак након сваке ставке)

    • vertical: ставке се попуњавају вертикално (прелом линије након сваке ставке)

    • columns_horizontal: ставке се попуњавају хоризонтално, приказане по колонама

    • columns_vertical: ставке се попуњавају вертикално, приказане по колонама

  • filling_left_right:

    • horizontal: ставке се попуњавају хоризонтално (размак након сваке ставке)

    • vertical: ставке се попуњавају вертикално (прелом линије након сваке ставке)

    • columns_horizontal: ставке се попуњавају хоризонтално, приказане по колонама

    • columns_vertical: ставке се попуњавају вертикално, приказане по колонама

  • size: величина траке у карактерима (0 значи аутоматска величина)

  • size_max: максимална величина траке (0 значи без ограничења)

  • color_fg: боја текста у траци

  • color_delim: боја граничника у траци

  • color_bg: боја позадине траке

  • color_bg_inactive: боја позадине за траку прозора која се не приказује у активном прозору

  • separator:

    • on: трака има граничну линију са осталим прозорима/тракама

    • off: нема граничника

  • items: листа ставки у траци раздвојених запетама (за размак између ставки), или са „+” (за спојене ставке)

Повратна вредност:

  • показивач на нову траку, NULL у случају грешке

C пример:

struct t_gui_bar *my_bar = weechat_bar_new ("mybar",
                                            "off",
                                            "100",
                                            "window",
                                            "",
                                            "top",
                                            "horizontal",
                                            "vertical",
                                            "0",
                                            "5",
                                            "default",
                                            "cyan",
                                            "blue",
                                            "darkgray",
                                            "off",
                                            "time,buffer_number+buffer_name");

Скрипта (Python):

# прототип
def bar_new(name: str, hidden: str, priority: str, type: str, condition: str, position: str,
            filling_top_bottom: str, filling_left_right: str, size: str, size_max: str,
            color_fg: str, color_delim: str, color_bg: str, color_bg_inactive: str,
            separator: str, items: str) -> str: ...

# пример
bar = weechat.bar_new("mybar", "off", "100", "window", "", "top", "horizontal", "vertical",
    "0", "5", "default", "cyan", "blue", "darkgray", "off", "time,buffer_number+buffer_name")
У програму WeeChat верзије ≥ 2.9, у језику Ruby, 4 боје (color_fg, color_delim, color_bg, color_bg_inactive) морају да се наведу у низу од 4 стринга (услед ограничења језика Ruby од 15 аргумената по функцији), за више информација погледајте WeeChat водич за скриптовање.

3.18.7. bar_set

Поставља нову вредност особине траке.

Прототип:

int weechat_bar_set (struct t_gui_bar *bar, const char *property,
                     const char *value);

Аргументи:

  • bar: показивач на траку

  • property: name, hidden, priority, conditions, position, filling_top_bottom, filling_left_right, size, size_max, color_fg, color_delim, color_bg, separator, items (погледајте bar_new)

  • value: нова вредност за особину

Повратна вредност:

  • 1 ако је нова вредност постављена, 0 у случају грешке

C пример:

weechat_bar_set (mybar, "position", "bottom");

Скрипта (Python):

# прототип
def bar_set(bar: str, property: str, value: str) -> int: ...

# пример
weechat.bar_set(my_bar, "position", "bottom")

3.18.8. bar_update

Освежава садржај траке на екрану.

Прототип:

void weechat_bar_update (const char *name);

Аргументи:

  • name: име траке

C пример:

weechat_bar_update ("mybar");

Скрипта (Python):

# прототип
def bar_update(name: str) -> int: ...

# пример
weechat.bar_update("mybar")

3.18.9. bar_remove

Уклања траку.

Прототип:

void weechat_bar_remove (struct t_gui_bar *bar);

Аргументи:

  • bar: показивач на траку

C пример:

weechat_bar_remove (mybar);

Скрипта (Python):

# прототип
def bar_remove(bar: str) -> int: ...

# пример
weechat.bar_remove(my_bar)

3.19. Команде

Функције за извршавање WeeChat команди.

3.19.1. command

Ажурирано у верзији 1.1.

Извршава команду или шаље текст у бафер.

Прототип:

int weechat_command (struct t_gui_buffer *buffer, const char *command);

Аргументи:

  • buffer: показивач на бафер (команда се извршава у овом баферу, употребите NULL за текући бафер)

  • command: команда која се извршава (ако почиње са „/”), или текст који се шаље у бафер

Повратна вредност (WeeChat ≥ 1.1):

  • WEECHAT_RC_OK ако је успешно

  • WEECHAT_RC_ERROR ако је дошло до грешке

C пример:

int rc;
rc = weechat_command (weechat_buffer_search ("irc", "libera.#weechat"),
                      "/whois FlashCode");

Скрипта (Python):

# прототип
def command(buffer: str, command: str) -> int: ...

# пример
rc = weechat.command(weechat.buffer_search("irc", "libera.#weechat"), "/whois FlashCode")

3.19.2. command_options

WeeChat ≥ 2.5.

Извршава команду или шаље текст у бафер са опцијама.

Прототип:

int weechat_command_options (struct t_gui_buffer *buffer, const char *command,
                             struct t_hashtable *options);

Аргументи:

  • buffer: показивач на бафер (команда се извршава у овом баферу, употребите NULL за текући бафер)

  • command: команда која се извршава (ако почиње са „/”), или текст који се шаље у бафер

  • options: хеш табела са неким опцијама (кључеви и вредности морају бити стринг) (може да буде NULL):

    • commands: листа команди које смеју да се изврше током овог позива раздвојене запетама; за формат, погледајте функцију string_match_list

    • delay: пауза за извршавање команде, у милисекундама

Повратна вредност:

  • WEECHAT_RC_OK ако је успешно

  • WEECHAT_RC_ERROR ако је дошло до грешке

C пример:

/* дозвољава се било која команда одим /exec, команда се извршава у року од 2 секунде */
int rc;
struct t_hashtable *options = weechat_hashtable_new (8,
                                                     WEECHAT_HASHTABLE_STRING,
                                                     WEECHAT_HASHTABLE_STRING,
                                                     NULL,
                                                     NULL);
weechat_hashtable_set (options, "commands", "*,!exec");
weechat_hashtable_set (options, "delay", "2000");
rc = weechat_command_options (NULL, "/some_command arguments", options);

Скрипта (Python):

# прототип
def command_options(buffer: str, command: str, options: Dict[str, str]) -> int: ...

# пример: дозвољава се било која команда осим /exec
rc = weechat.command("", "/some_command arguments", {"commands": "*,!exec"})

3.20. Довршавање

Функције за довршавање командне линије.

3.20.1. completion_new

WeeChat ≥ 2.9.

Креира ново довршавање.

Прототип:

struct t_gui_completion *weechat_completion_new (struct t_gui_buffer *buffer);

Аргументи:

  • buffer: показивач на бафер

Повратна вредност:

  • показивач на ново довршавање

C пример:

struct t_gui_completion *completion = weechat_completion_new (weechat_buffer_search_main ());

Скрипта (Python):

# прототип
def completion_new(buffer: str) -> str: ...

# пример
completion = weechat.completion_new(weechat.buffer_search_main())

WeeChat ≥ 2.9.

Тражи могуће речи на датој позицији у стрингу, у контексту довршавања.

Прототип:

int weechat_completion_search (struct t_gui_completion *completion, const char *data,
                               int position, int direction);

Аргументи:

  • completion: показивач на довршавање

  • data: стринг који треба да се доврши

  • position: индекс карактера у стрингу за довршавање (почиње од 0)

  • direction: 1 за наредно довршавање, -1 за претходно довршавање

Повратна вредност:

  • 1 ако је све OK, 0 у случају грешке

C пример:

struct t_gui_completion *completion = weechat_completion_new (weechat_buffer_search_main ());
if (weechat_completion_search (completion, "/help filt", 10, 1))
{
    /* ... */
}

Скрипта (Python):

# прототип
def completion_search(completion: str, data: str, position: int, direction: int) -> int: ...

# пример
completion = weechat.completion_new(weechat.buffer_search_main())
if weechat.completion_search(completion, "/help filt", 10, 1):
    # ...

3.20.3. completion_get_string

WeeChat ≥ 2.9.

Враћа особину довршавања као стринг.

Прототип:

const char *weechat_completion_get_string (struct t_gui_completion *completion,
                                           const char *property);

Аргументи:

  • completion: показивач на довршавање

  • property: име особине:

    • base_command: команда која се користи за довршавање

    • base_word: реч која се довршава

    • args: аргументи команде (укључујући и базну реч)

C пример:

int
my_completion_cb (const void *pointer, void *data, const char *completion_item,
                  struct t_gui_buffer *buffer,
                  struct t_gui_completion *completion)
{
    /* добијање аргумената команде */
    const char *args = weechat_completion_get_string (completion, "args");

    /* довршавање које зависи од args */
    /* ... */

    return WEECHAT_RC_OK;
}

Скрипта (Python):

# прототип
def completion_get_string(completion: str, property: str) -> str: ...

# пример
def my_completion_cb(data, completion_item, buffer, completion):
    # добавља аргументе команде
    args = weechat.completion_get_string(completion, "args")
    # довршавање у зависности од args
    # ...
    return weechat.WEECHAT_RC_OK

3.20.4. completion_list_add

WeeChat ≥ 2.9.

Додаје реч за довршавање.

Прототип:

void weechat_completion_list_add (struct t_gui_completion *completion,
                                  const char *word,
                                  int nick_completion,
                                  const char *where);

Аргументи:

  • completion: показивач на довршавање

  • word: реч која се додаје

  • nick_completion: 1 ако је реч надимак, у супротном 0

  • where: позиција у листи на коју ће се уметнути реч:

    • WEECHAT_LIST_POS_SORT: било која позиција, да листа остане сортирана

    • WEECHAT_LIST_POS_BEGINNING: почетак листе

    • WEECHAT_LIST_POS_END: крај листе

C пример: погледајте hook_completion.

Скрипта (Python):

# прототип
def completion_list_add(completion: str, word: str, nick_completion: int, where: str) -> int: ...

# пример: погледајте функцију hook_completion

3.20.5. completion_free

WeeChat ≥ 2.9.

Ослобађа меморију коју користи довршавање.

Прототип:

void weechat_completion_free (struct t_gui_completion *completion);

Аргументи:

  • completion: показивач на довршавање

C пример:

weechat_completion_free (completion);

Скрипта (Python):

# прототип
def completion_free(completion: str) -> int: ...

# пример
weechat.completion_free(completion)

3.21. Мрежа

Мрежне функције.

3.21.1. network_pass_proxy

Успоставља везу/аутентификацију са проксијем.

Ова функција је блокирајућа на позиву функције connect(), тако да једино сме да се позове из рачваног процеса па да не блокира програм WeeChat.

Прототип:

int weechat_network_pass_proxy (const char *proxy,
                                int sock,
                                const char *address,
                                int port);

Аргументи:

  • proxy: име проксија који треба да се користи

  • sock: сокет који треба да се користи

  • address