From 6d641e7fc52b5b93df28f563369661ae42a43c6b Mon Sep 17 00:00:00 2001
From: Gergely Nagy <algernon@madhouse-project.org>
Date: Tue, 21 Feb 2017 20:51:56 +0100
Subject: [PATCH] Make the lookup of a key pluggable

We want to allow plugins to change how keys are looked up - or where they are
looked up from -, and for this, the way we do that final lookup from `keymaps`
or elsewhere, must be overrideable.

We do this by having a `getKey` function pointer in the `Layer_` class, which
defaults to `getKeyFromPROGMEM`. Any plugin, or sketch, can change where
`getKey` points to, and thereby change the way keys are looked up.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
---
 src/layers.cpp | 18 ++++++++++++------
 src/layers.h   |  6 ++++++
 2 files changed, 18 insertions(+), 6 deletions(-)

diff --git a/src/layers.cpp b/src/layers.cpp
index 7dff82d4..c9464b2b 100644
--- a/src/layers.cpp
+++ b/src/layers.cpp
@@ -5,6 +5,7 @@ static uint32_t LayerState;
 
 uint8_t Layer_::highestLayer;
 uint8_t Layer_::keyMap[ROWS][COLS];
+Key (*Layer_::getKey)(uint8_t layer, byte row, byte col) = Layer.getKeyFromPROGMEM;
 
 static void handle_keymap_key_event(Key keymapEntry, uint8_t keyState) {
     if (keymapEntry.keyCode >= MOMENTARY_OFFSET) {
@@ -51,6 +52,15 @@ Layer_::Layer_ (void) {
     defaultLayer (0);
 }
 
+Key
+Layer_::getKeyFromPROGMEM (uint8_t layer, byte row, byte col) {
+    Key key;
+
+    key.raw = pgm_read_word(&(keymaps[layer][row][col]));
+
+    return key;
+}
+
 void
 Layer_::mergeLayers(void) {
 
@@ -65,9 +75,7 @@ Layer_::mergeLayers(void) {
 
             while (layer > DefaultLayer) {
                 if (Layer.isOn (layer)) {
-                    Key mappedKey;
-
-                    mappedKey.raw = pgm_read_word(&(keymaps[layer][r][c]));
+                    Key mappedKey = (*getKey)(layer, r, c);
 
                     if (mappedKey != Key_Transparent) {
                         keyMap[r][c] = layer;
@@ -82,10 +90,8 @@ Layer_::mergeLayers(void) {
 
 Key Layer_::lookup(byte row, byte col) {
     uint8_t layer = keyMap[row][col];
-    Key mappedKey;
-    mappedKey.raw = pgm_read_word(&(keymaps[layer][row][col]));
 
-    return mappedKey;
+    return (*getKey)(layer, row, col);
 }
 
 uint8_t Layer_::top (void) {
diff --git a/src/layers.h b/src/layers.h
index 33025d3e..3f1f748f 100644
--- a/src/layers.h
+++ b/src/layers.h
@@ -26,6 +26,10 @@ class Layer_ {
 
     static Key eventHandler(Key mappedKey, byte row, byte col, uint8_t keyState);
 
+    static Key (*getKey)(uint8_t layer, byte row, byte col);
+
+    static Key getKeyFromPROGMEM(uint8_t layer, byte row, byte col);
+
  private:
     static uint8_t highestLayer;
     static uint8_t keyMap[ROWS][COLS];
@@ -33,4 +37,6 @@ class Layer_ {
     static void mergeLayers(void);
 };
 
+Key layer_getKey (uint8_t layer, uint8_t r, uint8_t c);
+
 extern Layer_ Layer;