diff options
| author | Sebastien Helleu <flashcode@flashtux.org> | 2008-11-07 18:27:16 +0100 |
|---|---|---|
| committer | Sebastien Helleu <flashcode@flashtux.org> | 2008-11-07 18:27:16 +0100 |
| commit | 67d8312f461b74b747088b6661a21426ab2a01e6 (patch) | |
| tree | 2f797a4e048205a1eb03b9ddbf82166e26046940 /doc | |
| parent | bc5bb29970ee029ee646b8805b83b3a9d71a2ef8 (diff) | |
| download | weechat-67d8312f461b74b747088b6661a21426ab2a01e6.zip | |
Update developer guide (add 50% of new C API functions)
Diffstat (limited to 'doc')
22 files changed, 14505 insertions, 11848 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 085727fc2..45beff055 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -77,7 +77,7 @@ IF(BUILD_HTML OR BUILD_PDF) OUTPUT_VARIABLE DOC_DATE ) STRING(REPLACE "\n" "" DOC_DATE "${DOC_DATE}") - + CONFIGURE_FILE( ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in ${CMAKE_CURRENT_BINARY_DIR}/date.xml @@ -116,7 +116,7 @@ IF(BUILD_HTML OR BUILD_PDF) ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html.xsl.in ${CMAKE_CURRENT_SOURCE_DIR}/weechat-doc.css - COMMENT "Building html doc (${dlang})" + COMMENT "Building user guide - html doc (${dlang})" ) ADD_CUSTOM_TARGET(doc-user-html-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}/user/index.html) ADD_CUSTOM_TARGET(doc-user-html-one-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}/user/weechat_user.${dlang}.html) @@ -145,7 +145,7 @@ IF(BUILD_HTML OR BUILD_PDF) ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/autogen/* ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in - COMMENT "Building pdf doc (${dlang})" + COMMENT "Building user guide - pdf doc (${dlang})" ) ADD_CUSTOM_TARGET(doc-user-pdf-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/user/weechat_user.${dlang}.pdf) INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/user/weechat_user.${dlang}.pdf DESTINATION share/doc/${PROJECT_NAME}) @@ -184,7 +184,7 @@ IF(BUILD_HTML OR BUILD_PDF) ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html.xsl.in ${CMAKE_CURRENT_SOURCE_DIR}/weechat-doc.css - COMMENT "Building html doc (${dlang})" + COMMENT "Building developer guide - html doc (${dlang})" ) ADD_CUSTOM_TARGET(doc-dev-html-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}/dev/index.html) ADD_CUSTOM_TARGET(doc-dev-html-one-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}/dev/weechat_dev.${dlang}.html) @@ -213,7 +213,7 @@ IF(BUILD_HTML OR BUILD_PDF) ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/autogen/* ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in - COMMENT "Building pdf doc (${dlang})" + COMMENT "Building developer guide - pdf doc (${dlang})" ) ADD_CUSTOM_TARGET(doc-dev-pdf-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/dev/weechat_dev.${dlang}.pdf) INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/dev/weechat_dev.${dlang}.pdf DESTINATION share/doc/${PROJECT_NAME}) diff --git a/doc/de/Makefile.am b/doc/de/Makefile.am index 8c4363402..dae10391b 100644 --- a/doc/de/Makefile.am +++ b/doc/de/Makefile.am @@ -48,29 +48,29 @@ BOOK_COMMON_INCLUDE = authors.$(LANGCODE).xml \ intro.$(LANGCODE).xml BOOK_USER = weechat_user.$(LANGCODE) -BOOK_USER_INCLUDE = user/install.$(LANGCODE).xml \ - user/usage.$(LANGCODE).xml \ - user/plugins.$(LANGCODE).xml \ - user/plugin_alias.$(LANGCODE).xml \ - user/plugin_aspell.$(LANGCODE).xml \ - user/plugin_charset.$(LANGCODE).xml \ - user/plugin_fifo.$(LANGCODE).xml \ - user/plugin_irc.$(LANGCODE).xml \ - user/plugin_logger.$(LANGCODE).xml \ - user/plugin_scripts.$(LANGCODE).xml \ +BOOK_USER_INCLUDE = user/install.$(LANGCODE).xml \ + user/usage.$(LANGCODE).xml \ + user/plugins.$(LANGCODE).xml \ + user/plugin_alias.$(LANGCODE).xml \ + user/plugin_aspell.$(LANGCODE).xml \ + user/plugin_charset.$(LANGCODE).xml \ + user/plugin_fifo.$(LANGCODE).xml \ + user/plugin_irc.$(LANGCODE).xml \ + user/plugin_logger.$(LANGCODE).xml \ + user/plugin_scripts.$(LANGCODE).xml \ user/plugin_xfer.$(LANGCODE).xml BOOK_DEV = weechat_dev.$(LANGCODE) -BOOK_DEV_INCLUDE = dev/plugin_api.$(LANGCODE).xml \ - dev/plugin_scripts.$(LANGCODE).xml \ - dev/plugins.$(LANGCODE).xml \ - dev/weechat_dev.$(LANGCODE).xml +BOOK_DEV_INCLUDE = dev/plugins.$(LANGCODE).xml \ + dev/plugin_api.$(LANGCODE).xml \ + dev/plugin_c_api.$(LANGCODE).xml \ + dev/plugin_script_api.$(LANGCODE).xml QUICKSTART = weechat_quickstart.$(LANGCODE).txt -EXTRA_DIST = $(BOOK_AUTOGEN_INCLUDE) $(BOOK_COMMON_INCLUDE) \ - user/$(BOOK_USER).xml $(BOOK_USER_INCLUDE) \ - dev/$(BOOK_DEV).xml $(BOOK_DEV_INCLUDE) \ +EXTRA_DIST = $(BOOK_AUTOGEN_INCLUDE) $(BOOK_COMMON_INCLUDE) \ + user/$(BOOK_USER).xml $(BOOK_USER_INCLUDE) \ + dev/$(BOOK_DEV).xml $(BOOK_DEV_INCLUDE) \ $(QUICKSTART) if DBLATEX_FOUND diff --git a/doc/de/dev/plugin_api.de.xml b/doc/de/dev/plugin_api.de.xml index fed1bc6d6..f67bae785 100644 --- a/doc/de/dev/plugin_api.de.xml +++ b/doc/de/dev/plugin_api.de.xml @@ -21,3507 +21,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. --> -<section id="secAPIFunctions"> +<chapter id="chapPluginAPI"> <!-- TRANSLATION NEEDED --> <title>Plugin API</title> - <section id="secAPI_set_charset"> - <title>set_charset</title> - - <para> - Prototyp: - <command> - void set_charset (t_weechat_plugin *plugin, char *charset) - </command> - </para> - <para> - Legt neuen Zeichensatz für ein Plugin fest. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: neuer Zeichensatz, der benutzt - werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: - <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> - </para> - </section> + &plugin_c_api.de.xml; - <section id="secAPI_iconv_to_internal"> - <title>iconv_to_internal</title> - - <para> - Prototyp: - <command> - void iconv_to_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Konvertiert eine Zeichenkette in das interne Format von WeeChat - (UTF-8). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: ursprünglicher Zeichensatz, von - dem konvertiert werden soll - </para> - </listitem> - <listitem> - <para> - <option>string</option>: zu konvertierende Zeichenkette - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: konvertierte Zeichenkette - </para> - <para> - Anmerkung: der Speicher, der durch das Ergebnis belegt wird, muss - mit free() wieder freigegeben werden. - </para> - <para> - Beispiel: - <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "iso string: é à");</screen> - </para> - </section> + <!-- &plugin_script_api.de.xml; --> - <section id="secAPI_iconv_from_internal"> - <title>iconv_from_internal</title> - - <para> - Prototyp: - <command> - void iconv_from_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Konvertiert eine Zeichenkette von dem internen WeeChat-Zeichensatz - (UTF-8) in einen anderen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: Ziel-Zeichensatz - </para> - </listitem> - <listitem> - <para> - <option>string</option>: zu konvertierende Zeichenkette - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: konvertierte Zeichenkette - </para> - <para> - Anmerkung: der Speicher, der durch das Ergebnis belegt wird, muss - mit free() wieder freigegeben werden. - </para> - <para> - Beispiel: - <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "utf-8 string: é à");</screen> - </para> - </section> - - <section id="secAPI_ascii_strcasecmp"> - <title>ascii_strcasecmp</title> - - <para> - Prototyp: - <command> - int ascii_strcasecmp (t_weechat_plugin *plugin, - char *string1, char *string2) - </command> - </para> - <para> - Vergleich von Zeichenketten unabhängig von Sprache und - Schreibweise (gross/klein). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string1</option>: erste Zeichenkette des Vergleichs - </para> - </listitem> - <listitem> - <para> - <option>string2</option>: zweite Zeichenkette des Vergleichs - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner - Null wenn - string1 < string2, Null wenn string1 == string2, grösser Null - wenn string1 > string2 - </para> - <para> - Beispiel: - <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> - </para> - </section> - - <section id="secAPI_ascii_strncasecmp"> - <title>ascii_strncasecmp</title> - - <para> - Prototyp: - <command> - int ascii_strncasecmp (t_weechat_plugin *plugin, - char *string1, char *string2, int max) - </command> - </para> - <para> - Vergleich von Zeichenketten unabhängig von Sprache und Schreibweise - (gross/klein) für höchstens "max" Zeichen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string1</option>: erste Zeichenkette des Vergleichs - </para> - </listitem> - <listitem> - <para> - <option>string2</option>: zweite Zeichenkette des Vergleichs - </para> - </listitem> - <listitem> - <para> - <option>max</option>: maximale Zahl an Zeichen für den - Vergleich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner - Null wenn string1 < string2, Null wenn string1 == string2, - grösser Null wenn string1 > string2 - </para> - <para> - Beispiel: - <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> - </para> - </section> - - <section id="secAPI_explode_string"> - <title>explode_string</title> - - <para> - Prototyp: - <command> - char **explode_string (t_weechat_plugin *plugin, char *string, - char *separators, int num_items_max, int *num_items) - </command> - </para> - <para> - Zerlege eine Zeichenkette entsprechend eines oder mehrerer - Trennzeichen(s). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string</option>: zu zerlegende Zeichenkette - </para> - </listitem> - <listitem> - <para> - <option>separators</option>: zu verwendende(s) Trennzeichen - </para> - </listitem> - <listitem> - <para> - <option>num_items_max</option>: maximale Anzahl an zu - erzeugenden Teilen (0 = keine Grenze) - </para> - </listitem> - <listitem> - <para> - <option>num_items</option>: Zeiger auf eine int-Variable, - die die Anzahl der erzeugten - Teile enthält - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: ein Array von Zeichenketten, NULL bei Fehlern. - </para> - <para> - Hinweis: Das zurückgegebene Array muss nach der Benutzung mittels - "free_exloded_string" explizit freigegeben werden. - </para> - <para> - Beispiel: -<screen> -char **argv; -int argc; -argv = plugin->explode_string (plugin, string, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_free_exploded_string"> - <title>free_exploded_string</title> - - <para> - Prototyp: - <command> - char **free_exploded_string (t_weechat_plugin *plugin, - char **string) - </command> - </para> - <para> - Gib ein Array frei, dass infolge der Zerlegung eines Strings - reserviert wurde. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string</option>: ein Array von Strings - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner (?). - </para> - <para> - Beispiel: -<screen> -char *argv; -int argc; -argv = plugin->explode_string (plugin, string, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_mkdir_home"> - <title>mkdir_home</title> - - <para> - Prototyp: - <command> - int mkdir_home (t_weechat_plugin *plugin, char *directory) - </command> - </para> - <para> - Erzeugt ein Verzeichnis im WeeChat-Verzeichnis. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstrukur - </para> - </listitem> - <listitem> - <para> - <option>directory</option>: Verzeichnis, das erzeugt werden - soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: 1 wenn das Verzeichnis erfolgreich erstellt wurde, 0 - wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiel: -<screen> -if (!plugin->mkdir_home (plugin, "temp")) - plugin->print_server(plugin, "Konnte 'temp'-Verzeichnis im WeeChat-Verzeichnis nicht erstellen."); -</screen> - </para> - </section> - - <section id="secAPI_exec_on_files"> - <title>exec_on_files</title> - - <para> - Prototyp: - <command> - void exec_on_files (t_weechat_plugin *plugin, char *repertoire, - int (*callback)(t_weechat_plugin *, char *)) - </command> - </para> - <para> - Führe eine Funktion auf allen Dateien eines Verzeichnisses aus. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>directory</option>: Verzeichnis der zu verwendenden - Dateien - </para> - </listitem> - <listitem> - <para> - <option>callback</option>: die anzuwendende Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: -<screen> -int callback (t_weechat_plugin *plugin, char *file) -{ - plugin->print_server (plugin, "file: %s", file); - return 1; -} -... -plugin->exec_on_files (plugin, "/tmp", &callback); -</screen> - </para> - </section> - - <section id="secAPI_print"> - <title>print</title> - - <para> - Prototyp: - <command> - void print (t_weechat_plugin *plugin, - char *server, char *channel, char *message, ...) - </command> - </para> - <para> - Sende eine Nachricht an einen WeeChat-Puffer, bezeichnet durch - server und channel (beide können NULL sein, dann wird der aktuelle - Puffer verwendet). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, zu - welchem der Puffer gehört, in dem die Nachricht angezeigt - werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, in dem die - Nachricht angezeigt werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <!-- TRANSLATION NEEDED --> - <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> - Rückgabewert: keiner. - </para> - <para> - Beispiele: -<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 Fett \x0F\x03%02d Blau \x03%02d Grün", - 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> - Prototyp: - <command> - void print_server (t_weechat_plugin *plugin, - char *message, ...) - </command> - </para> - <para> - Zeige eine Nachricht im aktuellen Server-Puffer. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <para> - <!-- TRANSLATION NEEDED --> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: <screen>plugin->print_server (plugin, "hello");</screen> - </para> - </section> - - <section id="secAPI_log"> - <title>log</title> - - <para> - Prototyp: - <command> - void log (t_weechat_plugin *plugin, - char *server, char *channel, char *message, ...) - </command> - </para> - <para> - Schreibe eine Nachricht in die Log-Datei (für den entsprechenden - Server/Channel). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, zu - welchem der Log-Puffer gehört (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, zu welchem der - Log-Puffer gehört (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: -<screen> -plugin->log (plugin, "freenode", "#weechat", "test"); -</screen> - </para> - </section> - - <section id="secAPI_msg_handler_add"> - <title>msg_handler_add</title> - - <para> - Prototyp: - <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> - Erzeuge einen IRC-Message-Handler, der aufgerufen wird, wenn - eine Nachricht empfangen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Name (Typ) der IRC-Nachricht ("*" - für alle Nachrichten). - Eine Liste der bekannten IRC-Nachrichten ist in den - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> - und - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> - zu finden. - Weiterhin können sie einen speziellen Namen verwenden, der - mit "weechat_" beginnt, um spezielle Ereignisse zu - bearbeiten, wie in der folgenden Tabelle aufgeführt: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>weechat_pv</literal></entry> - <entry>private Nachricht empfangen</entry> - </row> - <row> - <entry><literal>weechat_highlight</literal></entry> - <entry> - hervorgehobene Nachricht (in einem Channel oder privatem Chat) - </entry> - </row> - <row> - <entry><literal>weechat_ctcp</literal></entry> - <entry> - CTCP-Nachricht empfangen (VERSION, PING, ...) - </entry> - </row> - <row> - <entry><literal>weechat_dcc</literal></entry> - <entry> - DCC-Nachricht empfangen (Chat oder Datei) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird, - wenn eine Nachricht empfangen wurde - </para> - <para> - Sie verwendet den folgenden Prototyp: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Argument argc ist auf 3 gesetzt, die folgenden Werte sind - im argv-Array: - <itemizedlist> - <listitem> - <para>argv[0] = Server Name</para> - </listitem> - <listitem> - <para>argv[1] = IRC Nachricht</para> - </listitem> - <listitem> - <para>argv[2] = Kommando Argumente</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente, die beim Aufruf - an die Funktion übergeben werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function - when called - <option>handler_pointer</option>: Zeiger, der an die Funktion - übergeben wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Zeiger auf den neuen Handler - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht - empfangen wurde, muss einen der folgenden Werte zurückgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: Die Nachricht - wird nicht an WeeChat übergeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: Die Nachricht - wird nicht an andere Plugins weitergegeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: Die Nachricht - wird weder an WeeChat noch an andere - Plugins weitergegeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: Funktion - erfolgreich vervollständigt und eine Hervorhebung bei den - empfangenen Nachrichten eingebaut - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<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> - Prototyp: - <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> - Erzeugt einen Handler für ein WeeChat-Kommando, der aufgerufen - wird, wenn der Anwender das Kommando ausführt (Beispiel: /command). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>command</option>: Name des neuen Kommandos, der auch - Name eines bereits existierenden Kommandos sein kann (mit - Bedacht zu verwenden, das ersetzte Kommando ist nicht - verfügbar, bis das Plugin entfernt wurde) - </para> - </listitem> - <listitem> - <para> - <option>description</option>: kurze Beschreibung des - Kommandos (angezeigt beim Ausführen von /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments</option>: kurze Beschreibung der Argumente - des Kommandos (angezeigt beim Ausführen von /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option>: lange Beschreibung - der Argumente des Kommandos (angezeigt beim Ausführen von - /help command) - </para> - </listitem> - <listitem> - <para> - <option>completion_template</option>: Vorlage für die - Vervollständigung; zum Beispiel bedeutet - "<literal>abc|%w def|%i</literal>", dass das erste Argument - "abc" oder ein WeeChat-Kommando sein kann und das zweite - Argument "def" oder ein IRC-Kommando. Eine leere - Zeichenkette bedeutet, dass WeeChat für jedes Argument - einen Nicknamen des gegenwärtigen Channels einsetzt, ein - NULL oder "-" schaltet die Vervollständigung für alle - Argumente ab. - </para> - <para> - Die folgenden Ersetzungen können verwendet werden: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>%-</literal></entry> - <entry>keine Vervollständigung für das Argument</entry> - </row> - <row> - <entry><literal>%*</literal></entry> - <entry> - <!-- TRANSLATION NEEDED --> - 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> - Aliase und Kommandos (WeeChat, IRC und Plugins) - </entry> - </row> - <row> - <entry><literal>%c</literal></entry> - <entry>gegenwärtiger Channel</entry> - </row> - <row> - <entry><literal>%C</literal></entry> - <entry>alle channels (inklusive Queries)</entry> - </row> - <row> - <entry><literal>%f</literal></entry> - <entry>Dateiname</entry> - </row> - <row> - <entry><literal>%h</literal></entry> - <entry>Plugin Kommandos</entry> - </row> - <row> - <entry><literal>%i</literal></entry> - <entry>IRC Kommandos (senden)</entry> - </row> - <row> - <entry><literal>%I</literal></entry> - <entry>IRC Kommandos (empfangen)</entry> - </row> - <row> - <entry><literal>%k</literal></entry> - <entry>Grundfunktionen</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>Nicknamen des gegenwärtigen Servers</entry> - </row> - <row> - <entry><literal>%M</literal></entry> - <entry> - Nicks auf dem gegenwärtigen Server (in allen - offenen Channeln) - </entry> - </row> - <row> - <entry><literal>%n</literal></entry> - <entry>Nicknamen des gegenwärtigen Channels</entry> - </row> - <row> - <entry><literal>%N</literal></entry> - <entry> - Nicknamen und Hostnamen des gegenwärtigen - Channels - </entry> - </row> - <row> - <entry><literal>%o</literal></entry> - <entry>Konfigurationseinstellungen</entry> - </row> - <row> - <entry><literal>%O</literal></entry> - <entry>Plugin Optionen</entry> - </row> - <row> - <entry><literal>%p</literal></entry> - <entry>Standard "part" Nachricht</entry> - </row> - <row> - <entry><literal>%q</literal></entry> - <entry>Standard "quit" Nachricht</entry> - </row> - <row> - <entry><literal>%s</literal></entry> - <entry>Name des gegenwärtigen Servers</entry> - </row> - <row> - <entry><literal>%S</literal></entry> - <entry>Namen aller definierten Server</entry> - </row> - <row> - <entry><literal>%t</literal></entry> - <entry>Topic des gegenwärtigen Channels</entry> - </row> - <row> - <entry><literal>%v</literal></entry> - <entry>Wert einer Konfigurationseinstellung</entry> - </row> - <row> - <entry><literal>%V</literal></entry> - <entry>Wert einer Plugin-Option</entry> - </row> - <row> - <entry><literal>%w</literal></entry> - <entry>WeeChat Kommandos</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird, - wenn das Kommando ausgeführt wird - </para> - <para> - Sie verwendet den folgenden Prototypen: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Das Argument argc ist auf 3 gesetzt, das Array argv enthält - die folgenden Werte: - <itemizedlist> - <listitem> - <para>argv[0] = Server Name</para> - </listitem> - <listitem> - <para>argv[1] = Kommando</para> - </listitem> - <listitem> - <para>argv[2] = Kommando-Argumente</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente, die an die Funktion - übergeben werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Zeiger, der an die Funktion - übergeben wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Zeiger auf den neuen Kommando-Handler. - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird, wenn das Kommando - ausgeführt wird, muss einen der folgende Werte zurückgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<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> - Prototyp: - <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> - Erzeuge einen zeitgesteuerten Handler, der periodisch - eine Funktion aufruft. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>interval</option>: Intervall (in Secunden) zwischen - zwei Aufrufen der Funktion - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird - </para> - <para> - Sie verwendet den folgenden Prototypen: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Das Argument argc ist auf 0 gesetzt und argv ist auf NULL - gesetzt. - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente der aufgerufenen - Funktion - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Zeiger, der an die Funktion - übergeben wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Zeiger auf den neuen timer-Handler. - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird, muss einen der folgende - Werte zurückgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<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> - Prototyp: - <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> - Erzeugt einen Keyboard-Handler, der nach dem Drücken einer Taste - aufgerufen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Die Funktion, die aufgerufen wird - </para> - <para> - Sie verwendet den folgenden Prototypen: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Das Argument argc ist auf 3 gesetzt, argv enthält die - folgenden Werte: - <itemizedlist> - <listitem> - <para> - argv[0] = Taste, die gedrückt wurde - (Name der internen Funktion oder '*' gefolgt von einem - Tastaturcode) - </para> - </listitem> - <listitem> - <para> - argv[1] = Kommandozeile vor dem Tastendruck - </para> - </listitem> - <listitem> - <para> - argv[2] = Kommandozeile nach dem Tastendruck - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente, die bei Aufruf der - Funktion übergeben - werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Zeiger auf die Funktion, - der bei Aufruf übergeben - wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Zeiger auf den Handler. - </para> - <para> - Hinweis: Die aufgerufene Funktion muss einen der folgenden Werte - zurückgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<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> - Prototyp: - <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> - Fügt einen Ereignishandler hinzu, der aufgerufen wird, wenn ein - Ereignis eintritt. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Strukture - </para> - </listitem> - <listitem> - <para> - <option>event</option> : Ereignis (siehe folgende Tabelle) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: aufgerufene Funktion - </para> - <para> - Es wird folgender Prototyp verwendet: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - <!-- TRANSLATION NEEDED --> - Arguments depend on event (see table below). - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argument, die an die aufgerufene - Funktion übergeben werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Pointer, der an die - aufgerufene Funktion übergeben werden - </para> - </listitem> - </itemizedlist> - </para> - <!-- TRANSLATION NEEDED --> - <para> - List of events: - <informaltable colsep="0" frame="none"> - <tgroup cols="3"> - <thead> - <row> - <entry>Ereignis</entry> - <entry>Beschreibung</entry> - <entry>Arguments</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>buffer_open</literal></entry> - <entry>ein Puffer wurde geöffnet</entry> - <entry> - argc = 1, argv = { buffer number } - </entry> - </row> - <row> - <entry><literal>buffer_close</literal></entry> - <entry>ein Puffer wurde geschlossen</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> - Rückgabewert: Pointer auf den neuen Ereignishandler. - </para> - <para> - Anmerkung: die aufgerufene Function muss einen der folgenden Werte - zurückgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion erfolgreich beendet - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void handler_remove (t_weechat_plugin *plugin, - t_plugin_handler *handler) - </command> - </para> - <para> - Entfernt einen Nachrichten- oder Kommando-Handler. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>handler</option>: Handler, der entfernt werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->handler_remove (plugin, my_handler);</screen> - </para> - </section> - - <section id="secAPI_handler_remove_all"> - <title>handler_remove_all</title> - - <para> - Prototyp: - <command> - void handler_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Entfernt alle Handler eines Plugins. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->handler_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_modifier_add"> - <title>modifier_add</title> - - <para> - Prototyp: - <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> - Füge einen Nachrichtenmodifikator hinzu. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>type</option>: Modifikatorart: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Art</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>wird bei eingehenden IRC-Nachrichten aufgerufen</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - wird bei jeder Benutzernachricht (oder Befehl) - aufgerufen (bevor WeeChat die Nachricht parst) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - wird unmittelbar vor dem Abschicken einer ausgehenden - Nachricht an den IRC-Server aufgerufen (auch bei - Nachrichten, die WeeChat automatisch an den Server - sendet) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Name der IRC-Nachricht (wird nur - bei den Arten "irc_in" and "irc_out" benutzt) - Um eine Liste der IRC-Nachrichten zu erhalten, lies bitte - folgende Dokumente:<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>. - Außerdem gibt es den Wert "*", der alle Nachrichten - anspricht (ohne Filter). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: aufgerufene Funktion - </para> - <para> - Folgender Prototyp wird dafür benutzt: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Argument argc hat den Wert 2, folgende Werte sind in dem - argv-Array: - <itemizedlist> - <listitem> - <para>argv[0] = Servername</para> - </listitem> - <listitem> - <para>argv[1] = Nachricht</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>modifier_args</option>: an die Funktion übergebene - Werte - </para> - </listitem> - <listitem> - <para> - <option>modifier_pointer</option>: an die Funktion - übergebener Zeiger - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Zeiger auf den neuen Nachrichtenmodifikator - </para> - <para> - Anmerkung: Die Funktion muss die veränderte Zeichenkette oder NULL - (wenn keine Änderungen erfolgten) zurückgeben. - Wenn die Funktion eine leere Zeichenkette zurückgibt, wird die - Nachricht komplett verworfen und nicht weiter von WeeChat - verarbeitet. (Seien Sie vorsichtig mit dem Verwerfen von - Nachrichten!) Die zurückgegebene Zeichenkette muss mit malloc() - zugewiesen worden sein und wird von WeeChat nach Gebrauch - automatisch mit free() wieder freigegeben. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void modifier_remove (t_weechat_plugin *plugin, - t_plugin_modifier *modifier) - </command> - </para> - <para> - Entfernt einen Nachrichtenmodifikator. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>modifier</option>: zu entfernender Modifikator - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->modifier_remove (plugin, my_modifier);</screen> - </para> - </section> - - <section id="secAPI_modifier_remove_all"> - <title>modifier_remove_all</title> - - <para> - Prototyp: - <command> - void modifier_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Entfernt alle Modifikatoren für ein Plugin. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->modifier_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_exec_command"> - <title>exec_command</title> - - <para> - Prototyp: - <command> - void exec_command (t_weechat_plugin - *plugin, char *server, char *channel, char *command) - </command> - </para> - <para> - Führe ein WeeChat-Kommando aus (oder sende eine Nachricht an - einen Channel). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, auf den - das Kommando angewendet werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, auf den das - Kommando angewendet werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>command</option>: Kommando - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - char *get_info (t_weechat_plugin *plugin, - char *info, char *server) - </command> - </para> - <para> - Gib eine Information über WeeChat oder einen Channel zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>info</option> : Name (Typ) der Information: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Info</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>version</literal></entry> - <entry>WeeChats Version</entry> - </row> - <row> - <entry><literal>nick</literal></entry> - <entry>Nickname</entry> - </row> - <row> - <entry><literal>channel</literal></entry> - <entry> - Name des Channels (NULL bei einem Server oder - Privatchat) - </entry> - </row> - <row> - <entry><literal>server</literal></entry> - <entry>Name des Servers</entry> - </row> - <row> - <entry><literal>type</literal></entry> - <entry> - Puffertyp: 0=standard, 1=DCC, 2=raw IRC data - </entry> - </row> - <row> - <entry><literal>away</literal></entry> - <entry>Status des "away"-Flags</entry> - </row> - <row> - <entry><literal>inactivity</literal></entry> - <entry> - Anzahl der Sekunden seit der letzten - Tastenbetätigung - </entry> - </row> - <row> - <entry><literal>input</literal></entry> - <entry> - Inhalt der Kommandozeile im gegenwärtigen Fenster - </entry> - </row> - <row> - <entry><literal>input_mask</literal></entry> - <entry> - Inhalt der Farbmaske für die Kommandozeile - </entry> - </row> - <row> - <entry><literal>input_pos</literal></entry> - <entry> - Position des Cursors in der Kommandozeile - </entry> - </row> - <row> - <entry><literal>weechat_dir</literal></entry> - <entry> - WeeChat-Verzeichnis (Standard: ~/.weechat/) - </entry> - </row> - <row> - <entry><literal>weechat_libdir</literal></entry> - <entry>WeeChat-Systemverzeichnis (Bibliotheken)</entry> - </row> - <row> - <entry><literal>weechat_sharedir</literal></entry> - <entry>WeeChat-Systemverzeichnis (gemeinsame Dateien)</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers um - Informationen zu lesen (wenn benötigt) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: angeforderte Information oder NULL - </para> - <para> - Hinweis: das Ergebnis muss nach Nutzung mit "free" wieder - freigegeben werden. - </para> - <para> - Beispiele: -<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> - Prototyp: - <command> - t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gib eine Liste der aktiven oder beendeten DCCs zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: verkettete Liste von DCCs. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</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 Typ: - 0 = Chatanfrage empfangen, - 1 = Chatanfrage gesendet, - 2 = Datei empfangen, - 3 = Datei gesendet - </entry> - </row> - <row> - <entry>int*</entry> - <entry><literal>status</literal></entry> - <entry> - DCC Status: - 0 = wartend, - 1 = verbindend, - 2 = aktiv, - 3 = beendet, - 4 = fehlgeschlagen, - 5 = unterbrochen durch Anwender - </entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_time</literal></entry> - <entry>Datum/Zeit der Erzeugung der DCC</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_transfer</literal></entry> - <entry>Datum/Zeit des Beginns der Übertragung der DCC</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>addr</literal></entry> - <entry>IP-Adresse des Partners</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>Port der DCC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>Nickname des Partners</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>filename</literal></entry> - <entry>Dateiname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>local_filename</literal></entry> - <entry>lokaler Dateiname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>filename_suffix</literal></entry> - <entry>Suffix wenn die Datei umbenannt wird</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>size</literal></entry> - <entry>Dateigrösse</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>pos</literal></entry> - <entry>Position in Datei</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>start_resume</literal></entry> - <entry>Startposition nach einer Unterbrechung</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>bytes_per_sec</literal></entry> - <entry> - Übertragungsrate (Bytes/s) seit Beginn der Übertragung - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>prev_dcc</literal></entry> - <entry> - Zeiger auf voheriges DCC-Info - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>next_dcc</literal></entry> - <entry> - Zeiger auf nächstes DCC-Info - </entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mittels - "free_dcc_info" wieder freigegeben werden. - </para> - <para> - Beispiele: -<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> - Prototyp: - <command> - void free_dcc_info (t_weechat_plugin *plugin, - t_plugin_dcc_info *dcc_info) - </command> - </para> - <para> - Gibt den Speicher einer Liste von DCC-Infos wieder frei. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>dcc_info</option>: Zeiger auf eine Liste mit - DCC-Infos, die mit "get_dcc_info" angelegt wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_dcc_info (plugin, dcc_info);</screen> - </para> - </section> - - <section id="secAPI_get_server_info"> - <title>get_server_info</title> - - <para> - Prototyp: - <command> - t_plugin_server_info *get_server_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gibt die Liste von IRC-Servern zurück (verbunden oder nicht) - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Liste von IRC-Servern. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>interner Servername</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoconnect</literal></entry> - <entry>1 wenn Autoconnect gesetzt ist, 0 sonst</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect</literal></entry> - <entry> - 1 wenn autoreconnect gesetzt ist, - 0 sonst - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect_delay</literal></entry> - <entry>Wartezeit vor erneutem Verbindungsversuch</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_line</literal></entry> - <entry> - 1 wenn der Servername auf der Kommandozeile angegeben - wurde (ist somit temporär) 0 sonst - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>address</literal></entry> - <entry>Serveradresse (Name oder 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-Verbindung</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl</literal></entry> - <entry>SSL-Verbindung</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>password</literal></entry> - <entry>Passwort</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick1</literal></entry> - <entry>primärer Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick2</literal></entry> - <entry>alternativer Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick3</literal></entry> - <entry>zweiter, alternativer Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>username</literal></entry> - <entry>Username</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>real name</literal></entry> - <entry>tatsächlicher Name</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>command</literal></entry> - <entry> - Kommando, dass bei erfolgreicher Verbindung - ausgeführt wurde - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_delay</literal></entry> - <entry>Verzögerung nach Ausführung des Kommandos</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>autojoin</literal></entry> - <entry>Channels, die automatisch betreten werden sollen</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autorejoin</literal></entry> - <entry> - 1 wenn Channels wieder betreten werden sollen, nachdem - man gekickt wurde 0 sonst - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>notify_levels</literal></entry> - <entry>Benachrichtigungs-Level von Channels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_iso</literal></entry> - <entry>Zeichensatz zum Dekodieren von ISO</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_utf</literal></entry> - <entry>Zeichensatz zum Dekodieren von UTF</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_encode</literal></entry> - <entry> - Zeichensatz der Channels zum Kodieren von - Nachrichten - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_connected</literal></entry> - <entry>1 wenn verbunden mit einem Server, 0 otherwise</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl_connected</literal></entry> - <entry>1 wenn verbunden über SSL, 0 sonst</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>gegenwärtiger Nickname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_away</literal></entry> - <entry>1 wenn away-flag gesetzt ist, 0 sonst</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>away_time</literal></entry> - <entry>Zeitspanne seit away-flag gesetzt ist</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>lag</literal></entry> - <entry>Lag (in Millisekunden)</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>prev_server</literal></entry> - <entry>Zeiger auf vorherigen Knoten der Liste</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>next_server</literal></entry> - <entry>Zeiger auf nächsten Knoten der Liste</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: das Ergebnis muss nach der Benutzung mit - "free_server_info" wieder freigegeben werden. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void free_server_info (t_weechat_plugin *plugin, - t_plugin_server_info *server_info) - </command> - </para> - <para> - Gib den Speicher einer Liste "server info" frei - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server_info</option>: Zeiger auf eine Server-Liste, - der von der Funktion "get_server_info" zurückgegeben wurde. - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_server_info (plugin, server_info);</screen> - </para> - </section> - - <section id="secAPI_get_channel_info"> - <title>get_channel_info</title> - - <para> - Prototyp: - <command> - t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, - char *server) - </command> - </para> - <para> - Gib eine Liste der Channels für einen Server zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Server - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: verkettete Liste von Channels für einen Server. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - 0 für einen normalen Channel, 1 für einen Privaten - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>Name des Channels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>topic</literal></entry> - <entry>Topic des Channels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>modes</literal></entry> - <entry>Channelmodus (Flags)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>limit</literal></entry> - <entry>Anzahl der erlaubten User</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>key</literal></entry> - <entry>Schlüssel des Channels</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>nicks_count</literal></entry> - <entry>Anzahl der Nicknamen des Channels</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>prev_channel</literal></entry> - <entry>Zeiger auf vorherigem Knoten der Liste</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>next_channel</literal></entry> - <entry>Zeiger auf nächsten Knoten der Liste</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit - "free_channel_info" wieder freigegeben werden. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void free_channel_info (t_weechat_plugin *plugin, - t_plugin_channel_info *channel_info) - </command> - </para> - <para> - Gibt den Speicher einer Liste "channel info" wieder frei. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>channel_info</option>: Zeiger auf eine Liste - "channel info", der von "get_channel_info" zurückgegeben - wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_channel_info (plugin, channel_info);</screen> - </para> - </section> - - <section id="secAPI_get_nick_info"> - <title>get_nick_info</title> - - <para> - Prototyp: - <command> - t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, - char *server, char *channel) - </command> - </para> - <para> - Gib eine Liste der Nicknamen für einen Channel zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: verkettete Liste von Nicknamen eines Channels. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>Nickname</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> - Flags, die für einen Nicknamen gesetzt sind: - Zweierpotenzen "oder" Zwischenwerte - (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>Zeiger auf vorherigen Knoten der Liste</entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>next_nick</literal></entry> - <entry>Zeiger auf nächsten Knoten der Liste</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free_nick_info" wieder freigegeben werden. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void free_nick_info (t_weechat_plugin *plugin, - t_plugin_nick_info *nick_info) - </command> - </para> - <para> - Gibt den Speicher einer Liste "nick info" frei. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>nick_info</option>: Zeiger auf eine Liste - "nick info", der von "get_nick_info" zurückgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_nick_info (plugin, nick_info);</screen> - </para> - </section> - - <section id="secAPI_get_config"> - <title>get_config</title> - - <para> - Prototyp: - <command> - char *get_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Gibt den Wert einer Option der WeeChat-Konfiguration zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Wert der Option, oder NULL, wenn nichts gefunden wurde. - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder - freigegeben werden. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - int set_config (t_weechat_plugin *plugin, - char *option, char *value) - </command> - </para> - <para> - Setze den Wert einer Option der WeeChat-Konfiguration. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - <listitem> - <para> - <option>value</option>: der neue Wert der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: 1 wenn der Wert der Option gesetzt werden konnte, - 0 bei Auftreten eines Fehlers. - </para> - <para> - Beispiel: -<screen> -plugin->set_config (plugin, "look_nicklist", "off"); -</screen> - </para> - </section> - - <section id="secAPI_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Prototyp: - <command> - char *get_plugin_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Gibt den Wert einer Option eines Plugins zurück. - Die Option wird aus "<literal>~/.weechat/plugins.rc</literal>" - gelesen und sieht so aus: "<literal>plugin.option=value</literal>" - (Hinweis: der Name des Plugins wird automatisch gesetzt). - - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Wert der Option, NULL wenn nichts gefunden wurde. - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder - freigegeben werden. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - int set_plugin_config (t_weechat_plugin *plugin, - char *option, char *value) - </command> - </para> - <para> - Setzt den Wert einer Option eines Plugins. - Die Option wird in die Datei - "<literal>~/.weechat/plugins.rc</literal>" geschrieben - und sieht so aus: "<literal>plugin.option=value</literal>" - (Hinweis: der Name des Plugins wird automatisch gesetzt) - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option, die gesetzt werden soll - </para> - </listitem> - <listitem> - <para> - <option>value</option>: Wert der zu setzenden Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: 1 wenn die Option gesetzt werden konnte, 0 wenn ein - Fehler aufgetreten ist. - </para> - <para> - Beispiel: -<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> - Hole IRC-Farbindex mit dem Farbnamen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf die Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>color_name</option>: Farbname - Folgende Farben sind erlaubt: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Farbname</entry> - <entry>Wert</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> - Rückgabewert: IRC-Farbindex, -1 wenn die Farbe nicht gefunden wurde. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void input_color (t_weechat_plugin *plugin, - int color, int start, int length) - </command> - </para> - <para> - Erzeugt einen Farbcode im Eingabepuffer. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf die Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>color</option>: Textfarbe (wenn der Wert < 0 ist, - dann wird der Eingabepuffer aufgefrischt und nicht verändert) - </para> - </listitem> - <listitem> - <para> - <option>start</option>: Startposition für Einfärbung (wenn - der Wert < 0 ist, wird die Maske neu initialisiert) - </para> - </listitem> - <listitem> - <para> - <option>length</option>: Länge der Einfärbung (wenn der Wert - <= 0 ist, wird die Maske neu initialisiert) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiele: -<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> - Gibt die Liste der WeeChat-Fenster zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: verkettete Liste der WeeChat-Fenster. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>win_x</literal></entry> - <entry>horizontale Fensterposition</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_y</literal></entry> - <entry>vertikale Fensterposition</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width</literal></entry> - <entry>Fensterbreite</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height</literal></entry> - <entry>Fensterhöhe</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width_pct</literal></entry> - <entry> - Breite in % (im Vergleich zum übergeordneten Fenster) - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height_pct</literal></entry> - <entry> - Höhe % (im Vergleich zum übergeordneten Fenster) - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_buffer</literal></entry> - <entry>Anzahl der angezeigten Puffer</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>prev_window</literal></entry> - <entry> - Zeiger auf die Informationen des vorhergehenden Fensters - </entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>next_window</literal></entry> - <entry> - Zeiger auf die Informationen des nächsten Fensters - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Anmerkung: Das Ergebnis muss nach Benutzung durch einen Aufruf der - "free_window_info"-Funktion gelöscht werden. - </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> - Prototyp: - <command> - void free_window_info (t_weechat_plugin *plugin, - t_plugin_window_info *window_info) - </command> - </para> - <para> - Gibt den Speicher wieder frei, der von der - Fenster-Informationsliste belegt wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>window_info</option>: Zeiger auf - Fenster-Informationsliste, der von der - "get_window_info"-Funktion zurückgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_window_info (plugin, window_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Prototyp: - <command> - t_plugin_buffer_info *get_buffer_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gibt eine Liste der WeeChat-Puffer zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: verkettete Liste der WeeChat-Puffer. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry>Puffertyp: 0=standard, 1=DCC, 2=raw IRC data</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>number</literal></entry> - <entry>Puffer-Nummer</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_displayed</literal></entry> - <entry>Anzahl der Fenster im Puffer</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>server_name</literal></entry> - <entry>Servername für den Puffer (kann NULL sein)</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel_name</literal></entry> - <entry>Channelname für den Puffer (kann NULL sein)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>notify_level</literal></entry> - <entry>Benachrichtigungslevel für den Puffer</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>log_filename</literal></entry> - <entry> - Name der Logdatei (NULL bedeutet, dass nichts geloggt - wird) - </entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>prev_buffer</literal></entry> - <entry>Zeiger auf die vorhergehenden Pufferinformationen</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>next_buffer</literal></entry> - <entry>Zeiger auf die nächsten Pufferinformationen</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Bemerkung: Das Ergebnis muss nach der Auswertung mit der - "free_buffer_info"-Funktion wieder gelöscht werden. - </para> - <para> - Beispiel: -<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> - Prototyp: - <command> - void free_buffer_info (t_weechat_plugin *plugin, - t_plugin_buffer_info *buffer_info) - </command> - </para> - <para> - Gibt den Speicher frei, der von der Puffer-Informationsliste - belegt wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>buffer_info</option>: pointer to buffer info list - returned by "get_buffer_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiel: - <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> - Gibt den Inhalt des Puffers zurück. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Channelname - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: Pufferinhalt (verkettete Liste mit den Zeilen). - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>time_t</entry> - <entry><literal>date</literal></entry> - <entry>Datum/Zeit</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>Zeileninhalt (Farbcodes wurden entfernt)</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>prev_line</literal></entry> - <entry>Zeiger auf die vorherige Zeile</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>next_line</literal></entry> - <entry>Zeiger auf die nächste Zeile</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Bemerkung: Das Ergebnis muss nach der Auswertung mit der - "free_buffer_data"-Funktion wieder gelöscht werden. - </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> - Gibt den Speicher frei, der von den Pufferzeilen belegt wurde. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>buffer_line</option>: Zeiger auf Pufferzeilen, der - von der "get_buffer_data"-Funktion zurückgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - Rückgabewert: keiner. - </para> - <para> - Beispiele: - <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> - </para> - </section> - -</section> - ---> +</chapter> diff --git a/doc/de/dev/plugin_c_api.de.xml b/doc/de/dev/plugin_c_api.de.xml new file mode 100644 index 000000000..89aeedec3 --- /dev/null +++ b/doc/de/dev/plugin_c_api.de.xml @@ -0,0 +1,3527 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +WeeChat documentation (german 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="secAPIFunctions"> + <!-- TRANSLATION NEEDED --> + <title>Plugin C API</title> + + <section id="secAPI_set_charset"> + <title>set_charset</title> + + <para> + Prototyp: + <command> + void set_charset (t_weechat_plugin *plugin, char *charset) + </command> + </para> + <para> + Legt neuen Zeichensatz für ein Plugin fest. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>charset</option>: neuer Zeichensatz, der benutzt + werden soll + </para> + </listitem> + </itemizedlist> + </para> + <para> + Beispiel: + <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> + </para> + </section> + + <section id="secAPI_iconv_to_internal"> + <title>iconv_to_internal</title> + + <para> + Prototyp: + <command> + void iconv_to_internal (t_weechat_plugin *plugin, char *charset, + char *string) + </command> + </para> + <para> + Konvertiert eine Zeichenkette in das interne Format von WeeChat + (UTF-8). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>charset</option>: ursprünglicher Zeichensatz, von + dem konvertiert werden soll + </para> + </listitem> + <listitem> + <para> + <option>string</option>: zu konvertierende Zeichenkette + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: konvertierte Zeichenkette + </para> + <para> + Anmerkung: der Speicher, der durch das Ergebnis belegt wird, muss + mit free() wieder freigegeben werden. + </para> + <para> + Beispiel: + <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "iso string: é à");</screen> + </para> + </section> + + <section id="secAPI_iconv_from_internal"> + <title>iconv_from_internal</title> + + <para> + Prototyp: + <command> + void iconv_from_internal (t_weechat_plugin *plugin, char *charset, + char *string) + </command> + </para> + <para> + Konvertiert eine Zeichenkette von dem internen WeeChat-Zeichensatz + (UTF-8) in einen anderen. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>charset</option>: Ziel-Zeichensatz + </para> + </listitem> + <listitem> + <para> + <option>string</option>: zu konvertierende Zeichenkette + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: konvertierte Zeichenkette + </para> + <para> + Anmerkung: der Speicher, der durch das Ergebnis belegt wird, muss + mit free() wieder freigegeben werden. + </para> + <para> + Beispiel: + <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "utf-8 string: é à");</screen> + </para> + </section> + + <section id="secAPI_ascii_strcasecmp"> + <title>ascii_strcasecmp</title> + + <para> + Prototyp: + <command> + int ascii_strcasecmp (t_weechat_plugin *plugin, + char *string1, char *string2) + </command> + </para> + <para> + Vergleich von Zeichenketten unabhängig von Sprache und + Schreibweise (gross/klein). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>string1</option>: erste Zeichenkette des Vergleichs + </para> + </listitem> + <listitem> + <para> + <option>string2</option>: zweite Zeichenkette des Vergleichs + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner + Null wenn + string1 < string2, Null wenn string1 == string2, grösser Null + wenn string1 > string2 + </para> + <para> + Beispiel: + <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> + </para> + </section> + + <section id="secAPI_ascii_strncasecmp"> + <title>ascii_strncasecmp</title> + + <para> + Prototyp: + <command> + int ascii_strncasecmp (t_weechat_plugin *plugin, + char *string1, char *string2, int max) + </command> + </para> + <para> + Vergleich von Zeichenketten unabhängig von Sprache und Schreibweise + (gross/klein) für höchstens "max" Zeichen. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>string1</option>: erste Zeichenkette des Vergleichs + </para> + </listitem> + <listitem> + <para> + <option>string2</option>: zweite Zeichenkette des Vergleichs + </para> + </listitem> + <listitem> + <para> + <option>max</option>: maximale Zahl an Zeichen für den + Vergleich + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner + Null wenn string1 < string2, Null wenn string1 == string2, + grösser Null wenn string1 > string2 + </para> + <para> + Beispiel: + <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> + </para> + </section> + + <section id="secAPI_explode_string"> + <title>explode_string</title> + + <para> + Prototyp: + <command> + char **explode_string (t_weechat_plugin *plugin, char *string, + char *separators, int num_items_max, int *num_items) + </command> + </para> + <para> + Zerlege eine Zeichenkette entsprechend eines oder mehrerer + Trennzeichen(s). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>string</option>: zu zerlegende Zeichenkette + </para> + </listitem> + <listitem> + <para> + <option>separators</option>: zu verwendende(s) Trennzeichen + </para> + </listitem> + <listitem> + <para> + <option>num_items_max</option>: maximale Anzahl an zu + erzeugenden Teilen (0 = keine Grenze) + </para> + </listitem> + <listitem> + <para> + <option>num_items</option>: Zeiger auf eine int-Variable, + die die Anzahl der erzeugten + Teile enthält + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: ein Array von Zeichenketten, NULL bei Fehlern. + </para> + <para> + Hinweis: Das zurückgegebene Array muss nach der Benutzung mittels + "free_exloded_string" explizit freigegeben werden. + </para> + <para> + Beispiel: +<screen> +char **argv; +int argc; +argv = plugin->explode_string (plugin, string, " ", 0, &argc); +... +if (argv != NULL) + plugin->free_exploded_string (plugin, argv); +</screen> + </para> + </section> + + <section id="secAPI_free_exploded_string"> + <title>free_exploded_string</title> + + <para> + Prototyp: + <command> + char **free_exploded_string (t_weechat_plugin *plugin, + char **string) + </command> + </para> + <para> + Gib ein Array frei, dass infolge der Zerlegung eines Strings + reserviert wurde. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>string</option>: ein Array von Strings + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner (?). + </para> + <para> + Beispiel: +<screen> +char *argv; +int argc; +argv = plugin->explode_string (plugin, string, " ", 0, &argc); +... +if (argv != NULL) + plugin->free_exploded_string (plugin, argv); +</screen> + </para> + </section> + + <section id="secAPI_mkdir_home"> + <title>mkdir_home</title> + + <para> + Prototyp: + <command> + int mkdir_home (t_weechat_plugin *plugin, char *directory) + </command> + </para> + <para> + Erzeugt ein Verzeichnis im WeeChat-Verzeichnis. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstrukur + </para> + </listitem> + <listitem> + <para> + <option>directory</option>: Verzeichnis, das erzeugt werden + soll + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: 1 wenn das Verzeichnis erfolgreich erstellt wurde, 0 + wenn ein Fehler aufgetreten ist. + </para> + <para> + Beispiel: +<screen> +if (!plugin->mkdir_home (plugin, "temp")) + plugin->print_server(plugin, "Konnte 'temp'-Verzeichnis im WeeChat-Verzeichnis nicht erstellen."); +</screen> + </para> + </section> + + <section id="secAPI_exec_on_files"> + <title>exec_on_files</title> + + <para> + Prototyp: + <command> + void exec_on_files (t_weechat_plugin *plugin, char *repertoire, + int (*callback)(t_weechat_plugin *, char *)) + </command> + </para> + <para> + Führe eine Funktion auf allen Dateien eines Verzeichnisses aus. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>directory</option>: Verzeichnis der zu verwendenden + Dateien + </para> + </listitem> + <listitem> + <para> + <option>callback</option>: die anzuwendende Funktion + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: +<screen> +int callback (t_weechat_plugin *plugin, char *file) +{ + plugin->print_server (plugin, "file: %s", file); + return 1; +} +... +plugin->exec_on_files (plugin, "/tmp", &callback); +</screen> + </para> + </section> + + <section id="secAPI_print"> + <title>print</title> + + <para> + Prototyp: + <command> + void print (t_weechat_plugin *plugin, + char *server, char *channel, char *message, ...) + </command> + </para> + <para> + Sende eine Nachricht an einen WeeChat-Puffer, bezeichnet durch + server und channel (beide können NULL sein, dann wird der aktuelle + Puffer verwendet). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Servers, zu + welchem der Puffer gehört, in dem die Nachricht angezeigt + werden soll (kann NULL sein) + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: Name des Channels, in dem die + Nachricht angezeigt werden soll (kann NULL sein) + </para> + </listitem> + <listitem> + <para> + <option>message</option>: Nachricht + </para> + </listitem> + </itemizedlist> + </para> + <!-- TRANSLATION NEEDED --> + <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> + Rückgabewert: keiner. + </para> + <para> + Beispiele: +<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 Fett \x0F\x03%02d Blau \x03%02d Grün", + 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> + Prototyp: + <command> + void print_server (t_weechat_plugin *plugin, + char *message, ...) + </command> + </para> + <para> + Zeige eine Nachricht im aktuellen Server-Puffer. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>message</option>: Nachricht + </para> + </listitem> + </itemizedlist> + </para> + <para> + <!-- TRANSLATION NEEDED --> + To display colored text, see <xref linkend="secAPI_print" />. + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: <screen>plugin->print_server (plugin, "hello");</screen> + </para> + </section> + + <section id="secAPI_log"> + <title>log</title> + + <para> + Prototyp: + <command> + void log (t_weechat_plugin *plugin, + char *server, char *channel, char *message, ...) + </command> + </para> + <para> + Schreibe eine Nachricht in die Log-Datei (für den entsprechenden + Server/Channel). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Servers, zu + welchem der Log-Puffer gehört (kann NULL sein) + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: Name des Channels, zu welchem der + Log-Puffer gehört (kann NULL sein) + </para> + </listitem> + <listitem> + <para> + <option>message</option>: Nachricht + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: +<screen> +plugin->log (plugin, "freenode", "#weechat", "test"); +</screen> + </para> + </section> + + <section id="secAPI_msg_handler_add"> + <title>msg_handler_add</title> + + <para> + Prototyp: + <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> + Erzeuge einen IRC-Message-Handler, der aufgerufen wird, wenn + eine Nachricht empfangen wird. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>message</option>: Name (Typ) der IRC-Nachricht ("*" + für alle Nachrichten). + Eine Liste der bekannten IRC-Nachrichten ist in den + <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + und + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> + zu finden. + Weiterhin können sie einen speziellen Namen verwenden, der + mit "weechat_" beginnt, um spezielle Ereignisse zu + bearbeiten, wie in der folgenden Tabelle aufgeführt: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>weechat_pv</literal></entry> + <entry>private Nachricht empfangen</entry> + </row> + <row> + <entry><literal>weechat_highlight</literal></entry> + <entry> + hervorgehobene Nachricht (in einem Channel oder privatem Chat) + </entry> + </row> + <row> + <entry><literal>weechat_ctcp</literal></entry> + <entry> + CTCP-Nachricht empfangen (VERSION, PING, ...) + </entry> + </row> + <row> + <entry><literal>weechat_dcc</literal></entry> + <entry> + DCC-Nachricht empfangen (Chat oder Datei) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>function</option>: Funktion, die aufgerufen wird, + wenn eine Nachricht empfangen wurde + </para> + <para> + Sie verwendet den folgenden Prototyp: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Argument argc ist auf 3 gesetzt, die folgenden Werte sind + im argv-Array: + <itemizedlist> + <listitem> + <para>argv[0] = Server Name</para> + </listitem> + <listitem> + <para>argv[1] = IRC Nachricht</para> + </listitem> + <listitem> + <para>argv[2] = Kommando Argumente</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: Argumente, die beim Aufruf + an die Funktion übergeben werden + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: pointer given to function + when called + <option>handler_pointer</option>: Zeiger, der an die Funktion + übergeben wird + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Zeiger auf den neuen Handler + </para> + <para> + Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht + empfangen wurde, muss einen der folgenden Werte zurückgeben: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgschlagen + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: Die Nachricht + wird nicht an WeeChat übergeben + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: Die Nachricht + wird nicht an andere Plugins weitergegeben + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: Die Nachricht + wird weder an WeeChat noch an andere + Plugins weitergegeben + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: Funktion + erfolgreich vervollständigt und eine Hervorhebung bei den + empfangenen Nachrichten eingebaut + </para> + </listitem> + </itemizedlist> + </para> + <para> + Beispiel: +<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> + Prototyp: + <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> + Erzeugt einen Handler für ein WeeChat-Kommando, der aufgerufen + wird, wenn der Anwender das Kommando ausführt (Beispiel: /command). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>command</option>: Name des neuen Kommandos, der auch + Name eines bereits existierenden Kommandos sein kann (mit + Bedacht zu verwenden, das ersetzte Kommando ist nicht + verfügbar, bis das Plugin entfernt wurde) + </para> + </listitem> + <listitem> + <para> + <option>description</option>: kurze Beschreibung des + Kommandos (angezeigt beim Ausführen von /help command) + </para> + </listitem> + <listitem> + <para> + <option>arguments</option>: kurze Beschreibung der Argumente + des Kommandos (angezeigt beim Ausführen von /help command) + </para> + </listitem> + <listitem> + <para> + <option>arguments_description</option>: lange Beschreibung + der Argumente des Kommandos (angezeigt beim Ausführen von + /help command) + </para> + </listitem> + <listitem> + <para> + <option>completion_template</option>: Vorlage für die + Vervollständigung; zum Beispiel bedeutet + "<literal>abc|%w def|%i</literal>", dass das erste Argument + "abc" oder ein WeeChat-Kommando sein kann und das zweite + Argument "def" oder ein IRC-Kommando. Eine leere + Zeichenkette bedeutet, dass WeeChat für jedes Argument + einen Nicknamen des gegenwärtigen Channels einsetzt, ein + NULL oder "-" schaltet die Vervollständigung für alle + Argumente ab. + </para> + <para> + Die folgenden Ersetzungen können verwendet werden: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Code</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>%-</literal></entry> + <entry>keine Vervollständigung für das Argument</entry> + </row> + <row> + <entry><literal>%*</literal></entry> + <entry> + <!-- TRANSLATION NEEDED --> + 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> + Aliase und Kommandos (WeeChat, IRC und Plugins) + </entry> + </row> + <row> + <entry><literal>%c</literal></entry> + <entry>gegenwärtiger Channel</entry> + </row> + <row> + <entry><literal>%C</literal></entry> + <entry>alle channels (inklusive Queries)</entry> + </row> + <row> + <entry><literal>%f</literal></entry> + <entry>Dateiname</entry> + </row> + <row> + <entry><literal>%h</literal></entry> + <entry>Plugin Kommandos</entry> + </row> + <row> + <entry><literal>%i</literal></entry> + <entry>IRC Kommandos (senden)</entry> + </row> + <row> + <entry><literal>%I</literal></entry> + <entry>IRC Kommandos (empfangen)</entry> + </row> + <row> + <entry><literal>%k</literal></entry> + <entry>Grundfunktionen</entry> + </row> + <row> + <entry><literal>%m</literal></entry> + <entry>Nicknamen des gegenwärtigen Servers</entry> + </row> + <row> + <entry><literal>%M</literal></entry> + <entry> + Nicks auf dem gegenwärtigen Server (in allen + offenen Channeln) + </entry> + </row> + <row> + <entry><literal>%n</literal></entry> + <entry>Nicknamen des gegenwärtigen Channels</entry> + </row> + <row> + <entry><literal>%N</literal></entry> + <entry> + Nicknamen und Hostnamen des gegenwärtigen + Channels + </entry> + </row> + <row> + <entry><literal>%o</literal></entry> + <entry>Konfigurationseinstellungen</entry> + </row> + <row> + <entry><literal>%O</literal></entry> + <entry>Plugin Optionen</entry> + </row> + <row> + <entry><literal>%p</literal></entry> + <entry>Standard "part" Nachricht</entry> + </row> + <row> + <entry><literal>%q</literal></entry> + <entry>Standard "quit" Nachricht</entry> + </row> + <row> + <entry><literal>%s</literal></entry> + <entry>Name des gegenwärtigen Servers</entry> + </row> + <row> + <entry><literal>%S</literal></entry> + <entry>Namen aller definierten Server</entry> + </row> + <row> + <entry><literal>%t</literal></entry> + <entry>Topic des gegenwärtigen Channels</entry> + </row> + <row> + <entry><literal>%v</literal></entry> + <entry>Wert einer Konfigurationseinstellung</entry> + </row> + <row> + <entry><literal>%V</literal></entry> + <entry>Wert einer Plugin-Option</entry> + </row> + <row> + <entry><literal>%w</literal></entry> + <entry>WeeChat Kommandos</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>function</option>: Funktion, die aufgerufen wird, + wenn das Kommando ausgeführt wird + </para> + <para> + Sie verwendet den folgenden Prototypen: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Das Argument argc ist auf 3 gesetzt, das Array argv enthält + die folgenden Werte: + <itemizedlist> + <listitem> + <para>argv[0] = Server Name</para> + </listitem> + <listitem> + <para>argv[1] = Kommando</para> + </listitem> + <listitem> + <para>argv[2] = Kommando-Argumente</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: Argumente, die an die Funktion + übergeben werden + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: Zeiger, der an die Funktion + übergeben wird + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Zeiger auf den neuen Kommando-Handler. + </para> + <para> + Hinweis: die Funktion, die aufgerufen wird, wenn das Kommando + ausgeführt wird, muss einen der folgende Werte zurückgeben: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich + </para> + </listitem> + </itemizedlist> + </para> + <para> + Beispiel: +<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> + Prototyp: + <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> + Erzeuge einen zeitgesteuerten Handler, der periodisch + eine Funktion aufruft. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>interval</option>: Intervall (in Secunden) zwischen + zwei Aufrufen der Funktion + </para> + </listitem> + <listitem> + <para> + <option>function</option>: Funktion, die aufgerufen wird + </para> + <para> + Sie verwendet den folgenden Prototypen: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Das Argument argc ist auf 0 gesetzt und argv ist auf NULL + gesetzt. + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: Argumente der aufgerufenen + Funktion + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: Zeiger, der an die Funktion + übergeben wird + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Zeiger auf den neuen timer-Handler. + </para> + <para> + Hinweis: die Funktion, die aufgerufen wird, muss einen der folgende + Werte zurückgeben: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich + </para> + </listitem> + </itemizedlist> + </para> + <para> + Beispiel: +<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> + Prototyp: + <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> + Erzeugt einen Keyboard-Handler, der nach dem Drücken einer Taste + aufgerufen wird. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>function</option>: Die Funktion, die aufgerufen wird + </para> + <para> + Sie verwendet den folgenden Prototypen: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Das Argument argc ist auf 3 gesetzt, argv enthält die + folgenden Werte: + <itemizedlist> + <listitem> + <para> + argv[0] = Taste, die gedrückt wurde + (Name der internen Funktion oder '*' gefolgt von einem + Tastaturcode) + </para> + </listitem> + <listitem> + <para> + argv[1] = Kommandozeile vor dem Tastendruck + </para> + </listitem> + <listitem> + <para> + argv[2] = Kommandozeile nach dem Tastendruck + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: Argumente, die bei Aufruf der + Funktion übergeben + werden + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: Zeiger auf die Funktion, + der bei Aufruf übergeben + wird + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Zeiger auf den Handler. + </para> + <para> + Hinweis: Die aufgerufene Funktion muss einen der folgenden Werte + zurückgeben: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich + </para> + </listitem> + </itemizedlist> + </para> + <para> + Beispiel: +<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> + Prototyp: + <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> + Fügt einen Ereignishandler hinzu, der aufgerufen wird, wenn ein + Ereignis eintritt. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Strukture + </para> + </listitem> + <listitem> + <para> + <option>event</option> : Ereignis (siehe folgende Tabelle) + </para> + </listitem> + <listitem> + <para> + <option>function</option>: aufgerufene Funktion + </para> + <para> + Es wird folgender Prototyp verwendet: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + <!-- TRANSLATION NEEDED --> + Arguments depend on event (see table below). + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option>: Argument, die an die aufgerufene + Funktion übergeben werden + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option>: Pointer, der an die + aufgerufene Funktion übergeben werden + </para> + </listitem> + </itemizedlist> + </para> + <!-- TRANSLATION NEEDED --> + <para> + List of events: + <informaltable colsep="0" frame="none"> + <tgroup cols="3"> + <thead> + <row> + <entry>Ereignis</entry> + <entry>Beschreibung</entry> + <entry>Arguments</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>buffer_open</literal></entry> + <entry>ein Puffer wurde geöffnet</entry> + <entry> + argc = 1, argv = { buffer number } + </entry> + </row> + <row> + <entry><literal>buffer_close</literal></entry> + <entry>ein Puffer wurde geschlossen</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> + Rückgabewert: Pointer auf den neuen Ereignishandler. + </para> + <para> + Anmerkung: die aufgerufene Function muss einen der folgenden Werte + zurückgeben: + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal>: Funktion fehlgeschlagen + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal>: Funktion erfolgreich beendet + </para> + </listitem> + </itemizedlist> + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void handler_remove (t_weechat_plugin *plugin, + t_plugin_handler *handler) + </command> + </para> + <para> + Entfernt einen Nachrichten- oder Kommando-Handler. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>handler</option>: Handler, der entfernt werden soll + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner + </para> + <para> + Beispiel: + <screen>plugin->handler_remove (plugin, my_handler);</screen> + </para> + </section> + + <section id="secAPI_handler_remove_all"> + <title>handler_remove_all</title> + + <para> + Prototyp: + <command> + void handler_remove_all (t_weechat_plugin *plugin) + </command> + </para> + <para> + Entfernt alle Handler eines Plugins. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner + </para> + <para> + Beispiel: + <screen>plugin->handler_remove_all (plugin);</screen> + </para> + </section> + + <section id="secAPI_modifier_add"> + <title>modifier_add</title> + + <para> + Prototyp: + <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> + Füge einen Nachrichtenmodifikator hinzu. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>type</option>: Modifikatorart: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Art</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>irc_in</literal></entry> + <entry>wird bei eingehenden IRC-Nachrichten aufgerufen</entry> + </row> + <row> + <entry><literal>irc_user</literal></entry> + <entry> + wird bei jeder Benutzernachricht (oder Befehl) + aufgerufen (bevor WeeChat die Nachricht parst) + </entry> + </row> + <row> + <entry><literal>irc_out</literal></entry> + <entry> + wird unmittelbar vor dem Abschicken einer ausgehenden + Nachricht an den IRC-Server aufgerufen (auch bei + Nachrichten, die WeeChat automatisch an den Server + sendet) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>message</option>: Name der IRC-Nachricht (wird nur + bei den Arten "irc_in" and "irc_out" benutzt) + Um eine Liste der IRC-Nachrichten zu erhalten, lies bitte + folgende Dokumente:<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>. + Außerdem gibt es den Wert "*", der alle Nachrichten + anspricht (ohne Filter). + </para> + </listitem> + <listitem> + <para> + <option>function</option>: aufgerufene Funktion + </para> + <para> + Folgender Prototyp wird dafür benutzt: + <command> + int my_function (t_weechat_plugin *plugin, + int argc, char **argv, + char *modifier_args, void *modifier_pointer) + </command> + </para> + <para> + Argument argc hat den Wert 2, folgende Werte sind in dem + argv-Array: + <itemizedlist> + <listitem> + <para>argv[0] = Servername</para> + </listitem> + <listitem> + <para>argv[1] = Nachricht</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>modifier_args</option>: an die Funktion übergebene + Werte + </para> + </listitem> + <listitem> + <para> + <option>modifier_pointer</option>: an die Funktion + übergebener Zeiger + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Zeiger auf den neuen Nachrichtenmodifikator + </para> + <para> + Anmerkung: Die Funktion muss die veränderte Zeichenkette oder NULL + (wenn keine Änderungen erfolgten) zurückgeben. + Wenn die Funktion eine leere Zeichenkette zurückgibt, wird die + Nachricht komplett verworfen und nicht weiter von WeeChat + verarbeitet. (Seien Sie vorsichtig mit dem Verwerfen von + Nachrichten!) Die zurückgegebene Zeichenkette muss mit malloc() + zugewiesen worden sein und wird von WeeChat nach Gebrauch + automatisch mit free() wieder freigegeben. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void modifier_remove (t_weechat_plugin *plugin, + t_plugin_modifier *modifier) + </command> + </para> + <para> + Entfernt einen Nachrichtenmodifikator. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>modifier</option>: zu entfernender Modifikator + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner + </para> + <para> + Beispiel: + <screen>plugin->modifier_remove (plugin, my_modifier);</screen> + </para> + </section> + + <section id="secAPI_modifier_remove_all"> + <title>modifier_remove_all</title> + + <para> + Prototyp: + <command> + void modifier_remove_all (t_weechat_plugin *plugin) + </command> + </para> + <para> + Entfernt alle Modifikatoren für ein Plugin. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Plugin-Struktur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner + </para> + <para> + Beispiel: + <screen>plugin->modifier_remove_all (plugin);</screen> + </para> + </section> + + <section id="secAPI_exec_command"> + <title>exec_command</title> + + <para> + Prototyp: + <command> + void exec_command (t_weechat_plugin + *plugin, char *server, char *channel, char *command) + </command> + </para> + <para> + Führe ein WeeChat-Kommando aus (oder sende eine Nachricht an + einen Channel). + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Servers, auf den + das Kommando angewendet werden soll (kann NULL sein) + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: Name des Channels, auf den das + Kommando angewendet werden soll (kann NULL sein) + </para> + </listitem> + <listitem> + <para> + <option>command</option>: Kommando + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + char *get_info (t_weechat_plugin *plugin, + char *info, char *server) + </command> + </para> + <para> + Gib eine Information über WeeChat oder einen Channel zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>info</option> : Name (Typ) der Information: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Info</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>version</literal></entry> + <entry>WeeChats Version</entry> + </row> + <row> + <entry><literal>nick</literal></entry> + <entry>Nickname</entry> + </row> + <row> + <entry><literal>channel</literal></entry> + <entry> + Name des Channels (NULL bei einem Server oder + Privatchat) + </entry> + </row> + <row> + <entry><literal>server</literal></entry> + <entry>Name des Servers</entry> + </row> + <row> + <entry><literal>type</literal></entry> + <entry> + Puffertyp: 0=standard, 1=DCC, 2=raw IRC data + </entry> + </row> + <row> + <entry><literal>away</literal></entry> + <entry>Status des "away"-Flags</entry> + </row> + <row> + <entry><literal>inactivity</literal></entry> + <entry> + Anzahl der Sekunden seit der letzten + Tastenbetätigung + </entry> + </row> + <row> + <entry><literal>input</literal></entry> + <entry> + Inhalt der Kommandozeile im gegenwärtigen Fenster + </entry> + </row> + <row> + <entry><literal>input_mask</literal></entry> + <entry> + Inhalt der Farbmaske für die Kommandozeile + </entry> + </row> + <row> + <entry><literal>input_pos</literal></entry> + <entry> + Position des Cursors in der Kommandozeile + </entry> + </row> + <row> + <entry><literal>weechat_dir</literal></entry> + <entry> + WeeChat-Verzeichnis (Standard: ~/.weechat/) + </entry> + </row> + <row> + <entry><literal>weechat_libdir</literal></entry> + <entry>WeeChat-Systemverzeichnis (Bibliotheken)</entry> + </row> + <row> + <entry><literal>weechat_sharedir</literal></entry> + <entry>WeeChat-Systemverzeichnis (gemeinsame Dateien)</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Servers um + Informationen zu lesen (wenn benötigt) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: angeforderte Information oder NULL + </para> + <para> + Hinweis: das Ergebnis muss nach Nutzung mit "free" wieder + freigegeben werden. + </para> + <para> + Beispiele: +<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> + Prototyp: + <command> + t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Gib eine Liste der aktiven oder beendeten DCCs zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: verkettete Liste von DCCs. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</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 Typ: + 0 = Chatanfrage empfangen, + 1 = Chatanfrage gesendet, + 2 = Datei empfangen, + 3 = Datei gesendet + </entry> + </row> + <row> + <entry>int*</entry> + <entry><literal>status</literal></entry> + <entry> + DCC Status: + 0 = wartend, + 1 = verbindend, + 2 = aktiv, + 3 = beendet, + 4 = fehlgeschlagen, + 5 = unterbrochen durch Anwender + </entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>start_time</literal></entry> + <entry>Datum/Zeit der Erzeugung der DCC</entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>start_transfer</literal></entry> + <entry>Datum/Zeit des Beginns der Übertragung der DCC</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>addr</literal></entry> + <entry>IP-Adresse des Partners</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>port</literal></entry> + <entry>Port der DCC</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>Nickname des Partners</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>filename</literal></entry> + <entry>Dateiname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>local_filename</literal></entry> + <entry>lokaler Dateiname</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>filename_suffix</literal></entry> + <entry>Suffix wenn die Datei umbenannt wird</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>size</literal></entry> + <entry>Dateigrösse</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>pos</literal></entry> + <entry>Position in Datei</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>start_resume</literal></entry> + <entry>Startposition nach einer Unterbrechung</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>bytes_per_sec</literal></entry> + <entry> + Übertragungsrate (Bytes/s) seit Beginn der Übertragung + </entry> + </row> + <row> + <entry>t_plugin_dcc_info *</entry> + <entry><literal>prev_dcc</literal></entry> + <entry> + Zeiger auf voheriges DCC-Info + </entry> + </row> + <row> + <entry>t_plugin_dcc_info *</entry> + <entry><literal>next_dcc</literal></entry> + <entry> + Zeiger auf nächstes DCC-Info + </entry> + </row> + + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Hinweis: Das Ergebnis muss nach der Benutzung mittels + "free_dcc_info" wieder freigegeben werden. + </para> + <para> + Beispiele: +<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> + Prototyp: + <command> + void free_dcc_info (t_weechat_plugin *plugin, + t_plugin_dcc_info *dcc_info) + </command> + </para> + <para> + Gibt den Speicher einer Liste von DCC-Infos wieder frei. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>dcc_info</option>: Zeiger auf eine Liste mit + DCC-Infos, die mit "get_dcc_info" angelegt wurde + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: + <screen>plugin->free_dcc_info (plugin, dcc_info);</screen> + </para> + </section> + + <section id="secAPI_get_server_info"> + <title>get_server_info</title> + + <para> + Prototyp: + <command> + t_plugin_server_info *get_server_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Gibt die Liste von IRC-Servern zurück (verbunden oder nicht) + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Liste von IRC-Servern. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>name</literal></entry> + <entry>interner Servername</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoconnect</literal></entry> + <entry>1 wenn Autoconnect gesetzt ist, 0 sonst</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoreconnect</literal></entry> + <entry> + 1 wenn autoreconnect gesetzt ist, + 0 sonst + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoreconnect_delay</literal></entry> + <entry>Wartezeit vor erneutem Verbindungsversuch</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>command_line</literal></entry> + <entry> + 1 wenn der Servername auf der Kommandozeile angegeben + wurde (ist somit temporär) 0 sonst + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>address</literal></entry> + <entry>Serveradresse (Name oder 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-Verbindung</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ssl</literal></entry> + <entry>SSL-Verbindung</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>password</literal></entry> + <entry>Passwort</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick1</literal></entry> + <entry>primärer Nickname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick2</literal></entry> + <entry>alternativer Nickname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick3</literal></entry> + <entry>zweiter, alternativer Nickname</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>username</literal></entry> + <entry>Username</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>real name</literal></entry> + <entry>tatsächlicher Name</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>command</literal></entry> + <entry> + Kommando, dass bei erfolgreicher Verbindung + ausgeführt wurde + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>command_delay</literal></entry> + <entry>Verzögerung nach Ausführung des Kommandos</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>autojoin</literal></entry> + <entry>Channels, die automatisch betreten werden sollen</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autorejoin</literal></entry> + <entry> + 1 wenn Channels wieder betreten werden sollen, nachdem + man gekickt wurde 0 sonst + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>notify_levels</literal></entry> + <entry>Benachrichtigungs-Level von Channels</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_decode_iso</literal></entry> + <entry>Zeichensatz zum Dekodieren von ISO</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_decode_utf</literal></entry> + <entry>Zeichensatz zum Dekodieren von UTF</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_encode</literal></entry> + <entry> + Zeichensatz der Channels zum Kodieren von + Nachrichten + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>is_connected</literal></entry> + <entry>1 wenn verbunden mit einem Server, 0 otherwise</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ssl_connected</literal></entry> + <entry>1 wenn verbunden über SSL, 0 sonst</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>gegenwärtiger Nickname</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>is_away</literal></entry> + <entry>1 wenn away-flag gesetzt ist, 0 sonst</entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>away_time</literal></entry> + <entry>Zeitspanne seit away-flag gesetzt ist</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>lag</literal></entry> + <entry>Lag (in Millisekunden)</entry> + </row> + <row> + <entry>t_plugin_server_info *</entry> + <entry><literal>prev_server</literal></entry> + <entry>Zeiger auf vorherigen Knoten der Liste</entry> + </row> + <row> + <entry>t_plugin_server_info *</entry> + <entry><literal>next_server</literal></entry> + <entry>Zeiger auf nächsten Knoten der Liste</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Hinweis: das Ergebnis muss nach der Benutzung mit + "free_server_info" wieder freigegeben werden. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void free_server_info (t_weechat_plugin *plugin, + t_plugin_server_info *server_info) + </command> + </para> + <para> + Gib den Speicher einer Liste "server info" frei + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>server_info</option>: Zeiger auf eine Server-Liste, + der von der Funktion "get_server_info" zurückgegeben wurde. + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: + <screen>plugin->free_server_info (plugin, server_info);</screen> + </para> + </section> + + <section id="secAPI_get_channel_info"> + <title>get_channel_info</title> + + <para> + Prototyp: + <command> + t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, + char *server) + </command> + </para> + <para> + Gib eine Liste der Channels für einen Server zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Server + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: verkettete Liste von Channels für einen Server. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry> + 0 für einen normalen Channel, 1 für einen Privaten + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>name</literal></entry> + <entry>Name des Channels</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>topic</literal></entry> + <entry>Topic des Channels</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>modes</literal></entry> + <entry>Channelmodus (Flags)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>limit</literal></entry> + <entry>Anzahl der erlaubten User</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>key</literal></entry> + <entry>Schlüssel des Channels</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>nicks_count</literal></entry> + <entry>Anzahl der Nicknamen des Channels</entry> + </row> + <row> + <entry>t_plugin_channel_info *</entry> + <entry><literal>prev_channel</literal></entry> + <entry>Zeiger auf vorherigem Knoten der Liste</entry> + </row> + <row> + <entry>t_plugin_channel_info *</entry> + <entry><literal>next_channel</literal></entry> + <entry>Zeiger auf nächsten Knoten der Liste</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Hinweis: Das Ergebnis muss nach der Benutzung mit + "free_channel_info" wieder freigegeben werden. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void free_channel_info (t_weechat_plugin *plugin, + t_plugin_channel_info *channel_info) + </command> + </para> + <para> + Gibt den Speicher einer Liste "channel info" wieder frei. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>channel_info</option>: Zeiger auf eine Liste + "channel info", der von "get_channel_info" zurückgegeben + wurde + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: + <screen>plugin->free_channel_info (plugin, channel_info);</screen> + </para> + </section> + + <section id="secAPI_get_nick_info"> + <title>get_nick_info</title> + + <para> + Prototyp: + <command> + t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, + char *server, char *channel) + </command> + </para> + <para> + Gib eine Liste der Nicknamen für einen Channel zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Servers + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: Name des Channels + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: verkettete Liste von Nicknamen eines Channels. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>Nickname</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> + Flags, die für einen Nicknamen gesetzt sind: + Zweierpotenzen "oder" Zwischenwerte + (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>Zeiger auf vorherigen Knoten der Liste</entry> + </row> + <row> + <entry>t_plugin_nick_info *</entry> + <entry><literal>next_nick</literal></entry> + <entry>Zeiger auf nächsten Knoten der Liste</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Hinweis: Das Ergebnis muss nach der Benutzung mit "free_nick_info" wieder freigegeben werden. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void free_nick_info (t_weechat_plugin *plugin, + t_plugin_nick_info *nick_info) + </command> + </para> + <para> + Gibt den Speicher einer Liste "nick info" frei. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>nick_info</option>: Zeiger auf eine Liste + "nick info", der von "get_nick_info" zurückgegeben wurde + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: + <screen>plugin->free_nick_info (plugin, nick_info);</screen> + </para> + </section> + + <section id="secAPI_get_config"> + <title>get_config</title> + + <para> + Prototyp: + <command> + char *get_config (t_weechat_plugin *plugin, char *option) + </command> + </para> + <para> + Gibt den Wert einer Option der WeeChat-Konfiguration zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>option</option>: Name der Option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Wert der Option, oder NULL, wenn nichts gefunden wurde. + </para> + <para> + Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder + freigegeben werden. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + int set_config (t_weechat_plugin *plugin, + char *option, char *value) + </command> + </para> + <para> + Setze den Wert einer Option der WeeChat-Konfiguration. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>option</option>: Name der Option + </para> + </listitem> + <listitem> + <para> + <option>value</option>: der neue Wert der Option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: 1 wenn der Wert der Option gesetzt werden konnte, + 0 bei Auftreten eines Fehlers. + </para> + <para> + Beispiel: +<screen> +plugin->set_config (plugin, "look_nicklist", "off"); +</screen> + </para> + </section> + + <section id="secAPI_get_plugin_config"> + <title>get_plugin_config</title> + + <para> + Prototyp: + <command> + char *get_plugin_config (t_weechat_plugin *plugin, char *option) + </command> + </para> + <para> + Gibt den Wert einer Option eines Plugins zurück. + Die Option wird aus "<literal>~/.weechat/plugins.rc</literal>" + gelesen und sieht so aus: "<literal>plugin.option=value</literal>" + (Hinweis: der Name des Plugins wird automatisch gesetzt). + + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>option</option>: Name der Option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Wert der Option, NULL wenn nichts gefunden wurde. + </para> + <para> + Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder + freigegeben werden. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + int set_plugin_config (t_weechat_plugin *plugin, + char *option, char *value) + </command> + </para> + <para> + Setzt den Wert einer Option eines Plugins. + Die Option wird in die Datei + "<literal>~/.weechat/plugins.rc</literal>" geschrieben + und sieht so aus: "<literal>plugin.option=value</literal>" + (Hinweis: der Name des Plugins wird automatisch gesetzt) + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf eine Plugin-Struktur + </para> + </listitem> + <listitem> + <para> + <option>option</option>: Name der Option, die gesetzt werden soll + </para> + </listitem> + <listitem> + <para> + <option>value</option>: Wert der zu setzenden Option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: 1 wenn die Option gesetzt werden konnte, 0 wenn ein + Fehler aufgetreten ist. + </para> + <para> + Beispiel: +<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> + Hole IRC-Farbindex mit dem Farbnamen. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf die Pluginstruktur + </para> + </listitem> + <listitem> + <para> + <option>color_name</option>: Farbname + Folgende Farben sind erlaubt: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Farbname</entry> + <entry>Wert</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> + Rückgabewert: IRC-Farbindex, -1 wenn die Farbe nicht gefunden wurde. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void input_color (t_weechat_plugin *plugin, + int color, int start, int length) + </command> + </para> + <para> + Erzeugt einen Farbcode im Eingabepuffer. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf die Pluginstruktur + </para> + </listitem> + <listitem> + <para> + <option>color</option>: Textfarbe (wenn der Wert < 0 ist, + dann wird der Eingabepuffer aufgefrischt und nicht verändert) + </para> + </listitem> + <listitem> + <para> + <option>start</option>: Startposition für Einfärbung (wenn + der Wert < 0 ist, wird die Maske neu initialisiert) + </para> + </listitem> + <listitem> + <para> + <option>length</option>: Länge der Einfärbung (wenn der Wert + <= 0 ist, wird die Maske neu initialisiert) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiele: +<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> + Gibt die Liste der WeeChat-Fenster zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstruktur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: verkettete Liste der WeeChat-Fenster. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>win_x</literal></entry> + <entry>horizontale Fensterposition</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_y</literal></entry> + <entry>vertikale Fensterposition</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_width</literal></entry> + <entry>Fensterbreite</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_height</literal></entry> + <entry>Fensterhöhe</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_width_pct</literal></entry> + <entry> + Breite in % (im Vergleich zum übergeordneten Fenster) + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_height_pct</literal></entry> + <entry> + Höhe % (im Vergleich zum übergeordneten Fenster) + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>num_buffer</literal></entry> + <entry>Anzahl der angezeigten Puffer</entry> + </row> + <row> + <entry>t_plugin_window_info *</entry> + <entry><literal>prev_window</literal></entry> + <entry> + Zeiger auf die Informationen des vorhergehenden Fensters + </entry> + </row> + <row> + <entry>t_plugin_window_info *</entry> + <entry><literal>next_window</literal></entry> + <entry> + Zeiger auf die Informationen des nächsten Fensters + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Anmerkung: Das Ergebnis muss nach Benutzung durch einen Aufruf der + "free_window_info"-Funktion gelöscht werden. + </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> + Prototyp: + <command> + void free_window_info (t_weechat_plugin *plugin, + t_plugin_window_info *window_info) + </command> + </para> + <para> + Gibt den Speicher wieder frei, der von der + Fenster-Informationsliste belegt wird. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstruktur + </para> + </listitem> + <listitem> + <para> + <option>window_info</option>: Zeiger auf + Fenster-Informationsliste, der von der + "get_window_info"-Funktion zurückgegeben wurde + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: + <screen>plugin->free_window_info (plugin, window_info);</screen> + </para> + </section> + + <section id="secAPI_get_buffer_info"> + <title>get_buffer_info</title> + + <para> + Prototyp: + <command> + t_plugin_buffer_info *get_buffer_info (t_weechat_plugin *plugin) + </command> + </para> + <para> + Gibt eine Liste der WeeChat-Puffer zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstruktur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: verkettete Liste der WeeChat-Puffer. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry>Puffertyp: 0=standard, 1=DCC, 2=raw IRC data</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>number</literal></entry> + <entry>Puffer-Nummer</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>num_displayed</literal></entry> + <entry>Anzahl der Fenster im Puffer</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>server_name</literal></entry> + <entry>Servername für den Puffer (kann NULL sein)</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>channel_name</literal></entry> + <entry>Channelname für den Puffer (kann NULL sein)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>notify_level</literal></entry> + <entry>Benachrichtigungslevel für den Puffer</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>log_filename</literal></entry> + <entry> + Name der Logdatei (NULL bedeutet, dass nichts geloggt + wird) + </entry> + </row> + <row> + <entry>t_plugin_buffer_info *</entry> + <entry><literal>prev_buffer</literal></entry> + <entry>Zeiger auf die vorhergehenden Pufferinformationen</entry> + </row> + <row> + <entry>t_plugin_buffer_info *</entry> + <entry><literal>next_buffer</literal></entry> + <entry>Zeiger auf die nächsten Pufferinformationen</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Bemerkung: Das Ergebnis muss nach der Auswertung mit der + "free_buffer_info"-Funktion wieder gelöscht werden. + </para> + <para> + Beispiel: +<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> + Prototyp: + <command> + void free_buffer_info (t_weechat_plugin *plugin, + t_plugin_buffer_info *buffer_info) + </command> + </para> + <para> + Gibt den Speicher frei, der von der Puffer-Informationsliste + belegt wird. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstruktur + </para> + </listitem> + <listitem> + <para> + <option>buffer_info</option>: pointer to buffer info list + returned by "get_buffer_info" function + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiel: + <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> + Gibt den Inhalt des Puffers zurück. + </para> + <para> + Argumente: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstruktur + </para> + </listitem> + <listitem> + <para> + <option>server</option>: interner Name des Servers + </para> + </listitem> + <listitem> + <para> + <option>channel</option>: Channelname + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: Pufferinhalt (verkettete Liste mit den Zeilen). + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Typ</entry> + <entry>Feld</entry> + <entry>Beschreibung</entry> + </row> + </thead> + <tbody> + <row> + <entry>time_t</entry> + <entry><literal>date</literal></entry> + <entry>Datum/Zeit</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>Zeileninhalt (Farbcodes wurden entfernt)</entry> + </row> + <row> + <entry>t_plugin_buffer_line *</entry> + <entry><literal>prev_line</literal></entry> + <entry>Zeiger auf die vorherige Zeile</entry> + </row> + <row> + <entry>t_plugin_buffer_line *</entry> + <entry><literal>next_line</literal></entry> + <entry>Zeiger auf die nächste Zeile</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Bemerkung: Das Ergebnis muss nach der Auswertung mit der + "free_buffer_data"-Funktion wieder gelöscht werden. + </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> + Gibt den Speicher frei, der von den Pufferzeilen belegt wurde. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: Zeiger auf Pluginstruktur + </para> + </listitem> + <listitem> + <para> + <option>buffer_line</option>: Zeiger auf Pufferzeilen, der + von der "get_buffer_data"-Funktion zurückgegeben wurde + </para> + </listitem> + </itemizedlist> + </para> + <para> + Rückgabewert: keiner. + </para> + <para> + Beispiele: + <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> + </para> + </section> + +</section> + +--> diff --git a/doc/de/dev/plugin_scripts.de.xml b/doc/de/dev/plugin_script_api.de.xml index 92a1937f8..92a1937f8 100644 --- a/doc/de/dev/plugin_scripts.de.xml +++ b/doc/de/dev/plugin_script_api.de.xml diff --git a/doc/de/dev/plugins.de.xml b/doc/de/dev/plugins.de.xml index 8ceb59370..90f4999cf 100644 --- a/doc/de/dev/plugins.de.xml +++ b/doc/de/dev/plugins.de.xml @@ -133,8 +133,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. </informaltable> </para> - <!-- &plugin_api.de.xml; --> - <section id="secCompilePlugin"> <title>Übersetzen eines Plugins</title> @@ -244,14 +242,4 @@ weechat_plugin_end (struct t_weechat_plugin *plugin) </section> - &plugin_irc.de.xml; - - <!-- &plugin_charset.de.xml; --> - - &plugin_fifo.de.xml; - - <!-- &plugin_scripts.de.xml; --> - - &plugin_xfer.de.xml; - </chapter> diff --git a/doc/de/dev/weechat_dev.de.xml b/doc/de/dev/weechat_dev.de.xml index a2bbecf51..30a32925f 100644 --- a/doc/de/dev/weechat_dev.de.xml +++ b/doc/de/dev/weechat_dev.de.xml @@ -30,11 +30,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. %include_autogen.xml; <!-- ***** written by hand: ***** --> - <!ENTITY intro.de.xml SYSTEM "intro.de.xml"> - <!ENTITY plugins.de.xml SYSTEM "plugins.de.xml"> - <!ENTITY plugin_api.de.xml SYSTEM "plugin_api.de.xml"> - <!ENTITY plugin_scripts.de.xml SYSTEM "plugin_scripts.de.xml"> - <!ENTITY authors.de.xml SYSTEM "authors.de.xml"> + <!ENTITY intro.de.xml SYSTEM "intro.de.xml"> + <!ENTITY plugins.de.xml SYSTEM "plugins.de.xml"> + <!ENTITY plugin_api.de.xml SYSTEM "plugin_api.de.xml"> + <!ENTITY plugin_c_api.de.xml SYSTEM "plugin_c_api.de.xml"> + <!ENTITY plugin_script_api.de.xml SYSTEM "plugin_script_api.de.xml"> + <!ENTITY authors.de.xml SYSTEM "authors.de.xml"> ]> <book lang="de"> @@ -100,7 +101,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. &intro.de.xml; - <!-- &plugins.de.xml; --> + &plugins.de.xml; + + &plugin_api.de.xml; &authors.de.xml; diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am index cafbfaf51..07e89ed38 100644 --- a/doc/en/Makefile.am +++ b/doc/en/Makefile.am @@ -48,29 +48,29 @@ BOOK_COMMON_INCLUDE = authors.$(LANGCODE).xml \ intro.$(LANGCODE).xml BOOK_USER = weechat_user.$(LANGCODE) -BOOK_USER_INCLUDE = user/install.$(LANGCODE).xml \ - user/usage.$(LANGCODE).xml \ - user/plugins.$(LANGCODE).xml \ - user/plugin_alias.$(LANGCODE).xml \ - user/plugin_aspell.$(LANGCODE).xml \ - user/plugin_charset.$(LANGCODE).xml \ - user/plugin_fifo.$(LANGCODE).xml \ - user/plugin_irc.$(LANGCODE).xml \ - user/plugin_logger.$(LANGCODE).xml \ - user/plugin_scripts.$(LANGCODE).xml \ +BOOK_USER_INCLUDE = user/install.$(LANGCODE).xml \ + user/usage.$(LANGCODE).xml \ + user/plugins.$(LANGCODE).xml \ + user/plugin_alias.$(LANGCODE).xml \ + user/plugin_aspell.$(LANGCODE).xml \ + user/plugin_charset.$(LANGCODE).xml \ + user/plugin_fifo.$(LANGCODE).xml \ + user/plugin_irc.$(LANGCODE).xml \ + user/plugin_logger.$(LANGCODE).xml \ + user/plugin_scripts.$(LANGCODE).xml \ user/plugin_xfer.$(LANGCODE).xml BOOK_DEV = weechat_dev.$(LANGCODE) -BOOK_DEV_INCLUDE = dev/plugin_api.$(LANGCODE).xml \ - dev/plugin_scripts.$(LANGCODE).xml \ - dev/plugins.$(LANGCODE).xml \ - dev/weechat_dev.$(LANGCODE).xml +BOOK_DEV_INCLUDE = dev/plugins.$(LANGCODE).xml \ + dev/plugin_api.$(LANGCODE).xml \ + dev/plugin_c_api.$(LANGCODE).xml \ + dev/plugin_script_api.$(LANGCODE).xml QUICKSTART = weechat_quickstart.$(LANGCODE).txt -EXTRA_DIST = $(BOOK_AUTOGEN_INCLUDE) $(BOOK_COMMON_INCLUDE) \ - user/$(BOOK_USER).xml $(BOOK_USER_INCLUDE) \ - dev/$(BOOK_DEV).xml $(BOOK_DEV_INCLUDE) \ +EXTRA_DIST = $(BOOK_AUTOGEN_INCLUDE) $(BOOK_COMMON_INCLUDE) \ + user/$(BOOK_USER).xml $(BOOK_USER_INCLUDE) \ + dev/$(BOOK_DEV).xml $(BOOK_DEV_INCLUDE) \ $(QUICKSTART) if DBLATEX_FOUND diff --git a/doc/en/dev/plugin_api.en.xml b/doc/en/dev/plugin_api.en.xml index 8d90cb480..3dd037d75 100644 --- a/doc/en/dev/plugin_api.en.xml +++ b/doc/en/dev/plugin_api.en.xml @@ -21,4708 +21,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. --> -<section id="secPluginAPI"> +<chapter id="chapPluginAPI"> <title>Plugin API</title> - <!-- =============================[ strings ]============================ --> + &plugin_c_api.en.xml; - <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); + <!-- &plugin_script_api.en.xml; --> -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> +</chapter> diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml new file mode 100644 index 000000000..59402a34f --- /dev/null +++ b/doc/en/dev/plugin_c_api.en.xml @@ -0,0 +1,7300 @@ +<?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="secPluginCApi"> + <title>C plugin API</title> + + <!-- =============================[ plugins ]============================ --> + + <section id="secPluginCApi_plugins"> + <title>Plugins</title> + + <para> + Functions to get infos about plugins. + </para> + + <section id="secPluginCApi_weechat_plugin_get_name"> + <title>weechat_plugin_get_name</title> + + <para> + Prototype: +<programlisting> +void weechat_plugin_get_name (struct t_weechat_plugin *plugin); +</programlisting> + </para> + <para> + Get plugin name (return "core" for WeeChat - NULL pointer). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option>: plugin pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>char *name = weechat_plugin_get_name (plugin);</screen> + </para> + </section> + + </section> + + <!-- =============================[ strings ]============================ --> + + <section id="secPluginCApi_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="secPluginCApi_weechat_charset_set"> + <title>weechat_charset_set</title> + + <para> + Prototype: +<programlisting> +void weechat_charset_set (const char *charset); +</programlisting> + </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="secPluginCApi_weechat_iconv_to_internal"> + <title>weechat_iconv_to_internal</title> + + <para> + Prototype: +<programlisting> +void weechat_iconv_to_internal (const char *charset, const char *string); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <para> + Example: + <screen>char *str = weechat_iconv_to_internal (plugin, "iso-8859-1", "iso string: é à");</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_iconv_from_internal"> + <title>weechat_iconv_from_internal</title> + + <para> + Prototype: +<programlisting> +void weechat_iconv_from_internal (const char *charset, const char *string); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <para> + Example: + <screen>char *str = weechat_iconv_from_internal ("iso-8859-1", "utf-8 string: é à");</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_gettext"> + <title>weechat_gettext</title> + + <para> + Prototype: +<programlisting> +char *weechat_gettext (const char *string); +</programlisting> + </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="secPluginCApi_weechat_ngettext"> + <title>weechat_ngettext</title> + + <para> + Prototype: +<programlisting> +char *weechat_ngettext (const char *string, const char *plural, int count); +</programlisting> + </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="secPluginCApi_weechat_strndup"> + <title>weechat_strndup</title> + + <para> + Prototype: +<programlisting> +char *weechat_strndup (const char *string, int length); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <para> + Example: + <screen>char *str = weechat_strndup ("abcdef", 3); /* result: "abc" */</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_string_tolower"> + <title>weechat_string_tolower</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_tolower (const char *string); +</programlisting> + </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="secPluginCApi_weechat_string_toupper"> + <title>weechat_string_toupper</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_toupper (const char *string); +</programlisting> + </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="secPluginCApi_weechat_strcasecmp"> + <title>weechat_strcasecmp</title> + + <para> + Prototype: +<programlisting> +int weechat_strcasecmp (const char *string1, const char *string2); +</programlisting> + </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="secPluginCApi_weechat_strncasecmp"> + <title>weechat_strncasecmp</title> + + <para> + Prototype: +<programlisting> +int weechat_strncasecmp (const char *string1, const char *string2, int max); +</programlisting> + </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="secPluginCApi_weechat_strcmp_ignore_chars"> + <title>weechat_strcmp_ignore_chars</title> + + <para> + Prototype: +<programlisting> +int weechat_strcmp_ignore_chars (const char *string1, const char *string2, + const char *chars_ignored, int case_sensitive); +</programlisting> + </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="secPluginCApi_weechat_strcasestr"> + <title>weechat_strcasestr</title> + + <para> + Prototype: +<programlisting> +int weechat_strcasestr (const char *string, const char *search); +</programlisting> + </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="secPluginCApi_weechat_string_match"> + <title>weechat_string_match</title> + + <para> + Prototype: +<programlisting> +int weechat_string_match (const char *string, const char *mask, + int case_sensitive); +</programlisting> + </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="secPluginCApi_weechat_string_replace"> + <title>weechat_string_replace</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_replace (const char *string, const char *search, + const char *replace); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <para> + Example: + <screen>char *str = weechat_string_replace ("test", "s", "x"); /* result: "text" */</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_string_remove_quotes"> + <title>weechat_string_remove_quotes</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_remove_quotes (const char *string, const char *quotes); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <para> + Example: + <screen>char *str = weechat_string_remove_quotes (string, " 'abc' ", "'"); /* result: "abc" */</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_string_strip"> + <title>weechat_string_strip</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_strip (const char *string, int left, int right, + const char *chars); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <para> + Example: + <screen>char *str = weechat_strip (string, " ", 0, 1); /* remove spaces at end of string */</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_string_has_highlight"> + <title>weechat_string_has_highlight</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_has_highlight (const char *string, + const char highlight_words); +</programlisting> + </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="secPluginCApi_weechat_string_mask_to_regex"> + <title>weechat_string_mask_to_regex</title> + + <para> + Prototype: +<programlisting> +char *weechat_string_mask_to_regex (const char *mask); +</programlisting> + </para> + <para> + Return a regex, built with a mask, where only special char is "*". + All special chars for regex are escaped. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>mask</option>: mask + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: regex. + </para> + <para> + Example: + <screen>char *regex = weechat_string_mask_to_regex ("test*mask");</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_string_explode"> + <title>weechat_string_explode</title> + + <para> + Prototype: +<programlisting> +char **weechat_string_explode (const char *string, + const char *separators, int keep_eol, + int num_items_max, int *num_items); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "weechat_string_free_exploded" + after use. + </para> + </note> + <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="secPluginCApi_weechat_string_free_exploded"> + <title>weechat_string_free_exploded</title> + + <para> + Prototype: +<programlisting> +void weechat_string_free_exploded (char **exploded_string); +</programlisting> + </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="secPluginCApi_weechat_string_build_with_exploded"> + <title>weechat_string_build_with_exploded</title> + + <para> + Prototype: +<programlisting> +char **weechat_string_build_with_exploded (char **exploded_string, + const char *separator); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to "free" after use. + </para> + </note> + <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="secPluginCApi_weechat_string_split_command"> + <title>weechat_string_split_command</title> + + <para> + Prototype: +<programlisting> +char **weechat_string_split_command (const char *command, char separator); +</programlisting> + </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> + <note> + <para> + Result has to be free by a call to + "weechat_string_free_splitted_command" after use. + </para> + </note> + <para> + Example: + <screen>char **argv = weechat_string_split_command ("/command1;/command2", ';');</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_string_splitted_command"> + <title>weechat_string_free_splitted_command</title> + + <para> + Prototype: +<programlisting> +void weechat_string_free_splitted_command (char **splitted_command); +</programlisting> + </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="secPluginCApi_utf8"> + <title>UTF-8</title> + + <para> + Some UTF-8 string functions. + </para> + + <section id="secPluginCApi_weechat_utf8_has_8bits"> + <title>weechat_utf8_has_8bits</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_has_8bits (const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_is_valid"> + <title>weechat_utf8_is_valid</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_is_valid (const char *string, char **error); +</programlisting> + </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="secPluginCApi_weechat_utf8_normalize"> + <title>weechat_utf8_normalize</title> + + <para> + Prototype: +<programlisting> +void weechat_utf8_normalize (const char *string, char replacement); +</programlisting> + </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="secPluginCApi_weechat_utf8_prev_char"> + <title>weechat_utf8_prev_char</title> + + <para> + Prototype: +<programlisting> +char *weechat_utf8_prev_char (const char *string_start, const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_next_char"> + <title>weechat_utf8_next_char</title> + + <para> + Prototype: +<programlisting> +char *weechat_utf8_next_char (const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_char_size"> + <title>weechat_utf8_char_size</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_char_size (const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_strlen"> + <title>weechat_utf8_strlen</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_strlen (const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_strnlen"> + <title>weechat_utf8_strnlen</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_strnlen (const char *string, int bytes); +</programlisting> + </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="secPluginCApi_weechat_utf8_strlen_screen"> + <title>weechat_utf8_strlen_screen</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_strlen_screen (const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_charcasecmp"> + <title>weechat_utf8_charcasecmp</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_charcasecmp (const char *string1, const char *string2); +</programlisting> + </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="secPluginCApi_weechat_utf8_char_size_screen"> + <title>weechat_utf8_char_size_screen</title> + + <para> + Prototype: +<programlisting> +int weechat_utf8_char_size_screen (const char *string); +</programlisting> + </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="secPluginCApi_weechat_utf8_add_offset"> + <title>weechat_utf8_add_offset</title> + + <para> + Prototype: +<programlisting> +char *weechat_utf8_add_offset (const char *string, int offset); +</programlisting> + </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="secPluginCApi_weechat_utf8_real_pos"> + <title>weechat_utf8_real_pos</title> + + <para> + Prototype: +<programlisting> +char *weechat_utf8_real_pos (const char *string, int pos); +</programlisting> + </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="secPluginCApi_weechat_utf8_pos"> + <title>weechat_utf8_pos</title> + + <para> + Prototype: +<programlisting> +char *weechat_utf8_pos (const char *string, int real_pos); +</programlisting> + </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="secPluginCApi_directories"> + <title>Directories</title> + + <para> + Some functions related to directories. + </para> + + <section id="secPluginCApi_weechat_mkdir_home"> + <title>weechat_mkdir_home</title> + + <para> + Prototype: +<programlisting> +int weechat_mkdir_home (char *directory, int mode); +</programlisting> + </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="secPluginCApi_weechat_mkdir"> + <title>weechat_mkdir</title> + + <para> + Prototype: +<programlisting> +int weechat_mkdir (char *directory, int mode); +</programlisting> + </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="secPluginCApi_weechat_mkdir_parents"> + <title>weechat_mkdir_parents</title> + + <para> + Prototype: +<programlisting> +int weechat_mkdir_parents (char *directory, int mode); +</programlisting> + </para> + <para> + Create a directory and make parent directories as needed. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>directory</option>: directory to create + </para> + </listitem> + <listitem> + <para> + <option>mode</option>: mode for new directory (and parents) + </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_parents ("/tmp/my/dir")) ... </screen> + </para> + </section> + + <section id="secPluginCApi_weechat_exec_on_files"> + <title>weechat_exec_on_files</title> + + <para> + Prototype: +<programlisting> +void weechat_exec_on_files (const char *directory, void *data, + int (*callback)(void *data, const char *filename)); +</programlisting> + </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="secPluginCApi_util"> + <title>Util</title> + + <para> + Some useful functions. + </para> + + <section id="secPluginCApi_weechat_timeval_cmp"> + <title>weechat_timeval_cmp</title> + + <para> + Prototype: +<programlisting> +int weechat_timeval_cmp (struct timeval *tv1, struct timeval *tv2); +</programlisting> + </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="secPluginCApi_weechat_timeval_diff"> + <title>weechat_timeval_diff</title> + + <para> + Prototype: +<programlisting> +long weechat_timeval_diff (struct timeval *tv1, struct timeval *tv2); +</programlisting> + </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="secPluginCApi_weechat_timeval_add"> + <title>weechat_timeval_add</title> + + <para> + Prototype: +<programlisting> +void weechat_timeval_add (struct timeval *tv, long interval); +</programlisting> + </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> + + <!-- ==========================[ sorted list ]=========================== --> + + <section id="secPluginCApi_sorted_list"> + <title>Sorted lists</title> + + <para> + Sorted list functions. + </para> + + <section id="secPluginCApi_weechat_list_new"> + <title>weechat_list_new</title> + + <para> + Prototype: +<programlisting> +struct t_weelist *weechat_list_new (); +</programlisting> + </para> + <para> + Create a new list. + </para> + <para> + Return value: pointer to new list. + </para> + <para> + Example: + <screen>struct t_weelist *list = weechat_list_new ();</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_add"> + <title>weechat_list_add</title> + + <para> + Prototype: +<programlisting> +struct t_weelist_item *weechat_list_add (struct t_weelist *weelist, + const char *data, const char *where); +</programlisting> + </para> + <para> + Add an item in a list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>weelist</option>: list pointer + </para> + </listitem> + <listitem> + <para> + <option>data</option>: data to insert in list + </para> + </listitem> + <listitem> + <para> + <option>where</option>: position in list (constants are: + WEECHAT_LIST_POS_SORT, WEECHAT_LIST_POS_BEGINNING or + WEECHAT_LIST_POS_END) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new item. + </para> + <para> + Example: + <screen>weechat_list_add (list, "my data", WEECHAT_LIST_POS_SORT);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_search"> + <title>weechat_list_search</title> + + <para> + Prototype: +<programlisting> +struct t_weelist_item *weechat_list_search (struct t_weelist *weelist, + const char *data); +</programlisting> + </para> + <para> + Search an item in a list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>weelist</option>: list pointer + </para> + </listitem> + <listitem> + <para> + <option>data</option>: data to search in list + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to item found, NULL if item was not found. + </para> + <para> + Example: + <screen>struct t_weelist_item *item = weechat_list_search (list, "my data");</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_casesearch"> + <title>weechat_list_casesearch</title> + + <para> + Prototype: +<programlisting> +struct t_weelist_item *weechat_list_casesearch (struct t_weelist *weelist, + const char *data); +</programlisting> + </para> + <para> + Search an item in a list (case sensitive search). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>weelist</option>: list pointer + </para> + </listitem> + <listitem> + <para> + <option>data</option>: data to search in list + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to item found, NULL if item was not found. + </para> + <para> + Example: + <screen>struct t_weelist_item *item = weechat_list_casesearch (list, "my data");</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_get"> + <title>weechat_list_get</title> + + <para> + Prototype: +<programlisting> +struct t_weelist_item *weechat_list_get (struct t_weelist *weelist, + int position); +</programlisting> + </para> + <para> + Get an item in a list by position. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>weelist</option>: list pointer + </para> + </listitem> + <listitem> + <para> + <option>position</option>: position in list (0 is first item) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to item found, NULL if item position was not + found. + </para> + <para> + Example: + <screen>struct t_weelist_item *item = weechat_list_get (list, 0); /* first item */</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_set"> + <title>weechat_list_set</title> + + <para> + Prototype: +<programlisting> +void weechat_list_set (struct t_weelist_item *item, const char *value); +</programlisting> + </para> + <para> + Set new value for an item. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>item</option>: item pointer + </para> + </listitem> + <listitem> + <para> + <option>value</option>: new value for item + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_list_set (item, "new data");/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_next"> + <title>weechat_list_next</title> + + <para> + Prototype: +<programlisting> +struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); +</programlisting> + </para> + <para> + Get next item in list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>item</option>: item pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to next item, NULL if pointer was last item in + list. + </para> + <para> + Example: + <screen>struct t_weelist_item *next_item = weechat_list_next_item (item);/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_prev"> + <title>weechat_list_prev</title> + + <para> + Prototype: +<programlisting> +struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); +</programlisting> + </para> + <para> + Get previous item in list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>item</option>: item pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to previous item, NULL if pointer was first item + in list. + </para> + <para> + Example: + <screen>struct t_weelist_item *prev_item = weechat_list_prev_item (item);/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_string"> + <title>weechat_list_string</title> + + <para> + Prototype: +<programlisting> +char *weechat_list_string (struct t_weelist_item *item); +</programlisting> + </para> + <para> + Get string value of an item. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>item</option>: item pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: string value of item. + </para> + <para> + Example: + <screen>char *value = weechat_list_string (item);/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_size"> + <title>weechat_list_size</title> + + <para> + Prototype: +<programlisting> +char *weechat_list_size (struct t_weelist *weelist); +</programlisting> + </para> + <para> + Get size of list (number of items). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>weelist</option>: list pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: size of list (number of items), 0 if list is empty. + </para> + <para> + Example: + <screen>int size = weechat_list_size (list);/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_remove"> + <title>weechat_list_remove</title> + + <para> + Prototype: +<programlisting> +void weechat_list_remove (struct t_weelist *weelist, + struct t_weelist_item *item); +</programlisting> + </para> + <para> + Remove an item in a list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>list</option>: list pointer + </para> + </listitem> + <listitem> + <para> + <option>item</option>: item pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_list_remove (list, item);/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_remove_all"> + <title>weechat_list_remove_all</title> + + <para> + Prototype: +<programlisting> +void weechat_list_remove_all (struct t_weelist *weelist); +</programlisting> + </para> + <para> + Remove all items in a list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>list</option>: list pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_list_remove_all (list);/</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_list_free"> + <title>weechat_list_free</title> + + <para> + Prototype: +<programlisting> +void weechat_list_free (struct t_weelist *weelist); +</programlisting> + </para> + <para> + Free a list. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>list</option>: list pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_list_free (list);/</screen> + </para> + </section> + + </section> + + <!-- ==========================[ config files ]========================== --> + + <section id="secPluginCApi_configuration_files"> + <title>Configuration files</title> + + <para> + Functions for configuration files. + </para> + + <section id="secPluginCApi_weechat_config_new"> + <title>weechat_config_new</title> + + <para> + Prototype: +<programlisting> +struct t_config_file *weechat_config_new (const char *name, + int (*callback_reload)(void *data, + struct t_config_file *config_file), + void *callback_reload_data); +</programlisting> + </para> + <para> + Create a new configuration file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>name</option>: name of configuration file (without path + or extension) + </para> + </listitem> + <listitem> + <para> + <option>callback_reload</option>: callback called when + configuration file is reloaded with /reload (optional, may be + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_reload_data</option>: pointer given to reload + callback when it is called by WeeChat + NULL) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new configuration file, NULL if an error + occured. + </para> + <note> + <para> + File is NOT created by this function. It will be created by call to + function <xref linkend="secPluginCApi_weechat_config_write" /> (you + should do that only after adding some sections (with + <xref linkend="secPluginCApi_weechat_config_new_section" />) and + options (with + <xref linkend="secPluginCApi_weechat_config_new_option" />). + </para> + </note> + <para> + Example: +<screen> +int +my_config_reload_cb (void *data, struct t_config_file *config_file) +{ + /* ... */ + + return WEECHAT_RC_OK; +} + +struct t_config_file *config_file = weechat_config_new ("test", &my_config_reload_cb, NULL); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_new_section"> + <title>weechat_config_new_section</title> + + <para> + Prototype: +<programlisting> +struct t_config_section *weechat_config_new_section (struct t_config_file *config_file, + const char *name, + int user_can_add_options, + int user_can_delete_options, + int (*callback_read)(void *data, + struct t_config_file *config_file, + struct t_config_section *section, + const char *option_name, + const char *value), + void *callback_read_data, + int (*callback_write)(void *data, + struct t_config_file *config_file, + struct t_config_section *section, const char *option_name), + void *callback_write_data, + int (*callback_write_default)(void *data, + struct t_config_file *config_file, + const char *section_name); + void *callback_write_default_data, + int (*callback_create_option)(void *data, + struct t_config_file *config_file, + struct t_config_section *section, + const char *option_name, + const char *value), + void *callback_create_option_data, + int (*callback_delete_option)(void *data, + struct t_config_file *config_file, + struct t_config_section *section, + struct t_config_option *option), + void *callback_delete_option_data); +</programlisting> + </para> + <para> + Create a new section in configuration file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + <listitem> + <para> + <option>name</option>: name of section + </para> + </listitem> + <listitem> + <para> + <option>user_can_add_options</option>: 1 if user can add options + in section, or 0 if it is forbidden + </para> + </listitem> + <listitem> + <para> + <option>user_can_delete_options</option>: 1 if user can delete + options in section, or 0 if it is forbidden + </para> + </listitem> + <listitem> + <para> + <option>callback_read</option>: callback called when an option + in section is read from disk (should be NULL for most cases, + except if options in your section need custom function) + </para> + </listitem> + <listitem> + <para> + <option>callback_read_data</option>: pointer given to read + callback when it is called by WeeChat + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_write</option>: callback called when section + is written in file (should be NULL for most cases, except if your + section needs to be written by a custom function) + </para> + </listitem> + <listitem> + <para> + <option>callback_write_data</option>: pointer given to write + callback when it is called by WeeChat + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_write_default</option>: callback called when + default values for section must be written in file + </para> + </listitem> + <listitem> + <para> + <option>callback_write_default_data</option>: pointer given to + write_default callback when it is called by WeeChat + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_create_option</option>: callback called when a + new option is created in section (NULL if section does not allow + new options to be created) + </para> + </listitem> + <listitem> + <para> + <option>callback_create_option_data</option>: pointer given to + create_option callback when it is called by WeeChat + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_delete_option</option>: callback called when an + option is deleted (NULL if section does not allow options to be + deleted) + </para> + </listitem> + <listitem> + <para> + <option>callback_delete_option_data</option>: pointer given to + delete_option callback when it is called by WeeChat + NULL) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new section in configuration file, NULL if an + error occured. + </para> + <para> + Example: +<screen> +int +my_section_read_cb (void *data, struct t_config_file *config_file, + struct t_config_section *section, const char *option_name, + const char *value) +{ + /* ... */ + + return WEECHAT_RC_OK; +} + +int +my_section_write_cb (void *data, struct t_config_file *config_file, + const char *section_name) +{ + /* ... */ + + return WEECHAT_RC_OK; +} + +int +my_section_write_default_cb (void *data, struct t_config_file *config_file, + const char *section_name) +{ + /* ... */ + + return WEECHAT_RC_OK; +} + +int +my_section_create_option_cb (void *data, struct t_config_file *config_file, + struct t_config_section *section, + const char *option_name, const char *value) +{ + /* ... */ + + return WEECHAT_RC_OK; +} + +int +my_section_delete_option_cb (void *data, struct t_config_file *config_file, + struct t_config_section *section, + struct t_config_option *option) +{ + /* ... */ + + return WEECHAT_RC_OK; +} + +/* standard section, user can not add/delete options */ +struct t_config_section *new_section1 = weechat_config_new ("section1", 0, 0, + NULL, NULL, /* read callback */ + NULL, NULL, /* write callback */ + NULL, NULL, /* write default callback */ + NULL, NULL, /* create option callback */ + NULL, NULL); /* delete option callback */ + +/* special section, user can add/delete options, and options need + callback to be read/written */ +struct t_config_section *new_section2 = weechat_config_new ("section2", 1, 1, + &my_section_read_cb, NULL, + &my_section_write_cb, NULL, + &my_section_write_default_cb, NULL, + &my_section_create_option_cb, NULL, + &my_section_delete_option_cb, NULL); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_search_section"> + <title>weechat_config_search_section</title> + + <para> + Prototype: +<programlisting> +struct t_config_section *weechat_config_search_section (struct t_config_file *config_file, + const char *section_name); +</programlisting> + </para> + <para> + Search a section in a configuration file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + <listitem> + <para> + <option>section_name</option>: name of section to search + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to section found, NULL if section was not found. + </para> + <para> + Example: +<screen> +struct t_config_section *section = weechat_config_search_section (config_file, "section"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_new_option"> + <title>weechat_config_new_option</title> + + <para> + Prototype: +<programlisting> +struct t_config_option *weechat_config_new_option (struct t_config_file *config_file, + struct t_config_section *section, + const char *name, + const char *type, + const char *description, + const char *string_values, + int min, + int max, + const chat *default_value, + const char *value, + int (*callback_check_value)(void *data, + struct t_config_option *option, + const char *value), + void *callback_check_value_data, + int (*callback_change)(void *data, + struct t_config_option *option), + void *callback_change_data, + int (*callback_delete)(void *data, + struct t_config_option *option), + void *callback_delete_data); +</programlisting> + </para> + <para> + Create a new option in a section of a configuration file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + <listitem> + <para> + <option>section</option>: section pointer + </para> + </listitem> + <listitem> + <para> + <option>name</option>: name of option + </para> + </listitem> + <listitem> + <para> + <option>type</option>: type of option, one of: + <itemizedlist> + <listitem> + <para>boolean</para> + </listitem> + <listitem> + <para>integer</para> + </listitem> + <listitem> + <para>string</para> + </listitem> + <listitem> + <para>color</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>description</option>: description of option + </para> + </listitem> + <listitem> + <para> + <option>string_values</option>: values as string (separated by + "|"), used for type integer (optional) + </para> + </listitem> + <listitem> + <para> + <option>min</option>: minimum value (for integer) + NULL) + </para> + </listitem> + <listitem> + <para> + <option>max</option>: maximum value (for integer) + </para> + </listitem> + <listitem> + <para> + <option>default_value</option>: default value for option (used + when option is reset) + </para> + </listitem> + <listitem> + <para> + <option>value</option>: value for option + </para> + </listitem> + <listitem> + <para> + <option>callback_check_value</option>: callback called to check + new value for an option (optional) + </para> + </listitem> + <listitem> + <para> + <option>callback_check_value_data</option>: pointer given to + check_value callback when it is called by WeeChat + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_change</option>: callback called when value of + option has changed (optional) + </para> + </listitem> + <listitem> + <para> + <option>callback_change_data</option>: pointer given to change + callback when it is called by WeeChat + NULL) + </para> + </listitem> + <listitem> + <para> + <option>callback_delete</option>: callback called when option + will be deleted (optional) + </para> + </listitem> + <listitem> + <para> + <option>callback_delete_data</option>: pointer given to delete + callback when it is called by WeeChat + NULL) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to new option in section, NULL if an error + occured. + </para> + <para> + Example: +<screen> +/* boolean */ +struct t_config_option *option1 = + weechat_config_new_option (config_file, section, + "option1", "My option, type boolean" + NULL, /* string values */ + 0, 0, /* min, max */ + "on", /* default */ + "on", /* value */ + NULL, NULL, /* check callback */ + NULL, NULL, /* change callback */ + NULL, NULL); /* delete callback */ + +/* integer */ +struct t_config_option *option2 = + weechat_config_new_option (config_file, section, + "option2", "My option, type integer" + NULL, /* string values */ + 0, 100, /* min, max */ + "15", /* default */ + "15", /* value */ + NULL, NULL, /* check callback */ + NULL, NULL, /* change callback */ + NULL, NULL); /* delete callback */ + +/* integer (with string values) */ +struct t_config_option *option3 = + weechat_config_new_option (config_file, section, + "option3", "My option, type integer (with string values)" + "top|bottom|left|right", /* string values */ + 0, 0, /* min, max */ + "bottom", /* default */ + "bottom", /* value */ + NULL, NULL, /* check callback */ + NULL, NULL, /* change callback */ + NULL, NULL); /* delete callback */ + +/* string */ +struct t_config_option *option4 = + weechat_config_new_option (config_file, section, + "option4", "My option, type string" + NULL, /* string values */ + 0, 0, /* min, max */ + "test", /* default */ + "test", /* value */ + NULL, NULL, /* check callback */ + NULL, NULL, /* change callback */ + NULL, NULL); /* delete callback */ + +/* color */ +struct t_config_option *option5 = + weechat_config_new_option (config_file, section, + "option5", "My option, type color" + NULL, /* string values */ + 0, 0, /* min, max */ + "lightblue", /* default */ + "lightblue", /* value */ + NULL, NULL, /* check callback */ + NULL, NULL, /* change callback */ + NULL, NULL); /* delete callback */ +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_search_option"> + <title>weechat_config_search_option</title> + + <para> + Prototype: +<programlisting> +struct t_config_option *weechat_config_search_option (struct t_config_file *config_file, + struct t_config_section *section, + const char *option_name); +</programlisting> + </para> + <para> + Search an option in a section of a configuration file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + <listitem> + <para> + <option>section</option>: section pointer + </para> + </listitem> + <listitem> + <para> + <option>option_name</option>: name of option to search + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to option found, NULL if option was not found. + </para> + <para> + Example: +<screen> +struct t_config_option *option = weechat_config_search_option (config_file, section, "option"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_search_with_string"> + <title>weechat_config_search_with_string</title> + + <para> + Prototype: +<programlisting> +void weechat_config_search_with_string (const char *option_name, + struct t_config_file **config_file, + struct t_config_section **section, + struct t_config_option **option); +</programlisting> + </para> + <para> + Search an option in in a configuration file with string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option_name</option>: full option name (format: + "file.section.option") + </para> + </listitem> + <listitem> + <para> + <option>config_file</option>: pointer to a configuration file + pointer, will be set to configuration file of option, if found + </para> + </listitem> + <listitem> + <para> + <option>section</option>: pointer to a section pointer, will be + set to section of option, if found + </para> + </listitem> + <listitem> + <para> + <option>option</option>: pointer to an option pointer, will be + set to option pointer, if found + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +struct t_config_file *ptr_config_file; +struct t_config_section *ptr_section; +struct t_config_option *ptr_option; + +weechat_config_search_with_string ("file.section.option", + &ptr_config_file, &ptr_section, &ptr_option); +if (ptr_option) +{ + /* option found */ + /* ... */ +} +else +{ + /* option not found */ + /* ... */ +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_string_to_boolean"> + <title>weechat_config_string_to_boolean</title> + + <para> + Prototype: +<programlisting> +int weechat_config_string_to_boolean (const char *text); +</programlisting> + </para> + <para> + Check if a text is "true" or "false". + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>text</option>: text to analyze + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if text is "true" ("on", "yes", "y", "true", "t", "1"), + or 0 if text is "false" ("off", "no", "n", "false", "f", "0"). + </para> + <para> + Example: +<screen> +if (weechat_config_string_to_boolean ("on")) +{ + /* true */ + /* ... */ +} +else +{ + /* false */ + /* never executed! */ +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_option_reset"> + <title>weechat_config_option_reset</title> + + <para> + Prototype: +<programlisting> +int weechat_config_option_reset (struct t_config_option *option, + int run_callback); +</programlisting> + </para> + <para> + Reset an option to its default value. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + <listitem> + <para> + <option>run_callback</option>: 1 for calling change callback if + option is changed, 0 otherwise + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: WEECHAT_CONFIG_OPTION_SET_OK_CHANGED if option value has + been reset, WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE if value was not + changed, WEECHAT_CONFIG_OPTION_SET_ERROR if an error occured. + </para> + <para> + Example: +<screen> +switch (weechat_config_option_reset (option, 1)) +{ + case WEECHAT_CONFIG_OPTION_SET_OK_CHANGED: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_SET_ERROR: + /* .... */ + break; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_option_set"> + <title>weechat_config_option_set</title> + + <para> + Prototype: +<programlisting> +int weechat_config_option_set (struct t_config_option *option, + const char *value, int run_callback); +</programlisting> + </para> + <para> + Set new value for an option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + <listitem> + <para> + <option>value</option>: new value for option + </para> + </listitem> + <listitem> + <para> + <option>run_callback</option>: 1 for calling change callback if + option is changed, 0 otherwise + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: WEECHAT_CONFIG_OPTION_SET_OK_CHANGED if option value has + been reset, WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE if value was not + changed, WEECHAT_CONFIG_OPTION_SET_ERROR if an error occured. + </para> + <para> + Example: +<screen> +switch (weechat_config_option_set (option, "new_value", 1)) +{ + case WEECHAT_CONFIG_OPTION_SET_OK_CHANGED: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_SET_ERROR: + /* .... */ + break; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_option_unset"> + <title>weechat_config_option_unset</title> + + <para> + Prototype: +<programlisting> +int weechat_config_option_unset (struct t_config_option *option); +</programlisting> + </para> + <para> + Unset/reset option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET if option value + has not been reset, WEECHAT_CONFIG_OPTION_UNSET_OK_RESET if option + value has been reset, WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED if option + has been removed, WEECHAT_CONFIG_OPTION_UNSET_ERROR if an error + occured. + </para> + <para> + Example: +<screen> +switch (weechat_config_option_unset (option)) +{ + case WEECHAT_CONFIG_OPTION_UNSET_OK_NO_RESET: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_UNSET_OK_RESET: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED: + /* .... */ + break; + case WEECHAT_CONFIG_OPTION_UNSET_ERROR: + /* .... */ + break; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_option_rename"> + <title>weechat_config_option_rename</title> + + <para> + Prototype: +<programlisting> +void weechat_config_option_rename (struct t_config_option *option, + const char *new_name); +</programlisting> + </para> + <para> + Rename an option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + <listitem> + <para> + <option>new_name</option>: new name for option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +weechat_config_option_rename (option, "new_name"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_option_get_pointer"> + <title>weechat_config_option_get_pointer</title> + + <para> + Prototype: +<programlisting> +void *weechat_config_option_get_pointer (struct t_config_option *option, + const char *property); +</programlisting> + </para> + <para> + Get a pointer on an option property. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + <listitem> + <para> + <option>property</option>: property name: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Property</entry> + <entry>Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>config_file</entry> + <entry>struct t_config_file *</entry> + <entry>configuration file pointer</entry> + </row> + <row> + <entry>section</entry> + <entry>struct t_config_section *</entry> + <entry>section pointer</entry> + </row> + <row> + <entry>name</entry> + <entry>char *</entry> + <entry>option name</entry> + </row> + <row> + <entry>type</entry> + <entry>int</entry> + <entry>option type</entry> + </row> + <row> + <entry>description</entry> + <entry>char *</entry> + <entry>option description</entry> + </row> + <row> + <entry>string_values</entry> + <entry>char **</entry> + <entry>string values</entry> + </row> + <row> + <entry>min</entry> + <entry>int</entry> + <entry>minimum value</entry> + </row> + <row> + <entry>max</entry> + <entry>int</entry> + <entry>maximum value</entry> + </row> + <row> + <entry>default_value</entry> + <entry>(depends on type)</entry> + <entry>default value</entry> + </row> + <row> + <entry>value</entry> + <entry>(depends on type)</entry> + <entry>current value</entry> + </row> + <row> + <entry>prev_option</entry> + <entry>struct t_config_option *</entry> + <entry>previous option pointer</entry> + </row> + <row> + <entry>next_option</entry> + <entry>struct t_config_option *</entry> + <entry>next option pointer</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +char *description = weechat_config_option_get_pointer (option, "description"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_boolean"> + <title>weechat_config_boolean</title> + + <para> + Prototype: +<programlisting> +int weechat_config_boolean (struct t_config_option *option); +</programlisting> + </para> + <para> + Get boolean value of option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: boolean value of option (0 or 1). + </para> + <para> + Example: +<screen> +if (weechat_config_boolean (option)) +{ + /* true */ +} +else +{ + /* false */ +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_integer"> + <title>weechat_config_integer</title> + + <para> + Prototype: +<programlisting> +int weechat_config_integer (struct t_config_option *option); +</programlisting> + </para> + <para> + Get integer value of option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: integer value of option. + </para> + <para> + Example: + <screen>int value = weechat_config_boolean (option);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_string"> + <title>weechat_config_string</title> + + <para> + Prototype: +<programlisting> +char *weechat_config_string (struct t_config_option *option); +</programlisting> + </para> + <para> + Get string value of option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: string value of option. + </para> + <para> + Example: + <screen>char *value = weechat_config_string (option);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_string"> + <title>weechat_config_string</title> + + <para> + Prototype: +<programlisting> +char *weechat_config_color (struct t_config_option *option); +</programlisting> + </para> + <para> + Get color value of option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: color value of option (string with name of color). + </para> + <para> + Example: + <screen>char *color = weechat_config_color (option);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_write_line"> + <title>weechat_config_write_line</title> + + <para> + Prototype: +<programlisting> +void weechat_config_write_line (struct t_config_file *config_file, + const char *option_name, + const char *value, ...); +</programlisting> + </para> + <para> + Write a line in a configuration file (this function should be called + only in "write" or "write_default" callbacks for a section). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + <listitem> + <para> + <option>option_name</option>: option name + </para> + </listitem> + <listitem> + <para> + <option>value</option>: value + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +int +my_section_write_cb (void *data, struct t_config_file *config_file, + const char *section_name) +{ + weechat_config_write_line (config_file, "option", "%s;%d", + "value", 123); + + return WEECHAT_RC_OK; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_write"> + <title>weechat_config_write</title> + + <para> + Prototype: +<programlisting> +int weechat_config_write (struct t_config_file *config_file); +</programlisting> + </para> + <para> + Write configuration file to disk. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: WEECHAT_CONFIG_WRITE_OK if configuration was written, + WEECHAT_CONFIG_WRITE_ERROR if an error occured, + WEECHAT_CONFIG_WRITE_MEMORY_ERROR if there was not enough memory. + </para> + <para> + Example: +<screen> +switch (weechat_config_write (config_file)) +{ + case WEECHAT_CONFIG_WRITE_OK: + /* ... */ + break; + case WEECHAT_CONFIG_WRITE_ERROR: + /* ... */ + break; + case WEECHAT_CONFIG_WRITE_MEMORY_ERROR: + /* ... */ + break; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_read"> + <title>weechat_config_read</title> + + <para> + Prototype: +<programlisting> +int weechat_config_read (struct t_config_file *config_file); +</programlisting> + </para> + <para> + Read configuration file from disk. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: WEECHAT_CONFIG_READ_OK if configuration was loaded, + WEECHAT_CONFIG_READ_MEMORY_ERROR if there was not enough memory, + WEECHAT_CONFIG_READ_FILE_NOT_FOUND if file was not found. + </para> + <para> + Example: +<screen> +switch (weechat_config_read (config_file)) +{ + case WEECHAT_CONFIG_READ_OK: + /* ... */ + break; + case WEECHAT_CONFIG_READ_MEMORY_ERROR: + /* ... */ + break; + case WEECHAT_CONFIG_READ_FILE_NOT_FOUND: + /* ... */ + break; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_reload"> + <title>weechat_config_reload</title> + + <para> + Prototype: +<programlisting> +int weechat_config_reload (struct t_config_file *config_file); +</programlisting> + </para> + <para> + Reload configuration file from disk. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: WEECHAT_CONFIG_READ_OK if configuration was reloaded, + WEECHAT_CONFIG_READ_MEMORY_ERROR if there was not enough memory, + WEECHAT_CONFIG_READ_FILE_NOT_FOUND if file was not found. + </para> + <para> + Example: +<screen> +switch (weechat_config_reload (config_file)) +{ + case WEECHAT_CONFIG_READ_OK: + /* ... */ + break; + case WEECHAT_CONFIG_READ_MEMORY_ERROR: + /* ... */ + break; + case WEECHAT_CONFIG_READ_FILE_NOT_FOUND: + /* ... */ + break; +} +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_option_free"> + <title>weechat_config_option_free</title> + + <para> + Prototype: +<programlisting> +void weechat_config_option_free (struct t_config_option *option); +</programlisting> + </para> + <para> + Free an option. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option</option>: option pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_config_option_free (option);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_section_free_options"> + <title>weechat_config_section_free_options</title> + + <para> + Prototype: +<programlisting> +void weechat_config_section_free_options (struct t_config_section *section); +</programlisting> + </para> + <para> + Free all options in a section. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>section</option>: section pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_config_section_free_options (section);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_section_free"> + <title>weechat_config_section_free</title> + + <para> + Prototype: +<programlisting> +void weechat_config_section_free (struct t_config_section *section); +</programlisting> + </para> + <para> + Free a section. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>section</option>: section pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_config_section_free (section);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_free"> + <title>weechat_config_free</title> + + <para> + Prototype: +<programlisting> +void weechat_config_free (struct t_config_file *config_file); +</programlisting> + </para> + <para> + Free a configuration file. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>config_file</option>: configuration file pointer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: + <screen>weechat_config_free (config_file);</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_get"> + <title>weechat_config_get</title> + + <para> + Prototype: +<programlisting> +struct t_config_option *weechat_config_get (const char *option_name); +</programlisting> + </para> + <para> + Search an option in in a configuration file with string. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option_name</option>: full option name (format: + "file.section.option") + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to option found, NULL if option was not found. + </para> + <para> + Example: +<screen> +struct t_config_option *option = weechat_config_get ("weechat.look.item_time_format"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_get_plugin"> + <title>weechat_config_get_plugin</title> + + <para> + Prototype: +<programlisting> +char *weechat_config_get_plugin (const char *option_name); +</programlisting> + </para> + <para> + Search an option in plugins configuration file (plugins.conf), by + adding prefix with current plugin name. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option_name</option>: option name, WeeChat will add + prefix "plugins.var.xxxx." (where xxxx is current plugin name). + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: pointer to option found, NULL if option was not found. + </para> + <para> + Example: +<screen> +/* if current plugin is "test", then look for value of option + "plugins.var.test.option" in plugins.conf file */ +char *value = weechat_config_get_plugin ("option"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_config_set_plugin"> + <title>weechat_config_set_plugin</title> + + <para> + Prototype: +<programlisting> +int weechat_config_set_plugin (const char *option_name, const char *value); +</programlisting> + </para> + <para> + Set value for option in in plugins configuration file (plugins.conf). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>option_name</option>: option name, WeeChat will add + prefix "plugins.var.xxxx." (where xxxx is current plugin name). + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: 1 if ok, 0 if an error occured. + </para> + <para> + Example: +<screen> +weechat_config_set_plugin ("option", "test_value"); +</screen> + </para> + </section> + + </section> + + <!-- ============================[ display ]============================= --> + + <section id="secPluginCApi_display"> + <title>Display</title> + + <para> + Functions to display text in buffers. + </para> + + <section id="secPluginCApi_weechat_prefix"> + <title>weechat_prefix</title> + + <para> + Prototype: +<programlisting> +char *weechat_prefix (const char *prefix); +</programlisting> + </para> + <para> + Get a prefix. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>prefix</option>: name of prefix: + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Prefix</entry> + <entry>Default value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>error</entry> + <entry>=!=</entry> + <entry>error message</entry> + </row> + <row> + <entry>network</entry> + <entry>--</entry> + <entry>message from network</entry> + </row> + <row> + <entry>action</entry> + <entry>*</entry> + <entry>self action</entry> + </row> + <row> + <entry>join</entry> + <entry>--></entry> + <entry>someone joins current chat</entry> + </row> + <row> + <entry>quit</entry> + <entry><--</entry> + <entry>someone leaves current chat</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: prefix value, empty string if prefix is not found + (not NULL). + </para> + <para> + Example: +<screen> +weechat_printf (NULL, "%sThis is an error...", + weechat_prefix ("error")); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_color"> + <title>weechat_color</title> + + <para> + Prototype: +<programlisting> +char *weechat_color (const char *color_name); +</programlisting> + </para> + <para> + Get a string color code for display. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>color_name</option>: name of color: may be a WeeChat + color name (from weechat.color.xxx), or a color with optional + background (separated by comma). + </para> + </listitem> + </itemizedlist> + </para> + <para> + Return value: string with color code, or a "reset color" code if color + is not found. + </para> + <para> + Example: +<screen> +weechat_printf (NULL, "Color: %sblue %schat default %sred on green", + weechat_color ("blue"), + weechat_color ("chat"), + weechat_color ("red,green")); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_printf"> + <title>weechat_printf</title> + + <para> + Prototype: +<programlisting> +void weechat_printf (struct t_gui_buffer *buffer, const char *message, ...); +</programlisting> + </para> + <para> + Display a message on a buffer. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>buffer</option>: buffer pointer, if NULL, message is + displayed on WeeChat buffer. + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message to display + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +weechat_printf (NULL, "Hello on WeeChat buffer"); +weechat_printf (buffer, "Hello on this buffer"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_printf_date"> + <title>weechat_printf_date</title> + + <para> + Prototype: +<programlisting> +void weechat_printf_date (struct t_gui_buffer *buffer, time_t date, + const char *message, ...); +</programlisting> + </para> + <para> + Display a message on a buffer, using a custom date. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>buffer</option>: buffer pointer, if NULL, message is + displayed on WeeChat buffer. + </para> + </listitem> + <listitem> + <para> + <option>date</option>: date for message + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message to display + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +weechat_printf (NULL, time (NULL) - 120, "Hello, 2 minutes ago"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_printf_tags"> + <title>weechat_printf_tags</title> + + <para> + Prototype: +<programlisting> +void weechat_printf_tags (struct t_gui_buffer *buffer, const char *tags, + const char *message, ...); +</programlisting> + </para> + <para> + Display a message on a buffer, using a custom tags. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>buffer</option>: buffer pointer, if NULL, message is + displayed on WeeChat buffer. + </para> + </listitem> + <listitem> + <para> + <option>tags</option>: tags for message, separated by a comma + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message to display + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +weechat_printf_tags (NULL, "notify_message", "Hello with a message notify tag"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_printf_date_tags"> + <title>weechat_printf_date_tags</title> + + <para> + Prototype: +<programlisting> +void weechat_printf_date_tags (struct t_gui_buffer *buffer, time_t date, + const char *tags, const char *message, ...); +</programlisting> + </para> + <para> + Display a message on a buffer, using a custom date and tags. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>buffer</option>: buffer pointer, if NULL, message is + displayed on WeeChat buffer. + </para> + </listitem> + <listitem> + <para> + <option>date</option>: date for message + </para> + </listitem> + <listitem> + <para> + <option>tags</option>: tags for message, separated by a comma + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message to display + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +weechat_printf_date_tags (NULL, time (NULL) - 120, "notify_message", + "Hello, 2 minutes ago, with a message notify tag"); +</screen> + </para> + </section> + + <section id="secPluginCApi_weechat_printf_y"> + <title>weechat_printf_y</title> + + <para> + Prototype: +<programlisting> +void weechat_printf_y (struct t_gui_buffer *buffer, int y, + const char *message, ...); +</programlisting> + </para> + <para> + Display a message on a line of a buffer with free content (see + <xref linkend="secPluginCApi_weechat_buffer_set" />). + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>buffer</option>: buffer pointer, if NULL, message is + displayed on WeeChat buffer. + </para> + </listitem> + <listitem> + <para> + <option>y</option>: line number (0 for first line) + </para> + </listitem> + <listitem> + <para> + <option>message</option>: message to display + </para> + </listitem> + </itemizedlist> + </para> + <para> + Example: +<screen> +weechat_printf_y (buffer, 2, "My message on third line"); +</screen> + </para> + </section> + + </section> + + <!-- ============================[ buffers ]============================= --> + + <section id="secPluginCApi_buffers"> + <title>Buffers</title> + + <para> + Functions to create/query/close buffers. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- ============================[ nicklist ]============================ --> + + <section id="secPluginCApi_nicklist"> + <title>Nicklist</title> + + <para> + Functions for buffer nicklist. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- ==============================[ bars ]============================== --> + + <section id="secPluginCApi_bars"> + <title>Bars</title> + + <para> + Functions for bars. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- ============================[ commands ]============================ --> + + <section id="secPluginCApi_commands"> + <title>Commands</title> + + <para> + Functions for executing WeeChat commands. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- ============================[ network ]============================= --> + + <section id="secPluginCApi_network"> + <title>Network</title> + + <para> + Network functions. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- =============================[ infos ]============================== --> + + <section id="secPluginCApi_infos"> + <title>Infos</title> + + <para> + Functions to get infos. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- ===========================[ infolists ]============================ --> + + <section id="secPluginCApi_infolists"> + <title>Infolists</title> + + <para> + Functions for infolists. + </para> + + <para> + Missing doc! + </para> + + </section> + + <!-- ============================[ upgrade ]============================= --> + + <section id="secPluginCApi_upgrade"> + <title>Upgrade</title> + + <para> + Functions for WeeChat upgrading. + </para> + + <para> + Missing doc! + </para> + + </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_script_api.en.xml index a4aa2ea7a..a1b13e537 100644 --- a/doc/en/dev/plugin_scripts.en.xml +++ b/doc/en/dev/plugin_script_api.en.xml @@ -21,8 +21,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. --> -<section id="secScriptsPlugins"> - <title>Scripts plugins</title> +<section id="secScriptPluginAPI"> + <title>Script plugin API</title> + + <!-- <para> Four plugins are provided with WeeChat to use script languages: @@ -2846,4 +2848,6 @@ end </section> + --> + </section> diff --git a/doc/en/dev/plugins.en.xml b/doc/en/dev/plugins.en.xml index fd2e2f7db..6b8456114 100644 --- a/doc/en/dev/plugins.en.xml +++ b/doc/en/dev/plugins.en.xml @@ -129,8 +129,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. </informaltable> </para> - &plugin_api.en.xml; - <section id="secCompilePlugin"> <title>Compile plugin</title> @@ -237,14 +235,4 @@ weechat_plugin_end (struct t_weechat_plugin *plugin) </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 index e21d3cf0e..c7c361fcb 100644 --- a/doc/en/dev/weechat_dev.en.xml +++ b/doc/en/dev/weechat_dev.en.xml @@ -30,11 +30,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. %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"> + <!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_c_api.en.xml SYSTEM "plugin_c_api.en.xml"> + <!ENTITY plugin_script_api.en.xml SYSTEM "plugin_script_api.en.xml"> + <!ENTITY authors.en.xml SYSTEM "authors.en.xml"> ]> <book lang="en"> @@ -94,7 +95,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. &intro.en.xml; - <!-- &plugins.en.xml; --> + &plugins.en.xml; + + &plugin_api.en.xml; &authors.en.xml; diff --git a/doc/fr/Makefile.am b/doc/fr/Makefile.am index 24fd0f01f..951b6ec47 100644 --- a/doc/fr/Makefile.am +++ b/doc/fr/Makefile.am @@ -48,29 +48,29 @@ BOOK_COMMON_INCLUDE = authors.$(LANGCODE).xml \ intro.$(LANGCODE).xml BOOK_USER = weechat_user.$(LANGCODE) -BOOK_USER_INCLUDE = user/install.$(LANGCODE).xml \ - user/usage.$(LANGCODE).xml \ - user/plugins.$(LANGCODE).xml \ - user/plugin_alias.$(LANGCODE).xml \ - user/plugin_aspell.$(LANGCODE).xml \ - user/plugin_charset.$(LANGCODE).xml \ - user/plugin_fifo.$(LANGCODE).xml \ - user/plugin_irc.$(LANGCODE).xml \ - user/plugin_logger.$(LANGCODE).xml \ - user/plugin_scripts.$(LANGCODE).xml \ +BOOK_USER_INCLUDE = user/install.$(LANGCODE).xml \ + user/usage.$(LANGCODE).xml \ + user/plugins.$(LANGCODE).xml \ + user/plugin_alias.$(LANGCODE).xml \ + user/plugin_aspell.$(LANGCODE).xml \ + user/plugin_charset.$(LANGCODE).xml \ + user/plugin_fifo.$(LANGCODE).xml \ + user/plugin_irc.$(LANGCODE).xml \ + user/plugin_logger.$(LANGCODE).xml \ + user/plugin_scripts.$(LANGCODE).xml \ user/plugin_xfer.$(LANGCODE).xml BOOK_DEV = weechat_dev.$(LANGCODE) -BOOK_DEV_INCLUDE = dev/plugin_api.$(LANGCODE).xml \ - dev/plugin_scripts.$(LANGCODE).xml \ - dev/plugins.$(LANGCODE).xml \ - dev/weechat_dev.$(LANGCODE).xml +BOOK_DEV_INCLUDE = dev/plugins.$(LANGCODE).xml \ + dev/plugin_api.$(LANGCODE).xml \ + dev/plugin_c_api.$(LANGCODE).xml \ + dev/plugin_script_api.$(LANGCODE).xml QUICKSTART = weechat_quickstart.$(LANGCODE).txt -EXTRA_DIST = $(BOOK_AUTOGEN_INCLUDE) $(BOOK_COMMON_INCLUDE) \ - user/$(BOOK_USER).xml $(BOOK_USER_INCLUDE) \ - dev/$(BOOK_DEV).xml $(BOOK_DEV_INCLUDE) \ +EXTRA_DIST = $(BOOK_AUTOGEN_INCLUDE) $(BOOK_COMMON_INCLUDE) \ + user/$(BOOK_USER).xml $(BOOK_USER_INCLUDE) \ + dev/$(BOOK_DEV).xml $(BOOK_DEV_INCLUDE) \ $(QUICKSTART) if DBLATEX_FOUND diff --git a/doc/fr/dev/plugin_api.fr.xml b/doc/fr/dev/plugin_api.fr.xml index 99e363984..fc8db0311 100644 --- a/doc/fr/dev/plugin_api.fr.xml +++ b/doc/fr/dev/plugin_api.fr.xml @@ -21,3541 +21,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. --> -<section id="secPluginAPI"> +<chapter id="chapPluginAPI"> <title>API extension</title> - <section id="secAPI_set_charset"> - <title>set_charset</title> - - <para> - Prototype : - <command> - void set_charset (t_weechat_plugin *plugin, char *charset) - </command> - </para> - <para> - Change le jeu de caractères de l'extension. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : nouveau jeu de caractères à - utiliser - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : - <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> - </para> - </section> + &plugin_c_api.fr.xml; - <section id="secAPI_iconv_to_internal"> - <title>iconv_to_internal</title> - - <para> - Prototype : - <command> - void iconv_to_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Convertit une chaîne de caractères vers le jeu de caractères - interne WeeChat (UTF-8). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : le jeu de caractères de départ - </para> - </listitem> - <listitem> - <para> - <option>string</option> : la chaîne à convertir - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la chaîne convertie. - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free" après utilisation. - </para> - <para> - Exemple : - <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "chaine iso: é à");</screen> - </para> - </section> + <!-- &plugin_script_api.fr.xml; --> - <section id="secAPI_iconv_from_internal"> - <title>iconv_from_internal</title> - - <para> - Prototype : - <command> - void iconv_from_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Convertit une chaîne de caractères depuis le jeu de caractères - interne WeeChat (UTF-8) vers un autre. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : le jeu de caractères voulu - </para> - </listitem> - <listitem> - <para> - <option>string</option> : la chaîne à convertir - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la chaîne convertie. - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free" après utilisation. - </para> - <para> - Exemple : - <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "chaine utf-8: é à");</screen> - </para> - </section> - - <section id="secAPI_ascii_strcasecmp"> - <title>ascii_strcasecmp</title> - - <para> - Prototype : - <command> - int ascii_strcasecmp (t_weechat_plugin *plugin, - char *chaine1, char *chaine2) - </command> - </para> - <para> - Effectue une comparaison entre deux chaînes, sans tenir compte des - majuscules/minuscules ni de la locale. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine1</option> : la première chaîne à comparer - </para> - </listitem> - <listitem> - <para> - <option>chaine2</option> : la deuxième chaîne à comparer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la différence entre les deux chaînes : négatif - si chaine1 < chaine2, zéro si chaine1 == chaine2, positif si - chaine1 > chaine2 - </para> - <para> - Exemple : - <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> - </para> - </section> - - <section id="secAPI_ascii_strncasecmp"> - <title>ascii_strncasecmp</title> - - <para> - Prototype : - <command> - int ascii_strncasecmp (t_weechat_plugin *plugin, - char *chaine1, char *chaine2, int max) - </command> - </para> - <para> - Effectue une comparaison entre deux chaînes, sans tenir compte des - majuscules/minuscules ni de la locale, en comparant au plus "max" - caractères. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine1</option> : la première chaîne à comparer - </para> - </listitem> - <listitem> - <para> - <option>chaine2</option> : la deuxième chaîne à comparer - </para> - </listitem> - <listitem> - <para> - <option>max</option> : nombre de caractères max à comparer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la différence entre les deux chaînes : négatif - si chaine1 < chaine2, zéro si chaine1 == chaine 2, positif si - chaine1 > chaine2 - </para> - <para> - Exemple : - <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> - </para> - </section> - - <section id="secAPI_explode_string"> - <title>explode_string</title> - - <para> - Prototype : - <command> - char **explode_string (t_weechat_plugin *plugin, char *chaine, - char *separateurs, int num_items_max, int *num_items) - </command> - </para> - <para> - Explose une chaîne en plusieurs selon un/des délimiteur(s). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine</option> : la chaîne à exploser - </para> - </listitem> - <listitem> - <para> - <option>separateurs</option> : les délimiteurs utilisés - pour exploser la chaîne - </para> - </listitem> - <listitem> - <para> - <option>num_items_max</option> : nombre maximum de - sous-chaînes créées (0 = pas de limite) - </para> - </listitem> - <listitem> - <para> - <option>num_items</option> : pointeur vers un entier qui - contiendra le nombre de sous-chaînes créées en retour - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : un tableau de chaînes, ou NULL si un problème - a été rencontré. - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_exploded_string" après utilisation. - </para> - <para> - Exemple : -<screen> -char **argv; -int argc; -argv = plugin->explode_string (plugin, chaine, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_free_exploded_string"> - <title>free_exploded_string</title> - - <para> - Prototype : - <command> - char **free_exploded_string (t_weechat_plugin *plugin, - char **chaine) - </command> - </para> - <para> - Libère la mémoire utilisée pour une explosion de chaîne. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine</option> : la chaîne explosée par la fonction - "explode_string" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : -<screen> -char *argv; -int argc; -argv = plugin->explode_string (plugin, chaine, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_mkdir_home"> - <title>mkdir_home</title> - - <para> - Prototype : - <command> - int mkdir_home (t_weechat_plugin *plugin, char *repertoire) - </command> - </para> - <para> - Créé un répertoire dans le répertoire de base de WeeChat. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>repertoire</option> : répertoire à créer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : 1 si le répertoire a été créé avec succès, - 0 si une erreur s'est produite. - </para> - <para> - Example: -<screen> -if (!plugin->mkdir_home (plugin, "temp")) - plugin->print_server(plugin, "Impossible de créer le répertoire 'temp' dans la base WeeChat."); -</screen> - </para> - </section> - - <section id="secAPI_exec_on_files"> - <title>exec_on_files</title> - - <para> - Prototype : - <command> - void exec_on_files (t_weechat_plugin *plugin, char *repertoire, - int (*callback)(t_weechat_plugin *, char *)) - </command> - </para> - <para> - Exécute une fonction sur tous les fichiers d'un répertoire. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>repertoire</option> : le répertoire où les fichiers - sont recherchés - </para> - </listitem> - <listitem> - <para> - <option>callback</option> : une fonction appelée pour chaque - fichier trouvé - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : -<screen> -int callback (t_weechat_plugin *plugin, char *fichier) -{ - plugin->print_server (plugin, "fichier: %s", fichier); - return 1; -} -... -plugin->exec_on_files (plugin, "/tmp", &callback); -</screen> - </para> - </section> - - <section id="secAPI_print"> - <title>print</title> - - <para> - Prototype : - <command> - void print (t_weechat_plugin *plugin, - char *serveur, char *canal, char *message, ...) - </command> - </para> - <para> - Affiche un message sur un tampon WeeChat, identifié par le serveur - et le canal (tous deux pouvant être NULL pour le tampon courant). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur pour - trouver le tampon dans lequel afficher (peut être NULL) - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal pour trouver le - tampon dans lequel afficher (peut être NULL) - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message à afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Pour afficher du texte en couleur, il faut utiliser les codes - suivants : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>0x02</entry> - <entry> - texte gras - </entry> - </row> - <row> - <entry>0x03 + "xx"</entry> - <entry> - couleur du texte "<literal>xx</literal>" - (voir <xref linkend="secAPI_get_irc_color" /> pour les - couleurs) - </entry> - </row> - <row> - <entry>0x03 + "xx,yy"</entry> - <entry> - couleur du texte "<literal>xx</literal>" - et du fond "<literal>yy</literal>" - (voir <xref linkend="secAPI_get_irc_color" /> pour les - couleurs) - </entry> - </row> - <row> - <entry>0x0F</entry> - <entry> - désactiver la couleur et tous les attributs - </entry> - </row> - <row> - <entry>0x12</entry> - <entry> - vidéo inverse (inversion de la couleur d'écriture et du - fond) - </entry> - </row> - <row> - <entry>0x1F</entry> - <entry> - texte souligné - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - NB: le même code (sans le numéro pour 0x03) peut être utilisé pour - stopper l'attribut défini. - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemples : -<screen> -plugin->print (plugin, NULL, NULL, "hello"); -plugin->print (plugin, NULL, "#weechat", "hello"); -plugin->print (plugin, "freenode", "#weechat", "hello"); -plugin->print (plugin, "freenode", "#weechat", "hello"); -plugin->print (plugin, NULL, NULL, - "test: \x02 gras \x0F\x03%02d bleu \x03%02d vert", - 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> - Affiche un message sur le tampon du serveur courant. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message à afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Pour afficher du texte en couleur, voir - <xref linkend="secAPI_print" />. - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : <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 *serveur, char *canal, char *message, ...) - </command> - </para> - <para> - Ecrit un message dans le fichier de log pour un serveur ou un - canal. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur pour - trouver le log du tampon (peut être NULL) - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal pour trouver le - tampon le log du tampon (peut être NULL) - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : -<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 *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de messages IRC, appelé dès qu'un message - IRC est reçu. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>message</option> : nom du message IRC pour lequel la - fonction est appelée ("*" pour tous les messages). - Pour connaître la liste des messages IRC disponibles, merci - de consulter les <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> - et - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - De plus, vous pouvez utiliser un nom spécial, préfixé par - "weechat_" pour capturer des évènements spéciaux, comme - décrit dans le tableau ci-dessous : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Nom</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>weechat_pv</literal></entry> - <entry>message privé reçu</entry> - </row> - <row> - <entry><literal>weechat_highlight</literal></entry> - <entry> - message avec highlight (sur un canal ou en privé) - </entry> - </row> - <row> - <entry><literal>weechat_ctcp</literal></entry> - <entry> - message CTCP reçu (VERSION, PING, etc...) - </entry> - </row> - <row> - <entry><literal>weechat_dcc</literal></entry> - <entry> - message DCC reçu (discussion ou fichier) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appelée lorsque le - message est reçu - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le paramètre argc vaut 3 et les arguments suivants sont - passés dans le tableau argv : - <itemizedlist> - <listitem> - <para>argv[0] = nom du serveur</para> - </listitem> - <listitem> - <para>argv[1] = message IRC</para> - </listitem> - <listitem> - <para>argv[2] = arguments de la commande</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : paramètres passés à la - fonction appelée - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur passé à la - fonction appelée - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : le pointeur vers le nouveau gestionnaire de - messages. - </para> - <para> - Note : la fonction appelée lorsque le message est reçu doit - renvoyer une des valeurs suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a échoué - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a réussi - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal> : le message - ne sera pas transmis à WeeChat - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal> : le message - ne sera pas transmis à d'autres extensions - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal> : le message - ne sera ni transmis à WeeChat ni à d'autres extensions - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal> : la fonction - a réussi et provoque un "highlight" sur le message reçu - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<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 reçu"); - 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 *commande, char *description, char *arguments, - char *arguments_description, char *modele_completion, - t_plugin_handler_func *fonction, char *handler_args, - void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de commande WeeChat, appelé dès que - l'utilisateur utilise la commande (par exemple /commande). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>commande</option> : nom de la nouvelle commande, - qui peut être une commande déjà existante (attention la - commande remplacée ne sera plus disponible jusqu'à ce que - l'extension soit déchargée) - </para> - </listitem> - <listitem> - <para> - <option>description</option> : brève description de la - commande (affichée par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>arguments</option> : brève description des - paramètres de la commande (affichée par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option> : longue description - des paramètres de la commande (affichée par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>modele_completion</option> : modèle pour la - complétion sous la forme "<literal>abc|%w def|%i</literal>" - qui signifie "abc" ou une commande WeeChat pour le premier - paramètre, et "def" ou une commande IRC pour le deuxième. - Une chaîne vide indique à WeeChat de compléter tout - paramètre avec un pseudo du canal courant, une valeur NULL - ou égale à "-" désactive toute complétion pour tous les - paramètres de la commande. - </para> - <para> - Les codes suivants peuvent être utilisés : - <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>aucune complétion pour le paramètre</entry> - </row> - <row> - <entry><literal>%*</literal></entry> - <entry> - répétition de la dernière complétion pour tous - les paramètres suivants (ce code doit être à la - fin du modèle de complétion, précédé d'un "|") - </entry> - </row> - <row> - <entry><literal>%a</literal></entry> - <entry>alias</entry> - </row> - <row> - <entry><literal>%A</literal></entry> - <entry> - alias et commandes (WeeChat, IRC et extensions) - </entry> - </row> - <row> - <entry><literal>%c</literal></entry> - <entry>canal courant</entry> - </row> - <row> - <entry><literal>%C</literal></entry> - <entry>tous les canaux (y compris les privés)</entry> - </row> - <row> - <entry><literal>%f</literal></entry> - <entry>nom de fichier</entry> - </row> - <row> - <entry><literal>%h</literal></entry> - <entry>commandes définies par des extensions</entry> - </row> - <row> - <entry><literal>%i</literal></entry> - <entry>commandes IRC (envoyées)</entry> - </row> - <row> - <entry><literal>%I</literal></entry> - <entry>commandes IRC (reçues)</entry> - </row> - <row> - <entry><literal>%k</literal></entry> - <entry>fonctions associées aux touches</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>pseudo sur le serveur courant</entry> - </row> - <row> - <entry><literal>%M</literal></entry> - <entry> - pseudos sur le serveur courant - (tous les canaux ouverts) - </entry> - </row> - <row> - <entry><literal>%n</literal></entry> - <entry>pseudos du canal courant</entry> - </row> - <row> - <entry><literal>%N</literal></entry> - <entry> - pseudos et noms de machines du canal - courant - </entry> - </row> - <row> - <entry><literal>%o</literal></entry> - <entry>options de configuration</entry> - </row> - <row> - <entry><literal>%O</literal></entry> - <entry>options des extensions</entry> - </row> - <row> - <entry><literal>%p</literal></entry> - <entry>message de "part" par défaut</entry> - </row> - <row> - <entry><literal>%q</literal></entry> - <entry>message de "quit" par défaut</entry> - </row> - <row> - <entry><literal>%s</literal></entry> - <entry>nom du serveur courant</entry> - </row> - <row> - <entry><literal>%S</literal></entry> - <entry>tous les serveurs</entry> - </row> - <row> - <entry><literal>%t</literal></entry> - <entry>titre du canal courant</entry> - </row> - <row> - <entry><literal>%v</literal></entry> - <entry>valeur d'une option de configuration</entry> - </row> - <row> - <entry><literal>%V</literal></entry> - <entry>valeur d'une option d'extension</entry> - </row> - <row> - <entry><literal>%w</literal></entry> - <entry>commandes WeeChat</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appelée lorsque la - commande est exécutée. - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le paramètre argc vaut 3 et les arguments suivants sont - passés dans le tableau argv : - <itemizedlist> - <listitem> - <para>argv[0] = nom du serveur</para> - </listitem> - <listitem> - <para>argv[1] = commande</para> - </listitem> - <listitem> - <para>argv[2] = arguments de la commande</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : paramètres passés à la - fonction appelée - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur passé à la - fonction appelée - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : le pointeur vers le nouveau gestionnaire de - commande. - </para> - <para> - Note : la fonction appelée lorsque la commande est exécutée doit - renvoyer une des valeurs suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a échoué - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a réussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int cmd_test (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, - "commande test, pseudo: %s", - (argv[2]) ? argv[2] : "aucun"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *cmd_handler; -cmd_handler = plugin->cmd_handler_add (plugin, "test", "Commande test", - "[pesudo]", "pseudo: un pseudo du canal", - "%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 intervalle, t_plugin_handler_func *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de temps, qui appelle périodiquement une - fonction. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>intervalle</option> : intervalle (en secondes) - entre deux appels de la fonction. - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appelée - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le paramètre argc vaut 0 et argv vaut NULL. - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : paramètres passés à la - fonction appelée - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur passé à la - fonction appelée - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : le pointeur vers le nouveau gestionnaire de - temps. - </para> - <para> - Note : la fonction appelée doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a échoué - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a réussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int mon_timer (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "mon timer"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *timer_handler; -timer_handler = plugin->timer_handler_add (plugin, 60, &mon_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 *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de clavier, appelé dès qu'une touche est - pressée. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appelée - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le paramètre argc vaut 3 et les arguments suivants sont - passés dans le tableau argv : - <itemizedlist> - <listitem> - <para> - argv[0] = touche appuyée (nom d'une fonction interne - ou bien '*' suivi du code d'une touche) - </para> - </listitem> - <listitem> - <para> - argv[1] = la ligne de commande avant l'action de la - touche - </para> - </listitem> - <listitem> - <para> - argv[2] = la ligne de commande après l'action de la - touche - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : paramètres passés à la - fonction appelée - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur passé à la - fonction appelée - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : le pointeur vers le nouveau gestionnaire de - clavier. - </para> - <para> - Note : la fonction appelée doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a échoué - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a réussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int mon_keyb (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argc == 2) - { - plugin->print (plugin, NULL, NULL, "touche appuyée: %s", argv[0]); - if (argv[1] && (argv[1][0] == '1')) - plugin->print (plugin, NULL, NULL, "le texte d'entrée a changé"); - else - plugin->print (plugin, NULL, NULL, "le texte d'entrée n'a pas changé"); - } - return PLUGIN_RC_OK; -} -... -t_plugin_handler *keyb_handler; -keyb_handler = plugin->keyboard_handler_add (plugin, &mon_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 *evenement, t_plugin_handler_func *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire d'évènement, appelé dès qu'un évènement se - produit. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>évènement</option> : évènement (voir le tableau - ci-dessous) - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appelée - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Les paramètres passés à la fonction dépendent de l'évènement - (voir le tableau ci-dessous). - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : paramètres passés à la - fonction appelée - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur passé à la - fonction appelée - </para> - </listitem> - </itemizedlist> - </para> - <para> - Liste des évènements : - <informaltable colsep="0" frame="none"> - <tgroup cols="3"> - <thead> - <row> - <entry>Evènement</entry> - <entry>Description</entry> - <entry>Paramètres</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>buffer_open</literal></entry> - <entry>un tampon a été ouvert</entry> - <entry> - argc = 1, argv = { numéro de tampon } - </entry> - </row> - <row> - <entry><literal>buffer_close</literal></entry> - <entry>un tampon a été fermé</entry> - <entry> - argc = 1, argv = { numéro de tampon } - </entry> - </row> - <row> - <entry><literal>buffer_move</literal></entry> - <entry>un tampon a été déplacé</entry> - <entry> - argc = 2, argv = { nouveau numéro de tampon, ancien - numéro } - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Valeur renvoyée : le pointeur vers le nouveau gestionnaire - d'évènement. - </para> - <para> - Note : la fonction appelée doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a échoué - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a réussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int mon_evenement (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "mon_evenement"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *event_handler; -event_handler = plugin->event_handler_add (plugin, "buffer_open", - &mon_evenement); -</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> - Supprime un gestionnaire de commande ou message. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>handler</option> : le gestionnaire à supprimer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <screen>plugin->handler_remove (plugin, mon_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> - Supprime tous les gestionnaires d'une extension. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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 *fonction, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Ajoute un modifieur de message. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>type</option> : type de modifieur : - <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>appelé pour chaque message IRC reçu</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - appelé pour chaque message (ou commande) envoyé par - l'utilisateur (avant traitement et affichage par - WeeChat) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - appelé pour chaque message sortant juste avant - envoi au serveur IRC (y compris pour les messages - envoyés automatiquement et de manière transparente - par WeeChat) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option> : nom du message IRC pour lequel la - fonction est appelée (utilisé uniquement pour les types - "irc_in" et "irc_out"). - Pour connaître la liste des messages IRC disponibles, merci - de consulter les <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> - et - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - La valeur spéciale "*" signifie tous les messages (pas de - filtre). - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appelée - </para> - <para> - Elle a le prototype suivant : - <command> - char *ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Le paramètre argc vaut 2 et les arguments suivants sont - passés dans le tableau argv : - <itemizedlist> - <listitem> - <para>argv[0] = nom du serveur</para> - </listitem> - <listitem> - <para>argv[1] = message</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>modifier_args</option> : paramètres passés à la - fonction appelée - </para> - </listitem> - <listitem> - <para> - <option>modifier_pointer</option> : pointeur passé à la - fonction appelée - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : le pointeur vers le nouveau modifieur de message. - </para> - <para> - Note : la fonction doit retourner une chaîne modifiée, ou NULL si - elle ne souhaite pas modifier le message. - Si elle retourne une chaine vide, alors le message est supprimé et - ne sera pas traité du tout par WeeChat (soyez prudent en supprimant - des messages !). - La chaîne renvoyée doit avoir été allouée par malloc() et sera - libérée (par appel à free()) automatiquement par WeeChat après - utilisation. - </para> - <para> - Exemple : -<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> - Supprime un modifieur de message. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>modifier</option> : le modifieur à supprimer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <screen>plugin->modifier_remove (plugin, mon_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> - Supprime tous les modifieurs d'une extension. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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 *serveur, char *canal, char *commande) - </command> - </para> - <para> - Execute une commande WeeChat ou envoie un message à un canal. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur où - exécuter la commande (peut être NULL) - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal où exécuter la - commande (peut être NULL) - </para> - </listitem> - <listitem> - <para> - <option>commande</option> : la commande à exécuter - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemples : -<screen> -plugin->exec_command (plugin, NULL, NULL, "/help nick"); -plugin->exec_command (plugin, "freenode", "#weechat", "bonjour"); -</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 *serveur) - </command> - </para> - <para> - Renvoie une information sur WeeChat ou un canal. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>info</option> : nom de l'info à obtenir : - <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>version de WeeChat</entry> - </row> - <row> - <entry><literal>nick</literal></entry> - <entry>pesudo</entry> - </row> - <row> - <entry><literal>channel</literal></entry> - <entry> - nom du canal (NULL pour un serveur ou un privé) - </entry> - </row> - <row> - <entry><literal>server</literal></entry> - <entry>nom du serveur</entry> - </row> - <row> - <entry><literal>type</literal></entry> - <entry> - type de tampon: 0=standard, 1=DCC, - 2=données IRC brutes - </entry> - </row> - <row> - <entry><literal>away</literal></entry> - <entry>drapeau "away"</entry> - </row> - <row> - <entry><literal>inactivity</literal></entry> - <entry> - nombre de secondes écoulées depuis que la dernière - touche a été appuyée - </entry> - </row> - <row> - <entry><literal>input</literal></entry> - <entry> - contenu de la ligne de commande de la fenêtre - courante - </entry> - </row> - <row> - <entry><literal>input_mask</literal></entry> - <entry> - contenu du masque de couleur de la ligne de - commande - </entry> - </row> - <row> - <entry><literal>input_pos</literal></entry> - <entry> - position du curseur dans la ligne de commande - </entry> - </row> - <row> - <entry><literal>weechat_dir</literal></entry> - <entry> - répertoire de base de WeeChat - (par défaut: ~/.weechat/) - </entry> - </row> - <row> - <entry><literal>weechat_libdir</literal></entry> - <entry>répertoire "lib" système de WeeChat</entry> - </row> - <row> - <entry><literal>weechat_sharedir</literal></entry> - <entry>répertoire "share" système de WeeChat</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur où - récupérer l'information (si nécessaire) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : l'information recherchée, NULL si non trouvée. - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free" après utilisation. - </para> - <para> - Exemples : -<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, vous êtes %s sur freenode " - "(inactif depuis %s secondes)", - 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> - Renvoie la liste des DCC en cours ou terminés. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la liste chaînée des DCC. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>server</literal></entry> - <entry>le serveur IRC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel</literal></entry> - <entry>le canal IRC</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - le type de DCC : - 0 = discussion reçue, - 1 = discussion envoyée, - 2 = fichier reçu, - 3 = fichier envoyé - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>status</literal></entry> - <entry> - le statut du DCC : - 0 = en attente, - 1 = en cours de connexion, - 2 = actif, - 3 = terminé, - 4 = échoué, - 5 = interrompu par l'utilisateur - </entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_time</literal></entry> - <entry>la date et heure de création du DCC</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_transfer</literal></entry> - <entry>la date et heure de démarrage du transfert</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>addr</literal></entry> - <entry>adresse IP de l'utilisateur distant</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>port utilisé pour le DCC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo de l'utilisateur distant</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>filename</literal></entry> - <entry>nom de fichier</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>local_filename</literal></entry> - <entry>nom de fichier local</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>filename_suffix</literal></entry> - <entry>suffixe si renommage de fichier</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>size</literal></entry> - <entry>taille du fichier</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>pos</literal></entry> - <entry>position actuelle dans le fichier</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>start_resume</literal></entry> - <entry>position de démarrage après une interruption</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>bytes_per_sec</literal></entry> - <entry> - nombre d'octets transmis par seconde depuis le début - du transfert - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>prev_dcc</literal></entry> - <entry> - pointeur vers l'info DCC précédente - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>next_dcc</literal></entry> - <entry> - pointeur vers l'info DCC suivante - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_dcc_info" après utilisation. - </para> - <para> - Exemples : -<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, avec: %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> - Libère la mémoire utilisée par une liste de DCC. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>dcc_info</option> : pointeur vers la liste DCC - renvoyée par la fonction "get_dcc_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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> - Renvoie la liste des serveurs IRC (connectés ou non). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur retournée : la liste chaînée des serveurs IRC. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>nom interne du serveur</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoconnect</literal></entry> - <entry>1 si auto-connexion au démarrage, 0 sinon</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect</literal></entry> - <entry> - 1 si auto-reconnexion quand déconnecté, - 0 sinon - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect_delay</literal></entry> - <entry>délai avant de tenter une reconnexion</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_line</literal></entry> - <entry> - 1 si le serveur vient de la ligne de commande - (donc temporaire), 0 sinon - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>address</literal></entry> - <entry>adresse du serveur (nom ou 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>connexion IPv6</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl</literal></entry> - <entry>connexion SSL</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>password</literal></entry> - <entry>mot de passe pour le serveur</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick1</literal></entry> - <entry>premier pseudo</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick2</literal></entry> - <entry>pseudo alternatif</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick3</literal></entry> - <entry>second pseudo alternatif</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>username</literal></entry> - <entry>nom d'utilisateur</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>real name</literal></entry> - <entry>nom réel</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>command</literal></entry> - <entry>commande exécutée une fois connecté</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_delay</literal></entry> - <entry>délai après exécution de la commande</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>autojoin</literal></entry> - <entry>canaux joints automatiquement</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autorejoin</literal></entry> - <entry> - 1 si les canaux sont rejoints après un "kick", - 0 sinon - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>notify_levels</literal></entry> - <entry>niveaux de notification des canaux</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_iso</literal></entry> - <entry> - jeux de caractères de décodage ISO pour les canaux - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_utf</literal></entry> - <entry> - jeux de caractères de décodage UTF pour les canaux - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_encode</literal></entry> - <entry> - jeux de caractères d'encodage pour les canaux - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_connected</literal></entry> - <entry>1 si connecté au serveur, 0 sinon</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl_connected</literal></entry> - <entry>1 si connecté via SSL, 0 sinon</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo courant</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_away</literal></entry> - <entry>1 si absent, 0 sinon</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>away_time</literal></entry> - <entry> - date/heure à laquelle l'utilisateur a été marqué absent - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>lag</literal></entry> - <entry>lag (en millisecondes)</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>prev_server</literal></entry> - <entry>pointeur vers les infos du serveur précédent</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>next_server</literal></entry> - <entry>pointeur vers les infos du serveur suivant</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_server_info" après utilisation. - </para> - <para> - Exemple : -<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, - "serveur: %s, addresse: %s, port: %d %s", - ptr_server_info->name, - ptr_server_info->address, - ptr_server_info->port, - (ptr_server_info->is_connected) ? "(connecté)" : ""); - } - 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> - Libère la mémoire utilisée par une liste de serveurs. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>server_info</option> : pointeur vers la liste de - serveurs retournée par la fonction "get_server_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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 *serveur) - </command> - </para> - <para> - Renvoie la liste des canaux IRC pour un serveur. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la liste chaînée des canaux IRC du serveur. - <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 pour un canal, 1 pour un privé</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>nom du canal</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>topic</literal></entry> - <entry>titre du canal</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>modes</literal></entry> - <entry>modes du canal</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>limit</literal></entry> - <entry>limite d'utilisateurs</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>key</literal></entry> - <entry>clé du canal</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>nicks_count</literal></entry> - <entry>nombre de pseudos présents sur le canal</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>prev_channel</literal></entry> - <entry>pointeur vers les infos du canal précédent</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>next_channel</literal></entry> - <entry>pointeur vers les infos du canal suivant</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_channel_info" après utilisation. - </para> - <para> - Exemple : -<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> - Libère la mémoire utilisée par une liste de canaux. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>channel_info</option> : pointeur vers la liste de - canaux retournée par la fonction "get_channel_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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 *serveur, char *canal) - </command> - </para> - <para> - Renvoie la liste des pseudos pour un canal. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la liste chaînée des pseudos présents - sur le canal. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>host</literal></entry> - <entry>nom de machine</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>flags</literal></entry> - <entry> - propriétés du pseudo, "ou" binaire entre plusieurs - valeurs (1 =propriétaire du canal, 2 = administrateur - du canal, 4 = op, 8 = demi-op, 16 = voix, 32 = absent) - </entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>prev_nick</literal></entry> - <entry>pointeur vers les infos du pseudo précédent</entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>next_nick</literal></entry> - <entry>pointeur vers les infos du pseudo précédent</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_nick_info" après utilisation. - </para> - <para> - Exemple : -<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> - Libère la mémoire utilisée par une liste de pseudos. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>nick_info</option> : pointeur vers la liste de - pseudos retournée par la fonction "get_nick_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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> - Renvoie la valeur d'une option de configuration WeeChat. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option à lire - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la valeur de l'option, NULL si non trouvée. - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free" après utilisation. - </para> - <para> - Exemples : -<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 *valeur) - </command> - </para> - <para> - Modifie la valeur d'une option de configuration WeeChat. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option à mettre à jour - </para> - </listitem> - <listitem> - <para> - <option>valeur</option> : nouvelle valeur pour l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : 1 si l'option a été modifiée avec succès, 0 si - une erreur s'est produite. - </para> - <para> - Exemple : -<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> - Renvoie la valeur d'une option de l'extension. - L'option est lue depuis le fichier - "<literal>~/.weechat/plugins.rc</literal>" et est - sous cette forme : "<literal>extension.option=valeur</literal>" - (NB : le nom de l'extension est ajouté automatiquement). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option à lire - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : la valeur de l'option, NULL si non trouvée. - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free" après utilisation. - </para> - <para> - Exemple : -<screen> -char *value = plugin->get_plugin_config (plugin, "ma_variable"); -</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 *valeur) - </command> - </para> - <para> - Modifie la valeur d'une option de l'extension. - L'option est écrite dans le fichier - "<literal>~/.weechat/plugins.rc</literal>" et est - sous cette forme : "<literal>extension.option=valeur</literal>" - (NB : le nom de l'extension est ajouté automatiquement). - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option à mettre à jour - </para> - </listitem> - <listitem> - <para> - <option>valeur</option> : nouvelle valeur pour l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : 1 si l'option a été modifiée avec succès, 0 si - une erreur s'est produite. - </para> - <para> - Exemple : -<screen> -plugin->set_plugin_config (plugin, "ma_variable", "valeur"); -</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 *nom_couleur) - </command> - </para> - <para> - Renvoie le numéro d'une couleur IRC avec son nom. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>nom_couleur</option> : nom de la couleur - Les couleure autorisées sont : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Nom couleur</entry> - <entry>Valeur</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> - Valeur renvoyée : numéro de la couleur IRC, -1 si la couleur - n'est pas trouvée. - </para> - <para> - Exemple : -<screen> -int color_blue = plugin->get_irc_color (plugin, "blue"); /* retourne 2 */ -</screen> - </para> - </section> - - <section id="secAPI_input_color"> - <title>input_color</title> - - <para> - Prototype : - <command> - void input_color (t_weechat_plugin *plugin, - int couleur, int debut, int longueur) - </command> - </para> - <para> - Ajoute de la couleur dans la zone de saisie. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>couleur</option> : couleur pour le texte (si < 0, - alors la zone de saisie est rafraichie, et il n'y a aucun - changement dans son contenu) - </para> - </listitem> - <listitem> - <para> - <option>debut</option> : position de début pour la coloration - (si < 0, alors le masque est réinitialisé) - </para> - </listitem> - <listitem> - <para> - <option>longueur</option> : longueur pour la coloration - (si <= 0, alors le masque est réinitialisé) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : -<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> - Retourne la liste des fenêtres WeeChat. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : liste chaînée des fenêtres WeeChat. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>win_x</literal></entry> - <entry>position horizontale de la fenêtre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_y</literal></entry> - <entry>position verticale de la fenêtre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width</literal></entry> - <entry>largeur de la fenêtre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height</literal></entry> - <entry>hauteur de la fenêtre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width_pct</literal></entry> - <entry>largeur en % (comparé à la fenêtre parent)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height_pct</literal></entry> - <entry>hauteur en % (comparé à la fenêtre parent)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_buffer</literal></entry> - <entry>numéro du tampon affiché</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>prev_window</literal></entry> - <entry>pointeur vers les infos de la fenêtre précédente</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>next_window</literal></entry> - <entry>pointeur vers les infos de la fenêtre suivante</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_window_info" après utilisation. - </para> - <para> - Exemple : -<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, "--- info fenêtre ---"); - 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, "pas d'info fenêtre !"); -</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> - Libère la mémoire utilisée par une liste de fenêtres. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>window_info</option> : pointeur vers la liste des - infos fenêtres retournée par la fonction "get_window_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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> - Retourne la liste des tampons WeeChat. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : liste chaînée des tampons WeeChat. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - type de tampon: 0=standard, 1=DCC, - 2=données IRC brutes - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>number</literal></entry> - <entry>numéro de tampon</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_displayed</literal></entry> - <entry>nombre de fenêtres affichant ce tampon</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>server_name</literal></entry> - <entry>nom du serveur pour le tampon (peut être NULL)</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel_name</literal></entry> - <entry>nom du canal pout le tampon (peut être NULL)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>notify_level</literal></entry> - <entry>niveau de notification du tampon</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>log_filename</literal></entry> - <entry> - nom du fichier de log (NULL signifie qu'il n'y a - pas de log) - </entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>prev_buffer</literal></entry> - <entry>pointeur vers les infos du tampon précédent</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>next_buffer</literal></entry> - <entry>pointeur vers les infos du tampon suivant</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_buffer_info" après utilisation. - </para> - <para> - Exemple : -<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, "--- info tampon ---"); - 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, "pas d'info tampon !"); -</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> - Libère la mémoire utilisée par une liste de tampons. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>buffer_info</option> : pointeur vers la liste des - infos tampons retournée par la fonction "get_buffer_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <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 *serveur, char *canal) - </command> - </para> - <para> - Renvoie le contenu du tampon. - </para> - <para> - Paramètres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : contenu du tampon (liste chaînée de lignes). - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>time_t</entry> - <entry><literal>date</literal></entry> - <entry>date et heure</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>data</literal></entry> - <entry> - contenu de la ligne (les codes couleur sont - retirés) - </entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>prev_line</literal></entry> - <entry>pointeur vers la ligne précédente</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>next_line</literal></entry> - <entry>pointeur vers la ligne suivante</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le résultat doit être libéré par un appel à la fonction - "free_buffer_data" après utilisation. - </para> - <para> - Exemple : -<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, pseudo: %s, données: %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> - Libère la mémoire utilisée par les lignes d'un tampon. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>buffer_line</option> : pointeur vers la liste des - lignes du tampon retournée par la fonction "get_buffer_data" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoyée : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> - </para> - </section> - -</section> +</chapter> diff --git a/doc/fr/dev/plugin_c_api.fr.xml b/doc/fr/dev/plugin_c_api.fr.xml new file mode 100644 index 000000000..601eeffa1 --- /dev/null +++ b/doc/fr/dev/plugin_c_api.fr.xml @@ -0,0 +1,3561 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +WeeChat documentation (french 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="secPluginCApi"> + <title>API extension en C</title> + + <section id="secAPI_set_charset"> + <title>set_charset</title> + + <para> + Prototype : + <command> + void set_charset (t_weechat_plugin *plugin, char *charset) + </command> + </para> + <para> + Change le jeu de caractères de l'extension. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>charset</option> : nouveau jeu de caractères à + utiliser + </para> + </listitem> + </itemizedlist> + </para> + <para> + Exemple : + <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> + </para> + </section> + + <section id="secAPI_iconv_to_internal"> + <title>iconv_to_internal</title> + + <para> + Prototype : + <command> + void iconv_to_internal (t_weechat_plugin *plugin, char *charset, + char *string) + </command> + </para> + <para> + Convertit une chaîne de caractères vers le jeu de caractères + interne WeeChat (UTF-8). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>charset</option> : le jeu de caractères de départ + </para> + </listitem> + <listitem> + <para> + <option>string</option> : la chaîne à convertir + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la chaîne convertie. + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free" après utilisation. + </para> + <para> + Exemple : + <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "chaine iso: é à");</screen> + </para> + </section> + + <section id="secAPI_iconv_from_internal"> + <title>iconv_from_internal</title> + + <para> + Prototype : + <command> + void iconv_from_internal (t_weechat_plugin *plugin, char *charset, + char *string) + </command> + </para> + <para> + Convertit une chaîne de caractères depuis le jeu de caractères + interne WeeChat (UTF-8) vers un autre. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>charset</option> : le jeu de caractères voulu + </para> + </listitem> + <listitem> + <para> + <option>string</option> : la chaîne à convertir + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la chaîne convertie. + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free" après utilisation. + </para> + <para> + Exemple : + <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "chaine utf-8: é à");</screen> + </para> + </section> + + <section id="secAPI_ascii_strcasecmp"> + <title>ascii_strcasecmp</title> + + <para> + Prototype : + <command> + int ascii_strcasecmp (t_weechat_plugin *plugin, + char *chaine1, char *chaine2) + </command> + </para> + <para> + Effectue une comparaison entre deux chaînes, sans tenir compte des + majuscules/minuscules ni de la locale. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>chaine1</option> : la première chaîne à comparer + </para> + </listitem> + <listitem> + <para> + <option>chaine2</option> : la deuxième chaîne à comparer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la différence entre les deux chaînes : négatif + si chaine1 < chaine2, zéro si chaine1 == chaine2, positif si + chaine1 > chaine2 + </para> + <para> + Exemple : + <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> + </para> + </section> + + <section id="secAPI_ascii_strncasecmp"> + <title>ascii_strncasecmp</title> + + <para> + Prototype : + <command> + int ascii_strncasecmp (t_weechat_plugin *plugin, + char *chaine1, char *chaine2, int max) + </command> + </para> + <para> + Effectue une comparaison entre deux chaînes, sans tenir compte des + majuscules/minuscules ni de la locale, en comparant au plus "max" + caractères. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>chaine1</option> : la première chaîne à comparer + </para> + </listitem> + <listitem> + <para> + <option>chaine2</option> : la deuxième chaîne à comparer + </para> + </listitem> + <listitem> + <para> + <option>max</option> : nombre de caractères max à comparer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la différence entre les deux chaînes : négatif + si chaine1 < chaine2, zéro si chaine1 == chaine 2, positif si + chaine1 > chaine2 + </para> + <para> + Exemple : + <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> + </para> + </section> + + <section id="secAPI_explode_string"> + <title>explode_string</title> + + <para> + Prototype : + <command> + char **explode_string (t_weechat_plugin *plugin, char *chaine, + char *separateurs, int num_items_max, int *num_items) + </command> + </para> + <para> + Explose une chaîne en plusieurs selon un/des délimiteur(s). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>chaine</option> : la chaîne à exploser + </para> + </listitem> + <listitem> + <para> + <option>separateurs</option> : les délimiteurs utilisés + pour exploser la chaîne + </para> + </listitem> + <listitem> + <para> + <option>num_items_max</option> : nombre maximum de + sous-chaînes créées (0 = pas de limite) + </para> + </listitem> + <listitem> + <para> + <option>num_items</option> : pointeur vers un entier qui + contiendra le nombre de sous-chaînes créées en retour + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : un tableau de chaînes, ou NULL si un problème + a été rencontré. + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_exploded_string" après utilisation. + </para> + <para> + Exemple : +<screen> +char **argv; +int argc; +argv = plugin->explode_string (plugin, chaine, " ", 0, &argc); +... +if (argv != NULL) + plugin->free_exploded_string (plugin, argv); +</screen> + </para> + </section> + + <section id="secAPI_free_exploded_string"> + <title>free_exploded_string</title> + + <para> + Prototype : + <command> + char **free_exploded_string (t_weechat_plugin *plugin, + char **chaine) + </command> + </para> + <para> + Libère la mémoire utilisée pour une explosion de chaîne. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>chaine</option> : la chaîne explosée par la fonction + "explode_string" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : +<screen> +char *argv; +int argc; +argv = plugin->explode_string (plugin, chaine, " ", 0, &argc); +... +if (argv != NULL) + plugin->free_exploded_string (plugin, argv); +</screen> + </para> + </section> + + <section id="secAPI_mkdir_home"> + <title>mkdir_home</title> + + <para> + Prototype : + <command> + int mkdir_home (t_weechat_plugin *plugin, char *repertoire) + </command> + </para> + <para> + Créé un répertoire dans le répertoire de base de WeeChat. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>repertoire</option> : répertoire à créer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : 1 si le répertoire a été créé avec succès, + 0 si une erreur s'est produite. + </para> + <para> + Example: +<screen> +if (!plugin->mkdir_home (plugin, "temp")) + plugin->print_server(plugin, "Impossible de créer le répertoire 'temp' dans la base WeeChat."); +</screen> + </para> + </section> + + <section id="secAPI_exec_on_files"> + <title>exec_on_files</title> + + <para> + Prototype : + <command> + void exec_on_files (t_weechat_plugin *plugin, char *repertoire, + int (*callback)(t_weechat_plugin *, char *)) + </command> + </para> + <para> + Exécute une fonction sur tous les fichiers d'un répertoire. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>repertoire</option> : le répertoire où les fichiers + sont recherchés + </para> + </listitem> + <listitem> + <para> + <option>callback</option> : une fonction appelée pour chaque + fichier trouvé + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : +<screen> +int callback (t_weechat_plugin *plugin, char *fichier) +{ + plugin->print_server (plugin, "fichier: %s", fichier); + return 1; +} +... +plugin->exec_on_files (plugin, "/tmp", &callback); +</screen> + </para> + </section> + + <section id="secAPI_print"> + <title>print</title> + + <para> + Prototype : + <command> + void print (t_weechat_plugin *plugin, + char *serveur, char *canal, char *message, ...) + </command> + </para> + <para> + Affiche un message sur un tampon WeeChat, identifié par le serveur + et le canal (tous deux pouvant être NULL pour le tampon courant). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur pour + trouver le tampon dans lequel afficher (peut être NULL) + </para> + </listitem> + <listitem> + <para> + <option>canal</option> : nom du canal pour trouver le + tampon dans lequel afficher (peut être NULL) + </para> + </listitem> + <listitem> + <para> + <option>message</option> : message à afficher + </para> + </listitem> + </itemizedlist> + </para> + <para> + Pour afficher du texte en couleur, il faut utiliser les codes + suivants : + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Code</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>0x02</entry> + <entry> + texte gras + </entry> + </row> + <row> + <entry>0x03 + "xx"</entry> + <entry> + couleur du texte "<literal>xx</literal>" + (voir <xref linkend="secAPI_get_irc_color" /> pour les + couleurs) + </entry> + </row> + <row> + <entry>0x03 + "xx,yy"</entry> + <entry> + couleur du texte "<literal>xx</literal>" + et du fond "<literal>yy</literal>" + (voir <xref linkend="secAPI_get_irc_color" /> pour les + couleurs) + </entry> + </row> + <row> + <entry>0x0F</entry> + <entry> + désactiver la couleur et tous les attributs + </entry> + </row> + <row> + <entry>0x12</entry> + <entry> + vidéo inverse (inversion de la couleur d'écriture et du + fond) + </entry> + </row> + <row> + <entry>0x1F</entry> + <entry> + texte souligné + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + NB: le même code (sans le numéro pour 0x03) peut être utilisé pour + stopper l'attribut défini. + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemples : +<screen> +plugin->print (plugin, NULL, NULL, "hello"); +plugin->print (plugin, NULL, "#weechat", "hello"); +plugin->print (plugin, "freenode", "#weechat", "hello"); +plugin->print (plugin, "freenode", "#weechat", "hello"); +plugin->print (plugin, NULL, NULL, + "test: \x02 gras \x0F\x03%02d bleu \x03%02d vert", + 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> + Affiche un message sur le tampon du serveur courant. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>message</option> : message à afficher + </para> + </listitem> + </itemizedlist> + </para> + <para> + Pour afficher du texte en couleur, voir + <xref linkend="secAPI_print" />. + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : <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 *serveur, char *canal, char *message, ...) + </command> + </para> + <para> + Ecrit un message dans le fichier de log pour un serveur ou un + canal. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur pour + trouver le log du tampon (peut être NULL) + </para> + </listitem> + <listitem> + <para> + <option>canal</option> : nom du canal pour trouver le + tampon le log du tampon (peut être NULL) + </para> + </listitem> + <listitem> + <para> + <option>message</option> : message + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : +<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 *fonction, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Ajoute un gestionnaire de messages IRC, appelé dès qu'un message + IRC est reçu. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>message</option> : nom du message IRC pour lequel la + fonction est appelée ("*" pour tous les messages). + Pour connaître la liste des messages IRC disponibles, merci + de consulter les <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + et + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. + De plus, vous pouvez utiliser un nom spécial, préfixé par + "weechat_" pour capturer des évènements spéciaux, comme + décrit dans le tableau ci-dessous : + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Nom</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>weechat_pv</literal></entry> + <entry>message privé reçu</entry> + </row> + <row> + <entry><literal>weechat_highlight</literal></entry> + <entry> + message avec highlight (sur un canal ou en privé) + </entry> + </row> + <row> + <entry><literal>weechat_ctcp</literal></entry> + <entry> + message CTCP reçu (VERSION, PING, etc...) + </entry> + </row> + <row> + <entry><literal>weechat_dcc</literal></entry> + <entry> + message DCC reçu (discussion ou fichier) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>fonction</option> : fonction appelée lorsque le + message est reçu + </para> + <para> + Elle a le prototype suivant : + <command> + int ma_fonction (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Le paramètre argc vaut 3 et les arguments suivants sont + passés dans le tableau argv : + <itemizedlist> + <listitem> + <para>argv[0] = nom du serveur</para> + </listitem> + <listitem> + <para>argv[1] = message IRC</para> + </listitem> + <listitem> + <para>argv[2] = arguments de la commande</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option> : paramètres passés à la + fonction appelée + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option> : pointeur passé à la + fonction appelée + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : le pointeur vers le nouveau gestionnaire de + messages. + </para> + <para> + Note : la fonction appelée lorsque le message est reçu doit + renvoyer une des valeurs suivantes : + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal> : la fonction a échoué + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal> : la fonction a réussi + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal> : le message + ne sera pas transmis à WeeChat + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal> : le message + ne sera pas transmis à d'autres extensions + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_IGNORE_ALL</literal> : le message + ne sera ni transmis à WeeChat ni à d'autres extensions + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal> : la fonction + a réussi et provoque un "highlight" sur le message reçu + </para> + </listitem> + </itemizedlist> + </para> + <para> + Exemple : +<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 reçu"); + 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 *commande, char *description, char *arguments, + char *arguments_description, char *modele_completion, + t_plugin_handler_func *fonction, char *handler_args, + void *handler_pointer) + </command> + </para> + <para> + Ajoute un gestionnaire de commande WeeChat, appelé dès que + l'utilisateur utilise la commande (par exemple /commande). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>commande</option> : nom de la nouvelle commande, + qui peut être une commande déjà existante (attention la + commande remplacée ne sera plus disponible jusqu'à ce que + l'extension soit déchargée) + </para> + </listitem> + <listitem> + <para> + <option>description</option> : brève description de la + commande (affichée par /help commande) + </para> + </listitem> + <listitem> + <para> + <option>arguments</option> : brève description des + paramètres de la commande (affichée par /help commande) + </para> + </listitem> + <listitem> + <para> + <option>arguments_description</option> : longue description + des paramètres de la commande (affichée par /help commande) + </para> + </listitem> + <listitem> + <para> + <option>modele_completion</option> : modèle pour la + complétion sous la forme "<literal>abc|%w def|%i</literal>" + qui signifie "abc" ou une commande WeeChat pour le premier + paramètre, et "def" ou une commande IRC pour le deuxième. + Une chaîne vide indique à WeeChat de compléter tout + paramètre avec un pseudo du canal courant, une valeur NULL + ou égale à "-" désactive toute complétion pour tous les + paramètres de la commande. + </para> + <para> + Les codes suivants peuvent être utilisés : + <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>aucune complétion pour le paramètre</entry> + </row> + <row> + <entry><literal>%*</literal></entry> + <entry> + répétition de la dernière complétion pour tous + les paramètres suivants (ce code doit être à la + fin du modèle de complétion, précédé d'un "|") + </entry> + </row> + <row> + <entry><literal>%a</literal></entry> + <entry>alias</entry> + </row> + <row> + <entry><literal>%A</literal></entry> + <entry> + alias et commandes (WeeChat, IRC et extensions) + </entry> + </row> + <row> + <entry><literal>%c</literal></entry> + <entry>canal courant</entry> + </row> + <row> + <entry><literal>%C</literal></entry> + <entry>tous les canaux (y compris les privés)</entry> + </row> + <row> + <entry><literal>%f</literal></entry> + <entry>nom de fichier</entry> + </row> + <row> + <entry><literal>%h</literal></entry> + <entry>commandes définies par des extensions</entry> + </row> + <row> + <entry><literal>%i</literal></entry> + <entry>commandes IRC (envoyées)</entry> + </row> + <row> + <entry><literal>%I</literal></entry> + <entry>commandes IRC (reçues)</entry> + </row> + <row> + <entry><literal>%k</literal></entry> + <entry>fonctions associées aux touches</entry> + </row> + <row> + <entry><literal>%m</literal></entry> + <entry>pseudo sur le serveur courant</entry> + </row> + <row> + <entry><literal>%M</literal></entry> + <entry> + pseudos sur le serveur courant + (tous les canaux ouverts) + </entry> + </row> + <row> + <entry><literal>%n</literal></entry> + <entry>pseudos du canal courant</entry> + </row> + <row> + <entry><literal>%N</literal></entry> + <entry> + pseudos et noms de machines du canal + courant + </entry> + </row> + <row> + <entry><literal>%o</literal></entry> + <entry>options de configuration</entry> + </row> + <row> + <entry><literal>%O</literal></entry> + <entry>options des extensions</entry> + </row> + <row> + <entry><literal>%p</literal></entry> + <entry>message de "part" par défaut</entry> + </row> + <row> + <entry><literal>%q</literal></entry> + <entry>message de "quit" par défaut</entry> + </row> + <row> + <entry><literal>%s</literal></entry> + <entry>nom du serveur courant</entry> + </row> + <row> + <entry><literal>%S</literal></entry> + <entry>tous les serveurs</entry> + </row> + <row> + <entry><literal>%t</literal></entry> + <entry>titre du canal courant</entry> + </row> + <row> + <entry><literal>%v</literal></entry> + <entry>valeur d'une option de configuration</entry> + </row> + <row> + <entry><literal>%V</literal></entry> + <entry>valeur d'une option d'extension</entry> + </row> + <row> + <entry><literal>%w</literal></entry> + <entry>commandes WeeChat</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>fonction</option> : fonction appelée lorsque la + commande est exécutée. + </para> + <para> + Elle a le prototype suivant : + <command> + int ma_fonction (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Le paramètre argc vaut 3 et les arguments suivants sont + passés dans le tableau argv : + <itemizedlist> + <listitem> + <para>argv[0] = nom du serveur</para> + </listitem> + <listitem> + <para>argv[1] = commande</para> + </listitem> + <listitem> + <para>argv[2] = arguments de la commande</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option> : paramètres passés à la + fonction appelée + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option> : pointeur passé à la + fonction appelée + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : le pointeur vers le nouveau gestionnaire de + commande. + </para> + <para> + Note : la fonction appelée lorsque la commande est exécutée doit + renvoyer une des valeurs suivantes : + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal> : la fonction a échoué + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal> : la fonction a réussi + </para> + </listitem> + </itemizedlist> + </para> + <para> + Exemple : +<screen> +int cmd_test (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, argv[0], NULL, + "commande test, pseudo: %s", + (argv[2]) ? argv[2] : "aucun"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *cmd_handler; +cmd_handler = plugin->cmd_handler_add (plugin, "test", "Commande test", + "[pesudo]", "pseudo: un pseudo du canal", + "%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 intervalle, t_plugin_handler_func *fonction, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Ajoute un gestionnaire de temps, qui appelle périodiquement une + fonction. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>intervalle</option> : intervalle (en secondes) + entre deux appels de la fonction. + </para> + </listitem> + <listitem> + <para> + <option>fonction</option> : fonction appelée + </para> + <para> + Elle a le prototype suivant : + <command> + int ma_fonction (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Le paramètre argc vaut 0 et argv vaut NULL. + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option> : paramètres passés à la + fonction appelée + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option> : pointeur passé à la + fonction appelée + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : le pointeur vers le nouveau gestionnaire de + temps. + </para> + <para> + Note : la fonction appelée doit renvoyer une des valeurs + suivantes : + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal> : la fonction a échoué + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal> : la fonction a réussi + </para> + </listitem> + </itemizedlist> + </para> + <para> + Exemple : +<screen> +int mon_timer (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, NULL, NULL, "mon timer"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *timer_handler; +timer_handler = plugin->timer_handler_add (plugin, 60, &mon_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 *fonction, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Ajoute un gestionnaire de clavier, appelé dès qu'une touche est + pressée. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>fonction</option> : fonction appelée + </para> + <para> + Elle a le prototype suivant : + <command> + int ma_fonction (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Le paramètre argc vaut 3 et les arguments suivants sont + passés dans le tableau argv : + <itemizedlist> + <listitem> + <para> + argv[0] = touche appuyée (nom d'une fonction interne + ou bien '*' suivi du code d'une touche) + </para> + </listitem> + <listitem> + <para> + argv[1] = la ligne de commande avant l'action de la + touche + </para> + </listitem> + <listitem> + <para> + argv[2] = la ligne de commande après l'action de la + touche + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option> : paramètres passés à la + fonction appelée + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option> : pointeur passé à la + fonction appelée + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : le pointeur vers le nouveau gestionnaire de + clavier. + </para> + <para> + Note : la fonction appelée doit renvoyer une des valeurs + suivantes : + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal> : la fonction a échoué + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal> : la fonction a réussi + </para> + </listitem> + </itemizedlist> + </para> + <para> + Exemple : +<screen> +int mon_keyb (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + if (argc == 2) + { + plugin->print (plugin, NULL, NULL, "touche appuyée: %s", argv[0]); + if (argv[1] && (argv[1][0] == '1')) + plugin->print (plugin, NULL, NULL, "le texte d'entrée a changé"); + else + plugin->print (plugin, NULL, NULL, "le texte d'entrée n'a pas changé"); + } + return PLUGIN_RC_OK; +} +... +t_plugin_handler *keyb_handler; +keyb_handler = plugin->keyboard_handler_add (plugin, &mon_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 *evenement, t_plugin_handler_func *fonction, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Ajoute un gestionnaire d'évènement, appelé dès qu'un évènement se + produit. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>évènement</option> : évènement (voir le tableau + ci-dessous) + </para> + </listitem> + <listitem> + <para> + <option>fonction</option> : fonction appelée + </para> + <para> + Elle a le prototype suivant : + <command> + int ma_fonction (t_weechat_plugin *plugin, + int argc, char **argv, + char *handler_args, void *handler_pointer) + </command> + </para> + <para> + Les paramètres passés à la fonction dépendent de l'évènement + (voir le tableau ci-dessous). + </para> + </listitem> + <listitem> + <para> + <option>handler_args</option> : paramètres passés à la + fonction appelée + </para> + </listitem> + <listitem> + <para> + <option>handler_pointer</option> : pointeur passé à la + fonction appelée + </para> + </listitem> + </itemizedlist> + </para> + <para> + Liste des évènements : + <informaltable colsep="0" frame="none"> + <tgroup cols="3"> + <thead> + <row> + <entry>Evènement</entry> + <entry>Description</entry> + <entry>Paramètres</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>buffer_open</literal></entry> + <entry>un tampon a été ouvert</entry> + <entry> + argc = 1, argv = { numéro de tampon } + </entry> + </row> + <row> + <entry><literal>buffer_close</literal></entry> + <entry>un tampon a été fermé</entry> + <entry> + argc = 1, argv = { numéro de tampon } + </entry> + </row> + <row> + <entry><literal>buffer_move</literal></entry> + <entry>un tampon a été déplacé</entry> + <entry> + argc = 2, argv = { nouveau numéro de tampon, ancien + numéro } + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Valeur renvoyée : le pointeur vers le nouveau gestionnaire + d'évènement. + </para> + <para> + Note : la fonction appelée doit renvoyer une des valeurs + suivantes : + <itemizedlist> + <listitem> + <para> + <literal>PLUGIN_RC_KO</literal> : la fonction a échoué + </para> + </listitem> + <listitem> + <para> + <literal>PLUGIN_RC_OK</literal> : la fonction a réussi + </para> + </listitem> + </itemizedlist> + </para> + <para> + Exemple : +<screen> +int mon_evenement (t_weechat_plugin *plugin, int argc, char **argv, + char *handler_args, void *handler_pointer) +{ + plugin->print (plugin, NULL, NULL, "mon_evenement"); + return PLUGIN_RC_OK; +} +... +t_plugin_handler *event_handler; +event_handler = plugin->event_handler_add (plugin, "buffer_open", + &mon_evenement); +</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> + Supprime un gestionnaire de commande ou message. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>handler</option> : le gestionnaire à supprimer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <screen>plugin->handler_remove (plugin, mon_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> + Supprime tous les gestionnaires d'une extension. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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 *fonction, + char *modifier_args, void *modifier_pointer) + </command> + </para> + <para> + Ajoute un modifieur de message. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>type</option> : type de modifieur : + <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>appelé pour chaque message IRC reçu</entry> + </row> + <row> + <entry><literal>irc_user</literal></entry> + <entry> + appelé pour chaque message (ou commande) envoyé par + l'utilisateur (avant traitement et affichage par + WeeChat) + </entry> + </row> + <row> + <entry><literal>irc_out</literal></entry> + <entry> + appelé pour chaque message sortant juste avant + envoi au serveur IRC (y compris pour les messages + envoyés automatiquement et de manière transparente + par WeeChat) + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>message</option> : nom du message IRC pour lequel la + fonction est appelée (utilisé uniquement pour les types + "irc_in" et "irc_out"). + Pour connaître la liste des messages IRC disponibles, merci + de consulter les <acronym>RFC</acronym>s + <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> + et + <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. + La valeur spéciale "*" signifie tous les messages (pas de + filtre). + </para> + </listitem> + <listitem> + <para> + <option>fonction</option> : fonction appelée + </para> + <para> + Elle a le prototype suivant : + <command> + char *ma_fonction (t_weechat_plugin *plugin, + int argc, char **argv, + char *modifier_args, void *modifier_pointer) + </command> + </para> + <para> + Le paramètre argc vaut 2 et les arguments suivants sont + passés dans le tableau argv : + <itemizedlist> + <listitem> + <para>argv[0] = nom du serveur</para> + </listitem> + <listitem> + <para>argv[1] = message</para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <option>modifier_args</option> : paramètres passés à la + fonction appelée + </para> + </listitem> + <listitem> + <para> + <option>modifier_pointer</option> : pointeur passé à la + fonction appelée + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : le pointeur vers le nouveau modifieur de message. + </para> + <para> + Note : la fonction doit retourner une chaîne modifiée, ou NULL si + elle ne souhaite pas modifier le message. + Si elle retourne une chaine vide, alors le message est supprimé et + ne sera pas traité du tout par WeeChat (soyez prudent en supprimant + des messages !). + La chaîne renvoyée doit avoir été allouée par malloc() et sera + libérée (par appel à free()) automatiquement par WeeChat après + utilisation. + </para> + <para> + Exemple : +<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> + Supprime un modifieur de message. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>modifier</option> : le modifieur à supprimer + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <screen>plugin->modifier_remove (plugin, mon_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> + Supprime tous les modifieurs d'une extension. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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 *serveur, char *canal, char *commande) + </command> + </para> + <para> + Execute une commande WeeChat ou envoie un message à un canal. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur où + exécuter la commande (peut être NULL) + </para> + </listitem> + <listitem> + <para> + <option>canal</option> : nom du canal où exécuter la + commande (peut être NULL) + </para> + </listitem> + <listitem> + <para> + <option>commande</option> : la commande à exécuter + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemples : +<screen> +plugin->exec_command (plugin, NULL, NULL, "/help nick"); +plugin->exec_command (plugin, "freenode", "#weechat", "bonjour"); +</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 *serveur) + </command> + </para> + <para> + Renvoie une information sur WeeChat ou un canal. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>info</option> : nom de l'info à obtenir : + <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>version de WeeChat</entry> + </row> + <row> + <entry><literal>nick</literal></entry> + <entry>pesudo</entry> + </row> + <row> + <entry><literal>channel</literal></entry> + <entry> + nom du canal (NULL pour un serveur ou un privé) + </entry> + </row> + <row> + <entry><literal>server</literal></entry> + <entry>nom du serveur</entry> + </row> + <row> + <entry><literal>type</literal></entry> + <entry> + type de tampon: 0=standard, 1=DCC, + 2=données IRC brutes + </entry> + </row> + <row> + <entry><literal>away</literal></entry> + <entry>drapeau "away"</entry> + </row> + <row> + <entry><literal>inactivity</literal></entry> + <entry> + nombre de secondes écoulées depuis que la dernière + touche a été appuyée + </entry> + </row> + <row> + <entry><literal>input</literal></entry> + <entry> + contenu de la ligne de commande de la fenêtre + courante + </entry> + </row> + <row> + <entry><literal>input_mask</literal></entry> + <entry> + contenu du masque de couleur de la ligne de + commande + </entry> + </row> + <row> + <entry><literal>input_pos</literal></entry> + <entry> + position du curseur dans la ligne de commande + </entry> + </row> + <row> + <entry><literal>weechat_dir</literal></entry> + <entry> + répertoire de base de WeeChat + (par défaut: ~/.weechat/) + </entry> + </row> + <row> + <entry><literal>weechat_libdir</literal></entry> + <entry>répertoire "lib" système de WeeChat</entry> + </row> + <row> + <entry><literal>weechat_sharedir</literal></entry> + <entry>répertoire "share" système de WeeChat</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur où + récupérer l'information (si nécessaire) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : l'information recherchée, NULL si non trouvée. + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free" après utilisation. + </para> + <para> + Exemples : +<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, vous êtes %s sur freenode " + "(inactif depuis %s secondes)", + 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> + Renvoie la liste des DCC en cours ou terminés. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la liste chaînée des DCC. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Champ</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>server</literal></entry> + <entry>le serveur IRC</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>channel</literal></entry> + <entry>le canal IRC</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry> + le type de DCC : + 0 = discussion reçue, + 1 = discussion envoyée, + 2 = fichier reçu, + 3 = fichier envoyé + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>status</literal></entry> + <entry> + le statut du DCC : + 0 = en attente, + 1 = en cours de connexion, + 2 = actif, + 3 = terminé, + 4 = échoué, + 5 = interrompu par l'utilisateur + </entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>start_time</literal></entry> + <entry>la date et heure de création du DCC</entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>start_transfer</literal></entry> + <entry>la date et heure de démarrage du transfert</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>addr</literal></entry> + <entry>adresse IP de l'utilisateur distant</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>port</literal></entry> + <entry>port utilisé pour le DCC</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>pseudo de l'utilisateur distant</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>filename</literal></entry> + <entry>nom de fichier</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>local_filename</literal></entry> + <entry>nom de fichier local</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>filename_suffix</literal></entry> + <entry>suffixe si renommage de fichier</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>size</literal></entry> + <entry>taille du fichier</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>pos</literal></entry> + <entry>position actuelle dans le fichier</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>start_resume</literal></entry> + <entry>position de démarrage après une interruption</entry> + </row> + <row> + <entry>unsigned long</entry> + <entry><literal>bytes_per_sec</literal></entry> + <entry> + nombre d'octets transmis par seconde depuis le début + du transfert + </entry> + </row> + <row> + <entry>t_plugin_dcc_info *</entry> + <entry><literal>prev_dcc</literal></entry> + <entry> + pointeur vers l'info DCC précédente + </entry> + </row> + <row> + <entry>t_plugin_dcc_info *</entry> + <entry><literal>next_dcc</literal></entry> + <entry> + pointeur vers l'info DCC suivante + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_dcc_info" après utilisation. + </para> + <para> + Exemples : +<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, avec: %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> + Libère la mémoire utilisée par une liste de DCC. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>dcc_info</option> : pointeur vers la liste DCC + renvoyée par la fonction "get_dcc_info" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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> + Renvoie la liste des serveurs IRC (connectés ou non). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur retournée : la liste chaînée des serveurs IRC. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Champ</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>name</literal></entry> + <entry>nom interne du serveur</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoconnect</literal></entry> + <entry>1 si auto-connexion au démarrage, 0 sinon</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoreconnect</literal></entry> + <entry> + 1 si auto-reconnexion quand déconnecté, + 0 sinon + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autoreconnect_delay</literal></entry> + <entry>délai avant de tenter une reconnexion</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>command_line</literal></entry> + <entry> + 1 si le serveur vient de la ligne de commande + (donc temporaire), 0 sinon + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>address</literal></entry> + <entry>adresse du serveur (nom ou 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>connexion IPv6</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ssl</literal></entry> + <entry>connexion SSL</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>password</literal></entry> + <entry>mot de passe pour le serveur</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick1</literal></entry> + <entry>premier pseudo</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick2</literal></entry> + <entry>pseudo alternatif</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick3</literal></entry> + <entry>second pseudo alternatif</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>username</literal></entry> + <entry>nom d'utilisateur</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>real name</literal></entry> + <entry>nom réel</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>command</literal></entry> + <entry>commande exécutée une fois connecté</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>command_delay</literal></entry> + <entry>délai après exécution de la commande</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>autojoin</literal></entry> + <entry>canaux joints automatiquement</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>autorejoin</literal></entry> + <entry> + 1 si les canaux sont rejoints après un "kick", + 0 sinon + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>notify_levels</literal></entry> + <entry>niveaux de notification des canaux</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_decode_iso</literal></entry> + <entry> + jeux de caractères de décodage ISO pour les canaux + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_decode_utf</literal></entry> + <entry> + jeux de caractères de décodage UTF pour les canaux + </entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>charset_encode</literal></entry> + <entry> + jeux de caractères d'encodage pour les canaux + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>is_connected</literal></entry> + <entry>1 si connecté au serveur, 0 sinon</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>ssl_connected</literal></entry> + <entry>1 si connecté via SSL, 0 sinon</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>pseudo courant</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>is_away</literal></entry> + <entry>1 si absent, 0 sinon</entry> + </row> + <row> + <entry>time_t</entry> + <entry><literal>away_time</literal></entry> + <entry> + date/heure à laquelle l'utilisateur a été marqué absent + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>lag</literal></entry> + <entry>lag (en millisecondes)</entry> + </row> + <row> + <entry>t_plugin_server_info *</entry> + <entry><literal>prev_server</literal></entry> + <entry>pointeur vers les infos du serveur précédent</entry> + </row> + <row> + <entry>t_plugin_server_info *</entry> + <entry><literal>next_server</literal></entry> + <entry>pointeur vers les infos du serveur suivant</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_server_info" après utilisation. + </para> + <para> + Exemple : +<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, + "serveur: %s, addresse: %s, port: %d %s", + ptr_server_info->name, + ptr_server_info->address, + ptr_server_info->port, + (ptr_server_info->is_connected) ? "(connecté)" : ""); + } + 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> + Libère la mémoire utilisée par une liste de serveurs. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>server_info</option> : pointeur vers la liste de + serveurs retournée par la fonction "get_server_info" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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 *serveur) + </command> + </para> + <para> + Renvoie la liste des canaux IRC pour un serveur. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la liste chaînée des canaux IRC du serveur. + <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 pour un canal, 1 pour un privé</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>name</literal></entry> + <entry>nom du canal</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>topic</literal></entry> + <entry>titre du canal</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>modes</literal></entry> + <entry>modes du canal</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>limit</literal></entry> + <entry>limite d'utilisateurs</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>key</literal></entry> + <entry>clé du canal</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>nicks_count</literal></entry> + <entry>nombre de pseudos présents sur le canal</entry> + </row> + <row> + <entry>t_plugin_channel_info *</entry> + <entry><literal>prev_channel</literal></entry> + <entry>pointeur vers les infos du canal précédent</entry> + </row> + <row> + <entry>t_plugin_channel_info *</entry> + <entry><literal>next_channel</literal></entry> + <entry>pointeur vers les infos du canal suivant</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_channel_info" après utilisation. + </para> + <para> + Exemple : +<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> + Libère la mémoire utilisée par une liste de canaux. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>channel_info</option> : pointeur vers la liste de + canaux retournée par la fonction "get_channel_info" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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 *serveur, char *canal) + </command> + </para> + <para> + Renvoie la liste des pseudos pour un canal. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur + </para> + </listitem> + <listitem> + <para> + <option>canal</option> : nom du canal + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la liste chaînée des pseudos présents + sur le canal. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Champ</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>pseudo</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>host</literal></entry> + <entry>nom de machine</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>flags</literal></entry> + <entry> + propriétés du pseudo, "ou" binaire entre plusieurs + valeurs (1 =propriétaire du canal, 2 = administrateur + du canal, 4 = op, 8 = demi-op, 16 = voix, 32 = absent) + </entry> + </row> + <row> + <entry>t_plugin_nick_info *</entry> + <entry><literal>prev_nick</literal></entry> + <entry>pointeur vers les infos du pseudo précédent</entry> + </row> + <row> + <entry>t_plugin_nick_info *</entry> + <entry><literal>next_nick</literal></entry> + <entry>pointeur vers les infos du pseudo précédent</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_nick_info" après utilisation. + </para> + <para> + Exemple : +<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> + Libère la mémoire utilisée par une liste de pseudos. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>nick_info</option> : pointeur vers la liste de + pseudos retournée par la fonction "get_nick_info" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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> + Renvoie la valeur d'une option de configuration WeeChat. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>option</option> : nom de l'option à lire + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la valeur de l'option, NULL si non trouvée. + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free" après utilisation. + </para> + <para> + Exemples : +<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 *valeur) + </command> + </para> + <para> + Modifie la valeur d'une option de configuration WeeChat. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>option</option> : nom de l'option à mettre à jour + </para> + </listitem> + <listitem> + <para> + <option>valeur</option> : nouvelle valeur pour l'option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : 1 si l'option a été modifiée avec succès, 0 si + une erreur s'est produite. + </para> + <para> + Exemple : +<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> + Renvoie la valeur d'une option de l'extension. + L'option est lue depuis le fichier + "<literal>~/.weechat/plugins.rc</literal>" et est + sous cette forme : "<literal>extension.option=valeur</literal>" + (NB : le nom de l'extension est ajouté automatiquement). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>option</option> : nom de l'option à lire + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : la valeur de l'option, NULL si non trouvée. + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free" après utilisation. + </para> + <para> + Exemple : +<screen> +char *value = plugin->get_plugin_config (plugin, "ma_variable"); +</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 *valeur) + </command> + </para> + <para> + Modifie la valeur d'une option de l'extension. + L'option est écrite dans le fichier + "<literal>~/.weechat/plugins.rc</literal>" et est + sous cette forme : "<literal>extension.option=valeur</literal>" + (NB : le nom de l'extension est ajouté automatiquement). + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>option</option> : nom de l'option à mettre à jour + </para> + </listitem> + <listitem> + <para> + <option>valeur</option> : nouvelle valeur pour l'option + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : 1 si l'option a été modifiée avec succès, 0 si + une erreur s'est produite. + </para> + <para> + Exemple : +<screen> +plugin->set_plugin_config (plugin, "ma_variable", "valeur"); +</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 *nom_couleur) + </command> + </para> + <para> + Renvoie le numéro d'une couleur IRC avec son nom. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>nom_couleur</option> : nom de la couleur + Les couleure autorisées sont : + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Nom couleur</entry> + <entry>Valeur</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> + Valeur renvoyée : numéro de la couleur IRC, -1 si la couleur + n'est pas trouvée. + </para> + <para> + Exemple : +<screen> +int color_blue = plugin->get_irc_color (plugin, "blue"); /* retourne 2 */ +</screen> + </para> + </section> + + <section id="secAPI_input_color"> + <title>input_color</title> + + <para> + Prototype : + <command> + void input_color (t_weechat_plugin *plugin, + int couleur, int debut, int longueur) + </command> + </para> + <para> + Ajoute de la couleur dans la zone de saisie. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>couleur</option> : couleur pour le texte (si < 0, + alors la zone de saisie est rafraichie, et il n'y a aucun + changement dans son contenu) + </para> + </listitem> + <listitem> + <para> + <option>debut</option> : position de début pour la coloration + (si < 0, alors le masque est réinitialisé) + </para> + </listitem> + <listitem> + <para> + <option>longueur</option> : longueur pour la coloration + (si <= 0, alors le masque est réinitialisé) + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : +<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> + Retourne la liste des fenêtres WeeChat. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : liste chaînée des fenêtres WeeChat. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Champ</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>win_x</literal></entry> + <entry>position horizontale de la fenêtre</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_y</literal></entry> + <entry>position verticale de la fenêtre</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_width</literal></entry> + <entry>largeur de la fenêtre</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_height</literal></entry> + <entry>hauteur de la fenêtre</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_width_pct</literal></entry> + <entry>largeur en % (comparé à la fenêtre parent)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>win_height_pct</literal></entry> + <entry>hauteur en % (comparé à la fenêtre parent)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>num_buffer</literal></entry> + <entry>numéro du tampon affiché</entry> + </row> + <row> + <entry>t_plugin_window_info *</entry> + <entry><literal>prev_window</literal></entry> + <entry>pointeur vers les infos de la fenêtre précédente</entry> + </row> + <row> + <entry>t_plugin_window_info *</entry> + <entry><literal>next_window</literal></entry> + <entry>pointeur vers les infos de la fenêtre suivante</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_window_info" après utilisation. + </para> + <para> + Exemple : +<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, "--- info fenêtre ---"); + 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, "pas d'info fenêtre !"); +</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> + Libère la mémoire utilisée par une liste de fenêtres. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>window_info</option> : pointeur vers la liste des + infos fenêtres retournée par la fonction "get_window_info" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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> + Retourne la liste des tampons WeeChat. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : liste chaînée des tampons WeeChat. + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Champ</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>int</entry> + <entry><literal>type</literal></entry> + <entry> + type de tampon: 0=standard, 1=DCC, + 2=données IRC brutes + </entry> + </row> + <row> + <entry>int</entry> + <entry><literal>number</literal></entry> + <entry>numéro de tampon</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>num_displayed</literal></entry> + <entry>nombre de fenêtres affichant ce tampon</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>server_name</literal></entry> + <entry>nom du serveur pour le tampon (peut être NULL)</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>channel_name</literal></entry> + <entry>nom du canal pout le tampon (peut être NULL)</entry> + </row> + <row> + <entry>int</entry> + <entry><literal>notify_level</literal></entry> + <entry>niveau de notification du tampon</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>log_filename</literal></entry> + <entry> + nom du fichier de log (NULL signifie qu'il n'y a + pas de log) + </entry> + </row> + <row> + <entry>t_plugin_buffer_info *</entry> + <entry><literal>prev_buffer</literal></entry> + <entry>pointeur vers les infos du tampon précédent</entry> + </row> + <row> + <entry>t_plugin_buffer_info *</entry> + <entry><literal>next_buffer</literal></entry> + <entry>pointeur vers les infos du tampon suivant</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_buffer_info" après utilisation. + </para> + <para> + Exemple : +<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, "--- info tampon ---"); + 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, "pas d'info tampon !"); +</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> + Libère la mémoire utilisée par une liste de tampons. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>buffer_info</option> : pointeur vers la liste des + infos tampons retournée par la fonction "get_buffer_info" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <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 *serveur, char *canal) + </command> + </para> + <para> + Renvoie le contenu du tampon. + </para> + <para> + Paramètres : + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>serveur</option> : nom interne du serveur + </para> + </listitem> + <listitem> + <para> + <option>canal</option> : nom du canal + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : contenu du tampon (liste chaînée de lignes). + <informaltable colsep="0" frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Type</entry> + <entry>Champ</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>time_t</entry> + <entry><literal>date</literal></entry> + <entry>date et heure</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>nick</literal></entry> + <entry>pseudo</entry> + </row> + <row> + <entry>char *</entry> + <entry><literal>data</literal></entry> + <entry> + contenu de la ligne (les codes couleur sont + retirés) + </entry> + </row> + <row> + <entry>t_plugin_buffer_line *</entry> + <entry><literal>prev_line</literal></entry> + <entry>pointeur vers la ligne précédente</entry> + </row> + <row> + <entry>t_plugin_buffer_line *</entry> + <entry><literal>next_line</literal></entry> + <entry>pointeur vers la ligne suivante</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + <para> + Note : le résultat doit être libéré par un appel à la fonction + "free_buffer_data" après utilisation. + </para> + <para> + Exemple : +<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, pseudo: %s, données: %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> + Libère la mémoire utilisée par les lignes d'un tampon. + </para> + <para> + Arguments: + <itemizedlist> + <listitem> + <para> + <option>plugin</option> : pointeur vers la structure + de l'extension + </para> + </listitem> + <listitem> + <para> + <option>buffer_line</option> : pointeur vers la liste des + lignes du tampon retournée par la fonction "get_buffer_data" + </para> + </listitem> + </itemizedlist> + </para> + <para> + Valeur renvoyée : aucune. + </para> + <para> + Exemple : + <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> + </para> + </section> + +</section> diff --git a/doc/fr/dev/plugin_scripts.fr.xml b/doc/fr/dev/plugin_script_api.fr.xml index ae35162d9..ae35162d9 100644 --- a/doc/fr/dev/plugin_scripts.fr.xml +++ b/doc/fr/dev/plugin_script_api.fr.xml diff --git a/doc/fr/dev/plugins.fr.xml b/doc/fr/dev/plugins.fr.xml index 024bfcf69..5407fb4d0 100644 --- a/doc/fr/dev/plugins.fr.xml +++ b/doc/fr/dev/plugins.fr.xml @@ -132,8 +132,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. </informaltable> </para> - <!-- &plugin_api.fr.xml; --> - <section id="secCompilePlugin"> <title>Compiler l'extension</title> @@ -243,14 +241,4 @@ weechat_plugin_end (struct t_weechat_plugin *plugin) </section> - &plugin_irc.fr.xml; - - <!-- &plugin_charset.fr.xml; --> - - &plugin_fifo.fr.xml; - - <!-- &plugin_scripts.fr.xml; --> - - &plugin_xfer.fr.xml; - </chapter> diff --git a/doc/fr/dev/weechat_dev.fr.xml b/doc/fr/dev/weechat_dev.fr.xml index 71df8d88e..4ebcbfcc4 100644 --- a/doc/fr/dev/weechat_dev.fr.xml +++ b/doc/fr/dev/weechat_dev.fr.xml @@ -30,11 +30,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. %include_autogen.xml; <!-- ***** written by hand: ***** --> - <!ENTITY intro.fr.xml SYSTEM "intro.fr.xml"> - <!ENTITY plugins.fr.xml SYSTEM "plugins.fr.xml"> - <!ENTITY plugin_api.fr.xml SYSTEM "plugin_api.fr.xml"> - <!ENTITY plugin_scripts.fr.xml SYSTEM "plugin_scripts.fr.xml"> - <!ENTITY authors.fr.xml SYSTEM "authors.fr.xml"> + <!ENTITY intro.fr.xml SYSTEM "intro.fr.xml"> + <!ENTITY plugins.fr.xml SYSTEM "plugins.fr.xml"> + <!ENTITY plugin_api.fr.xml SYSTEM "plugin_api.fr.xml"> + <!ENTITY plugin_c_api.fr.xml SYSTEM "plugin_c_api.fr.xml"> + <!ENTITY plugin_script_api.fr.xml SYSTEM "plugin_script_api.fr.xml"> + <!ENTITY authors.fr.xml SYSTEM "authors.fr.xml"> ]> <book lang="fr"> @@ -95,7 +96,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. &intro.fr.xml; - <!-- &plugins.fr.xml; --> + &plugins.fr.xml; + + &plugin_api.fr.xml; &authors.fr.xml; diff --git a/doc/weechat-doc.css b/doc/weechat-doc.css index da1ab6844..846f6dd6d 100644 --- a/doc/weechat-doc.css +++ b/doc/weechat-doc.css @@ -79,6 +79,20 @@ a:hover { font-size: 11px; } +.note { + border: dashed 1px #CCCCCC; + background-color: #FFFFFF; + margin: 0; + padding: 6px 6px 0 6px; +} + +.note h3 { + border: none; + background-color: #FFFFFF; + margin: 0; + padding: 0; +} + .programlisting { font-size: 11px; } diff --git a/doc/weechat-html-one.xsl.in b/doc/weechat-html-one.xsl.in index ad13bd2e8..da2884725 100644 --- a/doc/weechat-html-one.xsl.in +++ b/doc/weechat-html-one.xsl.in @@ -9,7 +9,7 @@ <xsl:param name="chunk.section.depth" select="2"/> <xsl:param name="chunk.quietly" select="1"/> <xsl:param name="chunk.first.sections" select="1"/> -<xsl:param name="generate.section.toc.level" select="3"/> +<xsl:param name="generate.section.toc.level" select="2"/> <xsl:param name="html.stylesheet">weechat-doc.css</xsl:param> diff --git a/doc/weechat-html.xsl.in b/doc/weechat-html.xsl.in index f0b7bef71..855807a37 100644 --- a/doc/weechat-html.xsl.in +++ b/doc/weechat-html.xsl.in @@ -9,7 +9,7 @@ <xsl:param name="chunk.section.depth" select="2"/> <xsl:param name="chunk.quietly" select="1"/> <xsl:param name="chunk.first.sections" select="1"/> -<xsl:param name="generate.section.toc.level" select="3"/> +<xsl:param name="generate.section.toc.level" select="2"/> <xsl:param name="html.stylesheet">weechat-doc.css</xsl:param> |