SourceForge Logo

NAME

Boucherot::signal::messages - A package that contains common messages handlers for the XChat's signal emulation

DESCRIPTION

This package contains some common functions that auto-called each time a particular event occurs.

For exemple, each time someone part from a channel you're in, a PART line is sent to you. And this package contain a function that will catch each part line, and then emit the appropriate XChat signal. (XP_TE_PART, XP_TE_UPART, XP_TE_PARTREASON or XP_TE_UPARTREASON)

GISSUML MODEL

Package Boucherot::signal::messages

Functions:

 +$ privmsg ( line : SCALAR, infoline : Hash ) :
 +$ nick ( line : SCALAR, infoline : Hash ) :
 +$ ctcp ( line : SCALAR, infoline : Hash ) :
 +$ join ( line : SCALAR, infoline : Hash ) :
 +$ part ( line : SCALAR, infoline : Hash ) :
 +$ quit ( line : SCALAR, infoline : Hash ) :
 +$ notice ( line : SCALAR, infoline : Hash ) :
 +$ mode ( line : SCALAR, infoline : Hash ) :
 +$ topic ( line : SCALAR, infoline : Hash ) :
 +$ kick ( line : SCALAR, infoline : Hash ) :
 +$ ev301 ( line : SCALAR, infoline : Hash ) :
 +$ ev311 ( line : SCALAR, infoline : Hash ) :
 +$ ev312 ( line : SCALAR, infoline : Hash ) :
 +$ ev314 ( line : SCALAR, infoline : Hash ) :
 +$ ev317 ( line : SCALAR, infoline : Hash ) :
 +$ ev318 ( line : SCALAR, infoline : Hash ) :
 +$ ev319 ( line : SCALAR, infoline : Hash ) :
 +$ ev322 ( line : SCALAR, infoline : Hash ) :
 +$ ev324 ( line : SCALAR, infoline : Hash ) :
 +$ ev329 ( line : SCALAR, infoline : Hash ) :
 +$ ev332 ( line : SCALAR, infoline : Hash ) :
 +$ ev333 ( line : SCALAR, infoline : Hash ) :
 +$ ev352 ( line : SCALAR, infoline : Hash ) :
 +$ ev353 ( line : SCALAR, infoline : Hash ) :
 +$ ev372 ( line : SCALAR, infoline : Hash ) :
 +$ ev375 ( line : SCALAR, infoline : Hash ) :
 +$ ev376 ( line : SCALAR, infoline : Hash ) :
 +$ ev421 ( line : SCALAR, infoline : Hash ) :
 +$ ev422 ( line : SCALAR, infoline : Hash ) :
 +$ ev433 ( line : SCALAR, infoline : Hash ) :
 +$ ev471 ( line : SCALAR, infoline : Hash ) :
 +$ ev473 ( line : SCALAR, infoline : Hash ) :
 +$ ev474 ( line : SCALAR, infoline : Hash ) :
 +$ ev475 ( line : SCALAR, infoline : Hash ) :
 +$ evSrvMsg ( line : SCALAR, infoline : Hash ) :
 +$ evSrvTxt ( line : SCALAR, infoline : Hash ) :
 -$ add_numeric_local_handlers ( evNum1 : SCALAR , evNum2 : SCALAR , ... ) :
 -$ add_numeric_local_server_message_handlers ( evNum1 : SCALAR , evNum2 : SCALAR , ... ) :
 -$ add_numeric_local_server_text_handlers ( evNum1 : SCALAR , evNum2 : SCALAR , ... ) :

METHODS

privmsg nick ctcp ... evNNN

 +$ privmsg ( line : SCALAR, infoline : Hash ) :
 +$ nick ( line : SCALAR, infoline : Hash ) :
 +$ ctcp ( line : SCALAR, infoline : Hash ) :
 +$ join ( line : SCALAR, infoline : Hash ) :
 +$ part ( line : SCALAR, infoline : Hash ) :
 +$ quit ( line : SCALAR, infoline : Hash ) :
 +$ notice ( line : SCALAR, infoline : Hash ) :
 +$ mode ( line : SCALAR, infoline : Hash ) :
 +$ topic ( line : SCALAR, infoline : Hash ) :
 +$ kick ( line : SCALAR, infoline : Hash ) :
 +$ ev301 ( line : SCALAR, infoline : Hash ) :
 +$ ev311 ( line : SCALAR, infoline : Hash ) :
 +$ ev312 ( line : SCALAR, infoline : Hash ) :
 +$ ev314 ( line : SCALAR, infoline : Hash ) :
 +$ ev317 ( line : SCALAR, infoline : Hash ) :
 +$ ev318 ( line : SCALAR, infoline : Hash ) :
 +$ ev319 ( line : SCALAR, infoline : Hash ) :
 +$ ev322 ( line : SCALAR, infoline : Hash ) :
 +$ ev324 ( line : SCALAR, infoline : Hash ) :
 +$ ev329 ( line : SCALAR, infoline : Hash ) :
 +$ ev332 ( line : SCALAR, infoline : Hash ) :
 +$ ev333 ( line : SCALAR, infoline : Hash ) :
 +$ ev352 ( line : SCALAR, infoline : Hash ) :
 +$ ev353 ( line : SCALAR, infoline : Hash ) :
 +$ ev372 ( line : SCALAR, infoline : Hash ) :
 +$ ev375 ( line : SCALAR, infoline : Hash ) :
 +$ ev376 ( line : SCALAR, infoline : Hash ) :
 +$ ev421 ( line : SCALAR, infoline : Hash ) :
 +$ ev422 ( line : SCALAR, infoline : Hash ) :
 +$ ev433 ( line : SCALAR, infoline : Hash ) :
 +$ ev471 ( line : SCALAR, infoline : Hash ) :
 +$ ev473 ( line : SCALAR, infoline : Hash ) :
 +$ ev474 ( line : SCALAR, infoline : Hash ) :
 +$ ev475 ( line : SCALAR, infoline : Hash ) :
 +$ evSrvMsg ( line : SCALAR, infoline : Hash ) :
 +$ evSrvTxt ( line : SCALAR, infoline : Hash ) :

Each of these functions track an event. Each line sent by the irc server contain a special field named ``event''. It can be either a word or a 3 digits number ( PRIVMSG or 372 for exemple ).

Each of these functions are associated with an event. that has the same name, if its a word event, or that is evNNN if the event is the numeric event NNN.

Those functions are called ``messages handlers'' in XChat. They usually take one argument in XChat, that is the line that must be analyse. There is a second argument, that is the line analysed by the infoline package. As the line has already be analysed, why would we analysed it twice ?

add_numeric_local_handlers

 -$ add_numeric_local_handlers ( evNum1 : SCALAR , evNum2 : SCALAR , ... ) :

This private function takes a lot of event number and auto associate the event number NNN with the function called evNNN of this current package.

add_numeric_local_server_message_handlers

 -$ add_numeric_local_server_message_handlers ( evNum1 : SCALAR , evNum2 : SCALAR , ... ) :

This private function takes a lot of event number and auto associate the event number NNN with the function called evSrvMsg of this current package. All those events are ``Server messages''

add_numeric_local_server_text_handlers

 -$ add_numeric_local_server_text_handlers ( evNum1 : SCALAR , evNum2 : SCALAR , ... ) :

This private function takes a lot of event number and auto associate the event number NNN with the function called evSrvTxt of this current package. All those events are ``Server texte messages''

AUTHORS

This class was written by Arthibus Gissehel <gissehel@vachefolle.com> in 2000.

NOTES

This class is part of the boucherot project.