WeeChat プラグイン API リファレンス

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

int weechat_plugin_end (struct t_weechat_plugin *plugin);

const char *weechat_plugin_get_name (struct t_weechat_plugin *plugin);

const char *name = weechat_plugin_get_name (plugin);

# プロトタイプ
name = weechat.plugin_get_name(plugin)

# 例
plugin = weechat.buffer_get_pointer(weechat.current_buffer(), "plugin")
name = weechat.plugin_get_name(plugin)

void weechat_charset_set (const char *charset);

weechat_charset_set ("iso-8859-1");

# プロトタイプ
weechat.charset_set(charset)

# 例
weechat.charset_set("iso-8859-1")

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

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

# プロトタイプ
str = weechat.iconv_to_internal(charset, string)

# 例
str = weechat.iconv_to_internal("iso-8859-1", "iso string: é à")

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

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

# プロトタイプ
str = weechat.iconv_from_internal(charset, string)

# 例
str = weechat.iconv_from_internal("iso-8859-1", "utf-8 string: é à")

const char *weechat_gettext (const char *string);

char *str = weechat_gettext ("hello");

# プロトタイプ
str = weechat.gettext(string)

# 例
str = weechat.gettext("hello")

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

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

# プロトタイプ
str = weechat.ngettext(string, plural, count)

# 例
num_files = 2
str = weechat.ngettext("file", "files", num_files)

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

char *str = weechat_strndup ("abcdef", 3); /* result: "abc" */
/* ... */
free (str);

void weechat_string_tolower (char *string);

char str[] = "AbCdé";
weechat_string_tolower (str); /* str is now: "abcdé" */

void weechat_string_toupper (char *string);

char str[] = "AbCdé";
weechat_string_toupper (str); /* str is now: "ABCDé" */

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

int diff = weechat_strcasecmp ("aaa", "CCC"); /* == -2 */

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

int diff = weechat_strcasecmp_range ("nick{away}", "NICK[away]", 29); /* == 0 */

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

int diff = weechat_strncasecmp ("aabb", "aacc", 2); /* == 0 */

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

int diff = weechat_strncasecmp_range ("nick{away}", "NICK[away]", 6, 29); /* == 0 */

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

int diff = weechat_strcmp_ignore_chars ("a-b", "--a-e", "-", 1); /* == -3 */

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

char *pos = weechat_strcasestr ("aBcDeF", "de"); /* result: pointer to "DeF" */

int weechat_strlen_screen (const char *string);

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

# プロトタイプ
length = weechat.strlen_screen(string)

# 例
length = weechat.strlen_screen("é") # 1

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

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 */

# プロトタイプ
match = weechat.string_match(string, mask, case_sensitive)

# 例s
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

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

char *str = weechat_string_replace ("test", "s", "x"); /* result: "text" */
/* ... */
free (str);

char *weechat_string_expand_home (const char *path);

char *str = weechat_string_expand_home ("~/file.txt");
/* result: "/home/xxx/file.txt" */
/* ... */
free (str);

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

char *str = weechat_string_remove_quotes (string, " 'I can't' ", "'");
/* result: "I can't" */
/* ... */
free (str);

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

char *str = weechat_string_strip (".abc -", 0, 1, "- ."); /* result: ".abc" */
/* ... */
free (str);

char *weechat_string_mask_to_regex (const char *mask);

char *str_regex = weechat_string_mask_to_regex ("test*mask");
/* result: "test.*mask" */
/* ... */
free (str_regex);

# プロトタイプ
regex = weechat.string_mask_to_regex(mask)

# 例
regex = weechat.string_mask_to_regex("test*mask") # "test.*mask"

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

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 */

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

regex_t my_regex;
if (weechat_string_regcomp (&my_regex, "(?i)test", REG_EXTENDED) != 0)
{
    /* error */
}

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

int hl = weechat_string_has_highlight ("my test string", "test,word2"); /* == 1 */

# プロトタイプ
highlight = weechat.string_has_highlight(string, highlight_words)

# 例
highlight = weechat.string_has_highlight("my test string", "test,word2") # 1

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

int hl = weechat_string_has_highlight_regex ("my test string", "test|word2"); /* == 1 */

# プロトタイプ
highlight = weechat.string_has_highlight_regex(string, regex)

# 例
highlight = weechat.string_has_highlight_regex("my test string", "test|word2") # 1

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

char **argv;
int argc;
argv = weechat_string_split ("abc de  fghi", " ", 0, 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", " ", 1, 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);

void weechat_string_free_split (char **split_string);

char *argv;
int argc;
argv = weechat_string_split (string, " ", 0, 0, &argc);
/* ... */
weechat_string_free_split (argv);

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

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);

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

char **argv = weechat_string_split_command ("/command1 arg;/command2", ';');
/* result: argv[0] == "/command1 arg"
           argv[1] == "/command2"
*/
weechat_free_split_command (argv);

void weechat_string_free_split_command (char **split_command);

char **argv = weechat_string_split_command ("/command1 arg;/command2", ';');
/* ... */
weechat_free_split_command (argv);

char *weechat_string_format_size (unsigned long long size);

/* examples with English locale */

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

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

char *str = weechat_string_format_size (1536); /* str == "1.5 KB" */
/* ... */
free (str);

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

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

/* 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);

# プロトタイプ
str = weechat.string_remove_color(string, replacement)

# 例
str = weechat.string_remove_color(my_string, "?")

void weechat_string_encode_base64 (const char *from, int length, char *to);

char *string = "abcdefgh", result[128];
weechat_string_encode_base64 (string, strlen (string), result);
/* result == "YWJjZGVmZ2g=" */

int weechat_string_decode_base64 (const char *from, char *to);

char *string = "YWJjZGVmZ2g=", result[128];
int length;
length = weechat_string_decode_base64 (string, result);
/* length == 8, result == "abcdefgh" */

int weechat_string_is_command_char (const char *string);

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

# プロトタイプ
is_cmdchar = weechat.string_is_command_char(string)

# 例s
command_char1 = weechat.string_is_command_char("/test") # == 1
command_char2 = weechat.string_is_command_char("test")  # == 0

const char *weechat_string_input_for_buffer (const char *string);

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" */

# プロトタイプ
str = weechat.string_input_for_buffer(string)

# 例s
str1 = weechat.string_input_for_buffer("test")   # "test"
str2 = weechat.string_input_for_buffer("/test")  # ""
str3 = weechat.string_input_for_buffer("//test") # "/test"

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

struct t_hashtable *options = weechat_hashtable_new (8,
                                                     WEECHAT_HASHTABLE_STRING,
                                                     WEECHAT_HASHTABLE_STRING,
                                                     NULL,
                                                     NULL);
if (options)
    weechat_hashtable_set (options, "type", "condition");
char *str1 = weechat_string_eval_expression ("${buffer.full_name}", NULL, NULL, NULL);          /* "core.weechat" */
char *str2 = weechat_string_eval_expression ("${window.win_width} > 100", NULL, NULL, options); /* "1" */
char *str3 = weechat_string_eval_expression ("abc =~ def", NULL, NULL, options);                /* "0" */

# プロトタイプ
str = weechat.string_eval_expression(expr, pointers, extra_vars, options)

# 例s
str1 = weechat.string_eval_expression("${buffer.full_name}", {}, {}, {})                          # "core.weechat"
str2 = weechat.string_eval_expression("${window.win_width} > 100", {}, {}, {"type": "condition"}) # "1"
str3 = weechat.string_eval_expression("abc =~ def", {}, {}, {"type": "condition"})                # "0"

int weechat_utf8_has_8bits (const char *string);

if (weechat_utf8_has_8bits (string))
{
    /* ... */
}

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

char *error;
if (weechat_utf8_is_valid (string, &error))
{
    /* ... */
}
else
{
    /* "error" points to first invalid char */
}

void weechat_utf8_normalize (char *string, char replacement);

weechat_utf8_normalize (string, '?');

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

char *prev_char = weechat_utf8_prev_char (string, ptr_in_string);

char *weechat_utf8_next_char (const char *string);

char *next_char = weechat_utf8_next_char (string);

int weechat_utf8_char_int (const char *string);

int char_int = weechat_utf8_char_int ("être"); /* "ê" as integer */

int weechat_utf8_char_size (const char *string);

int char_size = weechat_utf8_char_size ("être"); /* == 2 */

int weechat_utf8_strlen (const char *string);

int length = weechat_utf8_strlen ("chêne"); /* == 5 */

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

int length = weechat_utf8_strnlen ("chêne", 4); /* == 3 */

int weechat_utf8_strlen_screen (const char *string);

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

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

int diff = weechat_utf8_charcmp ("aaa", "ccc"); /* == -2 */

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

int diff = weechat_utf8_charcasecmp ("aaa", "CCC"); /* == -2 */

int weechat_utf8_char_size_screen (const char *string);

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

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

char *str = "chêne";
char *str2 = weechat_utf8_add_offset (str, 3); /* points to "ne" */

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

int pos = weechat_utf8_real_pos ("chêne", 3); /* == 4 */

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

int pos = weechat_utf8_pos ("chêne", 4); /* == 3 */

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

char *string = weechat_utf8_strndup ("chêne", 3); /* returns "chê" */
/* ... */
free (string);

int weechat_mkdir_home (char *directory, int mode);

if (!weechat_mkdir_home ("temp", 0755))
{
    /* error */
}

# プロトタイプ
weechat.mkdir_home(directory, mode)

# 例
weechat.mkdir_home("temp", 0755)

int weechat_mkdir (char *directory, int mode);

if (!weechat_mkdir ("/tmp/mydir", 0755))
{
    /* error */
}

# プロトタイプ
weechat.mkdir(directory, mode)

# 例
weechat.mkdir("/tmp/mydir", 0755)

int weechat_mkdir_parents (char *directory, int mode);

if (!weechat_mkdir_parents ("/tmp/my/dir", 0755))
{
    /* error */
}

# プロトタイプ
weechat.mkdir_parents(directory, mode)

# 例
weechat.mkdir_parents("/tmp/my/dir", 0755)

void weechat_exec_on_files (const char *directory,
                            int hidden_files,
                            void *data,
                            void (*callback)(void *data,
                                             const char *filename));

void callback (void *data, const char *filename)
{
    /* ... */
}
...
weechat_exec_on_files ("/tmp", 0, NULL, &callback);

char *weechat_file_get_content (const char *filename);

char *content;

content = weechat_file_get_content ("/tmp/test.txt");
/* ... */
free (content);

int weechat_util_timeval_cmp (struct timeval *tv1, struct timeval *tv2);

if (weechat_util_timeval_cmp (&tv1, &tv2) > 0)
{
    /* tv1 > tv2 */
}

long weechat_util_timeval_diff (struct timeval *tv1, struct timeval *tv2);

long diff = weechat_util_timeval_diff (&tv1, &tv2);

void weechat_util_timeval_add (struct timeval *tv, long interval);

weechat_util_timeval_add (&tv, 2000); /* add 2 seconds */

char *weechat_util_get_time_string (const time_t *date);

time_t date = time (NULL);
weechat_printf (NULL, "date: %s",
                weechat_util_get_time_string (&date));

int weechat_util_version_number (const char *version);

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 */

struct t_weelist *weechat_list_new ();

struct t_weelist *list = weechat_list_new ();

# プロトタイプ
list = weechat.list_new()

# 例
list = weechat.list_new()

struct t_weelist_item *weechat_list_add (struct t_weelist *weelist,
                                         const char *data,
                                         const char *where,
                                         void *user_data);

struct t_weelist_item *my_item =
    weechat_list_add (list, "my data", WEECHAT_LIST_POS_SORT, NULL);

# プロトタイプ
item = weechat.list_add(list, data, where, user_data)

# 例
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);

struct t_weelist_item *item = weechat_list_search (list, "my data");

# プロトタイプ
item = weechat.list_search(list, data)

# 例
item = weechat.list_search(list, "my data")

int weechat_list_search_pos (struct t_weelist *weelist,
                             const char *data);

int pos_item = weechat_list_search_pos (list, "my data");

# プロトタイプ
pos_item = weechat.list_search_pos(list, data)

# 例
pos_item = weechat.list_search_pos(list, "my data")

struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist,
                                                const char *data);

struct t_weelist_item *item = weechat_list_casesearch (list, "my data");

# プロトタイプ
item = weechat.list_casesearch(list, data)

# 例
item = weechat.list_casesearch(list, "my data")

int weechat_list_casesearch_pos (struct t_weelist *weelist,
                                 const char *data);

int pos_item = weechat_list_casesearch_pos (list, "my data");

# プロトタイプ
pos_item = weechat.list_casesearch_pos(list, data)

# 例
pos_item = weechat.list_casesearch_pos(list, "my data")

struct t_weelist_item *weechat_list_get (struct t_weelist *weelist,
                                         int position);

struct t_weelist_item *item = weechat_list_get (list, 0); /* first item */

# プロトタイプ
item = weechat.list_get(list, position)

# 例
item = weechat.list_get(list, 0)

void weechat_list_set (struct t_weelist_item *item, const char *value);

weechat_list_set (item, "new data");

# プロトタイプ
weechat.list_set(item, value)

# 例
weechat.list_set(item, "new data")

struct t_weelist_item *weechat_list_next (struct t_weelist_item *item);

struct t_weelist_item *next_item = weechat_list_next (item);

# プロトタイプ
item = weechat.list_next(item)

# 例
item = weechat.list_next(item)

struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item);

struct t_weelist_item *prev_item = weechat_list_prev (item);

# プロトタイプ
item = weechat.list_prev(item)

# 例
item = weechat.list_prev(item)

const char *weechat_list_string (struct t_weelist_item *item);

weechat_printf (NULL, "value of item: %s", weechat_list_string (item));

# プロトタイプ
value = weechat.list_string(item)

# 例
weechat.prnt("", "value of item: %s" % weechat.list_string(item))

char *weechat_list_size (struct t_weelist *weelist);

weechat_printf (NULL, "size of list: %d", weechat_list_size (list));

# プロトタイプ
size = weechat.list_size(list)

# 例
weechat.prnt("", "size of list: %d" % weechat.list_size(list))

void weechat_list_remove (struct t_weelist *weelist,
                          struct t_weelist_item *item);

weechat_list_remove (list, item);

# プロトタイプ
weechat.list_remove(list, item)

# 例
weechat.list_remove(list, item)

void weechat_list_remove_all (struct t_weelist *weelist);

weechat_list_remove_all (list);

# プロトタイプ
weechat.list_remove_all(list)

# 例
weechat.list_remove_all(list)

void weechat_list_free (struct t_weelist *weelist);

weechat_list_free (list);

# プロトタイプ
weechat.list_free(list)

# 例
weechat.list_free(list)

struct t_hashtable *weechat_hashtable_new (int size,
                                           const char *type_keys,
                                           const char *type_values,
                                           unsigned long (*callback_hash_key)(struct t_hashtable *hashtable,
                                                                              const void *key),
                                           int (*callback_keycmp)(struct t_hashtable *hashtable,
                                                                  const void *key1,
                                                                  const void *key2));

struct t_hashtable *hashtable = weechat_hashtable_new (8,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       WEECHAT_HASHTABLE_STRING,
                                                       NULL,
                                                       NULL);

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);

weechat_hashtable_set_with_size (hashtable, "my_key", 0,
                                 my_buffer, sizeof (my_buffer_struct));

struct t_hashtable_item *weechat_hashtable_set (struct t_hashtable *hashtable,
                                                const void *key, const void *value);

weechat_hashtable_set (hashtable, "my_key", "my_value");

void *weechat_hashtable_get (struct t_hashtable *hashtable, void *key);

void *value = weechat_hashtable_get (hashtable, "my_key");

int weechat_hashtable_has_key (struct t_hashtable *hashtable, void *key);

if (weechat_hashtable_has_key (hashtable, "my_key"))
{
    /* key is in hashtable */
    /* ... */
}

void 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);

void
map_cb (void *data, struct t_hashtable *hashtable,
        const void *key, const void *value)
{
    /* display key and value (they are both strings here) */
    weechat_printf (NULL, "key: '%s', value: '%s'",
                    (const char *)key,
                    (const char *)value);
}
/* ... */
weechat_hashtable_map (hashtable, &map_cb, NULL);

void 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);

void
map_cb (void *data, struct t_hashtable *hashtable,
        const char *key, const char *value)
{
    /* display key and value */
    weechat_printf (NULL, "key: '%s', value: '%s'",
                    key, value);
}
/* ... */
weechat_hashtable_map_string (hashtable, &map_cb, NULL);

int weechat_hashtable_get_integer (struct t_hashtable *hashtable,
                                   void *property);

int items_count = weechat_hashtable_get_integer (hashtable, "items_count");

const char *weechat_hashtable_get_string (struct t_hashtable *hashtable,
                                          const char *property);

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"));

void weechat_hashtable_set_pointer (struct t_hashtable *hashtable,
                                    const char *property, void *pointer);

void
my_free_value_cb (struct t_hashtable *hashtable, const void *key, void *value)
{
    /* ... */
}

weechat_hashtable_set_pointer (hashtable, "callback_free_value", &my_free_value_cb);

int weechat_hashtable_add_to_infolist (struct t_hashtable *hashtable,
                                       struct t_infolist_item *infolist_item,
                                       const char *prefix);

weechat_hashtable_add_to_infolist (hashtable, infolist_item, "testhash");

/* if hashtable contains:
     "key1" => "value 1"
     "key2" => "value 2"
   then following variables will be added to infolist item:
     "testhash_name_00000"  = "key1"
     "testhash_value_00000" = "value 1"
     "testhash_name_00001"  = "key2"
     "testhash_value_00001" = "value 2"
*/

void weechat_hashtable_remove (struct t_hashtable *hashtable, const void *key);

weechat_hashtable_remove (hashtable, "my_key");

void weechat_hashtable_remove_all (struct t_hashtable *hashtable);

weechat_hashtable_remove_all (hashtable);

void weechat_hashtable_free (struct t_hashtable *hashtable);

weechat_hashtable_free (hashtable);

struct t_config_file *weechat_config_new (const char *name,
                                          int (*callback_reload)(void *data,
                                                                 struct t_config_file *config_file),
                                          void *callback_reload_data);