diff options
| author | Sebastien Helleu <flashcode@flashtux.org> | 2008-11-06 09:47:52 +0100 |
|---|---|---|
| committer | Sebastien Helleu <flashcode@flashtux.org> | 2008-11-06 09:47:52 +0100 |
| commit | 885df965e50855cc07db442ea920ff524b860d25 (patch) | |
| tree | 08b8360420675f54db0d541ead44b0e4d3753df0 /doc/en/dev | |
| parent | 60d95151c52ac5d235be6bd87c3e7c454b33eb68 (diff) | |
| download | weechat-885df965e50855cc07db442ea920ff524b860d25.zip | |
Rename developer doc (-devel to -dev)
Diffstat (limited to 'doc/en/dev')
| -rw-r--r-- | doc/en/dev/plugin_api.en.xml | 4728 | ||||
| -rw-r--r-- | doc/en/dev/plugin_scripts.en.xml | 2849 | ||||
| -rw-r--r-- | doc/en/dev/plugins.en.xml | 250 | ||||
| -rw-r--r-- | doc/en/dev/weechat_dev.en.xml | 101 |
4 files changed, 7928 insertions, 0 deletions
diff --git a/doc/en/dev/plugin_api.en.xml b/doc/en/dev/plugin_api.en.xml new file mode 100644 index 000000000..8d90cb480 --- /dev/null +++ b/doc/en/dev/plugin_api.en.xml @@ -0,0 +1,4728 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +WeeChat documentation (english version) + +Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org> + +This manual is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +This manual is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. + +--> + +<section id="secPluginAPI"> + <title>Plugin API</title> + + <!-- =============================[ strings ]============================ --> + + <section id="secAPI_strings"> + <title>Strings</title> + + <para> + Many string functions below are already available thru standard C + functions, but it's recommended to use functions in this API because + they are ok with UTF-8 and locale. + </para> + + <section id="secAPI_weechat_charset_set"> + <title>weechat_charset_set</title> + + <para> + Prototype: + <command> + void weechat_charset_set (const char *charset) + </command> + </para> + <para> + Set new plugin charset. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>charset</option>: new charset to use + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_charset_set (plugin, "iso-8859-1");</screen> + </para> + </section> + + <section id="secAPI_weechat_iconv_to_internal"> + <title>weechat_iconv_to_internal</title> + + <para> + Prototype: + <command> + void weechat_iconv_to_internal (const char *charset, + const char *string) + </command> + </para> + <para> + Convert string to WeeChat internal charset (UTF-8). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>charset</option>: charset to convert + </para> + </listitem> + <listitem> + <para> + <option>string</option>: string to convert + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: converted string. + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen>char *str = weechat_iconv_to_internal (plugin, "iso-8859-1", "iso string: é à");</screen> + </para> + </section> + + <section id="secAPI_weechat_iconv_from_internal"> + <title>weechat_iconv_from_internal</title> + + <para> + Prototype: + <command> + void weechat_iconv_from_internal (const char *charset, + const char *string) + </command> + </para> + <para> + Convert string from internal WeeChat charset (UTF-8) to another. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>charset</option>: target charset + </para> + </listitem> + <listitem> + <para> + <option>string</option>: string to convert + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: converted string. + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen>char *str = weechat_iconv_from_internal ("iso-8859-1", "utf-8 string: é à");</screen> + </para> + </section> + + <section id="secAPI_weechat_gettext"> + <title>weechat_gettext</title> + + <para> + Prototype: + <command> + char *weechat_gettext (const char *string) + </command> + </para> + <para> + Return translated string (depends on local language). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string to translate + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: translated string. + </para> + <para> + Example: + <screen>char *str = weechat_gettext ("hello !");</screen> + </para> + </section> + + <section id="secAPI_weechat_ngettext"> + <title>weechat_ngettext</title> + + <para> + Prototype: + <command> + char *weechat_ngettext (const char *string, const char *plural, + int count) + </command> + </para> + <para> + Return translated string, using single or plural form, according to + count. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>single</option>: string to translate (single form) + </para> + </listitem> + <listitem> + <para> + <option>plural</option>: string to translate (plural form) + </para> + </listitem> + <listitem> + <para> + <option>count</option>: used to choose between single and plural + form + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: translated string. + </para> + <para> + Example: + <screen>char *str = weechat_ngettext ("file", "files", num_files);</screen> + </para> + </section> + + <section id="secAPI_weechat_strndup"> + <title>weechat_strndup</title> + + <para> + Prototype: + <command> + char *weechat_strndup (const char *string, int length) + </command> + </para> + <para> + Return duplicated string, with max "length" chars. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string to duplicate + </para> + </listitem> + <listitem> + <para> + <option>length</option>: max chars to duplicate + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: duplicated string. + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen>char *str = weechat_strndup ("abcdef", 3); /* result: "abc" */</screen> + </para> + </section> + + <section id="secAPI_weechat_string_tolower"> + <title>weechat_string_tolower</title> + + <para> + Prototype: + <command> + char *weechat_string_tolower (const char *string) + </command> + </para> + <para> + Convert UTF-8 string to lower case. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string to convert + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>weechat_string_tolower ("AbCdEé"); /* result: "abcdeé" */</screen> + </para> + </section> + + <section id="secAPI_weechat_string_toupper"> + <title>weechat_string_toupper</title> + + <para> + Prototype: + <command> + char *weechat_string_toupper (const char *string) + </command> + </para> + <para> + Convert UTF-8 string to upper case. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string to convert + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>weechat_string_toupper ("AbCdEé"); /* result: "ABCDEé" */</screen> + </para> + </section> + + <section id="secAPI_weechat_strcasecmp"> + <title>weechat_strcasecmp</title> + + <para> + Prototype: + <command> + int weechat_strcasecmp (const char *string1, const char *string2) + </command> + </para> + <para> + Locale and case independent string comparison. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string1</option>: first string for comparison + </para> + </listitem> + <listitem> + <para> + <option>string2</option>: second string for comparison + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: difference between two strings: negative if + string1 < string2, zero if string1 == string2, positive if + string1 > string2 + </para> + <para> + Example: + <screen>int diff = weechat_strcasecmp ("aaa", "CCC"); /* == -2 */ </screen> + </para> + </section> + + <section id="secAPI_weechat_strncasecmp"> + <title>weechat_strncasecmp</title> + + <para> + Prototype: + <command> + int weechat_strncasecmp (const char *string1, const char *string2, + int max) + </command> + </para> + <para> + Locale and case independent string comparison, for "max" chars. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string1</option>: first string for comparison + </para> + </listitem> + <listitem> + <para> + <option>string2</option>: second string for comparison + </para> + </listitem> + <listitem> + <para> + <option>max</option>: max number of chars for comparison + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: difference between two strings: negative if + string1 < string2, zero if string1 == string2, positive if + string1 > string2 + </para> + <para> + Example: + <screen>int diff = weechat_strncasecmp ("aaa", "CCC", 2); /* == -2 */</screen> + </para> + </section> + + <section id="secAPI_weechat_strcmp_ignore_chars"> + <title>weechat_strcmp_ignore_chars</title> + + <para> + Prototype: + <command> + int weechat_strcmp_ignore_chars (const char *string1, + const char *string2, const char *chars_ignored, int case_sensitive) + </command> + </para> + <para> + Locale (and optionally case independent) string comparison, ignoring + some chars. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string1</option>: first string for comparison + </para> + </listitem> + <listitem> + <para> + <option>string2</option>: second string for comparison + </para> + </listitem> + <listitem> + <para> + <option>chars_ignored</option>: string with chars to ignore + </para> + </listitem> + <listitem> + <para> + <option>case_sensitive</option>: 1 for case sensitive comparison, + 0 otherwise + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: difference between two strings: negative if + string1 < string2, zero if string1 == string2, positive if + string1 > string2 + </para> + <para> + Example: + <screen>int diff = weechat_strcmp_ignore_chars ("a-b", "--a-e", "-", 1); /* == -3 */</screen> + </para> + </section> + + <section id="secAPI_weechat_strcasestr"> + <title>weechat_strcasestr</title> + + <para> + Prototype: + <command> + int weechat_strcasestr (const char *string, const char *search) + </command> + </para> + <para> + Locale and case independent string search. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>search</option>: string to search in "string" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to string found, or NULL if not found + </para> + <para> + Example: + <screen>char *pos = weechat_strcasestr ("aBcDeF", "de"); /* result: pointer to "DeF" */</screen> + </para> + </section> + + <section id="secAPI_weechat_string_match"> + <title>weechat_string_match</title> + + <para> + Prototype: + <command> + int weechat_string_match (const char *string, const char *mask, + int case_sensitive) + </command> + </para> + <para> + Check if a string matches a mask. Mask may begin or end with "*" (no + other "*" are allowed inside mask). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>mask</option>: mask + </para> + </listitem> + <listitem> + <para> + <option>case_sensitive</option>: 1 for case sensitive search, + otherwise 0 + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if string matches mask, otherwise 0. + </para> + <para> + Examples: +<screen> +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 */ +</screen> + </para> + </section> + + <section id="secAPI_weechat_string_replace"> + <title>weechat_string_replace</title> + + <para> + Prototype: + <command> + char *weechat_string_replace (const char *string, const char *search, + const char *replace) + </command> + </para> + <para> + Replace "search" string by new one in a string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>search</option>: string to replace + </para> + </listitem> + <listitem> + <para> + <option>replace</option>: replacement for "search" string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: string with "search" replaced by "replace". + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen>char *str = weechat_string_replace ("test", "s", "x"); /* result: "text" */</screen> + </para> + </section> + + <section id="secAPI_weechat_string_remove_quotes"> + <title>weechat_string_remove_quotes</title> + + <para> + Prototype: + <command> + char *weechat_string_remove_quotes (const char *string, + const char *quotes) + </command> + </para> + <para> + Remove quotes at beginning/end of string (ignore spaces if there are + before first quote or after last quote). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>quotes</option>: string with list of quotes + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: string without quotes at beginning/end. + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen>char *str = weechat_string_remove_quotes (string, " 'abc' ", "'"); /* result: "abc" */</screen> + </para> + </section> + + <section id="secAPI_weechat_string_strip"> + <title>weechat_string_strip</title> + + <para> + Prototype: + <command> + char *weechat_string_strip (const char *string, int left, int right, + const char *chars) + </command> + </para> + <para> + Strip chars at beginning and/or end of string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>left</option>: strip left chars if different from 0 + </para> + </listitem> + <listitem> + <para> + <option>right</option>: strip right chars if different from 0 + </para> + </listitem> + <listitem> + <para> + <option>chars</option>: string with chars to strip + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: stripped string. + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen>char *str = weechat_strip (string, " ", 0, 1); /* remove spaces at end of string */</screen> + </para> + </section> + + <section id="secAPI_weechat_string_has_highlight"> + <title>weechat_string_has_highlight</title> + + <para> + Prototype: + <command> + char *weechat_string_has_highlight (const char *string, + const char highlight_words) + </command> + </para> + <para> + Check if a string has highlights, using list of highlight words. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>highlight_words</option>: list of highlight words, + separated by comma + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if string has one or more highlights, 0 otherwise. + </para> + <para> + Example: + <screen>if (weechat_string_has_highlight (string, "word1,word2")) ...</screen> + </para> + </section> + + <section id="secAPI_weechat_string_explode"> + <title>weechat_string_explode</title> + + <para> + Prototype: + <command> + char **weechat_string_explode (const char *string, + const char *separators, int keep_eol, int num_items_max, + int *num_items) + </command> + </para> + <para> + Explode a string according to one or more delimiter(s). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string to explode + </para> + </listitem> + <listitem> + <para> + <option>separators</option>: delimiters used for explosion + </para> + </listitem> + <listitem> + <para> + <option>keep_eol</option>: if different from 0, then each argument + will contain all string until end of line (see example below) + </para> + </listitem> + <listitem> + <para> + <option>num_items_max</option>: maximum number of items + created (0 = no limit) + </para> + </listitem> + <listitem> + <para> + <option>num_items</option>: pointer to int which will + contain number of items created + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: array of strings, NULL if problem. + </para> + <para> + Note: result has to be free by a call to "weechat_string_free_exploded" + after use. + </para> + <para> + Examples: + <screen> +char **argv; +int argc; +argv = weechat_string_explode ("abc de fghi", " ", 0, 0, &argc); +/* result: argv[0] == "abc" + argv[1] == "de" + argv[2] == "fghi" + argv[3] == NULL + argc == 3 +*/ +weechat_string_free_exploded (argv); + +argv = weechat_string_explode ("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_exploded (argv); + </screen> + </para> + </section> + + <section id="secAPI_weechat_string_free_exploded"> + <title>weechat_string_free_exploded</title> + + <para> + Prototype: + <command> + void weechat_string_free_exploded (char **exploded_string) + </command> + </para> + <para> + Free memory used by a string explosion. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>exploded_string</option>: string exploded by + "weechat_string_explode" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen> +char *argv; +int argc; +argv = weechat_string_explode (string, " ", 0, 0, &argc); +... +weechat_string_free_exploded (, argv); + </screen> + </para> + </section> + + <section id="secAPI_weechat_string_build_with_exploded"> + <title>weechat_string_build_with_exploded</title> + + <para> + Prototype: + <command> + char **weechat_string_build_with_exploded (char **exploded_string, + const char *separator) + </command> + </para> + <para> + Build a string with exploded string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>exploded_string</option>: string exploded by + "weechat_string_explode" function + </para> + </listitem> + <listitem> + <para> + <option>separator</option>: string used to separate strings + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: string built with exploded string. + </para> + <para> + Note: result has to be free by a call to "free" after use. + </para> + <para> + Example: + <screen> +char **argv; +int argc; +argv = weechat_string_explode ("abc def ghi", " ", 0, 0, &argc); +char *string = weechat_string_build_with_exploded (argv, ";"); +/* string == "abc;def;ghi" */ + </screen> + </para> + </section> + + <section id="secAPI_weechat_string_split_command"> + <title>weechat_string_split_command</title> + + <para> + Prototype: + <command> + char **weechat_string_split_command (const char *command, + char separator) + </command> + </para> + <para> + Split a list of commands separated by 'separator' (which can be escaped + by '\' in string). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>command</option>: command to split + </para> + </listitem> + <listitem> + <para> + <option>separator</option>: separator + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: array of strings, NULL if problem. + </para> + <para> + Note: result has to be free by a call to + "weechat_string_free_splitted_command" after use. + </para> + <para> + Example: + <screen>char **argv = weechat_string_split_command ("/command1;/command2", ';');</screen> + </para> + </section> + + <section id="secAPI_weechat_string_splitted_command"> + <title>weechat_string_free_splitted_command</title> + + <para> + Prototype: + <command> + void weechat_string_free_splitted_command (char **splitted_command) + </command> + </para> + <para> + Free memory used by a splitted command. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>splitted_command</option>: command splitted by + "weechat_string_split_commaand" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen> +char **argv = weechat_string_split_command ("/command1;/command2", ';'); +... +weechat_string_free_splitted_command (argv); + </screen> + </para> + </section> + + </section> + + <!-- ==============================[ UTF-8 ]============================= --> + + <section id="secAPI_utf8"> + <title>UTF-8</title> + + <para> + Some UTF-8 string functions. + </para> + + <section id="secAPI_weechat_utf8_has_8bits"> + <title>weechat_utf8_has_8bits</title> + + <para> + Prototype: + <command> + int weechat_utf8_has_8bits (const char *string) + </command> + </para> + <para> + Check if a string has 8-bits chars. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if string has 8-buts chars, 0 if only 7-bits chars. + </para> + <para> + Example: + <screen>if (weechat_utf8_has_8bits (string)) ...</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_is_valid"> + <title>weechat_utf8_is_valid</title> + + <para> + Prototype: + <command> + int weechat_utf8_is_valid (const char *string, char **error) + </command> + </para> + <para> + Check if a string is UTF-8 valid. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>error</option>: if not NULL, it is set with first non + valid UTF-8 char in string, if any + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if UTF-8 string is valid, 0 otherwise. + </para> + <para> + Example: + <screen> +char *error; +if (weechat_utf8_is_valid (string, &error)) ... + </screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_normalize"> + <title>weechat_utf8_normalize</title> + + <para> + Prototype: + <command> + void weechat_utf8_normalize (const char *string, char replacement) + </command> + </para> + <para> + Normalize UTF-8 string: remove non UTF-8 chars and replace them by a + char + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>replacement</option>: replacement char for non UTF-8 chars + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>weechat_utf8_normalize (string, '?');</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_prev_char"> + <title>weechat_utf8_prev_char</title> + + <para> + Prototype: + <command> + char *weechat_utf8_prev_char (const char *string_start, + const char *string) + </command> + </para> + <para> + Return previous UTF-8 char in a string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string_start</option>: start of string (function will not + return a char before this pointer) + </para> + </listitem> + <listitem> + <para> + <option>string</option>: pointer to string (must be >= + string_start) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to previous UTF-8 char, NULL if not found + (start of string reached) + </para> + <para> + Example: + <screen>char *prev_char = weechat_utf8_prev_char (string, ptr_in_string);</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_next_char"> + <title>weechat_utf8_next_char</title> + + <para> + Prototype: + <command> + char *weechat_utf8_next_char (const char *string) + </command> + </para> + <para> + Return next UTF-8 char in a string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to next UTF-8 char, NULL if not found + (end of string reached) + </para> + <para> + Example: + <screen>char *next_char = weechat_utf8_next_char (string);</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_char_size"> + <title>weechat_utf8_char_size</title> + + <para> + Prototype: + <command> + int weechat_utf8_char_size (const char *string) + </command> + </para> + <para> + Return UTF-8 char size (in bytes). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: UTF-8 char size (in bytes). + </para> + <para> + Example: + <screen>int char_size = weechat_utf8_char_size ("être"); /* == 2 */</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_strlen"> + <title>weechat_utf8_strlen</title> + + <para> + Prototype: + <command> + int weechat_utf8_strlen (const char *string) + </command> + </para> + <para> + Return UTF-8 string length (multi-byte char is considered as 1 char). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: UTF-8 string length (number of real chars). + </para> + <para> + Example: + <screen>int length = weechat_utf8_strlen ("chêne"); /* == 5 */</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_strnlen"> + <title>weechat_utf8_strnlen</title> + + <para> + Prototype: + <command> + int weechat_utf8_strnlen (const char *string, int bytes) + </command> + </para> + <para> + Return UTF-8 string length (multi-byte char is considered as 1 char), + for max bytes in string + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>bytes</option>: max bytes in string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: UTF-8 string length (number of real chars). + </para> + <para> + Example: + <screen>int length = weechat_utf8_strnlen ("chêne", 4); /* == 3 */</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_strlen_screen"> + <title>weechat_utf8_strlen_screen</title> + + <para> + Prototype: + <command> + int weechat_utf8_strlen_screen (const char *string) + </command> + </para> + <para> + Return number of chars needed on screen to display UTF-8 string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: number of chars needed on screen to display UTF-8 string. + </para> + <para> + Example: + <screen>int length_on_screen = weechat_utf8_strlen_screen ("东"); /* == 2 */</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_charcasecmp"> + <title>weechat_utf8_charcasecmp</title> + + <para> + Prototype: + <command> + int weechat_utf8_charcasecmp (const char *string1, + const char *string2) + </command> + </para> + <para> + Compare two UTF-8 chars (case is ignored). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string1</option>: first string for comparison + </para> + </listitem> + <listitem> + <para> + <option>string2</option>: second string for comparison + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: difference between first char of each string: negative if + char1 < char2, zero if char1 == char2, positive if char1 > char2 + </para> + <para> + Example: + <screen>if (weechat_utf8_charcasecmp (string1, string2) != 0) ...</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_char_size_screen"> + <title>weechat_utf8_char_size_screen</title> + + <para> + Prototype: + <command> + int weechat_utf8_char_size_screen (const char *string) + </command> + </para> + <para> + Return number of chars needed on screen to display UTF-8 char. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: number of chars needed on screen to display UTF-8 char. + </para> + <para> + Example: + <screen>int length_on_screen = weechat_utf8_char_size_screen (string)</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_add_offset"> + <title>weechat_utf8_add_offset</title> + + <para> + Prototype: + <command> + char *weechat_utf8_add_offset (const char *string, int offset) + </command> + </para> + <para> + Move forward N chars in an UTF-8 string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>offset</option>: number of chars + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to string, N chars after (NULL if it's not + reachable). + </para> + <para> + Example: + <screen>char *ptr = weechat_utf8_add_offset ("chêne", 3); /* points to "ne" */</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_real_pos"> + <title>weechat_utf8_real_pos</title> + + <para> + Prototype: + <command> + char *weechat_utf8_real_pos (const char *string, int pos) + </command> + </para> + <para> + Get real position in UTF-8 string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>pos</option>: position in chars + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: real position (in bytes) for "pos" chars in string. + </para> + <para> + Example: + <screen>int pos = weechat_utf8_real_pos ("chêne", 3); /* == 4 */</screen> + </para> + </section> + + <section id="secAPI_weechat_utf8_pos"> + <title>weechat_utf8_pos</title> + + <para> + Prototype: + <command> + char *weechat_utf8_pos (const char *string, int real_pos) + </command> + </para> + <para> + Get position in UTF-8 string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>string</option>: string + </para> + </listitem> + <listitem> + <para> + <option>real_pos</option>: position in bytes + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: position (in chars) for "real_pos" bytes in string. + </para> + <para> + Example: + <screen>int pos = weechat_utf8_real_pos ("chêne", 4); /* == 3 */</screen> + </para> + </section> + + </section> + + <!-- ===========================[ directories ]========================== --> + + <section id="secAPI_directories"> + <title>Directories</title> + + <para> + Some functions related to directories. + </para> + + <section id="secAPI_weechat_mkdir_home"> + <title>weechat_mkdir_home</title> + + <para> + Prototype: + <command> + int weechat_mkdir_home (char *directory, int mode) + </command> + </para> + <para> + Create a directory in WeeChat home. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>directory</option>: directory to create + </para> + </listitem> + <listitem> + <para> + <option>mode</option>: mode for new directory + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if directory was successfully created, 0 if an + error occurred. + </para> + <para> + Example: + <screen>if (!weechat_mkdir_home ("temp")) ... </screen> + </para> + </section> + + <section id="secAPI_weechat_mkdir"> + <title>weechat_mkdir</title> + + <para> + Prototype: + <command> + int weechat_mkdir (char *directory, int mode) + </command> + </para> + <para> + Create a directory. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>directory</option>: directory to create + </para> + </listitem> + <listitem> + <para> + <option>mode</option>: mode for new directory + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if directory was successfully created, 0 if an + error occurred. + </para> + <para> + Example: + <screen>if (!weechat_mkdir ("/tmp/mydir")) ... </screen> + </para> + </section> + + <section id="secAPI_weechat_exec_on_files"> + <title>weechat_exec_on_files</title> + + <para> + Prototype: + <command> + void weechat_exec_on_files (const char *directory, void *data, + int (*callback)(void *data, const char *filename)) + </command> + </para> + <para> + Find files in a directory and execute a callback on each file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>directory</option>: directory for searching files + </para> + </listitem> + <listitem> + <para> + <option>data</option>: pointer given to callback when calling it + found + </para> + </listitem> + <listitem> + <para> + <option>callback</option>: function called for each file + found + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: +<screen> +int callback (void *data, const char *filename) +{ + /* ... */ + return 1; +} +... +plugin->exec_on_files (plugin, "/tmp", &callback); +</screen> + </para> + </section> + + </section> + + <!-- ==============================[ util ]============================== --> + + <section id="secAPI_util"> + <title>Util</title> + + <para> + Some useful functions. + </para> + + <section id="secAPI_weechat_timeval_cmp"> + <title>weechat_timeval_cmp</title> + + <para> + Prototype: + <command> + int weechat_timeval_cmp (struct timeval *tv1, struct timeval *tv2) + </command> + </para> + <para> + Compare 2 timeval structures. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>tv1</option>: first timeval structure + </para> + </listitem> + <listitem> + <para> + <option>tv2</option>: second timeval structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: -1 if tv1 < char2, zero if tv1 == tv2, +1 if tv1 > + tv2 + </para> + <para> + Example: + <screen>if (weechat_timeval_cmp (&tv1, &tv2) > 0) ...</screen> + </para> + </section> + + <section id="secAPI_weechat_timeval_diff"> + <title>weechat_timeval_diff</title> + + <para> + Prototype: + <command> + long weechat_timeval_diff (struct timeval *tv1, struct timeval *tv2) + </command> + </para> + <para> + Return difference (in milliseconds) between 2 timeval structures. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>tv1</option>: first timeval structure + </para> + </listitem> + <listitem> + <para> + <option>tv2</option>: second timeval structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: difference in milliseconds. + </para> + <para> + Example: + <screen>long diff = weechat_timeval_diff (&tv1, &tv2);</screen> + </para> + </section> + + <section id="secAPI_weechat_timeval_add"> + <title>weechat_timeval_add</title> + + <para> + Prototype: + <command> + void weechat_timeval_add (struct timeval *tv, long interval) + </command> + </para> + <para> + Add interval (in milliseconds) to a timeval structure. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>tv</option>: timeval structure + </para> + </listitem> + <listitem> + <para> + <option>interval</option>: interval (in milliseconds) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>weechat_timeval_add (&tv, 2000); /* add 2 seconds */</screen> + </para> + </section> + + </section> + + To be continued... + + <!-- + + <section id="secAPI_print"> + <title>print</title> + + <para> + Prototype: + <command> + void print (t_weechat_plugin *plugin, + char *server, char *channel, char *message, ...) + </command> + </para> + <para> + Display a message on a WeeChat buffer, identified by server and + channel (both may be NULL for current buffer). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server to find + buffer for message display (may be NULL) + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: name of channel to find buffer + for message display (may be NULL) + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message + </para> + </listitem> + </itemizedlist> + </para> + <para> + To display colored text, there are following codes: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Code</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>0x02</entry> + <entry> + bold text + </entry> + </row> + <row> + <entry>0x03 + "xx"</entry> + <entry> + text color "<literal>xx</literal>" + (see <xref linkend="secAPI_get_irc_color" /> for colors) + </entry> + </row> + <row> + <entry>0x03 + "xx,yy"</entry> + <entry> + text color "<literal>xx</literal>" + and background "<literal>yy</literal>" + (see <xref linkend="secAPI_get_irc_color" /> for colors) + </entry> + </row> + <row> + <entry>0x0F</entry> + <entry> + disable color and attributes + </entry> + </row> + <row> + <entry>0x12</entry> + <entry> + reverse video (revert text color with background) + </entry> + </row> + <row> + <entry>0x1F</entry> + <entry> + underlined text + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + Note: the same code (without number for 0x03) may be used to stop + the attribute. + </para> + <para> + Return value: none. + </para> + <para> + Examples: +<screen> +plugin->print (plugin, NULL, NULL, "hello"); +plugin->print (plugin, NULL, "#weechat", "hello"); +plugin->print (plugin, "freenode", "#weechat", "hello"); +plugin->print (plugin, NULL, NULL, + "test: \x02 bold \x0F\x03%02d blue \x03%02d green", + plugin->get_irc_color (plugin, "blue"), + plugin->get_irc_color (plugin, "green")); +</screen> + </para> + </section> + + <section id="secAPI_print_server"> + <title>print_server</title> + + <para> + Prototype: + <command> + void print_server (t_weechat_plugin *plugin, + char *message, ...) + </command> + </para> + <para> + Display a message on current server buffer. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message + </para> + </listitem> + </itemizedlist> + </para> + <para> + To display colored text, see <xref linkend="secAPI_print" />. + </para> + <para> + Return value: none. + </para> + <para> + Example: <screen>plugin->print_server (plugin, "hello");</screen> + </para> + </section> + + <section id="secAPI_log"> + <title>log</title> + + <para> + Prototype: + <command> + void log (t_weechat_plugin *plugin, + char *server, char *channel, char *message, ...) + </command> + </para> + <para> + Write a message in log file for a server or a channel. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server to find + buffer for log (may be NULL) + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: name of channel to find buffer + for log (may be NULL) + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: +<screen> +plugin->log (plugin, "freenode", "#weechat", "test"); +</screen> + </para> + </section> + + <section id="secAPI_msg_handler_add"> + <title>msg_handler_add</title> + + <para> + Prototype: + <command> + t_plugin_handler *msg_handler_add (t_weechat_plugin + *plugin, char *message, t_plugin_handler_func *function, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Add an IRC message handler, called when an IRC message is + received. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>message</option>: name of IRC message ("*" for all + messages). + To know list of IRC messages, please consult + <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + and + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. + Moreover you can use a special name, prefixed by "weechat_" + to catch special events, as written in table below: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>weechat_pv</literal></entry> + <entry>private message received</entry> + </row> + <row> + <entry><literal>weechat_highlight</literal></entry> + <entry> + message with highlight (on a channel or pv) + </entry> + </row> + <row> + <entry><literal>weechat_ctcp</literal></entry> + <entry> + CTCP message received (VERSION, PING, ..) + </entry> + </row> + <row> + <entry><literal>weechat_dcc</literal></entry> + <entry> + DCC message received (chat or file) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called when message + is received + </para> + <para> + It uses following prototype: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Argument argc is set to 3, following values are set in + argv array: + <itemizedlist> + <listitem> + <para>argv[0] = server name</para> + </listitem> + <listitem> + <para>argv[1] = IRC message</para> + </listitem> + <listitem> + <para>argv[2] = command arguments</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: arguments given to function + when called + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: pointer given to function + when called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new message handler. + </para> + <para> + Note: function called when message is received has to return + one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: message + will not be sent to WeeChat + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: message + will not be sent to other plugins + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: message + will not be sent to WeeChat neither other plugins + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: function + successfully completed and make "highlight" on received + message + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +int msg_kick (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, argv[0], NULL, "KICK received"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *msg_handler; +msg_handler = plugin->msg_handler_add (plugin, "KICK", + &msg_kick, NULL, NULL); +</screen> + </para> + </section> + + <section id="secAPI_cmd_handler_add"> + <title>cmd_handler_add</title> + + <para> + Prototype: + <command> + t_plugin_handler *cmd_handler_add (t_weechat_plugin + *plugin, char *command, char *description, char *arguments, + char *arguments_description, char *completion_template, + t_plugin_handler_func *fonction, char *handler_args, + void *handler_pointer) + </command> + </para> + <para> + Add a WeeChat command handler, called when user uses command + (for example /command). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>command</option>: the new command name, which + may be an existing command (be careful, replaced command + will not be available until plugin is unloaded) + </para> + </listitem> + <listitem> + <para> + <option>description</option>: short command description + (displayed by /help command) + </para> + </listitem> + <listitem> + <para> + <option>arguments</option>: short description of command + arguments (displayed by /help command) + </para> + </listitem> + <listitem> + <para> + <option>arguments_description</option>: long description + of command arguments (displayed by /help command) + </para> + </listitem> + <listitem> + <para> + <option>completion_template</option>: template for + completion, like "<literal>abc|%w def|%i</literal>" + which means "abc" or a WeeChat command for first argument, + "def" or IRC command for second. + An empty string lets WeeChat complete any argument with + a nick from current channel, NULL or "-" disable completion + for all command arguments. + </para> + <para> + Following codes can be used: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Code</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>%-</literal></entry> + <entry>no completion for argument</entry> + </row> + <row> + <entry><literal>%*</literal></entry> + <entry> + repeat last completion for all following arguments + (this code has to be at the end of completion + template, preceded by "|") + </entry> + </row> + <row> + <entry><literal>%a</literal></entry> + <entry>alias</entry> + </row> + <row> + <entry><literal>%A</literal></entry> + <entry> + alias and commands (WeeChat, IRC and plugins) + </entry> + </row> + <row> + <entry><literal>%c</literal></entry> + <entry>current channel</entry> + </row> + <row> + <entry><literal>%C</literal></entry> + <entry>all channels (including queries)</entry> + </row> + <row> + <entry><literal>%f</literal></entry> + <entry>file name</entry> + </row> + <row> + <entry><literal>%h</literal></entry> + <entry>plugins commands</entry> + </row> + <row> + <entry><literal>%i</literal></entry> + <entry>IRC commands (sent)</entry> + </row> + <row> + <entry><literal>%I</literal></entry> + <entry>IRC commands (received)</entry> + </row> + <row> + <entry><literal>%k</literal></entry> + <entry>key functions</entry> + </row> + <row> + <entry><literal>%m</literal></entry> + <entry>nick on current server</entry> + </row> + <row> + <entry><literal>%M</literal></entry> + <entry> + nicks on current server (on all open channels) + </entry> + </row> + <row> + <entry><literal>%n</literal></entry> + <entry>nicks of current channel</entry> + </row> + <row> + <entry><literal>%N</literal></entry> + <entry>nicks and hostnames of current channel</entry> + </row> + <row> + <entry><literal>%o</literal></entry> + <entry>setup options</entry> + </row> + <row> + <entry><literal>%O</literal></entry> + <entry>plugin options</entry> + </row> + <row> + <entry><literal>%p</literal></entry> + <entry>default "part" message</entry> + </row> + <row> + <entry><literal>%q</literal></entry> + <entry>default "quit" message</entry> + </row> + <row> + <entry><literal>%s</literal></entry> + <entry>current server name</entry> + </row> + <row> + <entry><literal>%S</literal></entry> + <entry>all servers names</entry> + </row> + <row> + <entry><literal>%t</literal></entry> + <entry>topic of current channel</entry> + </row> + <row> + <entry><literal>%v</literal></entry> + <entry>setup option value</entry> + </row> + <row> + <entry><literal>%V</literal></entry> + <entry>plugin option value</entry> + </row> + <row> + <entry><literal>%w</literal></entry> + <entry>WeeChat commands</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called when command + is executed + </para> + <para> + It uses following prototype: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Argument argc is set to 3, following values are set in + argc array: + <itemizedlist> + <listitem> + <para>argv[0] = server name</para> + </listitem> + <listitem> + <para>argv[1] = command</para> + </listitem> + <listitem> + <para>argv[2] = command arguments</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: arguments given to function + when called + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: pointer given to function + when called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new command handler. + </para> + <para> + Note: function called when command is executed has to return + one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +int cmd_test (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, argv[0], NULL, + "test command, nick: %s", + (argv[2]) ? argv[2] : "none"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *cmd_handler; +cmd_handler = plugin->cmd_handler_add (plugin, "test", "Test command", + "[nick]", "nick: nick of channel", + "%n", &cmd_test, NULL, NULL); +</screen> + </para> + </section> + + <section id="secAPI_timer_handler_add"> + <title>timer_handler_add</title> + + <para> + Prototype: + <command> + t_plugin_handler *timer_handler_add (t_weechat_plugin + *plugin, int interval, t_plugin_handler_func *function, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Add a timer handler which periodically calls a function. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>interval</option>: interval (in seconds) between + two calls of function. + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + <para> + It uses following prototype: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Argument argc is set to 0, and argv is set to NULL. + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: arguments given to function + when called + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: pointer given to function + when called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new timer handler. + </para> + <para> + Note: function called has to return one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +int my_timer (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, NULL, NULL, "my timer"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *timer_handler; +timer_handler = plugin->timer_handler_add (plugin, 60, &my_timer); +</screen> + </para> + </section> + + <section id="secAPI_keyboard_handler_add"> + <title>keyboard_handler_add</title> + + <para> + Prototype: + <command> + t_plugin_handler *keyboard_handler_add (t_weechat_plugin + *plugin, t_plugin_handler_func *function, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Add a keyboard handler, called for any key pressed. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + <para> + It uses following prototype: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Argument argc is set to 3, following values are set in + argc array: + <itemizedlist> + <listitem> + <para> + argv[0] = key pressed (name of internal function or + '*' followed by a key code) + </para> + </listitem> + <listitem> + <para> + argv[1] = command line before key action + </para> + </listitem> + <listitem> + <para> + argv[2] = command line after key action + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: arguments given to function + when called + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: pointer given to function + when called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new message handler. + </para> + <para> + Note: function called has to return one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +int my_keyb (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + if (argc == 2) + { + plugin->print (plugin, NULL, NULL, "key pressed: %s", argv[0]); + if (argv[1] && (argv[1][0] == '1')) + plugin->print (plugin, NULL, NULL, "input text changed"); + else + plugin->print (plugin, NULL, NULL, "input text not changed"); + } + return PLUGIN_RC_OK; +} +... +t_plugin_handler *keyb_handler; +keyb_handler = plugin->keyboard_handler_add (plugin, &my_keyb); +</screen> + </para> + </section> + + <section id="secAPI_event_handler_add"> + <title>event_handler_add</title> + + <para> + Prototype: + <command> + t_plugin_handler *event_handler_add (t_weechat_plugin + *plugin, char *event, t_plugin_handler_func *function, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Add an event handler, called when an event happens. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>event</option> : event (see table below) + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + <para> + It uses following prototype: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Arguments depend on event (see table below). + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: arguments given to function + when called + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: pointer given to function + when called + </para> + </listitem> + </itemizedlist> + </para> + <para> + List of events: + <informaltable colsep="0" frame="none"> + <tgroup cols="3"> + <thead> + <row> + <entry>Event</entry> + <entry>Description</entry> + <entry>Arguments</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>buffer_open</literal></entry> + <entry>a buffer was open</entry> + <entry> + argc = 1, argv = { buffer number } + </entry> + </row> + <row> + <entry><literal>buffer_close</literal></entry> + <entry>a buffer was closed</entry> + <entry> + argc = 1, argv = { buffer number } + </entry> + </row> + <row> + <entry><literal>buffer_move</literal></entry> + <entry>a buffer was moved</entry> + <entry> + argc = 2, argv = { new buffer number, old number } + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Return value: pointer to new event handler. + </para> + <para> + Note: function called has to return one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +int my_event (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, NULL, NULL, "my_event"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *event_handler; +event_handler = plugin->event_handler_add (plugin, "buffer_open", + &my_event); +</screen> + </para> + </section> + + <section id="secAPI_handler_remove"> + <title>handler_remove</title> + + <para> + Prototype: + <command> + void handler_remove (t_weechat_plugin *plugin, + t_plugin_handler *handler) + </command> + </para> + <para> + Remove a command or message handler. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>handler</option>: handler to remove + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->handler_remove (plugin, my_handler);</screen> + </para> + </section> + + <section id="secAPI_handler_remove_all"> + <title>handler_remove_all</title> + + <para> + Prototype: + <command> + void handler_remove_all (t_weechat_plugin *plugin) + </command> + </para> + <para> + Remove all handlers for a plugin. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->handler_remove_all (plugin);</screen> + </para> + </section> + + <section id="secAPI_modifier_add"> + <title>modifier_add</title> + + <para> + Prototype: + <command> + t_plugin_modifier *modifier_add (t_weechat_plugin *plugin, + char *type, char *message, t_plugin_modifier_func *function, + char *modifier_args, void *modifier_pointer) + </command> + </para> + <para> + Add a message modifier. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>type</option>: modifier type: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>irc_in</literal></entry> + <entry>called for incoming IRC messages</entry> + </row> + <row> + <entry><literal>irc_user</literal></entry> + <entry> + called for each user message (or command) (before + WeeChat parses message) + </entry> + </row> + <row> + <entry><literal>irc_out</literal></entry> + <entry> + called for outgoing messages, immediately before + sending it to IRC server (this includes messages + sent automatically by WeeChat to server) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>message</option>: name of IRC message (used only for + types "irc_in" and "irc_out"). + To know list of IRC messages, please consult + <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + and + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. + Moreover, special value "*" means all messages (no filter). + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + <para> + It uses following prototype: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *modifier_args, void *modifier_pointer) + </command> + </para> + <para> + Argument argc is set to 2, following values are set in + argv array: + <itemizedlist> + <listitem> + <para>argv[0] = server name</para> + </listitem> + <listitem> + <para>argv[1] = message</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>modifier_args</option>: arguments given to function + when called + </para> + </listitem> + <listitem> + <para> + <option>modifier_pointer</option>: pointer given to function + when called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new message modifier. + </para> + <para> + Note: function has to return modified string, or NULL if no + changes are made to message. + If function returns empty string, then message is dropped and + will not be read at all by WeeChat (be careful when dropping + messages!). + Returned string must have been allocated by malloc() and will + be freed (with call to free()) automatically by WeeChat after use. + </para> + <para> + Example: +<screen> +char *adder (t_weechat_plugin *plugin, int argc, char **argv, + char *modifier_args, void *modifier_pointer) +{ + char *string; + string = malloc (strlen (argv[1]) + 16); + strcpy (string, argv[1]); + strcat (string, "test"); + return string; +} +... +t_plugin_modifier *modifier; +modifier = plugin->modifier_add (plugin, "irc_in", "privmsg", + &adder, NULL, NULL); +</screen> + </para> + </section> + + <section id="secAPI_modifier_remove"> + <title>modifier_remove</title> + + <para> + Prototype: + <command> + void modifier_remove (t_weechat_plugin *plugin, + t_plugin_modifier *modifier) + </command> + </para> + <para> + Remove a message modifier. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>modifier</option>: modifier to remove + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->modifier_remove (plugin, my_modifier);</screen> + </para> + </section> + + <section id="secAPI_modifier_remove_all"> + <title>modifier_remove_all</title> + + <para> + Prototype: + <command> + void modifier_remove_all (t_weechat_plugin *plugin) + </command> + </para> + <para> + Remove all modifiers for a plugin. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->modifier_remove_all (plugin);</screen> + </para> + </section> + + <section id="secAPI_exec_command"> + <title>exec_command</title> + + <para> + Prototype: + <command> + void exec_command (t_weechat_plugin + *plugin, char *server, char *channel, char *command) + </command> + </para> + <para> + Execute a WeeChat command (or send a message to a channel). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server for + executing command (may be NULL) + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: name of channel for executing + command (may be NULL) + </para> + </listitem> + <listitem> + <para> + <option>command</option>: command + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Examples: +<screen> +plugin->exec_command (plugin, NULL, NULL, "/help nick"); +plugin->exec_command (plugin, "freenode", "#weechat", "hello"); +</screen> + </para> + </section> + + <section id="secAPI_get_info"> + <title>get_info</title> + + <para> + Prototype: + <command> + char *get_info (t_weechat_plugin *plugin, + char *info, char *server) + </command> + </para> + <para> + Return an info about WeeChat or a channel. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>info</option> : name of info to read: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Info</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>version</literal></entry> + <entry>WeeChat's version</entry> + </row> + <row> + <entry><literal>nick</literal></entry> + <entry>nick</entry> + </row> + <row> + <entry><literal>channel</literal></entry> + <entry> + name of channel (NULL for a server or private) + </entry> + </row> + <row> + <entry><literal>server</literal></entry> + <entry>name of server</entry> + </row> + <row> + <entry><literal>type</literal></entry> + <entry> + buffer type: 0=standard, 1=DCC, 2=raw IRC data + </entry> + </row> + <row> + <entry><literal>away</literal></entry> + <entry>"away" flag</entry> + </row> + <row> + <entry><literal>inactivity</literal></entry> + <entry> + number of seconds since last key was pressed + </entry> + </row> + <row> + <entry><literal>input</literal></entry> + <entry> + content of command line for current window + </entry> + </row> + <row> + <entry><literal>input_mask</literal></entry> + <entry> + content of color mask for command line + </entry> + </row> + <row> + <entry><literal>input_pos</literal></entry> + <entry> + cursor position in command line + </entry> + </row> + <row> + <entry><literal>weechat_dir</literal></entry> + <entry> + WeeChat home directory + (by default: ~/.weechat/) + </entry> + </row> + <row> + <entry><literal>weechat_libdir</literal></entry> + <entry>WeeChat system lib directory</entry> + </row> + <row> + <entry><literal>weechat_sharedir</literal></entry> + <entry>WeeChat system share directory</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server for + reading info (if needed) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: information asked, NULL if not found. + </para> + <para> + Note: result has to be free by a call to "free" function after + use. + </para> + <para> + Examples: +<screen> +char *version = plugin->get_info (plugin, "version", NULL); +char *nick = plugin->get_info (plugin, "nick", "freenode"); +char *inactivity = plugin->get_info (plugin, "inactivity", NULL); + +plugin->print (plugin, NULL, NULL, + "WeeChat version %s, you are %s on freenode " + "(inactive for %s seconds)", + version, nick, inactivity); + +if (version) + free (version); +if (nick) + free (nick); +if (inactivity) + free (inactivity); +</screen> + </para> + </section> + + <section id="secAPI_get_dcc_info"> + <title>get_dcc_info</title> + + <para> + Prototype: + <command> + t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Return list of DCC currently active or finished. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: linked list of DCC. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>server</literal></entry> + <entry>IRC server</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>channel</literal></entry> + <entry>IRC channel</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry> + DCC type: + 0 = chat received, + 1 = chat sent, + 2 = file received, + 3 = file sent + </entry> + </row> + <row> + <entry>int*</entry> + <entry><literal>status</literal></entry> + <entry> + DCC status: + 0 = waiting, + 1 = connecting, + 2 = active, + 3 = finished, + 4 = failed, + 5 = interrupted by user + </entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>start_time</literal></entry> + <entry>date/time of DCC creation</entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>start_transfer</literal></entry> + <entry>date/time of DCC transfer start</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>addr</literal></entry> + <entry>IP address of remote user</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>port</literal></entry> + <entry>port used for DCC</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>remote nick</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>filename</literal></entry> + <entry>file name</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>local_filename</literal></entry> + <entry>local file name</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>filename_suffix</literal></entry> + <entry>suffix if renaming file</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>size</literal></entry> + <entry>file size</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>pos</literal></entry> + <entry>position in file</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>start_resume</literal></entry> + <entry>start position after interruption</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>bytes_per_sec</literal></entry> + <entry> + number of bytes per second since transfer start + </entry> + </row> + <row> + <entry>t_plugin_dcc_info *</entry> + <entry><literal>prev_dcc</literal></entry> + <entry> + pointer to previous DCC info + </entry> + </row> + <row> + <entry>t_plugin_dcc_info *</entry> + <entry><literal>next_dcc</literal></entry> + <entry> + pointer to next DCC info + </entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_dcc_info" function + after use. + </para> + <para> + Examples: +<screen> +t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin); +for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = ptr_dcc->next_dcc) +{ + plugin->print_server (plugin, "DCC type=%d, with: %s", + ptr_dcc->type, ptr_dcc->nick); +} +if (dcc_info) + plugin->free_dcc_info (plugin, dcc_info); +</screen> + </para> + </section> + + <section id="secAPI_free_dcc_info"> + <title>free_dcc_info</title> + + <para> + Prototype: + <command> + void free_dcc_info (t_weechat_plugin *plugin, + t_plugin_dcc_info *dcc_info) + </command> + </para> + <para> + Free memory used by a DCC list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>dcc_info</option>: pointer to DCC list returned by + "get_dcc_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_dcc_info (plugin, dcc_info);</screen> + </para> + </section> + + <section id="secAPI_get_server_info"> + <title>get_server_info</title> + + <para> + Prototype: + <command> + t_plugin_server_info *get_server_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Return list of IRC servers (connected or not). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: linked list of IRC servers. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>name</literal></entry> + <entry>server internal name</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoconnect</literal></entry> + <entry>1 if autoconnect at start-up, 0 otherwise</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoreconnect</literal></entry> + <entry> + 1 if autoreconnect when disconnected, + 0 otherwise + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoreconnect_delay</literal></entry> + <entry>delay before trying again connection</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>command_line</literal></entry> + <entry> + 1 if server was on command line (so it is temporary), + 0 otherwise + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>address</literal></entry> + <entry>server address (host or IP)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>port</literal></entry> + <entry>port</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ipv6</literal></entry> + <entry>IPv6 connection</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ssl</literal></entry> + <entry>SSL connection</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>password</literal></entry> + <entry>server password</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick1</literal></entry> + <entry>first nickname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick2</literal></entry> + <entry>alternate nickname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick3</literal></entry> + <entry>second alternate nickname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>username</literal></entry> + <entry>user name</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>real name</literal></entry> + <entry>real name</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>command</literal></entry> + <entry>command run once connected</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>command_delay</literal></entry> + <entry>delay after execution of command</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>autojoin</literal></entry> + <entry>channels joined automatically</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autorejoin</literal></entry> + <entry> + 1 if channels are rejoined when kicked, + 0 otherwise + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>notify_levels</literal></entry> + <entry>channels notify levels</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_decode_iso</literal></entry> + <entry>channels charsets for decoding ISO</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_decode_utf</literal></entry> + <entry>channels charsets for decoding UTF</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_encode</literal></entry> + <entry>channels charsets for encoding messages</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>is_connected</literal></entry> + <entry>1 if connected to server, 0 otherwise</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ssl_connected</literal></entry> + <entry>1 if connected with SSL, 0 otherwise</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>current nickname</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>is_away</literal></entry> + <entry>1 if away, 0 otherwise</entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>away_time</literal></entry> + <entry>time when user is marking as away</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>lag</literal></entry> + <entry>lag (in milliseconds)</entry> + </row> + <row> + <entry>t_plugin_server_info *</entry> + <entry><literal>prev_server</literal></entry> + <entry>pointer to previous server info</entry> + </row> + <row> + <entry>t_plugin_server_info *</entry> + <entry><literal>next_server</literal></entry> + <entry>pointer to next server info</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_server_info" + function after use. + </para> + <para> + Example: +<screen> +t_plugin_server_info *server_info, *ptr_server_info; +server_info = plugin->get_server_info (plugin); +if (server_info) +{ + for (ptr_server_info = server_info; ptr_server_info; + ptr_server_info = ptr_server_info->next_server) + { + plugin->print (plugin, NULL, NULL, + "server: %s, address: %s, port: %d %s", + ptr_server_info->name, + ptr_server_info->address, + ptr_server_info->port, + (ptr_server_info->is_connected) ? "(connected)" : ""); + } + plugin->free_server_info (plugin, server_info); +} +</screen> + </para> + </section> + + <section id="secAPI_free_server_info"> + <title>free_server_info</title> + + <para> + Prototype: + <command> + void free_server_info (t_weechat_plugin *plugin, + t_plugin_server_info *server_info) + </command> + </para> + <para> + Free memory used by server info list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server_info</option>: pointer to server list + returned by "get_server_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_server_info (plugin, server_info);</screen> + </para> + </section> + + <section id="secAPI_get_channel_info"> + <title>get_channel_info</title> + + <para> + Prototype: + <command> + t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, + char *server) + </command> + </para> + <para> + Return list of IRC channels for a server. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal server name + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: linked list of IRC channels for server. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry>0 for a channel, 1 for a private</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>name</literal></entry> + <entry>name of channel</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>topic</literal></entry> + <entry>topic of channel</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>modes</literal></entry> + <entry>channel modes</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>limit</literal></entry> + <entry>user limit</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>key</literal></entry> + <entry>channel key</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>nicks_count</literal></entry> + <entry>number of nicks on channel</entry> + </row> + <row> + <entry>t_plugin_channel_info *</entry> + <entry><literal>prev_channel</literal></entry> + <entry>pointer to previous channel info</entry> + </row> + <row> + <entry>t_plugin_channel_info *</entry> + <entry><literal>next_channel</literal></entry> + <entry>pointer to next channel info</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_channel_info" + function after use. + </para> + <para> + Example: +<screen> +t_plugin_channel_info *channel_info, *ptr_chan_info; +channel_info = plugin->get_channel_info (plugin, "freenode"); +if (channel_info) +{ + for (ptr_chan_info = channel_info; ptr_chan_info; + ptr_chan_info = ptr_chan_info->next_channel) + { + plugin->print (plugin, NULL, NULL, + " %s (type %d)", + ptr_chan_info->name, + ptr_chan_info->type); + } + plugin->free_channel_info (plugin, channel_info); +} +</screen> + </para> + </section> + + <section id="secAPI_free_channel_info"> + <title>free_channel_info</title> + + <para> + Prototype: + <command> + void free_channel_info (t_weechat_plugin *plugin, + t_plugin_channel_info *channel_info) + </command> + </para> + <para> + Free memory used by channel info list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>channel_info</option>: pointer to channel info list + returned by "get_channel_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_channel_info (plugin, channel_info);</screen> + </para> + </section> + + <section id="secAPI_get_nick_info"> + <title>get_nick_info</title> + + <para> + Prototype: + <command> + t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, + char *server, char *channel) + </command> + </para> + <para> + Return list of nicks for a channel. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal server name + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: channel name + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: linked list of nicks on channel. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>nick name</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>host</literal></entry> + <entry>hostname</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>flags</literal></entry> + <entry> + nick flags, binary "or" between values (1 = channel + owner, 2 = channel admin, 4 = op, 8 = halfop, + 16 = voice, 32 = away) + </entry> + </row> + <row> + <entry>t_plugin_nick_info *</entry> + <entry><literal>prev_nick</literal></entry> + <entry>pointer to previous nick info</entry> + </row> + <row> + <entry>t_plugin_nick_info *</entry> + <entry><literal>next_nick</literal></entry> + <entry>pointer to next nick info</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_nick_info" + function after use. + </para> + <para> + Example: +<screen> +t_plugin_nick_info *nick_info, *ptr_nick_info; +nick_info = plugin->get_nick_info (plugin, "freenode", "#weechat"); +if (nick_info) +{ + for (ptr_nick_info = nick_info; ptr_nick_info; + ptr_nick_info = ptr_nick_info->next_nick) + { + plugin->print (plugin, NULL, NULL, + " %s (flags: %d)", + ptr_nick_info->nick, + ptr_nick_info->flags); + } + plugin->free_nick_info (plugin, nick_info); +} +</screen> + </para> + </section> + + <section id="secAPI_free_nick_info"> + <title>free_nick_info</title> + + <para> + Prototype: + <command> + void free_nick_info (t_weechat_plugin *plugin, + t_plugin_nick_info *nick_info) + </command> + </para> + <para> + Free memory used by nick info list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>nick_info</option>: pointer to nick info list + returned by "get_nick_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_nick_info (plugin, nick_info);</screen> + </para> + </section> + + <section id="secAPI_get_config"> + <title>get_config</title> + + <para> + Prototype: + <command> + char *get_config (t_weechat_plugin *plugin, char *option) + </command> + </para> + <para> + Return value of a WeeChat config option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>option</option>: name of option to read + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: option value, NULL if not found. + </para> + <para> + Note: result has to be free by a call to "free" function after + use. + </para> + <para> + Examples: +<screen> +char *value1 = plugin->get_config (plugin, "look_set_title"); +char *value2 = plugin->get_config (plugin, "freenode.server_autojoin"); +</screen> + </para> + </section> + + <section id="secAPI_set_config"> + <title>set_config</title> + + <para> + Prototype: + <command> + int set_config (t_weechat_plugin *plugin, + char *option, char *value) + </command> + </para> + <para> + Update value of a WeeChat config option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>option</option>: name of option to update + </para> + </listitem> + <listitem> + <para> + <option>value</option>: new value for option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if option was successfully updated, 0 if an + error occurred. + </para> + <para> + Example: +<screen> +plugin->set_config (plugin, "look_nicklist", "off"); +</screen> + </para> + </section> + + <section id="secAPI_get_plugin_config"> + <title>get_plugin_config</title> + + <para> + Prototype: + <command> + char *get_plugin_config (t_weechat_plugin *plugin, char *option) + </command> + </para> + <para> + Return value of a plugin option. + Option is read from file "<literal>~/.weechat/plugins.rc</literal>" + and is like: "<literal>plugin.option=value</literal>" + (note: plugin name is automatically added). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>option</option>: name of option to read + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: option value, NULL if not found. + </para> + <para> + Note: result has to be free by a call to "free" function after + use. + </para> + <para> + Example: +<screen> +char *value = plugin->get_plugin_config (plugin, "my_var"); +</screen> + </para> + </section> + + <section id="secAPI_set_plugin_config"> + <title>set_plugin_config</title> + + <para> + Prototype: + <command> + int set_plugin_config (t_weechat_plugin *plugin, + char *option, char *value) + </command> + </para> + <para> + Update value of a plugin option. + Option is written in file "<literal>~/.weechat/plugins.rc</literal>" + and is like: "<literal>plugin.option=value</literal>" + (note: plugin name is automatically added). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>option</option>: name of option to update + </para> + </listitem> + <listitem> + <para> + <option>value</option>: new value for option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if option was successfully updated, 0 if an + error occurred. + </para> + <para> + Example: +<screen> +plugin->set_plugin_config (plugin, "my_var", "value"); +</screen> + </para> + </section> + + <section id="secAPI_get_irc_color"> + <title>get_irc_color</title> + + <para> + Prototype: + <command> + int get_irc_color (t_weechat_plugin *plugin, + char *color_name) + </command> + </para> + <para> + Get IRC color index with name. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>color_name</option>: color name + Allowed colors are: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Color name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>white</entry> + <entry>0</entry> + </row> + <row> + <entry>black</entry> + <entry>1</entry> + </row> + <row> + <entry>blue</entry> + <entry>2</entry> + </row> + <row> + <entry>green</entry> + <entry>3</entry> + </row> + <row> + <entry>lightred</entry> + <entry>4</entry> + </row> + <row> + <entry>red</entry> + <entry>5</entry> + </row> + <row> + <entry>magenta</entry> + <entry>6</entry> + </row> + <row> + <entry>brown</entry> + <entry>7</entry> + </row> + <row> + <entry>yellow</entry> + <entry>8</entry> + </row> + <row> + <entry>lightgreen</entry> + <entry>9</entry> + </row> + <row> + <entry>cyan</entry> + <entry>10</entry> + </row> + <row> + <entry>lightcyan</entry> + <entry>11</entry> + </row> + <row> + <entry>lightblue</entry> + <entry>12</entry> + </row> + <row> + <entry>lightmagenta</entry> + <entry>13</entry> + </row> + <row> + <entry>gray</entry> + <entry>14</entry> + </row> + <row> + <entry>lightgray</entry> + <entry>15</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: IRC color index, -1 if color is not found. + </para> + <para> + Example: +<screen> +int color_blue = plugin->get_irc_color (plugin, "blue"); /* return 2 */ +</screen> + </para> + </section> + + <section id="secAPI_input_color"> + <title>input_color</title> + + <para> + Prototype: + <command> + void input_color (t_weechat_plugin *plugin, + int color, int start, int length) + </command> + </para> + <para> + Add color in input buffer. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>color</option>: color for text (if < 0, then input + buffer is refresh, and there's no change in input buffer + content) + </para> + </listitem> + <listitem> + <para> + <option>start</option>: start position for color (if < 0, + then mask is reinitialized) + </para> + </listitem> + <listitem> + <para> + <option>length</option>: length for color (if <= 0, + then mask is reinitialized) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: +<screen> +plugin->input_color (plugin, plugin->get_irc_color (plugin, "blue"), 10, 5); +</screen> + </para> + </section> + + <section id="secAPI_get_window_info"> + <title>get_window_info</title> + + <para> + Prototype: + <command> + t_plugin_window_info *get_window_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Return list of WeeChat windows. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: linked list of WeeChat windows. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>win_x</literal></entry> + <entry>horizontal position of window</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_y</literal></entry> + <entry>vertical position of window</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_width</literal></entry> + <entry>width of window</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_height</literal></entry> + <entry>height of window</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_width_pct</literal></entry> + <entry>width % (compared to parent window)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_height_pct</literal></entry> + <entry>height % (compared to parent window)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>num_buffer</literal></entry> + <entry>number of displayed buffer</entry> + </row> + <row> + <entry>t_plugin_window_info *</entry> + <entry><literal>prev_window</literal></entry> + <entry>pointer to previous window info</entry> + </row> + <row> + <entry>t_plugin_window_info *</entry> + <entry><literal>next_window</literal></entry> + <entry>pointer to next window info</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_window_info" + function after use. + </para> + <para> + Example: +<screen> +t_plugin_window_info *window_info, *ptr_window; + +window_info = plugin->get_window_info (plugin); +if (window_info) +{ + for (ptr_window = window_info; ptr_window; ptr_window = ptr_window->next_window) + { + plugin->print (plugin, NULL, NULL, "window info"); + plugin->print (plugin, NULL, NULL, "(%d,%d), size: %dx%d, %%size: %d%%x%d%%", + ptr_window->win_x, ptr_window->win_y, + ptr_window->win_width, ptr_window->win_height, + ptr_window->win_width_pct, ptr_window->win_height_pct); + plugin->print (plugin, NULL, NULL, "num_buffer: %d", ptr_window->num_buffer); + } + plugin->free_window_info (plugin, window_info); +} +else + plugin->print (plugin, NULL, NULL, "no window info!"); +</screen> + </para> + </section> + + <section id="secAPI_free_window_info"> + <title>free_window_info</title> + + <para> + Prototype: + <command> + void free_window_info (t_weechat_plugin *plugin, + t_plugin_window_info *window_info) + </command> + </para> + <para> + Free memory used by window info list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>window_info</option>: pointer to window info list + returned by "get_window_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_window_info (plugin, window_info);</screen> + </para> + </section> + + <section id="secAPI_get_buffer_info"> + <title>get_buffer_info</title> + + <para> + Prototype: + <command> + t_plugin_buffer_info *get_buffer_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Return list of WeeChat buffers. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: linked list of WeeChat buffers. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry>buffer type: 0=standard, 1=DCC, 2=raw IRC data</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>number</literal></entry> + <entry>buffer number</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>num_displayed</literal></entry> + <entry>number of windows displaying buffer</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>server_name</literal></entry> + <entry>server name for buffer (may be NULL)</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>channel_name</literal></entry> + <entry>channel name for buffer (may be NULL)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>notify_level</literal></entry> + <entry>notify level for buffer</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>log_filename</literal></entry> + <entry>log filename (NULL means not logging)</entry> + </row> + <row> + <entry>t_plugin_buffer_info *</entry> + <entry><literal>prev_buffer</literal></entry> + <entry>pointer to previous buffer info</entry> + </row> + <row> + <entry>t_plugin_buffer_info *</entry> + <entry><literal>next_buffer</literal></entry> + <entry>pointer to next buffer info</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_buffer_info" + function after use. + </para> + <para> + Example: +<screen> +t_plugin_buffer_info *buffer_info, *ptr_buffer; + +buffer_info = plugin->get_buffer_info (plugin); +if (buffer_info) +{ + for (ptr_buffer = buffer_info; ptr_buffer; ptr_buffer = ptr_buffer->next_buffer) + { + plugin->print (plugin, NULL, NULL, "buffer info"); + plugin->print (plugin, NULL, NULL, "type: %d", ptr_buffer->type); + plugin->print (plugin, NULL, NULL, "number: %d", ptr_buffer->number); + plugin->print (plugin, NULL, NULL, "num_displayed: %d", ptr_buffer->num_displayed); + plugin->print (plugin, NULL, NULL, "server: %s", ptr_buffer->server_name); + plugin->print (plugin, NULL, NULL, "channel: %s", ptr_buffer->channel_name); + plugin->print (plugin, NULL, NULL, "notify level: %d", ptr_buffer->notify_level); + plugin->print (plugin, NULL, NULL, "log filename: %s", ptr_buffer->log_filename); + } + plugin->free_buffer_info (plugin, buffer_info); +} +else + plugin->print (plugin, NULL, NULL, "no buffer info!"); +</screen> + </para> + </section> + + <section id="secAPI_free_buffer_info"> + <title>free_buffer_info</title> + + <para> + Prototype: + <command> + void free_buffer_info (t_weechat_plugin *plugin, + t_plugin_buffer_info *buffer_info) + </command> + </para> + <para> + Free memory used by buffer info list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>buffer_info</option>: pointer to buffer info list + returned by "get_buffer_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_buffer_info (plugin, buffer_info);</screen> + </para> + </section> + + <section id="secAPI_get_buffer_data"> + <title>get_buffer_data</title> + + <para> + Prototype: + <command> + t_plugin_buffer_data *get_buffer_info (t_weechat_plugin *plugin, + char *server, char *channel) + </command> + </para> + <para> + Return content of buffer. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: channel name + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: buffer content (linked list of lines). + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Field</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>time_t</entry> + <entry><literal>date</literal></entry> + <entry>date and time</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>nick</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>data</literal></entry> + <entry>line content (color codes are removed)</entry> + </row> + <row> + <entry>t_plugin_buffer_line *</entry> + <entry><literal>prev_line</literal></entry> + <entry>pointer to previous line</entry> + </row> + <row> + <entry>t_plugin_buffer_line *</entry> + <entry><literal>next_line</literal></entry> + <entry>pointer to next line</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note: result has to be free by a call to "free_buffer_data" + function after use. + </para> + <para> + Example: +<screen> +t_plugin_buffer_line *buffer_line, *ptr_line; +char text_time[256]; + +buffer_line = plugin->get_buffer_data (plugin); +if (buffer_line) +{ + for (ptr_line = buffer_line; ptr_line; ptr_line = ptr_line->next_line) + { + strftime (text_time, sizeof (text_time), "%x %X", localtime (&(ptr_line->date))); + plugin->print (plugin, NULL, NULL, "date: %s, nick: %s, data: %s", + text_time, ptr_line->nick, ptr_line->data); + } + plugin->free_buffer_data (plugin, buffer_line); +} +</screen> + </para> + </section> + + <section id="secAPI_free_buffer_data"> + <title>free_buffer_data</title> + + <para> + Prototype: + <command> + void free_buffer_data (t_weechat_plugin *plugin, + t_plugin_buffer_line *buffer_line) + </command> + </para> + <para> + Free memory used by buffer line list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: pointer to plugin structure + </para> + </listitem> + <listitem> + <para> + <option>buffer_line</option>: pointer to buffer line list + returned by "get_buffer_data" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: none. + </para> + <para> + Example: + <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> + </para> + </section> + + --> + +</section> diff --git a/doc/en/dev/plugin_scripts.en.xml b/doc/en/dev/plugin_scripts.en.xml new file mode 100644 index 000000000..a4aa2ea7a --- /dev/null +++ b/doc/en/dev/plugin_scripts.en.xml @@ -0,0 +1,2849 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +WeeChat documentation (english version) + +Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org> + +This manual is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +This manual is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. + +--> + +<section id="secScriptsPlugins"> + <title>Scripts plugins</title> + + <para> + Four plugins are provided with WeeChat to use script languages: + Perl, Python, Ruby and Lua. + </para> + + <section id="secLoadUnloadScripts"> + <title>Load / unload scripts</title> + + <para> + Scripts are loaded and unloaded with <command>/perl</command>, + <command>/python</command>, <command>/ruby</command> and + <command>/lua</command> commands + (type <command>/help</command> in WeeChat for help about commands). + </para> + + <para> + Examples: + <itemizedlist> + <listitem> + <para> + Load a Perl script: + <command><userinput>/perl load /tmp/test.pl</userinput></command> + </para> + </listitem> + <listitem> + <para> + List all loaded Perl scripts: + <command><userinput>/perl</userinput></command> + </para> + </listitem> + <listitem> + <para> + Load a Python script: + <command><userinput>/python load /tmp/test.py</userinput></command> + </para> + </listitem> + <listitem> + <para> + List all loaded Python scripts: + <command><userinput>/python</userinput></command> + </para> + </listitem> + <listitem> + <para> + Load a Ruby script: + <command><userinput>/ruby load /tmp/test.rb</userinput></command> + </para> + </listitem> + <listitem> + <para> + List all loaded Ruby scripts: + <command><userinput>/ruby</userinput></command> + </para> + </listitem> + <listitem> + <para> + Load a Lua script: + <command><userinput>/lua load /tmp/test.lua</userinput></command> + </para> + </listitem> + <listitem> + <para> + List all loaded Lua scripts: + <command><userinput>/lua</userinput></command> + </para> + </listitem> + </itemizedlist> + </para> + + </section> + + <section id="secSyntaxByLanguage"> + <title>Syntax by language</title> + + <section id="secScriptPerl"> + <title>Perl</title> + + <para> + In a WeeChat Perl script, all API functions and variables are + prefixed by "<literal>weechat::</literal>". + Example: +<screen>weechat::register("test", "1.0", "end_test", "WeeChat perl script");</screen> + </para> + + </section> + + <section id="secScriptPython"> + <title>Python</title> + + <para> + A WeeChat Python script has to start by importing weechat: + <screen>import weechat</screen> + </para> + + <para> + All API functions and variables are prefixed by + "<literal>weechat.</literal>". + Example: +<screen>weechat.register("test", "1.0", "end_test", "WeeChat python script")</screen> + </para> + + </section> + + <section id="secScriptRuby"> + <title>Ruby</title> + + <para> + In a WeeChat Ruby script, all code has to be in functions. + So for main code, you have to define a + "<literal>weechat_init</literal>" function, which is automatically + called when script is loaded by WeeChat. Example: +<screen> +def weechat_init + Weechat.register("test", "1.0", "end_test", "WeeChat ruby script") + Weechat.add_command_handler("command", "my_command") + return Weechat::PLUGIN_RC_OK +end + +def my_command(server, args) + Weechat.print("my command") + return Weechat::PLUGIN_RC_OK +end +</screen> + </para> + + <para> + All API functions are prefixed by + "<literal>Weechat.</literal>" and variables by + "<literal>Weechat::</literal>". + </para> + + </section> + + <section id="secScriptLua"> + <title>Lua</title> + + <para> + In a WeeChat Lua script, all API functions are prefixed by + "<literal>weechat.</literal>". + Variables are prefixed by "<literal>weechat.</literal>" and + suffixed by "<literal>()</literal>". + Example: +<screen> +function message_handler(server, args) + weechat.print("I am a message handler") + return weechat.PLUGIN_RC_OK() +end +</screen> + </para> + + </section> + + </section> + + <section id="secWeeChatScriptsAPI"> + <title>WeeChat / scripts API</title> + + <section id="secScript_register"> + <title>register</title> + + <para> + Perl prototype: + <command> + weechat::register(name, version, end_function, description, + [charset]); + </command> + </para> + <para> + Python prototype: + <command> + weechat.register(name, version, end_function, description, + [charset]) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.register(name, version, end_function, description, + [charset]) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.register(name, version, end_function, description, + [charset]) + </command> + </para> + <para> + This is first function to call in script. + All WeeChat scripts have to call this function. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>name</option>: unique name to identify script + (each script must have unique name) + </para> + </listitem> + <listitem> + <para> + <option>version</option>: script version + </para> + </listitem> + <listitem> + <para> + <option>end_function</option>: function called when script is + unloaded (optional parameter, empty string means nothing is + called at the end) + </para> + </listitem> + <listitem> + <para> + <option>description</option>: short description of script + </para> + </listitem> + <listitem> + <para> + <option>charset</option>: charset used by script, you should + set this if script is not written with UTF-8 + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if script was registered, 0 if an error occured. + </para> + <para> + Examples: +<screen> +# perl +weechat::register("test", "1.0", "end_test", "Test script!", "ISO-8859-1"); + +# python +weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") + +# ruby +Weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") + +-- lua +weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") +</screen> + </para> + </section> + + <section id="secScript_set_charset"> + <title>set_charset</title> + + <para> + Perl prototype: + <command> + weechat::set_charset(charset); + </command> + </para> + <para> + Python prototype: + <command> + weechat.set_charset(charset) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.set_charset(charset) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.set_charset(charset) + </command> + </para> + <para> + Set new script charset. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>charset</option>: new script charset + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if new charset was set, 0 if an error occured. + </para> + <para> + Examples: +<screen> +# perl +weechat::set_charset("ISO-8859-1"); + +# python +weechat.set_charset("ISO-8859-1") + +# ruby +Weechat.set_charset("ISO-8859-1") + +-- lua +weechat.set_charset("ISO-8859-1") +</screen> + </para> + </section> + + <section id="secScript_print"> + <title>print</title> + + <para> + Perl prototype: + <command> + weechat::print(message, [channel, [server]]) + </command> + </para> + <para> + Python prototype: + <command> + weechat.prnt(message, [channel, [server]]) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.print(message, [channel, [server]]) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.print(message, [channel, [server]]) + </command> + </para> + <para> + Display a message on a WeeChat buffer, identified by server + and channel. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>message</option>: message + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: name of channel to find buffer + for message display + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server to find + buffer for message display + </para> + </listitem> + </itemizedlist> + </para> + <para> + To display colored text, see <xref linkend="secAPI_print" />. + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::print("message"); +weechat::print("message", "#weechat"); +weechat::print("message", "#weechat", "freenode"); +weechat::print("test: \x0305 red \x0F normal"); + +# python +weechat.prnt("message") +weechat.prnt("message", "#weechat") +weechat.prnt("message", "#weechat", "freenode") + +# ruby +Weechat.print("message") +Weechat.print("message", "#weechat") +Weechat.print("message", "#weechat", "freenode") + +-- lua +weechat.print("message") +weechat.print("message", "#weechat") +weechat.print("message", "#weechat", "freenode") +</screen> + </para> + </section> + + <section id="secScript_print_server"> + <title>print_server</title> + + <para> + Perl prototype: + <command> + weechat::print_server(message) + </command> + </para> + <para> + Python prototype: + <command> + weechat.print_server(message) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.print_server(message) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.print_server(message) + </command> + </para> + <para> + Display a message on server buffer. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>message</option>: message + </para> + </listitem> + </itemizedlist> + </para> + <para> + To display colored text, see <xref linkend="secAPI_print" />. + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::print_server("message"); +weechat::print_server("test: \x0305 red \x0F normal"); + +# python +weechat.print_server("message") + +# ruby +Weechat.print_server("message") + +-- lua +weechat.print_server("message") +</screen> + </para> + </section> + + <section id="secScript_log"> + <title>log</title> + + <para> + Perl prototype: + <command> + weechat::log(message, [channel, [server]]); + </command> + </para> + <para> + Python prototype: + <command> + weechat.log(message, [channel, [server]]) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.log(message, [channel, [server]]) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.log(message, [channel, [server]]) + </command> + </para> + <para> + Write a message in log file for a server or a channel. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>message</option>: message + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: name of channel to find buffer + for log + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server to find + buffer for log + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::log("message", "#weechat", "freenode"); + +# python +weechat.log("message", "#weechat", "freenode") + +# ruby +Weechat.log("message", "#weechat", "freenode") + +-- lua +weechat.log("message", "#weechat", "freenode") +</screen> + </para> + </section> + + <section id="secScript_add_message_handler"> + <title>add_message_handler</title> + + <para> + Perl prototype: + <command> + weechat::add_message_handler(message, function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.add_message_handler(message, function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.add_message_handler(message, function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.add_message_handler(message, function) + </command> + </para> + <para> + Add an IRC message handler, called when an IRC message is + received. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>message</option>: name of IRC message. To know list + of IRC messages, please consult <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + and + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. + Moreover you can use a special name, prefixed by "weechat_" + to catch special events (see + <xref linkend="secAPI_msg_handler_add" />). + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called when message is + received + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::add_message_handler ("privmsg", "my_function"); +sub my_function +{ + weechat::print("server=$_[0]"); + ($null, $channel, $message) = split ":",$_[1],3; + ($mask, $null, $channel) = split " ", $channel; + weechat::print("mask=$mask, channel=$channel, msg=$message"); + return weechat::PLUGIN_RC_OK; +} + +# python +weechat.add_message_handler ("privmsg", "my_function") +def my_function(server, args): + weechat.prnt("server="+server) + null, channel, message = string.split(args, ":", 2) + mask, null, channel = string.split(string.strip(channel), " ", 2) + weechat.prnt("mask="+mask+", canal="+channel+", message="+message) + return weechat.PLUGIN_RC_OK + +# ruby +Weechat.add_message_handler("privmsg", "my_function") +def my_function(server, args) + Weechat.print("server=#{server}, args=#{args}") + return Weechat::PLUGIN_RC_OK +end + +-- lua +weechat.add_message_handler ("privmsg", "my_function") +function my_function(server, args) + weechat.print("server=" .. server .. ", args=" .. args) + return weechat.PLUGIN_RC_OK() +end +</screen> + </para> + <para> + Note: function called when message is received has to return + one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: message + will not be sent to WeeChat + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: message + will not be sent to other plugins + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: message + will not be sent to WeeChat neither other plugins + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: function + successfully completed and make "highlight" on received + message + </para> + </listitem> + </itemizedlist> + </para> + </section> + + <section id="secScript_add_command_handler"> + <title>add_command_handler</title> + + <para> + Perl prototype: + <command> + weechat::add_command_handler(command, function, + [description, arguments, arguments_description, + completion_template]); + </command> + </para> + <para> + Python prototype: + <command> + weechat.add_command_handler(command, function, + [description, arguments, arguments_description, + completion_template]) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.add_command_handler(command, function, + [description, arguments, arguments_description, + completion_template]) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.add_command_handler(command, function, + [description, arguments, arguments_description, + completion_template]) + </command> + </para> + <para> + Add a WeeChat command handler, called when user uses command + (for example /command). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>command</option>: the new command name, which + may be an existing command (be careful, replaced command + will not be available until script is unloaded) + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called when command + is executed + </para> + </listitem> + <listitem> + <para> + <option>arguments</option>: short description of command + arguments (displayed by /help command) + </para> + </listitem> + <listitem> + <para> + <option>arguments_description</option>: long description + of command arguments (displayed by /help command) + </para> + </listitem> + <listitem> + <para> + <option>completion_template</option>: template for + completion, like "<literal>abc|%w def|%i</literal>" which + means "abc" or a WeeChat command for first argument, + "def" or IRC command for second. + (see <xref linkend="secAPI_cmd_handler_add" />) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::add_command_handler("command", "my_command"); +sub my_command +{ + weechat::print("server= $_[0], args: $_[1]"); + return weechat::PLUGIN_RC_OK; +} + +# python +weechat.add_command_handler("command", "my_command") +def my_command(server, args): + weechat.prnt("server="+server+", args="+args) + return weechat.PLUGIN_RC_OK + +# ruby +Weechat.add_command_handler("command", "my_command") +def my_command(server, args) + Weechat.print("server=#{server}, args=#{args}") + return Weechat::PLUGIN_RC_OK +end + +-- lua +weechat.add_command_handler("command", "my_command") +def my_command(server, args) + weechat.print("server="..server..", args="..args) + return weechat.PLUGIN_RC_OK() +end +</screen> + </para> + <para> + Notes: function called when command is executed has to return + one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal> : function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal> : function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + </section> + + <section id="secScript_add_timer_handler"> + <title>add_timer_handler</title> + + <para> + Perl prototype: + <command> + weechat::add_timer_handler(interval, function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.add_timer_handler(interval, function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.add_timer_handler(interval, function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.add_timer_handler(interval, function) + </command> + </para> + <para> + Add a timer handler which periodically calls a function. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>interval</option>: interval (in seconds) between + two calls of function. + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::add_timer_handler(60, "my_timer"); +sub my_timer +{ + weechat::print("this is timer handler"); + return weechat::PLUGIN_RC_OK; +} + +# python +weechat.add_timer_handler(60, "my_timer") +def my_timer(): + weechat.prnt("this is timer handler") + return weechat.PLUGIN_RC_OK + +# ruby +Weechat.add_timer_handler(60, "my_timer") +def my_timer() + Weechat.print("this is timer handler") + return Weechat::PLUGIN_RC_OK +end + +-- lua +weechat.add_timer_handler(60, "my_timer") +function my_timer() + weechat.print("this is timer handler") + return weechat.PLUGIN_RC_OK() +end +</screen> + </para> + <para> + Note: function called has to return one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + </section> + + <section id="secScript_add_keyboard_handler"> + <title>add_keyboard_handler</title> + + <para> + Perl prototype: + <command> + weechat::add_keyboard_handler(function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.add_keyboard_handler(function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.add_keyboard_handler(function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.add_keyboard_handler(function) + </command> + </para> + <para> + Add a keyboard handler, called for any key pressed. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>function</option>: function called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::add_keyboard_handler("my_keyboard"); +sub my_keyboard +{ + my $key = shift; + my $input_before = shift; + my $input_after = shift; + weechat::print("keyboard handler: key = '$key', " + ."input before = '$input_before' " + ."after = '$input_after'"); + return weechat::PLUGIN_RC_OK; +} + +# python +weechat.add_keyboard_handler("my_keyboard") +def my_keyboard(key, input_before, input_after): + weechat.prnt("keyboard handler: key = '%s', " \ + "input before = '%s' after = '%s'" + %(key, input_before, input_after)) + return weechat.PLUGIN_RC_OK + +# ruby +Weechat.add_keyboard_handler("my_keyboard") +def my_keyboard(key, input_before, input_after) + Weechat.print("keyboard handler: key = '#{key}', " \ + "input before = '#{input_before}' " \ + "after = '#{input_after}'") + return Weechat::PLUGIN_RC_OK +end + +-- lua +weechat.add_keyboard_handler("my_keyboard") +function my_keyboard(key, input_before, input_after) + weechat.print("keyboard handler: key = '"..key.. + "', input before = '"..input_before.. + "' after = '"..input_after.."'") + return weechat.PLUGIN_RC_OK() +end +</screen> + </para> + <para> + Note: function called has to return one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + </section> + + <section id="secScript_add_event_handler"> + <title>add_event_handler</title> + + <para> + Perl prototype: + <command> + weechat::add_event_handler(event, function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.add_event_handler(event, function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.add_event_handler(event, function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.add_event_handler(event, function) + </command> + </para> + <para> + Add an event handler, called when an event happens. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>event</option> : event + (see <xref linkend="secAPI_event_handler_add" />) + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::add_event_handler("buffer_open", "my_event"); +sub my_event +{ + weechat::print("buffer open"); + return weechat::PLUGIN_RC_OK; +} + +# python +weechat.add_event_handler("buffer_open", "my_event") +def my_event(): + weechat.prnt("buffer open") + return weechat.PLUGIN_RC_OK + +# ruby +Weechat.add_event_handler("buffer_open", "my_event") +def my_event() + Weechat.print("buffer open") + return Weechat::PLUGIN_RC_OK +end + +-- lua +weechat.add_event_handler("buffer_open", "my_event") +function my_event() + weechat.print("buffer open") + return weechat.PLUGIN_RC_OK() +end +</screen> + </para> + <para> + Note: function called has to return one of following values: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: function failed + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: function successfully + completed + </para> + </listitem> + </itemizedlist> + </para> + </section> + + <section id="secScript_remove_handler"> + <title>remove_handler</title> + + <para> + Perl prototype: + <command> + weechat::remove_handler(name, function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.remove_handler(name, function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.remove_handler(name, function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.remove_handler(name, function) + </command> + </para> + <para> + Remove a message or command handler. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>name</option>: name of IRC message or command + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::remove_handler("command", "my_command"); + +# python +weechat.remove_handler("command", "my_command") + +# ruby +Weechat.remove_handler("command", "my_command") + +-- lua +weechat.remove_handler("command", "my_command") +</screen> + </para> + </section> + + <section id="secScript_remove_timer_handler"> + <title>remove_timer_handler</title> + + <para> + Perl prototype: + <command> + weechat::remove_timer_handler(function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.remove_timer_handler(function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.remove_timer_handler(function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.remove_timer_handler(function) + </command> + </para> + <para> + Remove a timer handler. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>function</option>: function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::remove_timer_handler("my_timer"); + +# python +weechat.remove_timer_handler("my_timer") + +# ruby +Weechat.remove_timer_handler("my_timer") + +-- lua +weechat.remove_timer_handler("my_timer") +</screen> + </para> + </section> + + <section id="secScrip_remove_keyboard_handler"> + <title>remove_keyboard_handler</title> + + <para> + Perl prototype: + <command> + weechat::remove_keyboard_handler(function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.remove_keyboard_handler(function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.remove_keyboard_handler(function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.remove_keyboard_handler(function) + </command> + </para> + <para> + Remove a keyboard handler. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>function</option>: function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::remove_keyboard_handler("my_keyboard"); + +# python +weechat.remove_keyboard_handler("my_keyboard") + +# ruby +Weechat.remove_keyboard_handler("my_keyboard") + +-- lua +weechat.remove_keyboard_handler("my_keyboard") +</screen> + </para> + </section> + + <section id="secScrip_remove_event_handler"> + <title>remove_event_handler</title> + + <para> + Perl prototype: + <command> + weechat::remove_event_handler(function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.remove_event_handler(function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.remove_event_handler(function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.remove_event_handler(function) + </command> + </para> + <para> + Remove an event handler. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>function</option>: function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::remove_event_handler("my_event"); + +# python +weechat.remove_event_handler("my_event") + +# ruby +Weechat.remove_event_handler("my_event") + +-- lua +weechat.remove_event_handler("my_event") +</screen> + </para> + </section> + + <section id="secScript_add_modifier"> + <title>add_modifier</title> + + <para> + Perl prototype: + <command> + weechat::add_modifier(type, message, function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.add_modifier(type, message, function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.add_modifier(type, message, function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.add_modifier(type, message, function) + </command> + </para> + <para> + Add a message modifier. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>type</option>: modifier type: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>irc_in</literal></entry> + <entry>called for incoming IRC messages</entry> + </row> + <row> + <entry><literal>irc_user</literal></entry> + <entry> + called for each user message (or command) (before + WeeChat parses message) + </entry> + </row> + <row> + <entry><literal>irc_out</literal></entry> + <entry> + called for outgoing messages, immediately before + sending it to IRC server (this includes messages + sent automatically by WeeChat to server) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>message</option>: name of IRC message (used only for + types "irc_in" and "irc_out"). + To know list of IRC messages, please consult + <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + and + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. + Moreover, special value "*" means all messages (no filter). + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function called + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::add_modifier("irc_in", "privmsg", "mod_in"); +weechat::add_modifier("irc_out", "privmsg", "mod_out"); +sub mod_in +{ + return "$_[1] [modifier IN]"; +} +sub mod_out +{ + return "$_[1] [modifier OUT]"; +} + +# python +weechat.add_modifier("irc_in", "privmsg", "mod_in") +weechat.add_modifier("irc_out", "privmsg", "mod_out") +def mod_in(serveur, args): + return args + " [modifier IN]" +def mod_out(serveur, args): + return args + " [modifier OUT]" + +# ruby +Weechat.add_modifier("irc_in", "privmsg", "mod_in") +Weechat.add_modifier("irc_out", "privmsg", "mod_out") +def mod_in(server, args) + return args + " [modifier IN]" +end +def mod_out(server, args) + return args + " [modifier OUT]" +end + +-- lua +weechat.add_modifier("irc_in", "privmsg", "mod_in") +weechat.add_modifier("irc_out", "privmsg", "mod_out") +function mod_in(server, args) + return args .. " [modifier IN]" +end +function mod_out(server, args) + return args .. " [modifier OUT]" +end +</screen> + </para> + </section> + + <section id="secScript_remove_modifier"> + <title>remove_modifier</title> + + <para> + Perl prototype: + <command> + weechat::remove_modifier(type, message, function); + </command> + </para> + <para> + Python prototype: + <command> + weechat.remove_modifier(type, message, function) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.remove_modifier(type, message, function) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.remove_modifier(type, message, function) + </command> + </para> + <para> + Remove a message modifier. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>type</option>: modifier type + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message managed by modifier + </para> + </listitem> + <listitem> + <para> + <option>function</option>: function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::remove_modifier("irc_in", "privmsg", "mod_in"); + +# python +weechat.remove_modifier("irc_in", "privmsg", "mod_in") + +# ruby +Weechat.remove_modifier("irc_in", "privmsg", "mod_in") + +-- lua +weechat.remove_modifier("irc_in", "privmsg", "mod_in") +</screen> + </para> + </section> + + <section id="secScript_command"> + <title>command</title> + + <para> + Perl prototype: + <command> + weechat::command(command, [channel, [server]]); + </command> + </para> + <para> + Python prototype: + <command> + weechat.command(command, [channel, [server]]) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.command(command, [channel, [server]]) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.command(command, [channel, [server]]) + </command> + </para> + <para> + Execute a WeeChat command (or send a message to a channel). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>command</option>: command + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: name of channel for executing + command + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server for + executing command + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if success, 0 if an error occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::command("hello everybody!"); +weechat::command("/kick toto please leave this channel", "#weechat"); +weechat::command("/nick newnick", "", "freenode"); + +# python +weechat.command("hello everybody!") +weechat.command("/kick toto please leave this channel", "#weechat") +weechat.command("/nick newnick", "", "freenode") + +# ruby +Weechat.command("hello everybody!") +Weechat.command("/kick toto please leave this channel", "#weechat") +Weechat.command("/nick newnick", "", "freenode") + +-- lua +weechat.command("hello everybody!") +weechat.command("/kick toto please leave this channel", "#weechat") +weechat.command("/nick newnick", "", "freenode") +</screen> + </para> + </section> + + <section id="secScript_get_info"> + <title>get_info</title> + + <para> + Perl prototype: + <command> + weechat::get_info(name, [server]); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_info(name, [server]) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_info(name, [server]) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_info(name, [server]) + </command> + </para> + <para> + Return an info about WeeChat or a channel. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>name</option>: name of info to read + (see <xref linkend="secAPI_get_info" />) + </para> + </listitem> + <listitem> + <para> + <option>server</option>: internal name of server for + reading info (if needed) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: information asked, empty string if an error + occurred. + </para> + <para> + Examples: +<screen> +# perl +$version = get_info("version"); +$nick = get_info("nick", "freenode"); + +# python +version = weechat.get_info("version") +nick = weechat.get_info("nick", "freenode") + +# ruby +version = Weechat.get_info("version") +nick = Weechat.get_info("nick", "freenode") + +-- lua +version = weechat.get_info("version") +nick = weechat.get_info("nick", "freenode") +</screen> + </para> + </section> + + <section id="secScript_get_dcc_info"> + <title>get_dcc_info</title> + + <para> + Perl prototype: + <command> + weechat::get_dcc_info(); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_dcc_info() + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_dcc_info() + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_dcc_info() + </command> + </para> + <para> + Return list of DCC currently active or finished. + </para> + <para> + Return value: list of DCC + (see <xref linkend="secAPI_get_dcc_info" />). + </para> + <para> + Examples: +<screen> +# perl +my @dccs = weechat::get_dcc_info(); +if (@dccs) +{ + foreach my $dcc (@dccs) + { + while (my ($key, $value) = each %$dcc) + { + weechat::print("$key = '$value'"); + } + } +} +else +{ + weechat::print("no DCC"); +} + +# python +dccs = weechat.get_dcc_info() +if dccs != None: + if dccs == []: + weechat.prnt("no DCC") + else: + for d in dccs: + for b in d.keys(): + weechat.prnt("%s = '%s'" %(b, d[b])) +else: + weechat.prnt("error while getting DCC") + +# ruby +dccs = Weechat.get_dcc_info() +if dccs != nil + if dccs == [] + Weechat.print("no DCC") + else + dccs.each do |m| + m.each do |key, value| + Weechat.print("#{key} = '#{value}'") + end + end + end +else + Weechat.print("error while getting DCC") +end + +-- lua +dccs = weechat.get_dcc_info() +if dccs ~= nil then + if dccs then + dcc, dccinfos = next (dccs, nil) + while (dcc) do + key, value = next (dccinfos, nil) + while (key) do + weechat.print(key.." = '"..value.."'") + key, value = next (dccinfos, key) + end + dcc, dccinfos = next (dccs, dcc) + end + else + weechat.print("no DCC") + end +else + weechat.print("error while getting DCC") +end +</screen> + </para> + </section> + + <section id="secScript_get_server_info"> + <title>get_server_info</title> + + <para> + Perl prototype: + <command> + weechat::get_server_info(); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_server_info() + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_server_info() + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_server_info() + </command> + </para> + <para> + Return list of IRC servers (connected or not). + </para> + <para> + Return value: list of servers + (see <xref linkend="secAPI_get_server_info" />). + </para> + <para> + Examples: +<screen> +# perl +my $servers = weechat::get_server_info(); +if ($servers) +{ + while (my ($srvname, $srvinfos) = each %$servers) + { + while ( my ($key, $value) = each %$srvinfos) + { + weechat::print("$srvname -> $key = '$value'"); + } + } +} +else +{ + weechat::print("no server"); +} + +# python +servers = weechat.get_server_info() +if servers != None: + if servers == {}: + weechat.prnt("no server") + else: + for s in servers: + for i in servers[s]: + weechat.prnt("%s -> %s = '%s'" % (s, i, str(servers[s][i]))) +else: + weechat.prnt("error while getting servers") + +# ruby +servers = Weechat.get_server_info() +if servers != nil + if servers == [] + Weechat.print("no server") + else + servers.each do |n, s| + s.each do |key, value| + Weechat.print("#{n} -> #{key} = '#{value}'") + end + end + end +else + Weechat.print("error while getting servers") +end + +-- lua +servers = weechat.get_server_info() +if servers ~= nil then + if servers then + srv, srvinfos = next (servers, nil) + while (srv) do + key, value = next (srvinfos, nil) + while (key) do + weechat.print(srv.." -> "..key.." = '"..value.."'") + key, value = next (srvinfos, key) + end + srv, srvinfos = next (servers, srv) + end + else + weechat.print("no server") + end +else + weechat.print("error while getting servers") +end +</screen> + </para> + </section> + + <section id="secScript_get_channel_info"> + <title>get_channel_info</title> + + <para> + Perl prototype: + <command> + weechat::get_channel_info(server); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_channel_info(server) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_channel_info(server) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_channel_info(server) + </command> + </para> + <para> + Return list of IRC channels for a server. + </para> + <para> + Return value: list of IRC channels for server + (see <xref linkend="secAPI_get_channel_info" />). + </para> + <para> + Examples: +<screen> +# perl +my $channels = weechat::get_channel_info(weechat::get_info("server")); +if ($channels) +{ + while (my ($channame, $chaninfos) = each %$channels) + { + while (my ($key, $value) = each %$chaninfos) + { + weechat::print("$channame -> $key = '$value'"); + } + } +} +else +{ + weechat::print("no channel"); +} + +# python +chans = weechat.get_channel_info(weechat.get_info("server")) +if chans != None: + if chans == {}: + weechat.prnt("no channel") + else: + for s in chans: + for i in chans[s]: + weechat.prnt("%s -> %s = '%s'" % (s, i, str(chans[s][i]))) +else: + weechat.prnt("error while getting channels") + +# ruby +channels = Weechat.get_channel_info(Weechat.get_info("server")) +if channels != nil + if channels == {} + Weechat.print("no channel") + else + channels.each do |n, c| + c.each do |key, value| + Weechat.print("#{n} -> #{key} = '#{value}'") + end + end + end +else + Weechat.print("error while getting channels") +end + +-- lua +chans = weechat.get_channel_info(weechat.get_info("server")) +if chans ~= nil then + if chans then + chan, chaninfos = next (chans, nil) + while (chan) do + key, value = next (chaninfos, nil) + while (key) do + weechat.print(chan.." -> "..key.." = '"..value.."'") + key, value = next (chaninfos, key) + end + chan, chaninfos = next (chans, chan) + end + else + weechat.print("no channel") + end +else + weechat.print("error while getting channels") +end +</screen> + </para> + </section> + + <section id="secScript_get_nick_info"> + <title>get_nick_info</title> + + <para> + Perl prototype: + <command> + weechat::get_nick_info(server, channel); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_nick_info(server, channel) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_nick_info(server, channel) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_nick_info(server, channel) + </command> + </para> + <para> + Return list of nicks for a channel. + </para> + <para> + Return value: list of nicks on channel + (see <xref linkend="secAPI_get_nick_info" />). + </para> + <para> + Examples: +<screen> +# perl +my $nicks = weechat::get_nick_info("freenode", "#weechat"); +if ($nicks) +{ + while (my ($nickname, $nickinfos) = each %$nicks) + { + while ( my ($key, $value) = each %$nickinfos) + { + weechat::print("$nickname -> $key = '$value'"); + } + } +} +else +{ + weechat::print("no nick"); +} + +# python +nicks = weechat.get_nick_info("freenode", "#weechat") +if nicks != None: + if nicks == {}: + weechat.prnt("no nick") + else: + for n in nicks: + for f in nicks[n]: + weechat.prnt("%s -> %s = '%s'" % (n, f, str(nicks[n][f]))) +else: + weechat.prnt("error while getting nicks") + +# ruby +nicks = Weechat.get_nick_info("freenode", "#weechat") +if nicks != nil + if nicks == {} + Weechat.print("no nick") + else + nicks.each do |nk, nattr| + nattr.each do |key, value| + Weechat.print("#{nk} -> #{key} = '#{value}'") + end + end + end +else + Weechat.print("error while getting nicks") +end + +-- lua +nicks = weechat.get_nick_info("freenode", "#weechat") +if nicks ~= nil then + if nicks then + nick, nickinfos = next (nicks, nil) + while (nick) do + key, value = next (nickinfos, nil) + while (key) do + weechat.print(nick.." -> "..key.." = '"..value.."'") + key, value = next (nickinfos, key) + end + nick, nickinfos = next (nicks, nick) + end + else + weechat.print("no nick") + end +else + weechat.print("error while getting nicks") +end +</screen> + </para> + </section> + + <section id="secScript_get_config"> + <title>get_config</title> + + <para> + Perl prototype: + <command> + weechat::get_config(option); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_config(option) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_config(option) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_config(option) + </command> + </para> + <para> + Return value of a WeeChat config option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: name of option to read + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: option value, empty string if not found. + </para> + <para> + Examples: +<screen> +# perl +$value1 = weechat::get_config("look_nicklist"); +$value2 = weechat::get_config("freenode.server_autojoin"); + +# python +value1 = weechat.get_config("look_nicklist") +value2 = weechat.get_config("freenode.server_autojoin") + +# ruby +value1 = Weechat.get_config("look_nicklist") +value2 = Weechat.get_config("freenode.server_autojoin") + +-- lua +value1 = weechat.get_config("look_nicklist") +value2 = weechat.get_config("freenode.server_autojoin") +</screen> + </para> + </section> + + <section id="secScript_set_config"> + <title>set_config</title> + + <para> + Perl prototype: + <command> + weechat::set_config(option, value); + </command> + </para> + <para> + Python prototype: + <command> + weechat.set_config(option, value) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.set_config(option, value) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.set_config(option, value) + </command> + </para> + <para> + Update value of a WeeChat config option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: name of option to update + </para> + </listitem> + <listitem> + <para> + <option>value</option>: new value for option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if option was successfully updated, 0 if an error + occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::set_config("look_nicklist", "off"); +weechat::set_config("freenode.server_autojoin", "#weechat"); + +# python +weechat.set_config("look_nicklist", "off") +weechat.set_config("freenode.server_autojoin", "#weechat") + +# ruby +Weechat.set_config("look_nicklist", "off") +Weechat.set_config("freenode.server_autojoin", "#weechat") + +-- lua +weechat.set_config("look_nicklist", "off") +weechat.set_config("freenode.server_autojoin", "#weechat") +</screen> + </para> + </section> + + <section id="secScript_get_plugin_config"> + <title>get_plugin_config</title> + + <para> + Perl prototype: + <command> + weechat::get_plugin_config(option); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_plugin_config(option) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_plugin_config(option) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_plugin_config(option) + </command> + </para> + <para> + Return value of a plugin option. Option is read from file + "<literal>~/.weechat/plugins.rc</literal>" and is like: + "<literal>plugin.option=value</literal>" (note: plugin name + is automatically added). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: name of option to read + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: value of option, empty string if not found. + </para> + <para> + Examples : +<screen> +# perl +$value = weechat::get_plugin_config("my_var"); + +# python +value = weechat.get_plugin_config("my_var") + +# ruby +value = Weechat.get_plugin_config("my_var") + +-- lua +value = weechat.get_plugin_config("my_var") +</screen> + </para> + </section> + + <section id="secScript_set_plugin_config"> + <title>set_plugin_config</title> + + <para> + Perl prototype: + <command> + weechat::set_plugin_config(option, value); + </command> + </para> + <para> + Python prototype: + <command> + weechat.set_plugin_config(option, value) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.set_plugin_config(option, value) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.set_plugin_config(option, value) + </command> + </para> + <para> + Update value of a plugin option. Option is written in file + "<literal>~/.weechat/plugins.rc</literal>" and is like: + "<literal>plugin.option=value</literal>" (note: plugin name + is automatically added). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: name of option to update + </para> + </listitem> + <listitem> + <para> + <option>value</option>: new value for option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if option was successfully updated, 0 if an error + occurred. + </para> + <para> + Examples: +<screen> +# perl +weechat::set_plugin_config("my_var", "value"); + +# python +weechat.set_plugin_config("my_var", "value") + +# ruby +Weechat.set_plugin_config("my_var", "value") + +-- lua +weechat.set_plugin_config("my_var", "value") +</screen> + </para> + </section> + + <section id="secScript_get_irc_color"> + <title>get_irc_color</title> + + <para> + Perl prototype: + <command> + weechat::get_irc_color(color); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_irc_color(color) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_irc_color(color) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_irc_color(color) + </command> + </para> + <para> + Return IRC color index with name. + </para> + <para> + Return value: IRC color index, -1 if color is not found + (see <xref linkend="secAPI_get_irc_color" />). + </para> + <para> + Examples: +<screen> +# perl +my $color_blue = weechat::get_irc_color("blue"); + +# python +color_blue = weechat.get_irc_color("blue") + +# ruby +color_blue = Weechat.get_irc_color("blue") + +-- lua +color_blue = weechat.get_irc_color("blue") +</screen> + </para> + </section> + + <section id="secScript_input_color"> + <title>input_color</title> + + <para> + Perl prototype: + <command> + weechat::input_color(color); + </command> + </para> + <para> + Python prototype: + <command> + weechat.input_color(color) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.input_color(color) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.input_color(color) + </command> + </para> + <para> + Add color in input buffer. + </para> + <para> + Return value: none. + </para> + <para> + Examples: +<screen> +# perl +weechat::input_color(weechat::get_irc_color("blue"), 10, 5); + +# python +weechat.input_color(weechat.get_irc_color("blue"), 10, 5) + +# ruby +Weechat.input_color(Weechat.get_irc_color("blue"), 10, 5) + +-- lua +weechat.input_color(weechat.get_irc_color("blue"), 10, 5) +</screen> + </para> + </section> + + <section id="secScript_get_window_info"> + <title>get_window_info</title> + + <para> + Perl prototype: + <command> + weechat::get_window_info(); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_window_info() + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_window_info() + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_window_info() + </command> + </para> + <para> + Return list of WeeChat windows. + </para> + <para> + Return value: list of WeeChat windows + (see <xref linkend="secAPI_get_window_info" />). + </para> + <para> + Examples: +<screen> +# perl +my @wf = weechat::get_window_info(); +if (@wf) +{ + weechat::print("**** windows infos ****"); + foreach my $w (@wf) + { + while ( my ($key, $value) = each %$w) + { + weechat::print(" > $key => $value"); + } + weechat::print("----------------------"); + } +} +else +{ + weechat::print("**** no window info ****"); +} + +# python +wf = weechat.get_window_info() +if wf != None and wf != []: + weechat.prnt ("**** windows infos ****") + for w in wf: + for i in w: + weechat.prnt (" > %s => %s" % (i, w[i])) + weechat.prnt ("----------------------") +else: + weechat.prnt ("**** no window info ****") + +# ruby +wf = Weechat.get_window_info() +if wf != nil and wf != [] + Weechat.print("**** windows infos ****") + wf.each do |w| + w.each do |key, value| + Weechat.print(" > #{key} => #{value}") + end + Weechat.print("----------------------") + end +else + Weechat.print("**** no window info ****") +end + +-- lua +wf = weechat.get_window_info() +if wf then + weechat.print ("**** windows infos ****") + w, winfos = next (wf, nil) + while (w) do + key, value = next (winfos, nil) + while (key) do + weechat.print(" > " .. key .. " => " .. value) + key, value = next (winfos, key) + end + weechat.print ("----------------------") + w, winfos = next (wf, w) + end +else + weechat.print("**** no window info ****") +end +</screen> + </para> + </section> + + <section id="secScript_get_buffer_info"> + <title>get_buffer_info</title> + + <para> + Perl prototype: + <command> + weechat::get_buffer_info(); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_buffer_info() + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_buffer_info() + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_buffer_info() + </command> + </para> + <para> + Return list of WeeChat buffers. + </para> + <para> + Return value: list of WeeChat buffers + (see <xref linkend="secAPI_get_buffer_info" />). + </para> + <para> + Examples: +<screen> +# perl +my $bf = weechat::get_buffer_info(); +if ($bf) +{ + while ( my ($nobuf, $binfos) = each %$bf) + { + while ( my ($key, $value) = each %$binfos) + { + weechat::print(" > $key => $value"); + } + weechat::print("----------------------"); + } +} +else +{ + weechat::print("**** no buffer info ****"); +} + +# python +bf = weechat.get_buffer_info() +if bf != None and bf != {}: + for b in bf: + weechat.prnt ("**** info for buffer no %d ****" % b) + for c in bf[b]: + weechat.prnt (" > %s => %s" % (c, bf[b][c])) + weechat.prnt ("----------------------") +else: + weechat.prnt ("**** no buffer info ****") + +# ruby +bf = Weechat.get_buffer_info() +if bf != nil and bf != {} + bf.each do |n, c| + Weechat.print("**** info for buffer no #{n} ****") + c.each do |key, value| + Weechat.print(" > #{key} => #{value}") + end + Weechat.print("----------------------") + end +else + Weechat.print("**** no buffer info ****") +end + +-- lua +bf = weechat.get_buffer_info() +if bf then + b, binfos = next (bf, nil) + while (b) do + weechat.print("**** info for buffer no " .. b .. " ****") + key, value = next (binfos, nil) + while (key) do + weechat.print(" > " .. key .. " => " .. value) + key, value = next (binfos, key) + end + weechat.print ("----------------------") + b, infos = next (bf, b) + end +else + weechat.print("**** no buffer info ****") +end +</screen> + </para> + </section> + + <section id="secScript_get_buffer_data"> + <title>get_buffer_data</title> + + <para> + Perl prototype: + <command> + weechat::get_buffer_data(server, channel); + </command> + </para> + <para> + Python prototype: + <command> + weechat.get_buffer_data(server, channel) + </command> + </para> + <para> + Ruby prototype: + <command> + Weechat.get_buffer_data(server, channel) + </command> + </para> + <para> + Lua prototype: + <command> + weechat.get_buffer_data(server, channel) + </command> + </para> + <para> + Return content of buffer. + </para> + <para> + Return value: list of lines for buffer + (see <xref linkend="secAPI_get_buffer_data" />). + </para> + <para> + Examples: +<screen> +# perl +my $server = weechat::get_info("server"); +my $channel = weechat::get_info("channel"); +my @bc = weechat::get_buffer_data($server, $channel); +if (@bc) +{ + weechat::print("**** buffer data for '$channel'\@'$server' ****"); + foreach my $l (@bc) { + while ( my ($key, $value) = each %$l) { + weechat::print(" > $key => $value"); + } + weechat::print("----------------------"); + } +} +else +{ + weechat::print("**** no buffer data ****"); +} + +# python +server = weechat.get_info("server") +channel = weechat.get_info("channel") +bc = weechat.get_buffer_data(server, channel) +if bc != None and bc != []: + weechat.prnt ("**** buffer data for '%s'@'%s' ****" % (channel, server)) + for l in bc: + for i in l: + weechat.prnt (" > %s => %s" % (i, l[i])) + weechat.prnt ("----------------------") +else: + weechat.prnt ("**** no buffer data ****") + +# ruby +server = Weechat.get_info("server") +channel = Weechat.get_info("channel") +bc = Weechat.get_buffer_data(server, channel) +if bc != nil and bc != [] + Weechat.print("**** buffer data for '#{channel}'@'#{server}' ****") + bc.each do |l| + l.each do |key, value| + Weechat.print(" > #{key} => #{value}") + end + Weechat.print("----------------------") + end +else + Weechat.print("**** no buffer data ****") +end + +-- lua +server = weechat.get_info("server") +channel = weechat.get_info("channel") +bc = weechat.get_buffer_data(server, channel) +if bc then + b, bdatas = next (bc, nil) + weechat.print("**** buffer data for '" .. channel .. "'@'" .. server .. "' ****") + while (b) do + key, value = next (bdatas, nil) + while (key) do + weechat.print(" > " .. key .. " => " .. value) + key, value = next (bdatas, key) + end + weechat.print ("----------------------") + b, bdatas = next (bc, b) + end +else + weechat.print("**** no buffer data ****") +end +</screen> + </para> + </section> + + </section> + +</section> diff --git a/doc/en/dev/plugins.en.xml b/doc/en/dev/plugins.en.xml new file mode 100644 index 000000000..fd2e2f7db --- /dev/null +++ b/doc/en/dev/plugins.en.xml @@ -0,0 +1,250 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +WeeChat documentation (english version) + +Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org> + +This manual is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +This manual is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. + +--> + +<chapter id="chapPlugins"> + <title>Plugins</title> + + <para> + This chapter describes WeeChat plugin API and default plugins provided with + WeeChat. + </para> + + <section id="secPluginsInWeeChat"> + <title>Plugins in WeeChat</title> + + <para> + A plugin is a C program which can call WeeChat functions defined in + an interface. + </para> + + <para> + This C program does not need WeeChat sources to compile and can be + dynamically loaded into WeeChat with command + <command>/plugin</command>. + </para> + + <para> + The plugin has to be a dynamic library, for dynamic loading by + operating system. + Under GNU/Linux, the file has ".so" extension, ".dll" under + Windows. + </para> + + </section> + + <section id="secWriteAPlugin"> + <title>Write a plugin</title> + + <para> + The plugin has to include "weechat-plugin.h" file (available in + WeeChat source code). + This file defines structures and types used to communicate with + WeeChat. + </para> + + <para> + The plugin must use some mandatory macros (to define some variables) + and some functions (without them the plugin can't load): + + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Macro</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>WEECHAT_PLUGIN_NAME</literal></entry> + <entry>plugin name</entry> + </row> + <row> + <entry><literal>WEECHAT_PLUGIN_DESCRIPTION</literal></entry> + <entry>short description of plugin</entry> + </row> + <row> + <entry><literal>WEECHAT_PLUGIN_VERSION</literal></entry> + <entry>plugin version</entry> + </row> + <row> + <entry><literal>WEECHAT_PLUGIN_WEECHAT_VERSION</literal></entry> + <entry> + target WeeChat version where plugin will run (warning: plugin + will not run on any other WeeChat version!) + </entry> + </row> + <row> + <entry><literal>WEECHAT_PLUGIN_LICENSE</literal></entry> + <entry>plugin license</entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Function</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>int weechat_plugin_init (struct t_weechat_plugin *plugin, int argc, char *argv[])</literal></entry> + <entry> + function called when plugin is loaded, must return + WEECHAT_RC_OK if successful, WEECHAT_RC_ERROR if error + (if error, plugin will NOT be loaded), argc/argv are arguments + for plugin (given on command line by user) + </entry> + </row> + <row> + <entry><literal>int weechat_plugin_end (struct t_weechat_plugin *plugin)</literal></entry> + <entry>function called when plugin is unloaded</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + + &plugin_api.en.xml; + + <section id="secCompilePlugin"> + <title>Compile plugin</title> + + <para> + Compile does not need WeeChat sources, only file + "<literal>weechat-plugin.h</literal>". + </para> + + <para> + To compile a plugin which has one file "toto.c" (under GNU/Linux): +<screen> +<prompt>$ </prompt><userinput>gcc -fPIC -Wall -c toto.c</userinput> +<prompt>$ </prompt><userinput>gcc -shared -fPIC -o libtoto.so toto.o</userinput> +</screen> + </para> + + </section> + + <section id="secLoadPlugin"> + <title>Load plugin into WeeChat</title> + + <para> + Copy "libtoto.so" file into system plugins directory (for example + "<literal>/usr/local/lib/weechat/plugins</literal>") or into + user's plugins directory (for example + "<literal>/home/xxxxx/.weechat/plugins</literal>"). + </para> + + <para> + Under WeeChat: + <screen><userinput>/plugin load toto</userinput></screen> + </para> + + </section> + + <section id="secPluginExample"> + <title>Plugin example</title> + + <para> + Full example of plugin, which adds a /double command, which displays + two times arguments on current buffer, or execute two times a command + (ok that's not very useful, but that's just an example!): +<screen> +#include <stdlib.h> + +#include "weechat-plugin.h" + +WEECHAT_PLUGIN_NAME("double"); +WEECHAT_PLUGIN_DESCRIPTION("Test plugin for WeeChat"); +WEECHAT_PLUGIN_AUTHOR("FlashCode <flashcode@flashtux.org>"); +WEECHAT_PLUGIN_VERSION("0.1"); +WEECHAT_PLUGIN_WEECHAT_VERSION("0.2.7"); +WEECHAT_PLUGIN_LICENSE("GPL3"); + +struct t_weechat_plugin *weechat_plugin = NULL; + + +/* "/double" command manager */ + +int +double_cmd (void *data, struct t_gui_buffer *buffer, int argc, + char **argv, char **argv_eol) +{ + /* make C compiler happy */ + (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", + "msg", + "msg: message to display two times", + NULL, + &double_cmd, NULL); + + return WEECHAT_RC_OK; +} + +int +weechat_plugin_end (struct t_weechat_plugin *plugin) +{ + /* nothing done here */ + (void) plugin; + + return WEECHAT_RC_OK; +} +</screen> + </para> + + </section> + + </section> + + &plugin_irc.en.xml; + + <!-- &plugin_charset.en.xml; --> + + &plugin_fifo.en.xml; + + <!-- &plugin_scripts.en.xml; --> + + &plugin_xfer.en.xml; + +</chapter> diff --git a/doc/en/dev/weechat_dev.en.xml b/doc/en/dev/weechat_dev.en.xml new file mode 100644 index 000000000..e21d3cf0e --- /dev/null +++ b/doc/en/dev/weechat_dev.en.xml @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +WeeChat documentation (english version) + +Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org> + +This manual is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +This manual is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. + +--> + +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd" +[ + <!-- ***** auto-built: ***** --> + <!ENTITY date.xml SYSTEM "date.xml"> + <!ENTITY % include_autogen.xml SYSTEM "include_autogen.xml"> + %include_autogen.xml; + + <!-- ***** written by hand: ***** --> + <!ENTITY intro.en.xml SYSTEM "intro.en.xml"> + <!ENTITY plugins.en.xml SYSTEM "plugins.en.xml"> + <!ENTITY plugin_api.en.xml SYSTEM "plugin_api.en.xml"> + <!ENTITY plugin_scripts.en.xml SYSTEM "plugin_scripts.en.xml"> + <!ENTITY authors.en.xml SYSTEM "authors.en.xml"> +]> + +<book lang="en"> + + <bookinfo> + + <title>WeeChat 0.2.7-dev - Developer guide</title> + <subtitle>Fast, light and extensible chat client</subtitle> + + <author> + <firstname>Sébastien</firstname> + <surname>Helleu</surname> + <email>flashcode AT flashtux.org</email> + </author> + + &date.xml; + + <copyright> + <year>2008</year> + <holder>Sébastien Helleu</holder> + </copyright> + + <legalnotice> + <para> + This manual is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + </para> + <para> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + </para> + <para> + You should have received a copy of the GNU General Public License + along with this program. If not, see + <http://www.gnu.org/licenses/>. + </para> + </legalnotice> + + <abstract> + <para> + This manual documents development of WeeChat and its extensions. + It is part of WeeChat. + </para> + <para> + Latest version of this document can be found on this page: + <ulink url="http://weechat.flashtux.org/doc.php"> + http://weechat.flashtux.org/doc.php + </ulink> + </para> + </abstract> + + </bookinfo> + + &intro.en.xml; + + <!-- &plugins.en.xml; --> + + &authors.en.xml; + +</book> |