C4MessageInput Class Reference

#include <C4MessageInput.h>

Public Member Functions
	C4MessageInput ()
	~C4MessageInput ()
void	Default ()
void	Clear ()
bool	Init ()
void	AddCommand (const char *strCommand, const char *strScript)
class C4MessageBoardCommand *	GetCommand (const char *strName)
bool	CloseTypeIn ()
bool	StartTypeIn (bool fObjInput=false, C4Object *pObj=nullptr, bool fUpperCase=false, bool fTeam=false, int32_t iPlr=-1, const StdStrBuf &rsInputQuery=StdStrBuf())
bool	KeyStartTypeIn (bool fTeam)
bool	ToggleTypeIn ()
bool	IsTypeIn ()
C4ChatInputDialog *	GetTypeIn ()
void	StoreBackBuffer (const char *szMessage)
const char *	GetBackBuffer (int32_t iIndex)
bool	ProcessInput (const char *szText)
bool	ProcessCommand (const char *szCommand)
void	ClearPointers (C4Object *pObj)
void	AbortMsgBoardQuery (C4Object *pObj, int32_t iPlr)

Friends
class	C4ChatInputDialog

Detailed Description

Definition at line 106 of file C4MessageInput.h.

Constructor & Destructor Documentation

C4MessageInput()

C4MessageInput::C4MessageInput ( )

inline

Definition at line 109 of file C4MessageInput.h.

{ Default(); }

References Default().

Here is the call graph for this function:

~C4MessageInput()

C4MessageInput::~C4MessageInput ( )

inline

Definition at line 110 of file C4MessageInput.h.

{ Clear(); }

References Clear().

Here is the call graph for this function:

Member Function Documentation

AbortMsgBoardQuery()

void C4MessageInput::AbortMsgBoardQuery	(	C4Object *	pObj,
		int32_t	iPlr
	)

Definition at line 859 of file C4MessageInput.cpp.

{
    // close typein if it is used for the given parameters
    C4ChatInputDialog *pDlg = GetTypeIn();
    if (pDlg && pDlg->IsScriptQueried() && pDlg->GetScriptTargetObject() == pObj && pDlg->GetScriptTargetPlayer() == iPlr) CloseTypeIn();
}

References CloseTypeIn(), C4ChatInputDialog::GetScriptTargetObject(), C4ChatInputDialog::GetScriptTargetPlayer(), GetTypeIn(), and C4ChatInputDialog::IsScriptQueried().

Here is the call graph for this function:

AddCommand()

void C4MessageInput::AddCommand	(	const char *	strCommand,
		const char *	strScript
	)

Definition at line 833 of file C4MessageInput.cpp.

{
    if (GetCommand(strCommand)) return;
    // create entry
    C4MessageBoardCommand *pCmd = new C4MessageBoardCommand();
    SCopy(strCommand, pCmd->Name, C4MaxName);
    SCopy(strScript, pCmd->Script, _MAX_FNAME+30);
    // add to list
    pCmd->Next = pCommands; pCommands = pCmd;
}

References _MAX_FNAME, C4MaxName, GetCommand(), C4MessageBoardCommand::Name, C4MessageBoardCommand::Next, SCopy(), and C4MessageBoardCommand::Script.

Referenced by Init().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4MessageInput::Clear

(

)

Definition at line 253 of file C4MessageInput.cpp.

{
    // close any dialog
    CloseTypeIn();
    // free messageboard-commands
    C4MessageBoardCommand *pCmd;
    while ((pCmd = pCommands))
    {
        pCommands = pCmd->Next;
        delete pCmd;
    }
}

References CloseTypeIn(), and C4MessageBoardCommand::Next.

Referenced by C4Game::Clear(), and ~C4MessageInput().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearPointers()

void C4MessageInput::ClearPointers

(

C4Object *

pObj

)

Definition at line 852 of file C4MessageInput.cpp.

{
    // target object loose? stop input
    C4ChatInputDialog *pDlg = GetTypeIn();
    if (pDlg && pDlg->GetScriptTargetObject() == pObj) CloseTypeIn();
}

References CloseTypeIn(), C4ChatInputDialog::GetScriptTargetObject(), and GetTypeIn().

Referenced by C4Game::ClearPointers().

Here is the call graph for this function:

Here is the caller graph for this function:

CloseTypeIn()

bool C4MessageInput::CloseTypeIn

(

)

Definition at line 266 of file C4MessageInput.cpp.

{
    // close dialog if present and valid
    C4ChatInputDialog *pDlg = GetTypeIn();
    if (!pDlg) return false;
    pDlg->Close(false);
    return true;
}

References C4GUI::Dialog::Close(), and GetTypeIn().

Referenced by AbortMsgBoardQuery(), Clear(), ClearPointers(), StartTypeIn(), and ToggleTypeIn().

Here is the call graph for this function:

Here is the caller graph for this function:

Default()

void C4MessageInput::Default

(

)

Definition at line 247 of file C4MessageInput.cpp.

{
    // clear backlog
    for (auto & cnt : BackBuffer) cnt[0]=0;
}

Referenced by C4MessageInput(), and C4Game::Default().

Here is the caller graph for this function:

GetBackBuffer()

const char * C4MessageInput::GetBackBuffer

(

int32_t

iIndex

)

Definition at line 880 of file C4MessageInput.cpp.

{
    if (!Inside<int32_t>(iIndex, 0, C4MSGB_BackBufferMax-1)) return nullptr;
    return BackBuffer[iIndex];
}

References C4MSGB_BackBufferMax.

Referenced by C4GameLobby::MainDlg::KeyHistoryUpDown().

Here is the caller graph for this function:

GetCommand()

C4MessageBoardCommand * C4MessageInput::GetCommand

(

const char *

strName

)

Definition at line 844 of file C4MessageInput.cpp.

{
    for (C4MessageBoardCommand *pCmd = pCommands; pCmd; pCmd = pCmd->Next)
        if (SEqual(pCmd->Name, strName))
            return pCmd;
    return nullptr;
}

References C4MessageBoardCommand::Next, and SEqual().

Referenced by AddCommand(), and ProcessCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTypeIn()

C4ChatInputDialog* C4MessageInput::GetTypeIn ( )

inline

Definition at line 133 of file C4MessageInput.h.

{ return C4ChatInputDialog::GetInstance(); }

References C4ChatInputDialog::GetInstance().

Referenced by AbortMsgBoardQuery(), ClearPointers(), CloseTypeIn(), and ToggleTypeIn().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4MessageInput::Init

(

)

Definition at line 237 of file C4MessageInput.cpp.

{
    // add default commands
    if (!pCommands)
    {
        AddCommand("speed", "SetGameSpeed(%d)");
    }
    return true;
}

References AddCommand().

Referenced by C4Game::PreInit().

Here is the call graph for this function:

Here is the caller graph for this function:

IsTypeIn()

bool C4MessageInput::IsTypeIn

(

)

Definition at line 305 of file C4MessageInput.cpp.

{
    // check GUI and dialog
    return C4ChatInputDialog::IsShown();
}

References C4ChatInputDialog::IsShown().

Referenced by C4MessageBoard::Execute(), StartTypeIn(), and ToggleTypeIn().

Here is the call graph for this function:

Here is the caller graph for this function:

KeyStartTypeIn()

bool C4MessageInput::KeyStartTypeIn

(

bool

fTeam

)

Definition at line 283 of file C4MessageInput.cpp.

{
    // fullscreen only
    if (Application.isEditor) return false;
    // OK, start typing
    return StartTypeIn(false, nullptr, false, fTeam);
}

References Application, C4Application::isEditor, and StartTypeIn().

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessCommand()

bool C4MessageInput::ProcessCommand

(

const char *

szCommand

)

Definition at line 426 of file C4MessageInput.cpp.

{
    C4GameLobby::MainDlg *pLobby = ::Network.GetLobby();
    // command
    // must be 1 char longer than the longest command only. If given commands are longer, they will be truncated, and such a command won't exist anyway
    const int32_t MaxCommandLen = 20;
    char szCmdName[MaxCommandLen + 1];
    SCopyUntil(szCommand + 1, szCmdName, ' ', MaxCommandLen);
    // parameter
    const char *pCmdPar = SSearch(szCommand, " ");
    if (!pCmdPar) pCmdPar = "";
 
    // CAUTION when implementing special commands (like /quit) here:
    // those must not be executed when text is pasted, because that could crash the GUI system
    // when there are additional lines to paste, but the edit field is destructed by the command
 
    // lobby-only commands
    if (!Game.IsRunning && SEqualNoCase(szCmdName, "joinplr"))
    {
        // compose path from given filename
        StdStrBuf plrPath;
        plrPath.Format("%s%s", Config.General.UserDataPath, pCmdPar);
        // player join - check filename
        if (!ItemExists(plrPath.getData()))
        {
            C4GameLobby::LobbyError(FormatString(LoadResStr("IDS_MSG_CMD_JOINPLR_NOFILE"), plrPath.getData()).getData());
        }
        else
			::Network.Players.JoinLocalPlayer(plrPath.getData());
        return true;
    }
    if (!Game.IsRunning && SEqualNoCase(szCmdName, "plrclr"))
    {
        // get player name from input text
        int iSepPos = SCharPos(' ', pCmdPar, 0);
        C4PlayerInfo *pNfo=nullptr;
        int32_t idLocalClient = -1;
        if (::Network.Clients.GetLocal()) idLocalClient = ::Network.Clients.GetLocal()->getID();
        if (iSepPos>0)
        {
            // a player name is given: Parse it
            StdStrBuf sPlrName;
            sPlrName.Copy(pCmdPar, iSepPos);
            pCmdPar += iSepPos+1; int32_t id=0;
            while ((pNfo = Game.PlayerInfos.GetNextPlayerInfoByID(id)))
            {
                id = pNfo->GetID();
                if (WildcardMatch(sPlrName.getData(), pNfo->GetName())) break;
            }
        }
        else
            // no player name: Set local player
            pNfo = Game.PlayerInfos.GetPrimaryInfoByClientID(idLocalClient);
        C4ClientPlayerInfos *pCltNfo=nullptr;
        if (pNfo) pCltNfo = Game.PlayerInfos.GetClientInfoByPlayerID(pNfo->GetID());
        if (!pCltNfo)
        {
            C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_PLRCLR_NOPLAYER"));
        }
        else
        {
            // may color of this client be set?
            if (pCltNfo->GetClientID() != idLocalClient && !::Network.isHost())
            {
                C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_PLRCLR_NOACCESS"));
            }
            else
            {
                // get color to set
                uint32_t dwNewClr;
                if (sscanf(pCmdPar, "%x", &dwNewClr) != 1)
                {
                    C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_PLRCLR_USAGE"));
                }
                else
                {
                    // color validation
                    dwNewClr |= 0xff000000;
                    if (!dwNewClr) ++dwNewClr;
                    // request a color change to this color
                    C4ClientPlayerInfos LocalInfoRequest = *pCltNfo;
                    C4PlayerInfo *pPlrInfo = LocalInfoRequest.GetPlayerInfoByID(pNfo->GetID());
                    assert(pPlrInfo);
                    if (pPlrInfo)
                    {
                        pPlrInfo->SetOriginalColor(dwNewClr); // set this as a new color wish
                        ::Network.Players.RequestPlayerInfoUpdate(LocalInfoRequest);
                    }
                }
            }
        }
        return true;
    }
    if (!Game.IsRunning && SEqualNoCase(szCmdName, "start"))
    {
        // timeout given?
        int32_t iTimeout = Config.Lobby.CountdownTime;
        if (!::Network.isHost())
            C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_HOSTONLY"));
        else if (pCmdPar && *pCmdPar && (!sscanf(pCmdPar, "%d", &iTimeout) || iTimeout<0))
            C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_START_USAGE"));
        else if (pLobby)
        {
            // abort previous countdown
            if (::Network.isLobbyCountDown()) ::Network.AbortLobbyCountdown();
            // start new countdown (aborts previous if necessary)
            pLobby->Start(iTimeout);
        }
        else
        {
            if (iTimeout)
                ::Network.StartLobbyCountdown(iTimeout);
            else
				::Network.Start();
        }
        return true;
    }
    if (!Game.IsRunning && SEqualNoCase(szCmdName, "abort"))
    {
        if (!::Network.isHost())
            C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_HOSTONLY"));
        else if (::Network.isLobbyCountDown())
            ::Network.AbortLobbyCountdown();
        else
            C4GameLobby::LobbyError(LoadResStr("IDS_MSG_CMD_ABORT_NOCOUNTDOWN"));
        return true;
    }
 
    if (SEqual(szCmdName, "help"))
    {
        Log(LoadResStr(pLobby ? "IDS_TEXT_COMMANDSAVAILABLEDURINGLO" : "IDS_TEXT_COMMANDSAVAILABLEDURINGGA"));
        if (!Game.IsRunning)
        {
            LogF("/start [time] - %s", LoadResStr("IDS_TEXT_STARTTHEROUNDWITHSPECIFIE"));
            LogF("/abort - %s", LoadResStr("IDS_TEXT_ABORTSTARTCOUNTDOWN"));
            LogF("/alert - %s", LoadResStr("IDS_TEXT_ALERTTHEHOSTIFTHEHOSTISAW"));
            LogF("/joinplr [filename] - %s", LoadResStr("IDS_TEXT_JOINALOCALPLAYERFROMTHESP"));
            LogF("/plrclr [player] [RGB] - %s", LoadResStr("IDS_TEXT_CHANGETHECOLOROFTHESPECIF"));
            LogF("/plrclr [RGB] - %s", LoadResStr("IDS_TEXT_CHANGEYOUROWNPLAYERCOLOR"));
        }
        else
        {
            LogF("/fast [x] - %s", LoadResStr("IDS_TEXT_SETTOFASTMODESKIPPINGXFRA"));
            LogF("/slow - %s", LoadResStr("IDS_TEXT_SETTONORMALSPEEDMODE"));
            LogF("/chart - %s", LoadResStr("IDS_TEXT_DISPLAYNETWORKSTATISTICS"));
            LogF("/nodebug - %s", LoadResStr("IDS_TEXT_PREVENTDEBUGMODEINTHISROU"));
            LogF("/script [script] - %s", LoadResStr("IDS_TEXT_EXECUTEASCRIPTCOMMAND"));
            LogF("/screenshot [zoom] - %s", LoadResStr("IDS_TEXT_SAFEZOOMEDFULLSCREENSHOT"));
        }
        LogF("/kick [client] - %s", LoadResStr("IDS_TEXT_KICKTHESPECIFIEDCLIENT"));
        LogF("/observer [client] - %s", LoadResStr("IDS_TEXT_SETTHESPECIFIEDCLIENTTOOB"));
        LogF("/me [action] - %s", LoadResStr("IDS_TEXT_PERFORMANACTIONINYOURNAME"));
        LogF("/sound [sound] - %s", LoadResStr("IDS_TEXT_PLAYASOUNDFROMTHEGLOBALSO"));
        if (Game.IsRunning) LogF("/private [player] [message] - %s", LoadResStr("IDS_MSG_SENDAPRIVATEMESSAGETOTHES"));
        LogF("/team [message] - %s", LoadResStr("IDS_MSG_SENDAPRIVATEMESSAGETOYOUR"));
        LogF("/set comment [comment] - %s", LoadResStr("IDS_TEXT_SETANEWNETWORKCOMMENT"));
        LogF("/set password [password] - %s", LoadResStr("IDS_TEXT_SETANEWNETWORKPASSWORD"));
        LogF("/set maxplayer [number] - %s", LoadResStr("IDS_TEXT_SETANEWMAXIMUMNUMBEROFPLA"));
        LogF("/todo [text] - %s", LoadResStr("IDS_TEXT_ADDTODO"));
        LogF("/clear - %s", LoadResStr("IDS_MSG_CLEARTHEMESSAGEBOARD"));
        return true;
    }
    // dev-scripts
    if (SEqual(szCmdName, "script"))
    {
        if (!Game.IsRunning) return false;
        if (!Game.DebugMode) return false;
 
        ::Control.DoInput(CID_Script, new C4ControlScript(pCmdPar, C4ControlScript::SCOPE_Console), CDT_Decide);
        return true;
    }
    // set runtime properties
    if (SEqual(szCmdName, "set"))
    {
        if (SEqual2(pCmdPar, "maxplayer "))
        {
            if (::Control.isCtrlHost())
            {
                if (atoi(pCmdPar+10) == 0 && !SEqual(pCmdPar+10, "0"))
                {
                    Log("Syntax: /set maxplayer count");
                    return false;
                }
                ::Control.DoInput(CID_Set,
                                  new C4ControlSet(C4CVT_MaxPlayer, atoi(pCmdPar+10)),
                                  CDT_Decide);
                return true;
            }
        }
        if (SEqual2(pCmdPar, "comment ") || SEqual(pCmdPar, "comment"))
        {
            if (!::Network.isEnabled() || !::Network.isHost()) return false;
            // Set in configuration, update reference
            Config.Network.Comment.CopyValidated(pCmdPar[7] ? (pCmdPar+8) : "");
            ::Network.InvalidateReference();
            Log(LoadResStr("IDS_NET_COMMENTCHANGED"));
            return true;
        }
        if (SEqual2(pCmdPar, "password ") || SEqual(pCmdPar, "password"))
        {
            if (!::Network.isEnabled() || !::Network.isHost()) return false;
            ::Network.SetPassword(pCmdPar[8] ? (pCmdPar+9) : nullptr);
            if (pLobby) pLobby->UpdatePassword();
            return true;
        }
        // unknown property
        return false;
    }
    // get szen from network folder - not in lobby; use res tab there
    if (SEqual(szCmdName, "netgetscen"))
    {
        if (::Network.isEnabled() && !::Network.isHost() && !pLobby)
        {
            const C4Network2ResCore *pResCoreScen = Game.Parameters.Scenario.getResCore();
            if (pResCoreScen)
            {
                C4Network2Res::Ref pScenario = ::Network.ResList.getRefRes(pResCoreScen->getID());
                if (pScenario)
                    if (C4Group_CopyItem(pScenario->getFile(), Config.AtUserDataPath(GetFilename(Game.ScenarioFilename))))
                    {
                        LogF(LoadResStr("IDS_MSG_CMD_NETGETSCEN_SAVED"), Config.AtUserDataPath(GetFilename(Game.ScenarioFilename)));
                        return true;
                    }
            }
        }
        return false;
    }
    // clear message board
    if (SEqual(szCmdName, "clear"))
    {
        // lobby
        if (pLobby)
        {
            pLobby->ClearLog();
        }
        // fullscreen
        else if (::GraphicsSystem.MessageBoard)
            ::GraphicsSystem.MessageBoard->ClearLog();
        else
        {
            // EM mode
            Console.ClearLog();
        }
        return true;
    }
    // kick client
    if (SEqual(szCmdName, "kick"))
    {
        if (::Network.isEnabled() && ::Network.isHost())
        {
            // find client
            C4Client *pClient = Game.Clients.getClientByName(pCmdPar);
            if (!pClient)
            {
                LogF(LoadResStr("IDS_MSG_CMD_NOCLIENT"), pCmdPar);
                return false;
            }
            // league: Kick needs voting
            if (Game.Parameters.isLeague() && ::Players.GetAtClient(pClient->getID()))
                ::Network.Vote(VT_Kick, true, pClient->getID());
            else
                // add control
                Game.Clients.CtrlRemove(pClient, LoadResStr("IDS_MSG_KICKFROMMSGBOARD"));
        }
        return true;
    }
    // set fast mode
    if (SEqual(szCmdName, "fast"))
    {
        if (!Game.IsRunning) return false;
        int32_t iFS;
        if ((iFS=atoi(pCmdPar)) == 0) return false;
        // set frameskip and fullspeed flag
        Game.FrameSkip=Clamp<int32_t>(iFS,1,500);
        Game.FullSpeed=true;
        // start calculation immediatly
        Application.NextTick();
        return true;
    }
    // reset fast mode
    if (SEqual(szCmdName, "slow"))
    {
        if (!Game.IsRunning) return false;
        Game.FullSpeed=false;
        Game.FrameSkip=1;
        return true;
    }
 
    if (SEqual(szCmdName, "nodebug"))
    {
        if (!Game.IsRunning) return false;
        ::Control.DoInput(CID_Set, new C4ControlSet(C4CVT_DisableDebug, 0), CDT_Decide);
        return true;
    }
 
    // kick/activate/deactivate/observer
    if (SEqual(szCmdName, "activate") || SEqual(szCmdName, "deactivate") || SEqual(szCmdName, "observer"))
    {
        if (!::Network.isEnabled() || !::Network.isHost())
            { Log(LoadResStr("IDS_MSG_CMD_HOSTONLY")); return false; }
        // search for client
        C4Client *pClient = Game.Clients.getClientByName(pCmdPar);
        if (!pClient)
        {
            LogF(LoadResStr("IDS_MSG_CMD_NOCLIENT"), pCmdPar);
            return false;
        }
        // what to do?
        C4ControlClientUpdate *pCtrl = nullptr;
        if (szCmdName[0] == 'a') // activate
            pCtrl = new C4ControlClientUpdate(pClient->getID(), CUT_Activate, true);
        else if (szCmdName[0] == 'd' && !Game.Parameters.isLeague()) // deactivate
            pCtrl = new C4ControlClientUpdate(pClient->getID(), CUT_Activate, false);
        else if (szCmdName[0] == 'o' && !Game.Parameters.isLeague()) // observer
            pCtrl = new C4ControlClientUpdate(pClient->getID(), CUT_SetObserver);
        // perform it
        if (pCtrl)
            ::Control.DoInput(CID_ClientUpdate, pCtrl, CDT_Sync);
        else
            Log(LoadResStr("IDS_LOG_COMMANDNOTALLOWEDINLEAGUE"));
        return true;
    }
 
    // control mode
    if (SEqual(szCmdName, "centralctrl") || SEqual(szCmdName, "decentralctrl")  || SEqual(szCmdName, "asyncctrl"))
    {
        if (!::Network.isEnabled() || !::Network.isHost())
            { Log(LoadResStr("IDS_MSG_CMD_HOSTONLY")); return false; }
        ::Network.SetCtrlMode(*szCmdName == 'c' ? CNM_Central : *szCmdName == 'd' ? CNM_Decentral : CNM_Async);
        return true;
    }
 
    // show chart
    if (Game.IsRunning)
        if (SEqual(szCmdName, "chart"))
            return Game.ToggleChart();
 
    // whole map screenshot
    if (SEqual(szCmdName, "screenshot"))
    {
        double zoom = atof(pCmdPar);
        if (zoom<=0) zoom = 2;
        ::GraphicsSystem.SaveScreenshot(true, zoom);
        return true;
    }
 
    // add to TODO list
    if (SEqual(szCmdName, "todo"))
    {
        // must add something
        if (!pCmdPar || !*pCmdPar) return false;
        // try writing main file (usually {SCENARIO}/TODO.txt); if access is not possible, e.g. because scenario is packed, write to alternate file
        const char *todo_filenames[] = { ::Config.Developer.TodoFilename, ::Config.Developer.AltTodoFilename };
        bool success = false;
        for (auto & i : todo_filenames)
        {
            StdCopyStrBuf todo_filename(i);
            todo_filename.Replace("{USERPATH}", Config.General.UserDataPath);
            int replacements = todo_filename.Replace("{SCENARIO}", Game.ScenarioFile.GetFullName().getData());
            // sanity checks for writing scenario TODO file
            if (replacements)
            {
                // entered in editor with no file open?
                if (!::Game.ScenarioFile.IsOpen()) continue;
                // not into packed
                if (::Game.ScenarioFile.IsPacked()) continue;
                // not into temp network file
                if (::Control.isNetwork() && !::Control.isCtrlHost()) continue;
            }
            // try to append. May fail e.g. on packed scenario file, name getting too long, etc. Then fallback to alternate location.
            CStdFile todo_file;
            if (!todo_file.Append(todo_filename.getData())) continue;
            if (!todo_file.WriteString(pCmdPar)) continue;
            // check on file close because CStdFile may do a delayed write
            if (!todo_file.Close()) continue;
            success = true;
            break;
        }
        // no message on success to avoid cluttering the chat during debug sessions
        if (!success) Log(LoadResStr("IDS_ERR_TODO"));
        return true;
    }
 
    // custom command
    C4MessageBoardCommand *pCmd;
    if (Game.IsRunning)
        if ((pCmd = GetCommand(szCmdName)))
        {
            // get player number of first local player; if multiple players
            // share one computer, we can't distinguish between them anyway
            int32_t player_num = NO_OWNER;
            C4Player *player = ::Players.GetLocalByIndex(0);
            if (player) player_num = player->Number;
 
            // send command to network
            ::Control.DoInput(CID_MsgBoardCmd, new C4ControlMsgBoardCmd(szCmdName, pCmdPar, player_num), CDT_Decide);
 
            // ok
            return true;
        }
 
    // unknown command
    StdStrBuf sErr; sErr.Format(LoadResStr("IDS_ERR_UNKNOWNCMD"), szCmdName);
    if (pLobby) pLobby->OnError(sErr.getData()); else Log(sErr.getData());
    return false;
}

References C4Network2::AbortLobbyCountdown(), C4ConfigDeveloper::AltTodoFilename, CStdFile::Append(), Application, C4Config::AtUserDataPath(), C4CVT_DisableDebug, C4CVT_MaxPlayer, C4Group_CopyItem(), CDT_Decide, CDT_Sync, CID_ClientUpdate, CID_MsgBoardCmd, CID_Script, CID_Set, C4ConsoleGUI::ClearLog(), C4GameLobby::MainDlg::ClearLog(), C4Game::Clients, C4Network2::Clients, CStdFile::Close(), CNM_Async, CNM_Central, CNM_Decentral, C4ConfigNetwork::Comment, Config, Console, Control, StdStrBuf::Copy(), ValidatedStdCopyStrBufBase::CopyValidated(), C4ConfigLobby::CountdownTime, C4ClientList::CtrlRemove(), CUT_Activate, CUT_SetObserver, C4Game::DebugMode, C4Config::Developer, C4GameControl::DoInput(), StdStrBuf::Format(), FormatString(), C4Game::FrameSkip, C4Game::FullSpeed, Game, C4Config::General, C4PlayerList::GetAtClient(), C4ClientList::getClientByName(), C4ClientPlayerInfos::GetClientID(), C4PlayerInfoList::GetClientInfoByPlayerID(), GetCommand(), StdStrBuf::getData(), C4Network2Res::getFile(), GetFilename(), C4Group::GetFullName(), C4PlayerInfo::GetID(), C4Client::getID(), C4Network2Client::getID(), C4Network2ResCore::getID(), C4Network2::GetLobby(), C4Network2ClientList::GetLocal(), C4PlayerList::GetLocalByIndex(), C4PlayerInfo::GetName(), C4PlayerInfoList::GetNextPlayerInfoByID(), C4ClientPlayerInfos::GetPlayerInfoByID(), C4PlayerInfoList::GetPrimaryInfoByClientID(), C4Network2ResList::getRefRes(), C4GameRes::getResCore(), GraphicsSystem, C4Network2::InvalidateReference(), C4GameControl::isCtrlHost(), C4Network2::isEnabled(), C4Network2::isHost(), C4GameParameters::isLeague(), C4Network2::isLobbyCountDown(), C4GameControl::isNetwork(), C4Group::IsOpen(), C4Group::IsPacked(), C4Game::IsRunning, ItemExists(), C4Network2Players::JoinLocalPlayer(), LoadResStr(), C4Config::Lobby, C4GameLobby::LobbyError(), Log(), LogF(), C4GraphicsSystem::MessageBoard, Network, C4Config::Network, C4Application::NextTick(), NO_OWNER, C4GameLobby::MainDlg::OnError(), C4Game::Parameters, C4ScriptGuiWindowPropertyName::player, C4Game::PlayerInfos, C4Network2::Players, Players, StdStrBuf::Replace(), C4Network2Players::RequestPlayerInfoUpdate(), C4Network2::ResList, C4GraphicsSystem::SaveScreenshot(), C4GameParameters::Scenario, C4Game::ScenarioFile, C4Game::ScenarioFilename, SCharPos(), C4ControlScript::SCOPE_Console, SCopyUntil(), SEqual(), SEqual2(), SEqualNoCase(), C4Network2::SetCtrlMode(), C4PlayerInfo::SetOriginalColor(), C4Network2::SetPassword(), SSearch(), C4Network2::Start(), C4GameLobby::MainDlg::Start(), C4Network2::StartLobbyCountdown(), C4ConfigDeveloper::TodoFilename, C4Game::ToggleChart(), C4GameLobby::MainDlg::UpdatePassword(), C4ConfigGeneral::UserDataPath, C4Network2::Vote(), VT_Kick, WildcardMatch(), and CStdFile::WriteString().

Referenced by C4Console::In(), and ProcessInput().

Here is the call graph for this function:

Here is the caller graph for this function:

ProcessInput()

bool C4MessageInput::ProcessInput

(

const char *

szText

)

Definition at line 311 of file C4MessageInput.cpp.

{
    // helper variables
    char OSTR[402]; // cba
    C4ControlMessageType eMsgType;
    const char *szMsg = nullptr;
    int32_t iToPlayer = -1;
 
    // Starts with '^', "team:" or "/team ": Team message
    if (szText[0] == '^' || SEqual2NoCase(szText, "team:") || SEqual2NoCase(szText, "/team "))
    {
        if (!Game.Teams.IsTeamVisible())
        {
            // team not known; can't send!
            Log(LoadResStr("IDS_MSG_CANTSENDTEAMMESSAGETEAMSN"));
            return false;
        }
        else
        {
            eMsgType = C4CMT_Team;
            szMsg = szText[0] == '^' ? szText+1 :
                    szText[0] == '/' ? szText+6 : szText+5;
        }
    }
    // Starts with "/private ": Private message (running game only)
    else if (Game.IsRunning && SEqual2NoCase(szText, "/private "))
    {
        // get target name
        char szTargetPlr[C4MaxName + 1];
        SCopyUntil(szText + 9, szTargetPlr, ' ', C4MaxName);
        // search player
        C4Player *pToPlr = ::Players.GetByName(szTargetPlr);
        if (!pToPlr) return false;
        // set
        eMsgType = C4CMT_Private;
        iToPlayer = pToPlr->Number;
        szMsg = szText + 10 + SLen(szText);
        if (szMsg > szText + SLen(szText)) return false;
    }
    // Starts with "/me ": Me-Message
    else if (SEqual2NoCase(szText, "/me "))
    {
        eMsgType = C4CMT_Me;
        szMsg = szText+4;
    }
    // Starts with "/sound ": Sound-Message
    else if (SEqual2NoCase(szText, "/sound "))
    {
        eMsgType = C4CMT_Sound;
        szMsg = szText+7;
    }
    // Disabled due to spamming
    // Starts with "/alert": Taskbar flash (message optional)
    else if (SEqual2NoCase(szText, "/alert ") || SEqualNoCase(szText, "/alert"))
    {
        eMsgType = C4CMT_Alert;
        szMsg = szText+6;
        if (*szMsg) ++szMsg;
    }
    // Starts with '"': Let the clonk say it
    else if (Game.IsRunning && szText[0] == '"')
    {
        eMsgType = C4CMT_Say;
        // Append '"', if neccessary
        StdStrBuf text(szText);
        SCopy(szText, OSTR, 400);
        char *pEnd = OSTR + SLen(OSTR) - 1;
        if (*pEnd != '"') { *++pEnd = '"'; *++pEnd = 0; }
        szMsg = OSTR;
    }
    // Starts with '/': Command
    else if (szText[0] == '/')
        return ProcessCommand(szText);
    // Regular message
    else
    {
        eMsgType = C4CMT_Normal;
        szMsg = szText;
    }
 
    // message?
    if (szMsg)
    {
        char szMessage[C4MaxMessage + 1];
        // go over whitespaces, check empty message
        while (IsWhiteSpace(*szMsg)) szMsg++;
        if (!*szMsg)
        {
            if (eMsgType != C4CMT_Alert) return true;
            *szMessage = '\0';
        }
        else
        {
            // trim right
            const char *szEnd = szMsg + SLen(szMsg) - 1;
            while (IsWhiteSpace(*szEnd) && szEnd >= szMsg) szEnd--;
            // Say: Strip quotation marks in cinematic film mode
            if (Game.C4S.Head.Film == C4SFilm_Cinematic)
            {
                if (eMsgType == C4CMT_Say) { ++szMsg; szEnd--; }
            }
            // get message
            SCopy(szMsg, szMessage, std::min<ptrdiff_t>(C4MaxMessage, szEnd - szMsg + 1));
        }
        // get sending player (if any)
        C4Player *pPlr = Game.IsRunning ? ::Players.GetLocalByIndex(0) : nullptr;
        // send
        ::Control.DoInput(CID_Message,
                          new C4ControlMessage(eMsgType, szMessage, pPlr ? pPlr->Number : -1, iToPlayer),
                          CDT_Private);
    }
 
    return true;
}

References C4CMT_Alert, C4CMT_Me, C4CMT_Normal, C4CMT_Private, C4CMT_Say, C4CMT_Sound, C4CMT_Team, C4MaxMessage, C4MaxName, C4Game::C4S, C4SFilm_Cinematic, CDT_Private, CID_Message, Control, C4GameControl::DoInput(), C4SHead::Film, Game, C4PlayerList::GetByName(), C4PlayerList::GetLocalByIndex(), C4Scenario::Head, C4Game::IsRunning, C4TeamList::IsTeamVisible(), IsWhiteSpace(), LoadResStr(), Log(), C4Player::Number, Players, ProcessCommand(), SCopy(), SCopyUntil(), SEqual2NoCase(), SEqualNoCase(), SLen(), C4Game::Teams, and C4ScriptGuiWindowPropertyName::text.

Referenced by C4Console::In(), C4GameLobby::MainDlg::OnChatInput(), C4ChatInputDialog::OnChatInput(), and C4Application::OnCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

StartTypeIn()

bool C4MessageInput::StartTypeIn	(	bool	fObjInput = false,
		C4Object *	pObj = nullptr,
		bool	fUpperCase = false,
		bool	fTeam = false,
		int32_t	iPlr = -1,
		const StdStrBuf &	rsInputQuery = StdStrBuf()
	)

Definition at line 275 of file C4MessageInput.cpp.

{
    // close any previous
    if (IsTypeIn()) CloseTypeIn();
    // start new
    return ::pGUI->ShowRemoveDlg(new C4ChatInputDialog(fObjInput, pObj, fUpperCase, fTeam, iPlr, rsInputQuery));
}

References C4ChatInputDialog, CloseTypeIn(), IsTypeIn(), pGUI, and C4GUI::Screen::ShowRemoveDlg().

Referenced by KeyStartTypeIn(), and ToggleTypeIn().

Here is the call graph for this function:

Here is the caller graph for this function:

StoreBackBuffer()

void C4MessageInput::StoreBackBuffer

(

const char *

szMessage

)

Definition at line 866 of file C4MessageInput.cpp.

{
    if (!szMessage || !szMessage[0]) return;
    int32_t i,cnt;
    // Check: Remove doubled buffer
    for (i=0; i<C4MSGB_BackBufferMax-1; ++i)
        if (SEqual(BackBuffer[i], szMessage))
            break;
    // Move up buffers
    for (cnt=i; cnt>0; cnt--) SCopy(BackBuffer[cnt-1],BackBuffer[cnt]);
    // Add message
    SCopy(szMessage,BackBuffer[0], C4MaxMessage);
}

References C4MaxMessage, C4MSGB_BackBufferMax, SCopy(), and SEqual().

Referenced by C4GameLobby::MainDlg::OnChatInput(), and C4ChatInputDialog::OnChatInput().

Here is the call graph for this function:

Here is the caller graph for this function:

ToggleTypeIn()

bool C4MessageInput::ToggleTypeIn

(

)

Definition at line 291 of file C4MessageInput.cpp.

{
    // toggle off?
    if (IsTypeIn())
    {
        // no accidental close of script queried dlgs by chat request
        if (GetTypeIn()->IsScriptQueried()) return false;
        return CloseTypeIn();
    }
    else
        // toggle on!
        return StartTypeIn();
}

References CloseTypeIn(), GetTypeIn(), IsTypeIn(), and StartTypeIn().

Here is the call graph for this function:

Friends And Related Function Documentation

C4ChatInputDialog

friend class C4ChatInputDialog

friend

Definition at line 143 of file C4MessageInput.h.

Referenced by StartTypeIn().

---

The documentation for this class was generated from the following files:

• C4MessageInput.h
• C4MessageInput.cpp