ddnet/src/game/client/components/binds.cpp

/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
/* If you are missing that file, acquire a complete release at teeworlds.com.                */
#include <engine/config.h>
#include <engine/shared/config.h>
#include "binds.h"

bool CBinds::CBindsSpecial::OnInput(IInput::CEvent Event)
{
	// don't handle invalid events and keys that arn't set to anything
	if(((Event.m_Key >= KEY_F1 && Event.m_Key <= KEY_F12) || (Event.m_Key >= KEY_F13 && Event.m_Key <= KEY_F24)) && m_pBinds->m_apKeyBindings[Event.m_Key])
	{
		int Stroke = 0;
		if(Event.m_Flags&IInput::FLAG_PRESS)
			Stroke = 1;

		m_pBinds->GetConsole()->ExecuteLineStroked(Stroke, m_pBinds->m_apKeyBindings[Event.m_Key]);
		return true;
	}

	return false;
}

CBinds::CBinds()
{
	mem_zero(m_apKeyBindings, sizeof(m_apKeyBindings));
	m_SpecialBinds.m_pBinds = this;
}

CBinds::~CBinds()
{
	for(int i = 0; i < KEY_LAST; i++)
		if(m_apKeyBindings[i])
			mem_free(m_apKeyBindings[i]);
}

void CBinds::Bind(int KeyID, const char *pStr)
{
	if(KeyID < 0 || KeyID >= KEY_LAST)
		return;

	if(m_apKeyBindings[KeyID])
	{
		mem_free(m_apKeyBindings[KeyID]);
		m_apKeyBindings[KeyID] = 0;
	}

	char aBuf[256];
	if(!pStr[0])
	{
		str_format(aBuf, sizeof(aBuf), "unbound %s (%d)", Input()->KeyName(KeyID), KeyID);
	}
	else
	{
		int size = str_length(pStr) + 1;
		m_apKeyBindings[KeyID] = (char *)mem_alloc(size, 1);
		if(!m_apKeyBindings[KeyID])
		{
			str_format(aBuf, sizeof(aBuf), "couldn't bind %s (%d) (bind might be too long)", Input()->KeyName(KeyID), KeyID);
		}
		else
		{
			str_copy(m_apKeyBindings[KeyID], pStr, size);
			str_format(aBuf, sizeof(aBuf), "bound %s (%d) = %s", Input()->KeyName(KeyID), KeyID, m_apKeyBindings[KeyID]);
		}
	}
	Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "binds", aBuf);
}

bool CBinds::OnInput(IInput::CEvent e)
{
	// don't handle invalid events and keys that arn't set to anything
	if(e.m_Key <= 0 || e.m_Key >= KEY_LAST || !m_apKeyBindings[e.m_Key])
		return false;

	if(e.m_Flags&IInput::FLAG_PRESS)
		Console()->ExecuteLineStroked(1, m_apKeyBindings[e.m_Key]);
	if(e.m_Flags&IInput::FLAG_RELEASE)
		Console()->ExecuteLineStroked(0, m_apKeyBindings[e.m_Key]);
	return true;
}

void CBinds::UnbindAll()
{
	for(int i = 0; i < KEY_LAST; i++)
	{
		if(m_apKeyBindings)
			mem_free(m_apKeyBindings[i]);
		m_apKeyBindings[i] = 0;
	}
}

const char *CBinds::Get(int KeyID)
{
	if(KeyID > 0 && KeyID < KEY_LAST && m_apKeyBindings[KeyID])
		return m_apKeyBindings[KeyID];
	return "";
}

const char *CBinds::GetKey(const char *pBindStr)
{
	for(int KeyId = 0; KeyId < KEY_LAST; KeyId++)
	{
		const char *pBind = Get(KeyId);
		if(!pBind[0])
			continue;

		if(str_comp(pBind, pBindStr) == 0)
			return Input()->KeyName(KeyId);
	}

	return "";
}

void CBinds::SetDefaults()
{
	// set default key bindings
	UnbindAll();
	Bind(KEY_F1, "toggle_local_console");
	Bind(KEY_F2, "toggle_remote_console");
	Bind(KEY_TAB, "+scoreboard");
	Bind(KEY_BACKQUOTE, "+statboard");
	Bind(KEY_F10, "screenshot");

	Bind('a', "+left");
	Bind('d', "+right");

	Bind(KEY_SPACE, "+jump");
	Bind(KEY_MOUSE_1, "+fire");
	Bind(KEY_MOUSE_2, "+hook");
	Bind(KEY_LSHIFT, "+emote");
#if defined(__ANDROID__)
	Bind(KEY_RCTRL, "+fire");
	Bind(KEY_RETURN, "+hook");
	Bind(KEY_RIGHT, "+right");
	Bind(KEY_LEFT, "+left");
	Bind(KEY_UP, "+jump");
	Bind(KEY_DOWN, "+hook");
	Bind(KEY_PAGEUP, "+prevweapon");
	Bind(KEY_PAGEDOWN, "+nextweapon");
	Bind(KEY_F5, "spectate_previous");
	Bind(KEY_F6, "spectate_next");
#else
	Bind(KEY_RETURN, "+show_chat; chat all");
	Bind(KEY_RIGHT, "spectate_next");
	Bind(KEY_LEFT, "spectate_previous");
	Bind(KEY_RSHIFT, "+spectate");
#endif


	Bind('1', "+weapon1");
	Bind('2', "+weapon2");
	Bind('3', "+weapon3");
	Bind('4', "+weapon4");
	Bind('5', "+weapon5");

	Bind(KEY_MOUSE_WHEEL_UP, "+prevweapon");
	Bind(KEY_MOUSE_WHEEL_DOWN, "+nextweapon");

	Bind('t', "+show_chat; chat all");
	Bind('y', "+show_chat; chat team");
	Bind('z', "+show_chat; chat team"); // For German keyboards
	Bind('u', "+show_chat");
	Bind('i', "+show_chat; chat all /c ");

	Bind(KEY_F3, "vote yes");
	Bind(KEY_F4, "vote no");

	Bind('k', "kill");
	Bind('q', "say /pause");
	Bind('p', "say /pause");

	// DDRace

	if(g_Config.m_ClDDRaceBinds)
		SetDDRaceBinds(false);
}

void CBinds::OnConsoleInit()
{
	// bindings
	IConfig *pConfig = Kernel()->RequestInterface<IConfig>();
	if(pConfig)
		pConfig->RegisterCallback(ConfigSaveCallback, this);

	Console()->Register("bind", "s[key] r[command]", CFGFLAG_CLIENT, ConBind, this, "Bind key to execute the command");
	Console()->Register("dump_binds", "?s[key]", CFGFLAG_CLIENT, ConDumpBinds, this, "Print command executed by this keybindind or all binds");
	Console()->Register("unbind", "s[key]", CFGFLAG_CLIENT, ConUnbind, this, "Unbind key");
	Console()->Register("unbindall", "", CFGFLAG_CLIENT, ConUnbindAll, this, "Unbind all keys");

	// default bindings
	SetDefaults();
}

void CBinds::ConBind(IConsole::IResult *pResult, void *pUserData)
{
	CBinds *pBinds = (CBinds *)pUserData;
	const char *pKeyName = pResult->GetString(0);
	int id = pBinds->GetKeyID(pKeyName);

	if(!id)
	{
		char aBuf[256];
		str_format(aBuf, sizeof(aBuf), "key %s not found", pKeyName);
		pBinds->Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "binds", aBuf);
		return;
	}

	pBinds->Bind(id, pResult->GetString(1));
}

void CBinds::ConDumpBinds(IConsole::IResult *pResult, void *pUserData)
{
	CBinds *pBinds = (CBinds *)pUserData;
	if(pResult->NumArguments() == 1)
	{
		char aBuf[256];
		const char *pKeyName = pResult->GetString(0);

		int id = pBinds->GetKeyID(pKeyName);
		if (!id)
		{
			str_format(aBuf, sizeof(aBuf), "key '%s' not found", pKeyName);
			pBinds->Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "binds", aBuf);
		}
		else
		{
			if (!pBinds->m_apKeyBindings[id])
				str_format(aBuf, sizeof(aBuf), "%s (%d) is not bound", pKeyName, id);
			else
				str_format(aBuf, sizeof(aBuf), "%s (%d) = %s", pKeyName, id, pBinds->m_apKeyBindings[id]);

			pBinds->Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "binds", aBuf);
		}
	}
	else if(pResult->NumArguments() == 0)
	{
		char aBuf[1024];
		for(int i = 0; i < KEY_LAST; i++)
		{
			if(!pBinds->m_apKeyBindings[i])
				continue;
			str_format(aBuf, sizeof(aBuf), "%s (%d) = %s", pBinds->Input()->KeyName(i), i, pBinds->m_apKeyBindings[i]);
			pBinds->Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "binds", aBuf);
		}
	}
}

void CBinds::ConUnbind(IConsole::IResult *pResult, void *pUserData)
{
	CBinds *pBinds = (CBinds *)pUserData;
	const char *pKeyName = pResult->GetString(0);
	int id = pBinds->GetKeyID(pKeyName);

	if(!id)
	{
		char aBuf[256];
		str_format(aBuf, sizeof(aBuf), "key %s not found", pKeyName);
		pBinds->Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "binds", aBuf);
		return;
	}

	pBinds->Bind(id, "");
}

void CBinds::ConUnbindAll(IConsole::IResult *pResult, void *pUserData)
{
	CBinds *pBinds = (CBinds *)pUserData;
	pBinds->UnbindAll();
}

int CBinds::GetKeyID(const char *pKeyName)
{
	// check for numeric
	if(pKeyName[0] == '&')
	{
		int i = str_toint(pKeyName+1);
		if(i > 0 && i < KEY_LAST)
			return i; // numeric
	}

	// search for key
	for(int i = 0; i < KEY_LAST; i++)
	{
		if(str_comp(pKeyName, Input()->KeyName(i)) == 0)
			return i;
	}

	return 0;
}

void CBinds::ConfigSaveCallback(IConfig *pConfig, void *pUserData)
{
	CBinds *pSelf = (CBinds *)pUserData;

	char aBuffer[256];
	char *pEnd = aBuffer+sizeof(aBuffer)-8;
	pConfig->WriteLine("unbindall");
	for(int i = 0; i < KEY_LAST; i++)
	{
		if(!pSelf->m_apKeyBindings[i])
			continue;
		str_format(aBuffer, sizeof(aBuffer), "bind %s ", pSelf->Input()->KeyName(i));

		// process the string. we need to escape some characters
		const char *pSrc = pSelf->m_apKeyBindings[i];
		char *pDst = aBuffer + str_length(aBuffer);
		*pDst++ = '"';
		while(*pSrc && pDst < pEnd)
		{
			if(*pSrc == '"' || *pSrc == '\\') // escape \ and "
				*pDst++ = '\\';
			*pDst++ = *pSrc++;
		}
		*pDst++ = '"';
		*pDst++ = 0;

		pConfig->WriteLine(aBuffer);
	}
}

// DDRace

void CBinds::SetDDRaceBinds(bool FreeOnly)
{
	if(!FreeOnly)
	{
		Bind(KEY_KP_PLUS, "zoom+");
		Bind(KEY_KP_MINUS, "zoom-");
		Bind(KEY_KP_MULTIPLY, "zoom");
		Bind(KEY_HOME, "kill");
		Bind(KEY_PAUSE, "say /pause");
		Bind(KEY_UP, "+jump");
		Bind(KEY_LEFT, "+left");
		Bind(KEY_RIGHT, "+right");
		Bind('[', "+prevweapon");
		Bind(']', "+nextweapon");
		Bind('c', "say /rank");
		Bind('v', "say /info");
		Bind('b', "say /top5");
		Bind('x', "emote 14");
		Bind('h', "emote 2");
		Bind('m', "emote 5");
		Bind('s', "+showhookcoll");
		Bind('x', "toggle cl_dummy 0 1");
#if !defined(__ANDROID__)
		Bind(KEY_PAGEDOWN, "toggle cl_show_quads 0 1");
		Bind(KEY_PAGEUP, "toggle cl_overlay_entities 0 100");
#endif
		Bind(KEY_KP_0, "say /emote normal 999999");
		Bind(KEY_KP_1, "say /emote happy 999999");
		Bind(KEY_KP_2, "say /emote angry 999999");
		Bind(KEY_KP_3, "say /emote pain 999999");
		Bind(KEY_KP_4, "say /emote surprise 999999");
		Bind(KEY_KP_5, "say /emote blink 999999");
		Bind(KEY_MOUSE_3, "+spectate");
		Bind(KEY_MINUS, "spectate_previous");
		Bind(KEY_EQUALS, "spectate_next");
	}
	else
	{
		if(!Get(KEY_KP_PLUS)[0])
			Bind(KEY_KP_PLUS, "zoom+");
		if(!Get(KEY_KP_MINUS)[0])
			Bind(KEY_KP_MINUS, "zoom-");
		if(!Get(KEY_KP_MULTIPLY)[0])
			Bind(KEY_KP_MULTIPLY, "zoom");
		if(!Get(KEY_HOME)[0])
			Bind(KEY_HOME, "kill");
		if(!Get(KEY_PAUSE)[0])
			Bind(KEY_PAUSE, "say /pause");
		if(!Get(KEY_UP)[0])
			Bind(KEY_UP, "+jump");
		if(!Get(KEY_LEFT)[0])
			Bind(KEY_LEFT, "+left");
		if(!Get(KEY_RIGHT)[0])
			Bind(KEY_RIGHT, "+right");
		if(!Get('[')[0])
			Bind('[', "+prevweapon");
		if(!Get(']')[0])
			Bind(']', "+nextweapon");
		if(!Get('c')[0])
			Bind('c', "say /rank");
		if(!Get('v')[0])
			Bind('v', "say /info");
		if(!Get('b')[0])
			Bind('b', "say /top5");
		if(!Get('x')[0])
			Bind('x', "emote 14");
		if(!Get(KEY_KP_PLUS)[0])
			Bind('h', "emote 2");
		if(!Get('m')[0])
			Bind('m', "emote 5");
		if(!Get('s')[0])
			Bind('s', "+showhookcoll");
		if(!Get('x')[0])
			Bind('x', "toggle cl_dummy 0 1");
		if(!Get(KEY_PAGEDOWN)[0])
			Bind(KEY_PAGEDOWN, "toggle cl_show_quads 0 1");
		if(!Get(KEY_PAGEUP)[0])
			Bind(KEY_PAGEUP, "toggle cl_overlay_entities 0 100");
		if(!Get(KEY_KP_0)[0])
			Bind(KEY_KP_0, "say /emote normal 999999");
		if(!Get(KEY_KP_1)[0])
			Bind(KEY_KP_1, "say /emote happy 999999");
		if(!Get(KEY_KP_2)[0])
			Bind(KEY_KP_2, "say /emote angry 999999");
		if(!Get(KEY_KP_3)[0])
			Bind(KEY_KP_3, "say /emote pain 999999");
		if(!Get(KEY_KP_4)[0])
			Bind(KEY_KP_4, "say /emote surprise 999999");
		if(!Get(KEY_KP_5)[0])
			Bind(KEY_KP_5, "say /emote blink 999999");
		if(!Get(KEY_MOUSE_3)[0])
			Bind(KEY_MOUSE_3, "+spectate");
		if(!Get(KEY_MINUS)[0])
			Bind(KEY_MINUS, "spectate_previous");
		if(!Get(KEY_EQUALS)[0])
			Bind(KEY_EQUALS, "spectate_next");
	}

	g_Config.m_ClDDRaceBindsSet = 1;
}