Add satan keymap: HHKB-alike based on dbroqua's, with mouse functionality (#1948)

* Add satan keymap: HHKB-alike based on dbroqua's, with mouse functionality and without LED functionality

* move mouse layer to DOUBLE_HOLD, add UTIL layer for TRIPLE_HOLD

- UTIL layer
    - currently has "RESET" key and nothing else.
    - functionality otherwise covered by bootmagic should go here

- small bugfix: dispatch of [QTY]_HOLD should be based on range tap count
  falls in, not exact count.

4 files changed, 238 insertions, 0 deletions

diff --git a/keyboards/satan/keymaps/dkrieger/config.h b/keyboards/satan/keymaps/dkrieger/config.h
new file mode 100644
index 0000000000..faea4d660f
--- /dev/null
+++ b/keyboards/satan/keymaps/dkrieger/config.h
@@ -0,0 +1,26 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+
+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, either version 2 of the License, or
+(at your option) any later version.
+
+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/>.
+*/
+
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#include "../../config.h"
+
+/* Tap Dance */
+#define TAPPING_TERM 200
+
+#endif
diff --git a/keyboards/satan/keymaps/dkrieger/keymap.c b/keyboards/satan/keymaps/dkrieger/keymap.c
new file mode 100644
index 0000000000..5e88498b0a
--- /dev/null
+++ b/keyboards/satan/keymaps/dkrieger/keymap.c
@@ -0,0 +1,167 @@
+#include "satan.h"
+#include "action_layer.h"
+
+#define _DEFAULT 0
+#define _FN 1
+#define _MOUSE 2
+#define _MOUSESHIFT 3
+#define _UTIL 4
+
+// Fillers to make layering more clear
+#define ______ KC_TRNS
+
+enum {
+  SUPER_FN = 0,
+  SINGLE_HOLD = 1,
+  DOUBLE_HOLD = 2,
+  TRIPLE_HOLD = 3
+};
+
+typedef struct {
+  bool is_press_action;
+  int state;
+} tap;
+
+int cur_dance (qk_tap_dance_state_t *state) {
+  if (state->interrupted == false || state->pressed) {
+    if (state->count < 2) return SINGLE_HOLD;
+    if (state->count < 3) return DOUBLE_HOLD;
+    else return TRIPLE_HOLD;
+  }
+  else return 9;
+}
+
+//instantiate an instance of 'tap' for the 'fn' tap dance.
+static tap fn_tap_state = {
+  .is_press_action  = true,
+  .state = 0
+};
+
+void fn_finished (qk_tap_dance_state_t *state, void *user_data) {
+  fn_tap_state.state = cur_dance(state);
+  switch (fn_tap_state.state) {
+    /* case SINGLE_HOLD: register_code(MO(_FN)); break; */
+    case SINGLE_HOLD: layer_on(_FN); break;
+    case DOUBLE_HOLD: layer_on(_MOUSE); break;
+    case TRIPLE_HOLD: layer_on(_UTIL);
+  }
+}
+
+void fn_reset (qk_tap_dance_state_t *state, void *user_data) {
+  switch (fn_tap_state.state) {
+    case SINGLE_HOLD: layer_off(_FN); break;
+    case DOUBLE_HOLD: layer_off(_MOUSE); layer_off(_MOUSESHIFT); break;
+    case TRIPLE_HOLD: layer_off(_UTIL);
+  }
+}
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [SUPER_FN] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, fn_finished, fn_reset)
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Qwerty gui/alt/space/alt/gui
+ * ,-----------------------------------------------------------------------------------------.
+ * | Esc |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |  -  |  =  |  \  |  `  |
+ * |-----------------------------------------------------------------------------------------+
+ * | Tab    |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  [  |  ]  |  Bksp  |
+ * |-----------------------------------------------------------------------------------------+
+ * | Ctrl    |  A  |  S  |  D  |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |    Enter    |
+ * |-----------------------------------------------------------------------------------------+
+ * | Shift     |  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  |  /  | RShift    | FN  |
+ * |-----------------------------------------------------------------------------------------+
+ *         |LGUI | LAlt  |               Space                | RAlt   |RGUI |
+ *         `-----------------------------------------------------------------'
+ */
+  [_DEFAULT] = KEYMAP_HHKB( /* Basic QWERTY */
+      KC_ESC,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,    KC_9,   KC_0,       KC_MINS,    KC_EQL, KC_BSLS,    KC_GRV, \
+      KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,    KC_O,   KC_P,       KC_LBRC,    KC_RBRC,KC_BSPC,  \
+      KC_LCTL,  KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,    KC_L,   KC_SCLN,    KC_QUOT,    KC_ENT,   \
+      KC_LSFT,  KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT, KC_SLSH,    KC_RSFT,    TD(SUPER_FN), \
+      ______,   KC_LGUI,KC_LALT,                KC_SPC,                          KC_RALT,KC_RGUI,    ______,     ______ \
+      ),
+
+/* FN Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * |     | F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 | F11 | F12 | Ins | Del |
+ * |-----------------------------------------------------------------------------------------+
+ * |  CAPS  | BL- | BL+ | BL  |     |     |     |     | Psc | Slck| Paus| Up  |     |        |
+ * |-----------------------------------------------------------------------------------------+
+ * |         | Vol-| Vol+| Mute|     |     | *   | /   | Home| PgUp| Left|Right|             |
+ * |-----------------------------------------------------------------------------------------+
+ * |           | Prev| Play| Next|     |     | +   | -   | End  |PgDn| Down|           |     |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       |       |                                 | Stop  |       |
+ *         `-----------------------------------------------------------------'
+ */
+  [_FN] = KEYMAP_HHKB( /* Layer 1 */
+      ______, KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  KC_F7,  KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12, KC_INS,  KC_DEL, \
+      KC_CAPS,  ______, ______, ______, ______, ______, ______, ______, KC_PSCR, KC_SLCK, KC_PAUS, KC_UP,   ______, ______,  \
+      ______,   KC_VOLD,KC_VOLU,KC_MUTE,______, ______, KC_PAST,KC_PSLS,KC_HOME, KC_PGUP, KC_LEFT, KC_RGHT, ______,   \
+      ______,   KC_MPRV,KC_MPLY,KC_MNXT,______, ______, KC_PPLS,KC_PMNS,KC_END,  KC_PGDN, KC_DOWN, ______,  ______,  \
+      ______,   ______, ______,                 ______,                 KC_MSTP, ______,  ______,  ______ \
+      ),
+
+/* MOUSE Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * |     |     |     |     |     |     |     |     |     |     |     |     |     |     |RESET|
+ * |----------------------------------------------------------------------------------------- 
+ * |        |     |     |     |     |     |     |     |     |     |     |UCurs|     |        |
+ * |----------------------------------------------------------------------------------------- 
+ * |         |     |     |     |     |     |     |     |     |     |LCurs|RCurs|             |
+ * |----------------------------------------------------------------------------------------- 
+ * | ScrollHold|     |     |     |     |     |     |     |      |    |DCurs| ScrollHold|     |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       |       |                          LClick | MClick| RClick|
+ *         `-----------------------------------------------------------------'
+ */
+  [_MOUSE] = KEYMAP_HHKB(
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,  RESET, \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_MS_UP, ______, ______,  \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_MS_LEFT, KC_MS_RIGHT, ______,   \
+      MO(_MOUSESHIFT), ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_MS_DOWN, MO(_MOUSESHIFT), ______,  \
+      ______,   ______, ______,                 KC_MS_BTN1,                 KC_MS_BTN3, KC_MS_BTN2, ______, ______ \
+      ),
+
+/* MOUSESHIFT Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |
+ * |----------------------------------------------------------------------------------------- 
+ * |        |     |     |     |     |     |     |     |     |     |     |UScrl|     |        |
+ * |----------------------------------------------------------------------------------------- 
+ * |         |     |     |     |     |     |     |     |     |     |LScrl|RScrl|             |
+ * |----------------------------------------------------------------------------------------- 
+ * |           |     |     |     |     |     |     |     |      |    |DScrl|           |     |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       |       |                                 |       |       |
+ *         `-----------------------------------------------------------------'
+ */
+  [_MOUSESHIFT] = KEYMAP_HHKB(
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_MS_WH_UP, ______, ______,  \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_MS_WH_LEFT, KC_MS_WH_RIGHT, ______,   \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_MS_WH_DOWN, ______, ______,  \
+      ______,   ______, ______,                 ______,                 ______, ______, ______, ______ \
+      ),
+
+/* UTIL Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * |     |     |     |     |     |     |     |     |     |     |     |     |     |     |RESET|
+ * |----------------------------------------------------------------------------------------- 
+ * |        |     |     |     |     |     |     |     |     |     |     |     |     |        |
+ * |----------------------------------------------------------------------------------------- 
+ * |         |     |     |     |     |     |     |     |     |     |     |     |             |
+ * |----------------------------------------------------------------------------------------- 
+ * |           |     |     |     |     |     |     |     |      |    |     |           |     |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       |       |                                 |       |       |
+ *         `-----------------------------------------------------------------'
+ */
+  [_UTIL] = KEYMAP_HHKB(
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, RESET, \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,  \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,   \
+      ______,   ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______,  \
+      ______,   ______, ______,                 ______,                 ______, ______, ______, ______ \
+      )
+};
diff --git a/keyboards/satan/keymaps/dkrieger/readme.md b/keyboards/satan/keymaps/dkrieger/readme.md
new file mode 100644
index 0000000000..8941132391
--- /dev/null
+++ b/keyboards/satan/keymaps/dkrieger/readme.md
@@ -0,0 +1,23 @@
+# dkrieger HHKB like Layout
+
+Base derived from dbroqua (special thanks)
+
+Based on HHKB with the following [dip switches][1] engaged:
+
+- SW3: delete key -> backspace
+- SW5: swap alt and meta keys
+- SW2: Mac Mode (partial implementation, includes media keys
+    - Note: this was copied from dbroqua, there seem to have been some
+      modifications from stock Mac Mode
+
+Additionally, this layout includes a mouse layer engaged by tapping Fn 3 times,
+holding on the third time. The arrow keys move the mouse, scrolling when shift
+is held (either left or right). Right alt is left click, right meta is right
+click.
+
+# Programming Instructions:
+Enter into programming mode and run the following command.
+```
+$ sudo KEYMAP=dkrieger_hhkb make dfu
+```
+[1]: http://www.elitekeyboards.com/products.php?sub=pfu_keyboards,hhkbpro2&pid=pdkb400b
diff --git a/keyboards/satan/keymaps/dkrieger/rules.mk b/keyboards/satan/keymaps/dkrieger/rules.mk
new file mode 100644
index 0000000000..4c280ceb04
--- /dev/null
+++ b/keyboards/satan/keymaps/dkrieger/rules.mk
@@ -0,0 +1,22 @@
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in 
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = yes         # Console for debug(+400)
+COMMAND_ENABLE = yes        # Commands for debug and configuration
+NKRO_ENABLE = yes           # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = no           # Audio output on port C6
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+TAP_DANCE_ENABLE = yes
+
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif