tdenetwork/ksirc/chanparser.h

290 lines
6.0 KiB

#ifndef CHAN_PARSER_H
#define CHAN_PARSER_H
#include <tqcolor.h>
#include <tqdict.h>
/*
* This file defines the parser, and all exceptions generated
* by the toplevel parse_input function.
*/
class ChannelParser; // Main class defined
class TQString;
class KSircTopLevel;
class parseResult
{
public:
parseResult() { }
virtual ~parseResult() { }
// Empty
};
/*
* Parsing is ok, this is the string to display
*/
class parseSucc : public parseResult
{
public:
TQString string; // String to display
TQColor colour;
TQString pm;
parseSucc(const TQString &_s, const TQColor &_c = TQColor(), const TQString &_pm = TQString()){
string = _s;
colour = _c;
pm = _pm;
}
};
/*
* parseError is a fatal error message.
* arg0: if it is not empty, it will get displayed to the channel screen (in error colour with mad smile)
* arg1: if none empty goes to stderr
*/
class parseError : public parseResult
{
public:
TQString str;
TQString err;
parseError(const TQString &_s, const TQString &_e)
{
str = _s;
err = _e;
}
};
class parseWrongChannel : public parseSucc
{
public:
parseWrongChannel(const TQString &_s, const TQColor &_c = TQColor(), const TQString &_pm = TQString())
: parseSucc(_s, _c, _pm)
{
}
};
class parseJoinPart : public parseSucc
{
public:
parseJoinPart(const TQString &_s, const TQColor &_c = TQColor(), const TQString &_pm = TQString())
: parseSucc(_s, _c, _pm)
{
}
};
class infoFoundNick {
public:
char nick[101];
infoFoundNick(char *_n){
strncpy(nick, _n, 100);
nick[100]='\0';
}
};
class badModeChangeError // Mode change barfed up, exit out
{
public:
TQString str;
char *msg;
badModeChangeError(TQString _str, char *_msg)
{
str = _str;
msg = _msg;
}
};
class wrongChannelError // Message was not intended for us, display str and continue
{
public:
int display;
wrongChannelError(int _display)
{
display = _display;
}
};
class doneModes // Finished parsing modes from the extModes string
{
public:
doneModes(int /*i*/)
{
}
};
// End of exceptions
class parseFunc
{
public:
parseResult *(ChannelParser::*parser)(TQString);
parseFunc(parseResult *(ChannelParser::*_parser)(TQString)){
parser = _parser;
}
private:
parseFunc(); // Disable the default no argument constructor
};
class ChannelParser {
public:
/**
* ChannelParser takes a KSircTopLevel as it's first argument so
* we can refrence it latter.
*
* NOTE: the KSircTopLevel befriends the parser so we can have access to.
* NOTE2: don't abuse this you little wanker.
*/
ChannelParser(KSircTopLevel *_top);
/**
* parse() thanks the string to be parsed and parses it.
* It returns a class of type 'parseResult' or 0.
*/
parseResult *parse(TQString string);
private:
KSircTopLevel *top;
/**
* These are helper variables used internally in the parsing functions
*/
bool prompt_active;
int current_item;
int top_item;
/**
* The parser Table holds a list of functions with parse
* sepecific commands and arguments. The key for the dict is the
* first 3 characters of the "search key" for the string type.
*
* Even through the parserTable is static, the functions called manipulate
* this object.
*
* The functions do the following:
* - On succesfull compleion: generte a parseSucc exception
* - On failure generate: parseFailed, etc
*/
static TQDict<parseFunc> parserTable;
/*
* Note regarding ssfe control messages:
*
* They are converted from the form `#ssfe#<COMMAND> to `<COMMAND>`
* t/m is converted to t
*/
/**
* Start of the praser function definitions
*
* Each function returns void (since they never return it does matter)
* 1 argument, the string to parse
*
*/
/**
* SSFE clear 'l' function, clears main window
*/
parseResult * parseSSFEClear(TQString string);
/**
* SSFE Status is used to update caption, and op status
*
*/
parseResult * parseSSFEStatus(TQString string);
/**
* SSFE Init is called by ssfe when it's time to init and setup
*/
parseResult * parseSSFEInit(TQString string);
/**
* SSFE msg is called for each /msg sent to a diffrent user
*/
parseResult * parseSSFEMsg(TQString string);
/**
* SSFE Out, not used
*/
parseResult * parseSSFEOut(TQString string);
/**
* SSFE Prompt, same function used for p and P, gives a password prompt
*/
parseResult * parseSSFEPrompt(TQString string);
/**
* SSFE Reconnect called when (re)connected to a server
*/
parseResult * parseSSFEReconnect(TQString string);
/**
* That's all the SSFE control messages, the rest are info *\S* message
*/
/**
* *** is a generic infomation messge
*/
parseResult * parseINFOInfo(TQString string);
/**
* *E* is a error message
*/
parseResult * parseINFOError(TQString string);
/**
* *#* is a list of nicks, used to update the nick list if it's for
* the current channel.
*/
parseResult * parseINFONicks(TQString in_string);
/**
* *>* is a join message. If it's for the current channel
*/
parseResult * parseINFOJoin(TQString string);
/**
* *<* is a part message, if it's for the current channel remove it.
* There's multiple part types, so parsing it more complicated.
*/
parseResult * parseINFOPart(TQString string);
/**
* *N* Is a nick change, update the nick list if needed
* Nick changes go outto all windows, so the nick may not be on
* out current channel.
*/
parseResult * parseINFOChangeNick(TQString string);
/*
* *M* is a mode change. Parsing is mode changes is probably the most
* complicated of all the parsings
*/
parseResult * parseINFOMode(TQString string);
/*
* * is a ctcp actiion. Simply print a pretty * for the user
*/
parseResult * parseCTCPAction(TQString string);
/*
* *T* is a topic message, catch it and update the status is required
*/
parseResult * parseINFOTopic(TQString string);
private:
void highlightNick(TQString &string, TQString &nick);
};
#endif