Prototyp: int ascii_strcasecmp (t_weechat_plugin *plugin, char *string1, char *string2)

Vergleich von Zeichenketten unabhängig von Sprache und Schreibweise (gross/klein).

Argumente:

Rückgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner Null wenn string1 < string2, Null wenn string1 == string2, grösser Null wenn string1 > string2

Beispiel:

if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...

Prototyp: int ascii_strncasecmp (t_weechat_plugin *plugin, char *string1, char *string2, int max)

Vergleich von Zeichenketten unabhängig von Sprache und Schreibweise (gross/klein) für höchstens "max" Zeichen.

Argumente:

Rückgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner Null wenn string1 < string2, Null wenn string1 == string2, grösser Null wenn string1 > string2

Beispiel:

if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...

Prototyp: char **explode_string (t_weechat_plugin *plugin, char *string, char *separators, int num_items_max, int *num_items)

Zerlege eine Zeichenkette entsprechend eines oder mehrerer Trennzeichen(s).

Argumente:

Rückgabewert: ein Array von Zeichenketten, NULL bei Fehlern.

Hinweis: Das zurückgegebene Array muss nach der Benutzung mittels "free_exloded_string" explizit freigegeben werden.

Beispiel:

char **argv;
int argc;
argv = plugin->explode_string (plugin, string, " ", 0, &argc);
...
if (argv != NULL)
    plugin->free_exploded_string (plugin, argv);

Prototyp: char **free_exploded_string (t_weechat_plugin *plugin, char **string)

Gib ein Array frei, dass infolge der Zerlegung eines Strings reserviert wurde.

Argumente:

Rückgabewert: keiner (?).

Beispiel:

char *argv;
int argc;
argv = plugin->explode_string (plugin, string, " ", 0, &argc);
...
if (argv != NULL)
    plugin->free_exploded_string (plugin, argv);

Prototyp: void exec_on_files (t_weechat_plugin *plugin, char *repertoire, int (*callback)(t_weechat_plugin *, char *))

Führe eine Funktion auf allen Dateien eines Verzeichnisses aus.

Argumente:

Rückgabewert: keiner.

Beispiel:

int callback (t_weechat_plugin *plugin, char *file)
{
    plugin->print_server (plugin, "file: %s", file);
    return 1;
}
...
plugin->exec_on_files (plugin, "/tmp", &callback);

Prototyp: void print (t_weechat_plugin *plugin, char *server, char *channel, char *message, ...)

Sende eine Nachricht an einen WeeChat-Puffer, bezeichnet durch server und channel (beide können NULL sein, dann wird der aktuelle Puffer verwendet).

Argumente:

Rückgabewert: keiner.

Beispiele:

plugin->print (plugin, NULL, NULL, "hello");
plugin->print (plugin, NULL, "#weechat", "hello");
plugin->print (plugin, "freenode", "#weechat", "hello");

Prototyp: void print_server (t_weechat_plugin *plugin, char *message, ...)

Zeige eine Nachricht im aktuellen Server-Puffer.

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->print_server (plugin, "hello");

Prototyp: void print_infobar (t_weechat_plugin *plugin, int time, char *message, ...)

Zeige eine Nachricht in der Infobar für eine bestimmte Zeit

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->print_infobar (plugin, 5, "hello");

Prototyp: void infobar_remove (t_weechat_plugin *plugin, int count)

Entferne eine oder mehr Nachrichten aus der Infobar.

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->infobar_remove (1);

Prototyp: void log (t_weechat_plugin *plugin, char *server, char *channel, char *message, ...)

Schreibe eine Nachricht in die Log-Datei (für den entsprechenden Server/Channel).

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->log (plugin, "freenode", "#weechat", "test");

Prototyp: t_plugin_handler *msg_handler_add (t_weechat_plugin *plugin, char *message, t_plugin_handler_func *function, char *handler_args, void *handler_pointer)

Erzeuge einen IRC-Message-Handler, der aufgerufen wird, wenn eine Nachricht empfangen wird.

Argumente:

Rückgabewert: Zeiger auf den neuen Handler

Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht empfangen wurde, muss einen der folgenden Werte zurückgeben:

Beispiel:

int msg_kick (t_weechat_plugin *plugin, char *server, char *command,
              char *arguments, char *handler_args, void *handler_pointer)
{
    plugin->print (plugin, server, NULL, "KICK received");
    return PLUGIN_RC_OK;
}
...
plugin->msg_handler_add (plugin, "KICK", &msg_kick, NULL, NULL);

Prototyp: 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)

Erzeugt einen Handler für ein WeeChat-Kommando, der aufgerufen wird, wenn der Anwender das Kommando ausführt (Beispiel: /command).

Argumente:

Rückgabewert: Zeiger auf den neuen Kommando-Handler.

Hinweis: die Funktion, die aufgerufen wird, wenn das Kommando ausgeführt wird, muss einen der folgende Werte zurückgeben:

Beispiel:

int cmd_test (t_weechat_plugin *plugin, char *server,
              char *command, char *arguments, char *handler_args,
              void *handler_pointer)
{
    plugin->print (plugin, server, NULL,
                   "test command, nick: %s",
                   (arguments) ? arguments : "none");
    return PLUGIN_RC_OK;
}
...
plugin->cmd_handler_add (plugin, "test", "Test command",
                         "[nick]", "nick: nick of channel",
                         "%n", &cmd_test, NULL, NULL);

Prototyp: t_plugin_handler *timer_handler_add (t_weechat_plugin *plugin, int interval, t_plugin_handler_func *function, char *handler_args, void *handler_pointer)

Erzeuge einen zeitgesteuerten Handler, der periodisch eine Funktion aufruft.

Argumente:

Rückgabewert: Zeiger auf den neuen timer-Handler.

Hinweis: die Funktion, die aufgerufen wird, muss einen der folgende Werte zurückgeben:

Beispiel:

int my_timer (t_weechat_plugin *plugin, char *server, char *command,
              char *arguments, char *handler_args, void *handler_pointer)
{
    plugin->print (plugin, NULL, NULL, "my timer");
    return PLUGIN_RC_OK;
}
...
plugin->timer_handler_add (plugin, 60, &my_timer);

Prototyp: t_plugin_handler *keyboard_handler_add (t_weechat_plugin *plugin, t_plugin_handler_func *function, char *handler_args, void *handler_pointer)

Erzeugt einen Keyboard-Handler, der nach dem Drücken einer Taste aufgerufen wird.

Argumente:

Rückgabewert: Zeiger auf den Handler.

Hinweis: Die aufgerufene Funktion muss einen der folgenden Werte zurückgeben:

Beispiel:

int keyb_handler (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;
}
...
plugin->keyboard_handler_add (plugin, &keyb_handler);

Prototyp: void handler_remove (t_weechat_plugin *plugin, t_plugin_handler *handler)

Entfernt einen Nachrichten- oder Kommando-Handler.

Argumente:

Rückgabewert: keiner

Beispiel:

plugin->handler_remove (plugin, my_handler);

Prototyp: void handler_remove_all (t_weechat_plugin *plugin)

Entfernt alle Handler eines Plugins.

Argumente:

Rückgabewert: keiner

Beispiel:

plugin->handler_remove_all (plugin);

Prototyp: void exec_command (t_weechat_plugin *plugin, char *server, char *channel, char *command)

Führe ein WeeChat-Kommando aus (oder sende eine Nachricht an einen Channel).

Argumente:

Rückgabewert: keiner

Beispiel:

plugin->exec_command (plugin, NULL, NULL, "/help nick");
plugin->exec_command (plugin, "freenode", "#weechat", "hello");

Prototyp: char *get_info (t_weechat_plugin *plugin, char *info, char *server)

Gib eine Information über WeeChat oder einen Channel zurück.

Argumente:

Rückgabewert: angeforderte Information oder NULL

Hinweis: das Ergebnis muss nach Nutzung mit "free" wieder freigegeben werden.

Beispiele:

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

Prototyp: t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin)

Gib eine Liste der aktiven oder beendeten DCCs zurück.

Argumente:

Rückgabewert: verkettete Liste von DCCs.

Hinweis: Das Ergebnis muss nach der Benutzung mittels "free_dcc_info" wieder freigegeben werden.

Beispiele:

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

Prototyp: void free_dcc_info (t_weechat_plugin *plugin, t_plugin_dcc_info *dcc_info)

Gibt den Speicher einer Liste von DCC-Infos wieder frei.

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->free_dcc_info (plugin, dcc_info);

Prototyp: t_plugin_server_info *get_server_info (t_weechat_plugin *plugin)

Gibt die Liste von IRC-Servern zurück (verbunden oder nicht)

Argumente:

Rückgabewert: Liste von IRC-Servern.

Hinweis: das Ergebnis muss nach der Benutzung mit "free_server_info" wieder freigegeben werden.

Beispiel:

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

Prototyp: void free_server_info (t_weechat_plugin *plugin, t_plugin_server_info *server_info)

Gib den Speicher einer Liste "server info" frei

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->free_server_info (plugin, server_info);

Prototyp: t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, char *server)

Gib eine Liste der Channels für einen Server zurück.

Argumente:

Rückgabewert: verkettete Liste von Channels für einen Server.

Hinweis: Das Ergebnis muss nach der Benutzung mit "free_channel_info" wieder freigegeben werden.

Beispiel:

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

Prototyp: void free_channel_info (t_weechat_plugin *plugin, t_plugin_channel_info *channel_info)

Gibt den Speicher einer Liste "channel info" wieder frei.

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->free_channel_info (plugin, channel_info);

Prototyp: t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, char *server, char *channel)

Gib eine Liste der Nicknamen für einen Channel zurück.

Argumente:

Rückgabewert: verkettete Liste von Nicknamen eines Channels.

Hinweis: Das Ergebnis muss nach der Benutzung mit "free_nick_info" wieder freigegeben werden.

Beispiel:

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

Prototyp: void free_nick_info (t_weechat_plugin *plugin, t_plugin_nick_info *nick_info)

Gibt den Speicher einer Liste "nick info" frei.

Argumente:

Rückgabewert: keiner.

Beispiel:

plugin->free_nick_info (plugin, nick_info);

Prototyp: char *get_config (t_weechat_plugin *plugin, char *option)

Gibt den Wert einer Option der WeeChat-Konfiguration zurück.

Argumente:

Rückgabewert: Wert der Option, oder NULL, wenn nichts gefunden wurde.

Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder freigegeben werden.

Beispiel:

char *value1 = plugin->get_config (plugin, "look_set_title");
char *value2 = plugin->get_config (plugin, "freenode.server_autojoin");

Prototyp: int set_config (t_weechat_plugin *plugin, char *option, char *value)

Setze den Wert einer Option der WeeChat-Konfiguration.

Argumente:

Rückgabewert: 1 wenn der Wert der Option gesetzt werden konnte, 0 bei Auftreten eines Fehlers.

Beispiel:

plugin->set_config (plugin, "look_nicklist", "off");

Prototyp: char *get_plugin_config (t_weechat_plugin *plugin, char *option)

Gibt den Wert einer Option eines Plugins zurück. Die Option wird aus "~/.weechat/plugins.rc" gelesen und sieht so aus: "plugin.option=value" (Hinweis: der Name des Plugins wird automatisch gesetzt).

Argumente:

Rückgabewert: Wert der Option, NULL wenn nichts gefunden wurde.

Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder freigegeben werden.

Beispiel:

char *value = plugin->get_plugin_config (plugin, "my_var");

Prototyp: int set_plugin_config (t_weechat_plugin *plugin, char *option, char *value)

Setzt den Wert einer Option eines Plugins. Die Option wird in die Datei "~/.weechat/plugins.rc" geschrieben und sieht so aus: "plugin.option=value" (Hinweis: der Name des Plugins wird automatisch gesetzt)

Argumente:

Rückgabewert: 1 wenn die Option gesetzt werden konnte, 0 wenn ein Fehler aufgetreten ist.

Beispiel:

plugin->set_plugin_config (plugin, "my_var", "value");