chatwindow.h

Go to the documentation of this file.

/*
 * chatwindow.h - Author: Andrew Craig
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * 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 (version 2 of the License)
 * 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.
 *
 */

// chatwindow.h: interface for the pawsChatWindow class.
//

#ifndef PAWS_CHAT_WINDOW
#define PAWS_CHAT_WINDOW

// CS INCLUDES
#include <csutil/array.h>
#include <csutil/redblacktree.h>
#include <csutil/hashr.h>

#include "net/cmdbase.h"
#include "util/stringarray.h"

// Hunspell includes
#ifdef HUNSPELL
#include <hunspell.hxx>
#endif

// PAWS INCLUDES
#include "paws/pawswidget.h"
#include "paws/pawsmenu.h"
#include "gui/pawsignore.h"
#include "gui/pawscontrolwindow.h"

#define CONFIG_CHAT_FILE_NAME       "/planeshift/userdata/options/chat.xml"
#define CONFIG_CHAT_FILE_NAME_DEF   "/planeshift/data/options/chat_def.xml"

enum CHAT_COMBAT_FILTERS {
    COMBAT_SUCCEEDED = 1,
    COMBAT_BLOCKED   = 2,
    COMBAT_DODGED    = 4,
    COMBAT_MISSED    = 8,
    COMBAT_FAILED    = 16,
    COMBAT_STANCE    = 32,
    COMBAT_TOTAL_AMOUNT = 6
};

class pawsMessageTextBox;
//class pawsEditTextBox;
class pawsChatHistory;
class pawsTabWindow;
//struct iSoundManager;

struct ChatSettings
{
    int playerColor;
    int chatColor;
    int systemColor;
    int adminColor;
    int npcColor;
    int tellColor;
    int guildColor;
    int allianceColor;
    int shoutColor;
    int channelColor;
    int gmColor;
    int yourColor;
    int groupColor;
    int auctionColor;
    int helpColor;
    bool joindefaultchannel;
    bool defaultlastchat;
    bool looseFocusOnSend;
    bool mouseFocus;
    bool dirtyLogChannelFile[CHAT_END]; 
    csString logChannelFile[CHAT_END];  
    csString channelBracket[CHAT_END];  
    bool enabledLogging[CHAT_END]; 
    bool enableBadWordsFilterIncoming;
    bool enableBadWordsFilterOutgoing;
    bool echoScreenInSystem;
    bool mainBrackets; 
    bool yourColorMix; 
    csArray<csString> badWords;
    csArray<csString> goodWords;
    csArray<csString> completionItems; 
    csHash<csString, csString> bindings;
    csArray<csString> subNames;
    int selectTabStyle;
    int vicinityFilters; 
    int meFilters; 
    unsigned int tabSetting; 
    
    void SetLogChannelFile(unsigned int type, csString newName)
    {
        if(type < CHAT_END && newName != logChannelFile[type])
        {
            dirtyLogChannelFile[type] = true;
            logChannelFile[type] = newName;
        }
    }
};


//--------------------------------------------------------------------------


class pawsChatWindow  : public pawsControlledWindow, public psCmdBase
{
public:
    pawsChatWindow();
    virtual ~pawsChatWindow();

    void HandleMessage( MsgEntry* message );

    const char* HandleCommand( const char* cmd );

    bool OnMenuAction(pawsWidget * widget, const pawsMenuAction & action);
    bool PostSetup();

    bool OnChildMouseEnter(pawsWidget* widget);
    bool OnChildMouseExit(pawsWidget* widget);

    bool OnMouseDown( int button, int modifiers, int x , int y );

    bool OnKeyDown( utf32_char keyCode, utf32_char key, int modifiers );

    bool OnDoubleClick(int button, int modifiers, int x , int y) { return OnMouseDown(button, modifiers, x, y); }

    bool InputActive();

    virtual bool OnButtonPressed( int button, int keyModifier, pawsWidget* widget );
    void SwitchChannel(const csString &name, pawsWidget* widget = NULL);

    void PerformAction( const char* action );

    void Clear(int mode = -2); // -2 means "/clear all"

       void SelectChatTab(int tab);


    void AutoReply(void);

    void SetAway(const char* text);

    virtual void OnLostFocus();
    virtual void Show();

    csString GetBracket(int type); 

    void ChatOutput(const char* data, int colour = -1, int type = CHAT_SYSTEM, bool flashEnabled = true, bool hasCharName = false, int hotkeyChannel = 0);

    void AddAutoCompleteName(const char *name);
    void RemoveAutoCompleteName(const char *name);

    ChatSettings& GetSettings() {return settings;}

    void SaveChatSettings();
    void LoadChatSettings();

    void RefreshCommandList();

    pawsIgnoreWindow*  GetIgnoredList() { return IgnoredList; }

    void BadWordsFilter(csString& s);

    int mixColours(int colour1, int colour2);

    bool LeaveChannel(int hotkeyChannel);

    void JoinChannel(csString name);
    
    /* returns the input text box widget
     */
    pawsEditTextBox* getInputTextBox() {return inputText;};
    
    void writeChatHistory();

    void ReloadChatWindow();

    char const * GetFontName()
    {
        return fontName.GetData();
    }

    bool LoadSetting();

   void  SetChatWindowFont(const char *FontName, int FontSize);


protected:

    void HandleSystemMessage( MsgEntry* message );

    void FormatMessage(csString &sText, csString &sPerson, csString prependingText, csString &buff, bool &hasCharName);

    void SendChatLine(csString& inputText);

    void SubscribeCommands();

    void TabCompleteCommand(const char *cmd);
    void TabCompleteName(const char *cmd);

    void DetermineChatTabAndSelect(int chattype);        


    pawsIgnoreWindow*  IgnoredList;
    csString           replyList[4];
    int replyCount;

    csString awayText;

    csArray<csString> autoCompleteNames;
    csArray<csArray<csString> *> autoCompleteLists;

    csRedBlackTree<psString> commandList;
    csArray<csString> systemTriggers;
    csArray<csString> chatTriggers;

    pawsEditTextBox* inputText;

    pawsTabWindow* tabs;

    bool havePlayerName;

    csString noCasePlayerName;
    csString noCasePlayerForename;

    pawsChatHistory* chatHistory;

    csString currLine;

    ChatSettings settings;

    csRef<iFile> logFile[CHAT_END];
    csHash<csRef<iFile>, uint> openLogFiles;

    bool isInChannel;

    void LogMessage(const char* message, int type = CHAT_SAY);

    void CreateSettingNode(iDocumentNode* mNode,int color,const char* name);

    void ReplayMessages(unsigned int reqLines);

    csHashReversible<uint32_t, csString> channelIDs;
    csArray<uint16_t> channels;        
};

//--------------------------------------------------------------------------

CREATE_PAWS_FACTORY( pawsChatWindow );


//--------------------------------------------------------------------------
class pawsChatHistory
{
public:
    pawsChatHistory();
    ~pawsChatHistory();

    void Insert(const char *str);

    csString* GetCommand(int n);

    csString* GetNext();

    csString* GetPrev();

    void SetGetLoc(unsigned int pos) { getLoc = pos; }
    unsigned int curLoc() { return getLoc; };

private:
    unsigned int getLoc;

    csPDelArray<csString> buffer;
};

#endif