/*
* The Mana World
* Copyright (C) 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* This program 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 2 of the License, or
* any later version.
*
* This program 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef CHAT_H
#define CHAT_H
#include <list>
#include <string>
#include <map>
#include <guichan/actionlistener.hpp>
#include <guichan/keylistener.hpp>
#include "window.h"
class BrowserBox;
class Channel;
class Recorder;
class ScrollArea;
class TabbedArea;
class ItemLinkHandler;
#ifdef EATHENA_SUPPORT
class Network;
class Party;
#endif
enum
{
BY_GM,
#ifdef EATHENA_SUPPORT
BY_PARTY,
#endif
BY_PLAYER,
BY_OTHER,
BY_SERVER,
BY_CHANNEL,
ACT_WHISPER, // getting whispered at
ACT_IS, // equivalent to "/me" on IRC
BY_LOGGER
};
/**
* gets in between usernick and message text depending on
* message type
*/
#define CAT_NORMAL ": "
#define CAT_IS ""
#define CAT_WHISPER " whispers: "
#define DEFAULT_CHAT_WINDOW_SCROLL 7 // 1 means `1/8th of the window size'.
/**
* The chat window.
*
* \ingroup Interface
*/
class ChatWindow : public Window,
public gcn::ActionListener,
public gcn::KeyListener
{
public:
/**
* Constructor.
*/
#ifdef TMWSERV_SUPPORT
ChatWindow();
#else
ChatWindow(Network *network);
#endif
/**
* Destructor: used to write back values to the config file
*/
~ChatWindow();
/**
* Called when the widget changes size. Used for adapting the size of
* the tabbed area.
*/
void widgetResized(const gcn::Event &event);
void logic();
/**
* Adds a line of text to our message list. Parameters:
*
* @param line Text message.
* @param own Type of message (usually the owner-type).
* @param channelName which channel to send the message to.
* @param ignoreRecord should this not be recorded?
*/
void chatLog(std::string line,
int own = BY_SERVER,
std::string channelName = "",
bool ignoreRecord = false);
/**
* Gets the focused tab's name
*/
const std::string& getFocused() const;
/**
* Clear the tab with the given name
*/
void clearTab(const std::string &tab);
/**
* Performs action.
*/
void action(const gcn::ActionEvent &event);
/**
* Request focus for typing chat message.
*/
void requestChatFocus();
/**
* Checks whether ChatWindow is Focused or not.
*/
bool isInputFocused();
/** Called to remove the channel from the channel manager */
void removeChannel(short channelId);
void removeChannel(const std::string &channelName);
void removeChannel(Channel *channel);
/** Called to create a new channel tab */
void createNewChannelTab(const std::string &channelName);
/** Called to output text to a specific channel */
void sendToChannel(short channel,
const std::string &user,
const std::string &msg);
#ifdef TMWSERV_SUPPORT
/**
* Determines whether the message is a command or message, then
* sends the given message to the game server to be said, or to the
* command handler
*
* @param msg The message text which is to be sent.
*
*/
void chatSend(std::string &msg);
#else
/**
* Determines whether to send a command or an ordinary message, then
* contructs packets & sends them.
*
* @param nick The character's name to display in front.
* @param msg The message text which is to be send.
*
* NOTE:
* The nickname is required by the server, if not specified
* the message may not be sent unless a command was intended
* which requires another packet to be constructed! you can
* achieve this by putting a slash ("/") infront of the
* message followed by the command name and the message.
* of course all slash-commands need implemented handler-
* routines. ;-)
* remember, a line starting with "@" is not a command that needs
* to be parsed rather is sent using the normal chat-packet.
*
* EXAMPLE:
* // for an global announcement /- command
* chatlog.chat_send("", "/announce Hello to all logged in users!");
* // for simple message by a user /- message
* chatlog.chat_send("Zaeiru", "Hello to all users on the screen!");
*/
void chatSend(const std::string &nick, std::string msg);
#endif
/** Called when key is pressed */
void keyPressed(gcn::KeyEvent &event);
/** Called to set current text */
void setInputText(std::string input_str);
/** Called to add item to chat */
void addItemText(const std::string &item);
/** Override to reset mTmpVisible */
void setVisible(bool visible);
/** Check if tab with that name already exists */
bool tabExists(const std::string &tabName);
/**
* Scrolls the chat window
*
* @param amount direction and amount to scroll. Negative numbers scroll
* up, positive numbers scroll down. The absolute amount indicates the
* amount of 1/8ths of chat window real estate that should be scrolled.
*/
void scroll(int amount);
#ifdef EATHENA_SUPPORT
/**
* party implements the partying chat commands
*
* @param command is the party command to perform
* @param msg is the remainder of the message
*/
void party(const std::string &command, const std::string &msg);
#endif
/**
* help implements the /help command
*
* @param msg1 is the command that the player needs help on
* @param msg2 is the sub-command relating to the command
*/
void help(const std::string &msg1, const std::string &msg2);
private:
#ifdef EATHENA_SUPPORT
Network *mNetwork;
#endif
bool mTmpVisible;
int mItems;
int mItemsKeep;
void whisper(const std::string &nick, std::string msg);
/** One item in the chat log */
struct CHATLOG
{
std::string nick;
std::string text;
int own;
};
/**
* A structure combining a BrowserBox with its ScrollArea.
*/
struct ChatArea
{
ChatArea(BrowserBox *b, ScrollArea *s):
browser(b), scroll(s)
{}
BrowserBox *browser;
ScrollArea *scroll;
};
/** Used for showing item popup on clicking links **/
ItemLinkHandler *mItemLinkHandler;
/** Tabbed area for holding each channel. */
TabbedArea *mChatTabs;
/** Input box for typing chat messages. */
gcn::TextField *mChatInput;
typedef std::map<const std::string, ChatArea> ChannelMap;
/** Map each tab to its browser and scroll area. */
ChannelMap mChannels;
typedef std::list<std::string> History;
typedef History::iterator HistoryIterator;
History mHistory; /**< Command history. */
HistoryIterator mCurHist; /**< History iterator. */
Recorder *mRecorder; /**< Recording class */
bool mReturnToggles; /**< Marks whether <Return> toggles the chat log
or not */
#ifdef EATHENA_SUPPORT
char mPartyPrefix; /**< Messages beginning with the prefix are sent to
the party */
Party *mParty;
#endif
};
extern ChatWindow *chatWindow;
#endif
