Fix console key being printed into the console

Author: VReaperV

src/common/KeyIdentification.h

@@ -55,7 +55,6 @@ namespace Scancode {
 
 class Key
 {
-public:
 public:
     enum class Kind {
         INVALID,      // No key.

src/engine/client/key_binding.cpp

@@ -274,16 +274,18 @@ void SetBinding(Key key, int team, std::string binding)
 	bindingsModified = true;
 }
 
-const std::vector<Key>& GetConsoleKeys()
-{
-	static std::vector<Keyboard::Key> consoleKeys;
+static std::vector<Keyboard::Key> consoleKeys;
+static std::string consoleKeysString;
 
+void UpdateConsoleKeyCache() {
 	// Only parse the variable when it changes
 	Util::optional<std::string> modifiedString = cl_consoleKeys.GetModifiedValue();
 	if ( modifiedString )
 	{
 		const char* text_p = modifiedString.value().c_str();
 		consoleKeys.clear();
+		consoleKeysString.clear();
+
 		while ( true )
 		{
 			const char* token = COM_Parse( &text_p );
@@ -294,13 +296,25 @@ const std::vector<Key>& GetConsoleKeys()
 			Keyboard::Key k = Keyboard::StringToKey(token);
 			if (k.IsBindable()) {
 				consoleKeys.push_back(k);
+				consoleKeysString += KeyToStringUnprefixed( k );
 			}
 		}
 	}
+}
+
+const std::vector<Key>& GetConsoleKeys()
+{
+	UpdateConsoleKeyCache();
 
 	return consoleKeys;
 }
 
+const std::string& GetConsoleKeysString() {
+	UpdateConsoleKeyCache();
+
+	return consoleKeysString;
+}
+
 void SetConsoleKeys(const std::vector<Key>& keys)
 {
 	std::string text;

src/engine/client/key_identification.cpp

@@ -186,6 +186,32 @@ Key StringToKey(Str::StringRef str)
     return Key::NONE;
 }
 
+std::string KeyToStringUnprefixed( Key key ) {
+    if ( key.kind() == Key::Kind::KEYNUM ) {
+        return KeynumToString( key.AsKeynum() );
+    }
+
+    if ( key.kind() == Key::Kind::UNICODE_CHAR ) {
+        return CharToString( key.AsCharacter() );
+    }
+
+    if ( key.kind() == Key::Kind::SCANCODE ) {
+        int sc = key.AsScancode();
+        if ( char c = ScancodeToAscii( sc ) ) {
+            return CharToString( c );
+        }
+        for ( auto& functionKey : leftRightFunctionKeys ) {
+            if ( sc == functionKey.scancode ) {
+                return functionKey.name;
+            }
+        }
+        // make a hex string
+        return Str::Format( "0x%02x", key.AsScancode() );
+    }
+
+    return "<INVALID KEY>";
+}
+
 std::string KeyToString(Key key)
 {
     if (key.kind() == Key::Kind::KEYNUM) {

src/engine/client/key_identification.h

@@ -39,6 +39,7 @@ namespace Keyboard {
 
 Key StringToKey(Str::StringRef name);
 std::string KeyToString(Key key);
+std::string KeyToStringUnprefixed(Key key);
 
 // Returns the code point of a character typed by the given key, or 0 if none is found.
 int GetCharForScancode(int scancode);

src/engine/client/keys.h

@@ -78,6 +78,7 @@ Util::optional<std::string> GetBinding(Key key, BindTeam team, bool useDefault);
 // Get/set the keys which toggle (both open and close) the console.
 // The source of truth is cl_consoleKeys, but these provide an interface with Key objects.
 const std::vector<Key>& GetConsoleKeys();
+const std::string& GetConsoleKeysString();
 void SetConsoleKeys(const std::vector<Key>& keys);
 
 // Gets all keys that, if pressed, would execute the given command, based on the current team.

src/engine/sys/sdl_input.cpp

@@ -1113,6 +1113,20 @@ static void IN_ProcessEvents( bool dropInput )
 				{
 					std::string text = e.text.text;
 
+					/* We can get a console key as a text event after we've opened the console from a key up/down event,
+					*  in a separate execution of IN_ProcessEvents()
+					*  The key character can also be anywhere in the text
+					*  This might be an SDL bug */
+					text.erase(
+						std::remove_if( text.begin(), text.end(),
+							[]( unsigned char c ) {
+								for( const unsigned char key : Keyboard::GetConsoleKeysString() ) {
+									return c == key;
+								}
+							}
+						), text.end()
+					);
+
 					const char* c = text.c_str();
 					while ( *c ) {
 						int width = Q_UTF8_Width( c );