Kaleidoscope/src/key_events.h

#pragma once
#include <Arduino.h>

#include "key_defs.h"
#include "keyswitch_state.h"
#include "MouseWrapper.h"
#include "LEDControl.h"
#include "Storage.h"
#include "keymap_metadata.h"
#include "hooks.h"

//static const Key keymaps[KEYMAPS][ROWS][COLS];
extern uint8_t primary_keymap;
extern uint8_t temporary_keymap;
extern const Key keymaps[][ROWS][COLS];

// sending events to the computer
void handle_synthetic_key_event( Key mappedKey, uint8_t currentState, uint8_t previousState);
void handle_key_event(byte row, byte col, uint8_t currentState, uint8_t previousState);
void press_key(Key mappedKey);
void handle_keymap_key_event(Key keymapEntry, uint8_t currentState, uint8_t previousState);
void handle_mouse_key_event(Key mappedKey, uint8_t currentState, uint8_t previousState);
bool handle_key_event_default(byte row, byte col, uint8_t currentState, uint8_t previousState);

Key lookup_key(byte keymap, byte row, byte col);
First pass at extracting key event functions to their own source files 9 years ago			`#pragma once`
			`#include <Arduino.h>`

			`#include "key_defs.h"`
what we called matrix_state really only dealt with a the state of a single keyswitch 9 years ago			`#include "keyswitch_state.h"`
rename mouse_movement to MouseWrapper in preparation for making it a class 9 years ago			`#include "MouseWrapper.h"`
Rename LEDControl.cpp and move some variable initialization into the class defintion. (Also, a couple of signed ints had previously been inadvertently converted into unsigned ints. Now fixed) 9 years ago			`#include "LEDControl.h"`
Cleaner separation for our 'Storage' class 9 years ago			`#include "Storage.h"`
Rename keymaps.h to keymap_metadata, so it's less likely generated/keymaps.h and keymap_metadata.h will get confused with each other 8 years ago			`#include "keymap_metadata.h"`
Small hook rework Two things are done here: loop() hooks are introduced, and both loop and event handler hooks are pre-allocated for HOOK_MAX (64 by default) elements. Two helpers are introduced too, that make it easier to append a new hook to the end of these arrays. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 8 years ago			`#include "hooks.h"`
First pass at extracting key event functions to their own source files 9 years ago
move keymaps to progmem. This is a fairly large memory win 8 years ago			`//static const Key keymaps[KEYMAPS][ROWS][COLS];`
First pass at extracting key event functions to their own source files 9 years ago			`extern uint8_t primary_keymap;`
			`extern uint8_t temporary_keymap;`
Separate the keymap layout from the core firmware This moves the layouts to the sketch directory, so that other sketches can easily use a different keymap. In the process, not much had to be changed, and a number of things still remain in the core that assume the default keymap (such as the NUMPAD_KEYMAP thing in LEDControl.cpp), but this is a first step. The downside is that the keymap is no longer static, because that would conflict with the extern declaration, and the NUMPAD_KEYMAP is a byte, instead of a compile-time define. Alltogether, the difference is small enough to be acceptable. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 8 years ago			`extern const Key keymaps[][ROWS][COLS];`
First pass at extracting key event functions to their own source files 9 years ago
			`// sending events to the computer`
Add an alternate version of our keystate code that depends on in-hardware debouncing 9 years ago			`void handle_synthetic_key_event( Key mappedKey, uint8_t currentState, uint8_t previousState);`
			`void handle_key_event(byte row, byte col, uint8_t currentState, uint8_t previousState);`
First pass at extracting key event functions to their own source files 9 years ago			`void press_key(Key mappedKey);`
Add an alternate version of our keystate code that depends on in-hardware debouncing 9 years ago			`void handle_keymap_key_event(Key keymapEntry, uint8_t currentState, uint8_t previousState);`
			`void handle_mouse_key_event(Key mappedKey, uint8_t currentState, uint8_t previousState);`
Rework the custom event handler architecture Instead of a single custom function, have an array of functions that get called in order, until one of them returns true. Defaults to the normal event handler. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 8 years ago			`bool handle_key_event_default(byte row, byte col, uint8_t currentState, uint8_t previousState);`
Add a lookup_key() method This allows external libraries to look up the keycode for a given position, without having to reimplement the keymap themselves. This becomes important when you hook into the event processing. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org> 8 years ago
			`Key lookup_key(byte keymap, byte row, byte col);`