diff options
Diffstat (limited to 'docs/Signals.pm')
-rw-r--r-- | docs/Signals.pm | 467 |
1 files changed, 462 insertions, 5 deletions
diff --git a/docs/Signals.pm b/docs/Signals.pm index 0ea689f..d6d3ec9 100644 --- a/docs/Signals.pm +++ b/docs/Signals.pm @@ -20,29 +20,486 @@ have been revised to note Perl variable types and class names. Arguments are passed to signal handlers in the usual way, via C<@_>. + + =head2 Core =over 4 -=item C<"gui exit"> I<None> +=item C<"gui exit"> +I<None> -=item C<"gui dialog" string $type, string $text> +=item C<"gui dialog"> + string C<$type>, string C<$text> =item C<"send command"> -C<string $command, Irssi::Server $server, Irssi::Windowitem -$window_item> + C<string $command> L<Irssi::Server> C<$server>, L<Irssi::Windowitem> + C<$window_item> + +=back + +=head3 F<chat-protocols.c>: + +B<TODO: What are CHAT_PROTOCOL_REC types?> + +=over 4 + +=item C<"chat protocol created"> CHAT_PROTOCOL_REC + +=item C<"chat protocol updated"> CHAT_PROTOCOL_REC + +=item C<"chat protocol destroyed"> CHAT_PROTOCOL_REC + +=back + +=head3 F<channels.c>: + +=over 4 + +=item C<"channel created"> L<Irssi::Channel>, int C<$automatic> + +=item C<"channel destroyed"> L<Irssi::Channel> C<$channel> + +=back + +=head3 F<chatnets.c>: + +=over 4 + +=item C<"chatnet created"> CHATNET_REC + +=item C<"chatnet destroyed"> CHATNET_REC + +=back + +=head3 F<commands.c>: + +=over 4 + +=item C<"commandlist new">, L<Irssi::Command> C<$cmd> + +=item C<"commandlist remove"> L<Irssi::Command> C<$cmd> + +=item C<"error command"> int C<$err>, string C<$cmd> + +=item C<"send command"> string C<$args>, + L<Irssi::Server> C<$server>, L<Irssi::Windowitem> C<$witem> + +=item C<"send text"> string C<$line>, L<Irssi::Server> C<$server>, + L<Irssi::Windowitem> C<$witem> + +=item C<"command "<cmd>> string C<$args>, L<Irssi::Server> C<$server>, + L<Irssi::Windowitem> C<$witem> + +B<TODO: check this "cmd" out?> + +=item C<"default command"> string C<$args>, L<Irssi::Server> C<$server>, + L<Irssi::Windowitem> C<$witem> + +=back + +=head3 F<ignore.c>: + +=over 4 + +=item C<"ignore created"> L<Irssi::Ignore> C<$ignore> + +=item C<"ignore destroyed"> L<Irssi::Ignore> C<$ignore> + +=item C<"ignore changed"> L<Irssi::Ignore> C<$ignore> + +=back + +=head3 F<log.c>: + +=over 4 + +=item C<"log new"> L<Irssi::Log> C<$log> + +=item C<"log remove"> L<Irssi::Log> C<$log> + +=item C<"log create failed"> L<Irssi::Log> C<$log> + +=item C<"log locked"> L<Irssi::Log> C<$log> + +=item C<"log started"> L<Irssi::Log> C<$log> + +=item C<"log stopped"> L<Irssi::Log> C<$log> + +=item C<"log rotated"> L<Irssi::Log> C<$log> + +=item C<"log written"> L<Irssi::Log> C<$log>, string C<$line> + +=back + +=head3 F<modules.c>: + +B<TODO: what are these types?> + +=over 4 + +=item "module loaded", MODULE_REC, MODULE_FILE_REC + +=item "module unloaded", MODULE_REC, MODULE_FILE_REC + +=item "module error", int error, char *text, char *rootmodule, char *submodule + +=back + +=head3 F<nicklist.c>: + +=over 4 + +=item C<"nicklist new"> L<Irssi::Channel> C<$channel>, L<Irssi::Nick> C<$nick> + +=item "nicklist remove", CHANNEL_REC, NICK_REC + +=item "nicklist changed", CHANNEL_REC, NICK_REC, char *old_nick + +=item "nicklist host changed", CHANNEL_REC, NICK_REC + +=item "nicklist gone changed", CHANNEL_REC, NICK_REC + +=item "nicklist serverop changed", CHANNEL_REC, NICK_REC + +=back + +=head3 pidwait.c: + +=over 4 + +=item "pidwait", int pid, int status + +=back + +=head3 queries.c: + +=over 4 + +=item "query created", QUERY_REC, int automatic + +=item "query destroyed", QUERY_REC + +=item "query nick changed", QUERY_REC, char *orignick + +=item "window item name changed", WI_ITEM_REC + +=item "query address changed", QUERY_REC + +=item "query server changed", QUERY_REC, SERVER_REC + +=back + + +=head3 rawlog.c: + +=over 4 + +=item "rawlog", RAWLOG_REC, char *data + +=back + +=head3 server.c: + +=over 4 + +=item "server looking", SERVER_REC + +=item "server connected", SERVER_REC + +=item "server connecting", SERVER_REC, ulong *ip + +=item "server connect failed", SERVER_REC + +=item "server disconnected", SERVER_REC + +=item "server quit", SERVER_REC, char *msg + +=item "server sendmsg", SERVER_REC, char *target, char *msg, int target_type + +=back + +=head3 settings.c: + +=over 4 + +=item "setup changed" + +=item "setup reread", char *fname + +=item "setup saved", char *fname, int autosaved =back =head2 IRC Core -=head2 IRC Module +=head3 bans.c: + + "ban type changed", char *bantype + +=head3 channels, nicklist: + + "channel joined", CHANNEL_REC + "channel wholist", CHANNEL_REC + "channel sync", CHANNEL_REC + + "channel topic changed", CHANNEL_REC + +=head3 ctcp.c: + + "ctcp msg", SERVER_REC, char *args, char *nick, char *addr, char *target + "ctcp msg "<cmd>, SERVER_REC, char *args, char *nick, char *addr, char *target + "default ctcp msg", SERVER_REC, char *args, char *nick, char *addr, char *target + "ctcp reply", SERVER_REC, char *args, char *nick, char *addr, char *target + "ctcp reply "<cmd>, SERVER_REC, char *args, char *nick, char *addr, char *target + "default ctcp reply", SERVER_REC, char *args, char *nick, char *addr, char *target + "ctcp action", SERVER_REC, char *args, char *nick, char *addr, char *target + +=head3 irc-log.c: + + "awaylog show", LOG_REC, int away_msgs, int filepos + +=head3 irc-nicklist.c: + + "server nick changed", SERVER_REC + +=head3 irc-servers.c: + + "event connected", SERVER_REC + +=head3 irc.c: + + "server event", SERVER_REC, char *data, char *sender_nick, char *sender_address + "event "<cmd>, SERVER_REC, char *args, char *sender_nick, char *sender_address + "default event", SERVER_REC, char *data, char *sender_nick, char *sender_address + "whois default event", SERVER_REC, char *args, char *sender_nick, char *sender_address + + "server incoming", SERVER_REC, char *data + +(for perl parser..) + "redir "<cmd>, SERVER_REC, char *args, char *sender_nick, char *sender_address + +=head3 lag.c: + + "server lag", SERVER_REC + "server lag disconnect", SERVER_REC + +=head3 massjoin.c: + + "massjoin", CHANNEL_REC, GSList of NICK_RECs + +=head3 mode-lists.c: + + "ban new", CHANNEL_REC, BAN_REC + "ban remove", CHANNEL_REC, BAN_REC, char *setby + +=head3 modes.c: + + "channel mode changed", CHANNEL_REC, char *setby + "nick mode changed", CHANNEL_REC, NICK_REC, char *setby, char *mode, char *type + "user mode changed", SERVER_REC, char *old + "away mode changed", SERVER_REC + +=head3 netsplit.c: + + "netsplit server new", SERVER_REC, NETSPLIT_SERVER_REC + "netsplit server remove", SERVER_REC, NETSPLIT_SERVER_REC + "netsplit new", NETSPLIT_REC + "netsplit remove", NETSPLIT_REC + + +=head2 IRC Modules + + +=head3 dcc*.c: + + "dcc ctcp "<cmd>, char *args, DCC_REC + "default dcc ctcp", char *args, DCC_REC + "dcc unknown ctcp", char *args, char *sender, char *sendaddr + + "dcc reply "<cmd>, char *args, DCC_REC + "default dcc reply", char *args, DCC_REC + "dcc unknown reply", char *args, char *sender, char *sendaddr + + "dcc chat message", DCC_REC, char *msg + + "dcc created", DCC_REC + "dcc destroyed", DCC_REC + "dcc connected", DCC_REC + "dcc rejecting", DCC_REC + "dcc closed", DCC_REC + "dcc request", DCC_REC, char *sendaddr + "dcc request send", DCC_REC + "dcc chat message", DCC_REC, char *msg + "dcc transfer update", DCC_REC + "dcc get receive", DCC_REC + "dcc error connect", DCC_REC + "dcc error file create", DCC_REC, char *filename + "dcc error file open", char *nick, char *filename, int errno + "dcc error get not found", char *nick + "dcc error send exists", char *nick, char *filename + "dcc error unknown type", char *type + "dcc error close not found", char *type, char *nick, char *filename + +=head3 autoignore.c: + + "autoignore new", SERVER_REC, AUTOIGNORE_REC + "autoignore remove", SERVER_REC, AUTOIGNORE_REC + +=head3 flood.c: + + "flood", SERVER_REC, char *nick, char *host, int level, char *target + +=head3 notifylist.c: + + "notifylist new", NOTIFYLIST_REC + "notifylist remove", NOTIFYLIST_REC + "notifylist joined", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg + "notifylist away changed", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg + "notifylist left", SERVER_REC, char *nick, char *user, char *host, char *realname, char *awaymsg + +=head3 proxy/listen.c: + + "proxy client connected", CLIENT_REC + "proxy client disconnected", CLIENT_REC + "proxy client command", CLIENT_REC, char *args, char *data + "proxy client dump", CLIENT_REC, char *data + =head2 Display (FE) Common +B<Requires to work properly:> + + "gui print text", WINDOW_REC, int fg, int bg, int flags, char *text, TEXT_DEST_REC + +(Can be used to determine when all "gui print text"s are sent (not required)) + "gui print text finished", WINDOW_REC + +B<Provides signals:> + +=head3 completion.c: + + "complete word", GList * of char*, WINDOW_REC, char *word, char *linestart, int *want_space + +=head3 fe-common-core.c: + + "irssi init read settings" + +=head3 fe-exec.c: + + "exec new", PROCESS_REC + "exec remove", PROCESS_REC, int status + "exec input", PROCESS_REC, char *text + +=head3 fe-messages.c: + + "message public", SERVER_REC, char *msg, char *nick, char *address, char *target + "message private", SERVER_REC, char *msg, char *nick, char *address + "message own_public", SERVER_REC, char *msg, char *target + "message own_private", SERVER_REC, char *msg, char *target, char *orig_target + "message join", SERVER_REC, char *channel, char *nick, char *address + "message part", SERVER_REC, char *channel, char *nick, char *address, char *reason + "message quit", SERVER_REC, char *nick, char *address, char *reason + "message kick", SERVER_REC, char *channel, char *nick, char *kicker, char *address, char *reason + "message nick", SERVER_REC, char *newnick, char *oldnick, char *address + "message own_nick", SERVER_REC, char *newnick, char *oldnick, char *address + "message invite", SERVER_REC, char *channel, char *nick, char *address + "message topic", SERVER_REC, char *channel, char *topic, char *nick, char *address + +=head3 keyboard.c: + + "keyinfo created", KEYINFO_REC + "keyinfo destroyed", KEYINFO_REC + +=head3 printtext.c: + + "print text", TEXT_DEST_REC *dest, char *text, char *stripped + +=head3 themes.c: + + "theme created", THEME_REC + "theme destroyed", THEME_REC + +=head3 window-activity.c: + + "window hilight", WINDOW_REC + "window dehilight", WINDOW_REC + "window activity", WINDOW_REC, int old_level + "window item hilight", WI_ITEM_REC + "window item activity", WI_ITEM_REC, int old_level + +=head3 window-items.c: + + "window item new", WINDOW_REC, WI_ITEM_REC + "window item remove", WINDOW_REC, WI_ITEM_REC + "window item moved", WINDOW_REC, WI_ITEM_REC, WINDOW_REC + "window item changed", WINDOW_REC, WI_ITEM_REC + "window item server changed", WINDOW_REC, WI_ITEM_REC + +=head3 windows.c: + + "window created", WINDOW_REC + "window destroyed", WINDOW_REC + "window changed", WINDOW_REC, WINDOW_REC old + "window changed automatic", WINDOW_REC + "window server changed", WINDOW_REC, SERVER_REC + "window refnum changed", WINDOW_REC, int old + "window name changed", WINDOW_REC + "window history changed", WINDOW_REC, char *oldname + "window level changed", WINDOW_REC + =head2 Display (FE) IRC +=head3 fe-events.c: + + "default event numeric", SERVER_REC, char *data, char *nick, char *address + +=head3 fe-irc-messages.c: + + "message irc op_public", SERVER_REC, char *msg, char *nick, char *address, char *target + "message irc own_wall", SERVER_REC, char *msg, char *target + "message irc own_action", SERVER_REC, char *msg, char *target + "message irc action", SERVER_REC, char *msg, char *nick, char *address, char *target + "message irc own_notice", SERVER_REC, char *msg, char *target + "message irc notice", SERVER_REC, char *msg, char *nick, char *address, char *target + "message irc own_ctcp", SERVER_REC, char *cmd, char *data, char *target + "message irc ctcp", SERVER_REC, char *cmd, char *data, char *nick, char *address, char *target + +=head3 fe-modes.c: + + "message irc mode", SERVER_REC, char *channel, char *nick, char *addr, char *mode + +=head3 dcc/fe-dcc-chat-messages.c: + + "message dcc own", DCC_REC *dcc, char *msg + "message dcc own_action", DCC_REC *dcc, char *msg + "message dcc own_ctcp", DCC_REC *dcc, char *cmd, char *data + "message dcc", DCC_REC *dcc, char *msg + "message dcc action", DCC_REC *dcc, char *msg + "message dcc ctcp", DCC_REC *dcc, char *cmd, char *data + =head2 Display (FE) Text +=head3 F<gui-readline.c>: + +=over 4 + +=item C<"gui key pressed"> int C<$key> + +=back + +=head3 F<gui-printtext.c>: + +=over 4 + +=item C<"beep"> I<None> + +=back + =head2 Perl Scripting +=over 4 + +=item C<"script error"> PERL_SCRIPT_REC, string C<$errormsg> + +=back |