Fix bug in handling reserved keystrokes

Fix bug where any Ctrl-Shift keystrokes are dropped even if they are not
reserved keystrokes.

Formatting changes (replaced all tab chars with spaces)

keymapper.ino

@@ -18,21 +18,31 @@
 #include "keymapper_game.h"
 
 //#define DEBUG
-
-
 #define modeLED 13
 
+
+
+
+// function definitions
+bool HandleReservedKeystrokes(uint8_t mod, uint8_t key);
+void play_word_game(void);
+
+
+
+
+// variable definitions
 typedef enum 
 {
-	qwerty=0, 
+    qwerty=0, 
-	tarmak1,
+    tarmak1,
-	tarmak2,
+    tarmak2,
-	tarmak3,
+    tarmak3,
-	tarmak4,
+    tarmak4,
-	colemak,
+    colemak,
-	dvorak
+    dvorak
 } KeyboardLayout;
 
+// keymap based on the scancodes from 4 to 57, refer to the HID usage table on the meaning of each element
 PROGMEM prog_uint8_t qwertyKeymap[] = {4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57};
 PROGMEM prog_uint8_t tarmak1Keymap[] = {4, 5, 6, 7, 13, 9, 10, 11, 12, 17, 8, 15, 16, 14, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57};
 PROGMEM prog_uint8_t tarmak2Keymap[] = {4, 5, 6, 7, 9, 23, 13, 11, 12, 17, 8, 15, 16, 14, 18, 19, 20, 21, 22, 10, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57};
@@ -42,12 +52,12 @@ PROGMEM prog_uint8_t colemakKeymap[] = {4, 5, 6, 22, 9, 23, 7, 11, 24, 17, 8, 12
 
 const uint8_t *keymap[] =
 {   
-  qwertyKeymap,
+    qwertyKeymap,
-  tarmak1Keymap,
+    tarmak1Keymap,
-  tarmak2Keymap,
+    tarmak2Keymap,
-  tarmak3Keymap,
+    tarmak3Keymap,
-  tarmak4Keymap,
+    tarmak4Keymap,
-  colemakKeymap
+    colemakKeymap
 };
 
 
@@ -60,11 +70,12 @@ KeyboardLayout currentLayout = qwerty;
 
 class KbdRptParser : public KeyboardReportParser
 {
-        void PrintKey(uint8_t mod, uint8_t key);
+    void PrintKey(uint8_t mod, uint8_t key);
         
 protected:
-	virtual void OnKeyDown	(uint8_t mod, uint8_t key);
+    virtual void OnKeyDown (uint8_t mod, uint8_t key);
-	virtual void OnKeyUp	(uint8_t mod, uint8_t key);
+    virtual void OnKeyUp (uint8_t mod, uint8_t key);
+    virtual void Parse(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf);
 };
 
 void KbdRptParser::PrintKey(uint8_t m, uint8_t key)    
@@ -87,7 +98,7 @@ void KbdRptParser::PrintKey(uint8_t m, uint8_t key)
     Serial.print((mod.bmRightCtrl   == 1) ? "C" : " ");
     Serial.print((mod.bmRightShift  == 1) ? "S" : " ");
     Serial.print((mod.bmRightAlt    == 1) ? "A" : " ");
-    Serial.println((mod.bmRightGUI    == 1) ? "G" : " ");
+    Serial.println((mod.bmRightGUI  == 1) ? "G" : " ");
 
 };
 
@@ -97,68 +108,20 @@ void KbdRptParser::OnKeyDown(uint8_t mod, uint8_t key)
 #ifdef DEBUG
     Serial.print("DN ");
     PrintKey(mod, key);
-
 #endif
     
-	// check if we are changing layouts
+    if (!HandleReservedKeystrokes(mod, key))
-    if ((mod & 0x22) && (mod & 0x11))  {
+    {
-        switch (key) {
+        // print the key based on the current layout
-            case 0x27:    // 0
+        if (key-4 < 54)        // transpose of 4 becoz our array starts from 0 but A is 4
-                currentLayout = qwerty;
+                               // limit check to 57, which is the last mappable key (CAPSLOCK)
-                digitalWrite(modeLED, LOW);
+            key = pgm_read_byte(keymap[currentLayout]+key-4);
     
-#ifdef DEBUG				
+        keyBuffer[0] = mod;
-                Serial.print("Current layout: ");
+        keyBuffer[2] = key;
-                Serial.println(currentLayout);
         
-				for (uint8_t i=0; i<54; i++)
+        HID_SendReport(2,keyBuffer,sizeof(keyBuffer));    
-					Serial.println(pgm_read_byte(keymap[currentLayout]+i));
-#endif
-					break;
-
-			case 0x1e:    // 1
-                currentLayout = tarmak1;
-                digitalWrite(modeLED, HIGH);
-                break;
-
-			case 0x1f:    // 2
-                currentLayout = tarmak2;
-                digitalWrite(modeLED, HIGH);
-                break;
-
-			case 0x20:    // 3
-                currentLayout = tarmak3;
-                digitalWrite(modeLED, HIGH);
-                break;
-
-			case 0x21:    // 4
-                currentLayout = tarmak4;
-                digitalWrite(modeLED, HIGH);
-                break;
-
-			case 0x22:    // 5
-                currentLayout = colemak;
-                digitalWrite(modeLED, HIGH);
-                break;
-
-
-			case 0x2c:    // space bar
-                play_word_game();
-                break;
-        }
     }
-	else
-	{
-		// print the key based on the current layout
-		if (key-4 < 54)		// transpose of 4 becoz our array starts from 0 but A is 4
-							// limit check to 57, which is the last mappable key (CAPSLOCK)
-			key = pgm_read_byte(keymap[currentLayout]+key-4);
-	
-		keyBuffer[0] = mod;
-		keyBuffer[2] = key;
-		
-		HID_SendReport(2,keyBuffer,sizeof(keyBuffer));    
-	}
 }
 
 void KbdRptParser::OnKeyUp(uint8_t mod, uint8_t key)    
@@ -175,6 +138,211 @@ void KbdRptParser::OnKeyUp(uint8_t mod, uint8_t key)
 
 }
 
+// Copy and pasted over from Oleg's library in preparation for next major revision
+
+// void KbdRptParser::Parse(HID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)
+// {
+// Serial.println ("This is my own parse function!");
+
+	// // On error - return
+	// if (buf[2] == 1)
+		// return;
+		
+	// KBDINFO	*pki = (KBDINFO*)buf;
+
+	// for (uint8_t i=2; i<8; i++)
+	// {
+		// bool down = true;
+		// bool up	  = true;
+
+		// for (uint8_t j=2; j<8; j++)
+		// {
+			// if (buf[i] == prevState.bInfo[j] && buf[i] != 1)	// if at least one of the keys are the same
+				// down = false;									// as the previous state, then it could not 
+																// // have been pressed again
+			// if (buf[j] == prevState.bInfo[i] && prevState.bInfo[i] != 1)	// if any of the keys in the previous
+				// up = false;													// is found now, then it has not been
+		// }																	// released
+			
+		// if (down)
+		// {
+			// HandleLockingKeys(hid, buf[i]);
+			// OnKeyDown(*buf, buf[i]);
+			// }
+		// if (up)
+		// {
+			// OnKeyUp(prevState.bInfo[0], prevState.bInfo[i]);
+		// }
+	// }
+
+	// // handle modifier keys
+	// if ( (buf[0] & 0x01) > (prevState.bInfo[0] & 0x01))		// left CTRL was pressed
+		// OnKeyDown (*buf, 0xe0);
+	// if ( (buf[0] & 0x01) < (prevState.bInfo[0] & 0x01))		// left CTRL was release
+		// OnKeyUp (prevState.bInfo[0], 0xe0);
+
+	// if ( (buf[0] & 0x02) > (prevState.bInfo[0] & 0x02))		// left SHIFT was pressed
+		// OnKeyDown (*buf, 0xe1);
+	// if ( (buf[0] & 0x02) < (prevState.bInfo[0] & 0x02))		// left SHIFT was release
+		// OnKeyUp (prevState.bInfo[0], 0xe1);
+		
+	// if ( (buf[0] & 0x04) > (prevState.bInfo[0] & 0x04))		// left ALT was pressed
+		// OnKeyDown (*buf, 0xe2);
+	// if ( (buf[0] & 0x04) < (prevState.bInfo[0] & 0x04))		// left ALT was release
+		// OnKeyUp (prevState.bInfo[0], 0xe2);
+		
+	// if ( (buf[0] & 0x08) > (prevState.bInfo[0] & 0x08))		// left GUI was pressed
+		// OnKeyDown (*buf, 0xe3);
+	// if ( (buf[0] & 0x08) < (prevState.bInfo[0] & 0x08))		// left GUI was release
+		// OnKeyUp (prevState.bInfo[0], 0xe3);
+
+	// if ( (buf[0] & 0x10) > (prevState.bInfo[0] & 0x10))		// right CTRL was pressed
+		// OnKeyDown (*buf, 0xe4);
+	// if ( (buf[0] & 0x10) < (prevState.bInfo[0] & 0x10))		// right CTRL was release
+		// OnKeyUp (prevState.bInfo[0], 0xe4);
+
+	// if ( (buf[0] & 0x20) > (prevState.bInfo[0] & 0x20))		// right SHIFT was pressed
+		// OnKeyDown (*buf, 0xe5);
+	// if ( (buf[0] & 0x20) < (prevState.bInfo[0] & 0x20))		// right SHIFT was release
+		// OnKeyUp (prevState.bInfo[0], 0xe5);
+		
+	// if ( (buf[0] & 0x40) > (prevState.bInfo[0] & 0x40))		// right ALT was pressed
+		// OnKeyDown (*buf, 0xe6);
+	// if ( (buf[0] & 0x40) < (prevState.bInfo[0] & 0x40))		// right ALT was release
+		// OnKeyUp (prevState.bInfo[0], 0xe6);
+		
+	// if ( (buf[0] & 0x80) > (prevState.bInfo[0] & 0x80))		// right GUI was pressed
+		// OnKeyDown (*buf, 0xe7);
+	// if ( (buf[0] & 0x80) < (prevState.bInfo[0] & 0x80))		// right GUI was release
+		// OnKeyUp (prevState.bInfo[0], 0xe7);
+
+
+
+
+	// /*
+	// for (uint8_t i=0; i<8; i++)
+		// prevState.bInfo[i] = buf[i];
+	// */
+	// memcpy(prevState.bInfo, buf, 8);		// potentially faster than the loop? code seems to compile smaller also
+// };
+
+
+bool HandleReservedKeystrokes(uint8_t mod, uint8_t key) // return true if it is a reserved keystroke
+{
+    // check if we are changing layouts
+    if ((mod & 0x22) && (mod & 0x11))  {        // Shift-Alt keystrokes
+        switch (key) {
+            case 0x27:    // 0
+                currentLayout = qwerty;
+                digitalWrite(modeLED, LOW);
+                return true;
+
+            case 0x1e:    // 1
+                currentLayout = tarmak1;
+                digitalWrite(modeLED, HIGH);
+                return true;
+
+            case 0x1f:    // 2
+                currentLayout = tarmak2;
+                digitalWrite(modeLED, HIGH);
+                return true;
+
+            case 0x20:    // 3
+                currentLayout = tarmak3;
+                digitalWrite(modeLED, HIGH);
+                return true;
+
+            case 0x21:    // 4
+                currentLayout = tarmak4;
+                digitalWrite(modeLED, HIGH);
+                return true;
+
+            case 0x22:    // 5
+                currentLayout = colemak;
+                digitalWrite(modeLED, HIGH);
+                return true;
+
+            case 0x2c:    // space bar
+                play_word_game();
+                return true;
+        }
+    }
+
+// note that in the current implementation of HandleReservedKeystrokes, this
+// part of the code will never get called even if DEBUG is defined
+#ifdef DEBUG
+    Serial.print("Current layout: ");
+    Serial.println(currentLayout);
+    
+    for (uint8_t i=0; i<54; i++)
+        Serial.println(pgm_read_byte(keymap[currentLayout]+i));
+#endif
+
+    return false;
+
+
+}
+
+
+// *******************************
+// ****     WORD GAME!!!       ***
+// *******************************
+
+void play_word_game(void)
+{
+    char buffer[GAME_MAXWORDLENGTH];
+    char priorityAlphabets[10];
+    char *instrPtr;
+
+    uint16_t randNum;
+
+    switch (currentLayout) {
+        case tarmak1:
+            strcpy (priorityAlphabets, "nek");
+            break;
+        case tarmak2:
+            strcpy (priorityAlphabets, "ftg");
+            break;
+        case tarmak3:
+            strcpy (priorityAlphabets, "jyo");
+            break;
+        case tarmak4:
+            strcpy (priorityAlphabets, "lui");
+            break;
+        case colemak:
+            strcpy (priorityAlphabets, "rspd");
+            break;
+        default:
+            strcpy (priorityAlphabets, "");
+    }
+
+    Keyboard.print( "Word game! Letters being prioritised: " );
+    Keyboard.println( priorityAlphabets );
+
+    for (int i = 0; i < 15; i++)  {
+        if (priorityAlphabets[0] != 0) {
+            instrPtr = NULL;
+            while (instrPtr == NULL) {
+                randNum = random(GAME_NUMWORDS);
+                strcpy_P(buffer, (char*)pgm_read_word(&(game_word_list[randNum]))); 
+                instrPtr = strpbrk (buffer, priorityAlphabets);
+            }
+        } 
+        else {
+            randNum = random(GAME_NUMWORDS);
+            strcpy_P(buffer, (char*)pgm_read_word(&(game_word_list[randNum]))); 
+        }
+        
+        Keyboard.print( buffer );
+        Keyboard.print( " " );
+    }
+    Keyboard.println( "" );
+}
+  
+
+  
+  
+  
   
 USB     Usb;
 //USBHub     Hub(&Usb);
@@ -185,83 +353,27 @@ uint32_t next_time;
 KbdRptParser Prs;
 
 
-// *******************************
-// **** 	WORD GAME!!!       ***
-// *******************************
-
-void play_word_game()
-{
-  char buffer[GAME_MAXWORDLENGTH];
-  char priorityAlphabets[10];
-  char *instrPtr;
-  
-  uint16_t randNum;
-
-  switch (currentLayout) {
-	case tarmak1:
-		strcpy (priorityAlphabets, "nek");
-		break;
-	case tarmak2:
-		strcpy (priorityAlphabets, "ftg");
-		break;
-	case tarmak3:
-		strcpy (priorityAlphabets, "jyo");
-		break;
-	case tarmak4:
-		strcpy (priorityAlphabets, "lui");
-		break;
-	case colemak:
-		strcpy (priorityAlphabets, "rspd");
-		break;
-	default:
-		strcpy (priorityAlphabets, "");
-  }
-
-  Keyboard.print( "Word game! Letters being prioritised: " );
-  Keyboard.println( priorityAlphabets );
-  
-  for (int i = 0; i < 15; i++)  {
-	if (priorityAlphabets[0] != 0) {
-		instrPtr = NULL;
-		while (instrPtr == NULL) {
-			randNum = random(GAME_NUMWORDS);
-			strcpy_P(buffer, (char*)pgm_read_word(&(game_word_list[randNum]))); 
-			instrPtr = strpbrk (buffer, priorityAlphabets);
-		}
-	} 
-	else {
-		randNum = random(GAME_NUMWORDS);
-		strcpy_P(buffer, (char*)pgm_read_word(&(game_word_list[randNum]))); 
-	}
-		
-	Keyboard.print( buffer );
-    Keyboard.print( " " );
-  }
-  Keyboard.println( "" );
-}
-  
-
   
   
   
   
 void setup()
 {
-  randomSeed(analogRead(0));
+    randomSeed(analogRead(0));
 
-  // initialize the digital pin as an output.
+    // initialize the digital pin as an output.
-  pinMode(modeLED, OUTPUT);  
+    pinMode(modeLED, OUTPUT);  
 
 
 
-  Keyboard.begin();
+    Keyboard.begin();
 
 #ifdef DEBUG
-  Serial.begin( 115200 );
+    Serial.begin( 115200 );
-  Serial.println("Start");
+    Serial.println("Start");
 #endif
 
-  if (Usb.Init() == -1)
+    if (Usb.Init() == -1)
 
 #ifdef DEBUG
     Serial.println("OSC did not start.");
@@ -269,16 +381,16 @@ void setup()
     delay( 1 );
 #endif
 
-  delay( 200 );
+    delay( 200 );
 
-  next_time = millis() + 5000;
+    next_time = millis() + 5000;
 
-  Keyboard2.SetReportParser(0, (HIDReportParser*)&Prs);
+    Keyboard2.SetReportParser(0, (HIDReportParser*)&Prs);
 }
 
 void loop()
 {
-  Usb.Task();
+    Usb.Task();
     
 }