Merge remote-tracking branch 'plugin/Escape-OneShot/f/monorepo' into f/monorepo-stage2

doc/plugin/Escape-OneShot.md

@@ -0,0 +1,41 @@
+# Kaleidoscope-Escape-OneShot
+
+Turn the `Esc` key into a special key, that can cancel any active `OneShot`
+effect - or act as the normal `Esc` key if none are active, or if any of them
+are still held. For those times when one accidentally presses a one-shot key, or
+change their minds.
+
+## Using the plugin
+
+To use the plugin, one needs to include the header, and activate it. No further
+configuration is necessary.
+
+```c++
+#include <Kaleidoscope.h>
+#include <Kaleidoscope-OneShot.h>
+#include <Kaleidoscope-Escape-OneShot.h>
+
+KALEIDOSCOPE_INIT_PLUGINS(OneShot,
+                          EscapeOneShot);
+
+void setup () {
+  Kaleidoscope.setup ();
+}
+```
+
+The plugin only makes sense when using one-shot keys.
+
+## Plugin methods
+
+The plugin provides the `EscapeOneShot` object, which has no public methods.
+
+## Dependencies
+
+* [Kaleidoscope-OneShot](OneShot.md)
+
+## Further reading
+
+Starting from the [example][plugin:example] is the recommended way of getting
+started with the plugin.
+
+ [plugin:example]: ../../examples/Escape-OneShot/Escape-OneShot.ino

examples/Escape-OneShot/Escape-OneShot.ino

@@ -0,0 +1,73 @@
+/* -*- mode: c++ -*-
+ * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active.
+ * Copyright (C) 2016, 2017, 2018  Keyboard.io, Inc
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <Kaleidoscope.h>
+#include <Kaleidoscope-OneShot.h>
+#include <Kaleidoscope-Escape-OneShot.h>
+
+// *INDENT-OFF*
+const Key keymaps[][ROWS][COLS] PROGMEM = {
+  [0] = KEYMAP_STACKED
+  (
+    Key_NoKey,    Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey,
+    Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab,
+    Key_PageUp,   Key_A, Key_S, Key_D, Key_F, Key_G,
+    Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape,
+
+    OSM(LeftControl), Key_Backspace, OSM(LeftGui), Key_LeftShift,
+    Key_Keymap1_Momentary,
+
+    Key_skip,  Key_6, Key_7, Key_8,     Key_9,      Key_0,         Key_skip,
+    Key_Enter, Key_Y, Key_U, Key_I,     Key_O,      Key_P,         Key_Equals,
+               Key_H, Key_J, Key_K,     Key_L,      Key_Semicolon, Key_Quote,
+    Key_skip,  Key_N, Key_M, Key_Comma, Key_Period, Key_Slash,     Key_Minus,
+
+    Key_RightShift, OSM(RightAlt), Key_Spacebar, OSM(RightControl),
+    OSL(1)
+  ),
+
+  [1] = KEYMAP_STACKED
+  (
+    ___, ___, ___, ___, ___, ___, ___,
+    ___, ___, ___, ___, ___, ___, ___,
+    ___, ___, ___, ___, ___, ___,
+    ___, ___, ___, ___, ___, ___, ___,
+
+    ___, ___, ___, ___,
+    ___,
+
+    ___, ___,         ___,         	___,        	___,        	___, ___,
+    ___, ___,         ___,         	___,        	___,        	___, ___,
+         Key_UpArrow, Key_DownArrow, 	Key_LeftArrow, 	Key_RightArrow, ___, ___,
+    ___, ___,         ___,         	___,        	___,        	___, ___,
+
+    ___, ___, ___, ___,
+    ___
+  ),
+};
+// *INDENT-ON*
+
+KALEIDOSCOPE_INIT_PLUGINS(OneShot,
+                          EscapeOneShot);
+
+void setup() {
+  Kaleidoscope.setup();
+}
+
+void loop() {
+  Kaleidoscope.loop();
+}

src/Kaleidoscope-Escape-OneShot.h

@@ -0,0 +1,20 @@
+/* -*- mode: c++ -*-
+ * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active.
+ * Copyright (C) 2016, 2017  Keyboard.io, Inc
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <kaleidoscope/plugin/Escape-OneShot.h>

src/kaleidoscope/plugin/Escape-OneShot.cpp

@@ -0,0 +1,43 @@
+/* -*- mode: c++ -*-
+ * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active.
+ * Copyright (C) 2016, 2017, 2018  Keyboard.io, Inc
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <Kaleidoscope.h>
+#include <Kaleidoscope-OneShot.h>
+#include <Kaleidoscope-Escape-OneShot.h>
+
+namespace kaleidoscope {
+namespace plugin {
+
+EventHandlerResult EscapeOneShot::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState) {
+  if (mapped_key.raw != Key_Escape.raw ||
+      (keyState & INJECTED) ||
+      !keyToggledOn(keyState))
+    return EventHandlerResult::OK;
+
+  if (!::OneShot.isActive() || ::OneShot.isPressed())
+    return EventHandlerResult::OK;
+
+  KeyboardHardware.maskKey(row, col);
+
+  ::OneShot.cancel(true);
+  return EventHandlerResult::EVENT_CONSUMED;
+}
+
+}
+}
+
+kaleidoscope::plugin::EscapeOneShot EscapeOneShot;

src/kaleidoscope/plugin/Escape-OneShot.h

@@ -0,0 +1,33 @@
+/* -*- mode: c++ -*-
+ * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active.
+ * Copyright (C) 2016, 2017, 2018  Keyboard.io, Inc
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free Software
+ * Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <Kaleidoscope.h>
+
+namespace kaleidoscope {
+namespace plugin {
+class EscapeOneShot : public kaleidoscope::Plugin {
+ public:
+  EscapeOneShot(void) {}
+
+  EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t keyState);
+};
+}
+}
+
+extern kaleidoscope::plugin::EscapeOneShot EscapeOneShot;