Keymap: xtonhasvim updates (#3768)

* cherrypicking file changes just for updates

* removed unused heat foo

* avoid defining own min/max

* add license

* formatting

5 files changed, 258 insertions, 26 deletions

diff --git a/users/xtonhasvim/fancylighting.c b/users/xtonhasvim/fancylighting.c
new file mode 100644
index 0000000000..f4af5ec55d
--- /dev/null
+++ b/users/xtonhasvim/fancylighting.c
@@ -0,0 +1,167 @@
+ /* Copyright 2015-2017 Christon DeWan
+ *
+ * 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/>.
+ */
+
+#ifdef RGBLIGHT_ENABLE
+
+#include <math.h>
+
+#include "rgblight.h"
+#include "color.h"
+#include "fancylighting.h"
+
+
+__attribute__ ((weak))
+void matrix_scan_keymap(void) {
+  // override me, if you want.
+  return;
+}
+
+#define ABSDIFF(a,b) ((a)>(b)?(a)-(b):(b)-(a))
+
+#define FADE_BACK_TIME 500
+#define BREATH_FIRE_TIME 1000
+#define ANIMATION_STEP_INTERVAL 20
+#define POWER_KEY_OFFSET (RGBLED_NUM / 2)
+#define SPACE_OFFSET_MAX (RGBLED_NUM / 2)
+
+
+uint16_t effect_start_timer = 0;
+uint8_t user_rgb_mode = 0;
+LED_TYPE shadowed_led[RGBLED_NUM] = {0};
+
+void start_firey_return(void) {
+  user_rgb_mode = BREATH_FIRE;
+  effect_start_timer = timer_read();
+  for(uint8_t i = 0; i < RGBLED_NUM; i++) {
+    shadowed_led[i] = led[i];
+  }
+}
+
+/** 0---max
+ *  [___]
+ *  [__/]
+ *  [_/\]
+ *  [/\_]
+ *  [\__]
+ *  [___]
+ **/
+
+void set_color_for_offsets(uint16_t time_offset, uint16_t space_offset, uint8_t idx) {
+  float time_progress = (float)time_offset / BREATH_FIRE_TIME;
+  float space_progress = (float)space_offset / SPACE_OFFSET_MAX;
+  float progress = time_progress * 5.0 - space_progress;
+  if(progress > 1.0) {
+    progress -= 1.0;
+    progress /= 4.0;
+    progress = 1.0 - progress;
+  }
+  progress = fmax(0.0,progress);
+  progress *= progress; // squared!
+
+  float alpha = (time_progress + 0.1) * 7.0 - space_progress;
+  alpha = fmin(1.0, alpha*alpha);
+
+  LED_TYPE px[1] = {0};
+  sethsv((uint16_t)(fmod(time_progress * 1.5 + space_progress,1.0)*360), 255, (uint8_t)(progress*255),&px[0]);
+  led[idx].r = alpha * px[0].r + ( 1.0 - alpha) * shadowed_led[idx].r;
+  led[idx].g = alpha * px[0].g + ( 1.0 - alpha) * shadowed_led[idx].g;
+  led[idx].b = alpha * px[0].b + ( 1.0 - alpha) * shadowed_led[idx].b;
+}
+
+/**
+ * It's actually a rainbow: a fire curve didn't really look right.
+ * it's still cool, though!
+ */
+void rgb_mode_breath_fire(void) {
+  static uint16_t last_timer = 0;
+  if(!last_timer) last_timer = timer_read();
+  uint16_t this_timer = timer_read();
+
+  // too soon. don't spam updates
+  if(this_timer - last_timer < ANIMATION_STEP_INTERVAL) return;
+
+  uint16_t elapsed = this_timer - effect_start_timer;
+
+  last_timer = this_timer;
+  if(elapsed >= BREATH_FIRE_TIME) {
+    // complete
+    user_rgb_mode = FADE_BACK;
+    effect_start_timer = this_timer;
+  } else {
+    // linear fade
+    for(uint16_t i = 0; i < RGBLED_NUM; i++) {
+      uint16_t space_offset = ABSDIFF(i,POWER_KEY_OFFSET);
+      if(space_offset > SPACE_OFFSET_MAX) space_offset = RGBLED_NUM - space_offset;
+
+      set_color_for_offsets(elapsed, space_offset, i);
+    }
+    rgblight_set();
+  }
+}
+
+void rgb_mode_fade_back(void) {
+  static uint16_t last_timer = 0;
+  if(!last_timer) last_timer = timer_read();
+  uint16_t this_timer = timer_read();
+
+  // too soon. don't spam updates
+  if(this_timer - last_timer < ANIMATION_STEP_INTERVAL) return;
+
+  uint16_t elapsed = this_timer - effect_start_timer;
+
+  last_timer = this_timer;
+  float progress = (float)elapsed / FADE_BACK_TIME;
+  progress = fmin(1.0,progress);
+
+  for(uint8_t i = 0; i < RGBLED_NUM; i++) {
+    led[i].r = shadowed_led[i].r * progress;
+    led[i].g = shadowed_led[i].g * progress;
+    led[i].b = shadowed_led[i].b * progress;
+  }
+  rgblight_set();
+
+  if(elapsed >= FADE_BACK_TIME) user_rgb_mode = 0;
+}
+
+/** called when layer state or vstate has changed */
+__attribute__ ((weak))
+void set_state_leds(void) {
+  return;
+}
+
+void matrix_scan_user(void) {
+  static uint32_t last_layer = 0;
+  static uint32_t last_vstate = 0;
+  if(last_layer != layer_state || last_vstate != vstate) set_state_leds();
+  last_layer = layer_state;
+  last_vstate = vstate;
+
+  switch (user_rgb_mode) {
+    case BREATH_FIRE:
+      rgb_mode_breath_fire();
+      break;
+    case FADE_BACK:
+      rgb_mode_fade_back();
+      break;
+  }
+  matrix_scan_keymap();
+}
+
+#else
+
+void start_firey_return(void) {}
+
+#endif
diff --git a/users/xtonhasvim/fancylighting.h b/users/xtonhasvim/fancylighting.h
new file mode 100644
index 0000000000..982010d3d5
--- /dev/null
+++ b/users/xtonhasvim/fancylighting.h
@@ -0,0 +1,35 @@
+p /* Copyright 2015-2017 Christon DeWan
+ *
+ * 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 _fancy_lighting_h
+#define _fancy_lighting_h
+#ifdef RGBLIGHT_ENABLE
+
+#include "xtonhasvim.h"
+
+extern uint8_t user_rgb_mode;
+extern LED_TYPE shadowed_led[];
+
+void start_firey_return(void);
+
+#endif //_fancy_lighting_h
+
+enum xtonhasvim_rgbmodes {
+  BREATH_FIRE = 1,
+  FADE_BACK
+};
+
+#endif //RGBLIGHT_ENABLE
diff --git a/users/xtonhasvim/rules.mk b/users/xtonhasvim/rules.mk
index 3777917f8f..a901bfcf67 100644
--- a/users/xtonhasvim/rules.mk
+++ b/users/xtonhasvim/rules.mk
@@ -1 +1,2 @@
 SRC += xtonhasvim.c
+SRC += fancylighting.c
diff --git a/users/xtonhasvim/xtonhasvim.c b/users/xtonhasvim/xtonhasvim.c
index a2ff2fa31c..5f6701830f 100644
--- a/users/xtonhasvim/xtonhasvim.c
+++ b/users/xtonhasvim/xtonhasvim.c
@@ -15,6 +15,7 @@
  */
 
 #include "xtonhasvim.h"
+#include "fancylighting.h"
 
 /************************************
  * helper foo
@@ -53,13 +54,13 @@ static void ALT(uint16_t keycode) {
 }
 
 
-static uint16_t vstate = VIM_START;
+uint16_t vstate = VIM_START;
 static bool yank_was_lines = false;
 static bool SHIFTED = false;
 static uint32_t mod_override_layer_state = 0;
 static uint16_t mod_override_triggering_key = 0;
 
-static void edit(void) { vstate = VIM_START; layer_on(_EDIT); layer_off(_CMD); }
+static void edit(void) { vstate = VIM_START; layer_clear(); }
 #define EDIT edit()
 
 
@@ -102,25 +103,54 @@ static void simple_movement(uint16_t keycode) {
   }
 }
 
+static void comma_period(uint16_t keycode) {
+  switch (keycode) {
+  case VIM_COMMA:
+    if (SHIFTED) {
+      // indent
+      CMD(KC_LBRACKET);
+    } else {
+      // toggle comment
+      CMD(KC_SLASH);
+    }
+    break;
+  case VIM_PERIOD:
+    if (SHIFTED) {
+      // outdent
+      CMD(KC_RBRACKET);
+    }
+    break;
+  }
+}
+
 __attribute__ ((weak))
 bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
   return true;
 }
 
-#define PASS_THRU process_record_keymap(keycode, record)
-
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  if(record->event.pressed && layer_state_is(_CMD) && IS_MOD(keycode)) {
+  /* keymap gets first whack */
+  if(!process_record_keymap(keycode, record)) return false;
+
+  /****** FIREY_RETURN *****/
+  if(record->event.pressed && keycode == FIREY_RETURN) {
+    start_firey_return();
+    TAP(KC_ENT);
+  }
+
+  /****** mod passthru *****/
+  if(record->event.pressed && layer_state_is(vim_cmd_layer()) && (IS_MOD(keycode) || keycode == LSFT(KC_LALT))) {
     mod_override_layer_state = layer_state;
     mod_override_triggering_key = keycode;
+    // TODO: change this to track key location instead
     layer_clear();
-    return PASS_THRU; // let the event fall through...
+    return true; // let the event fall through...
   }
   if(mod_override_layer_state && !record->event.pressed && keycode == mod_override_triggering_key) {
     layer_state_set(mod_override_layer_state);
     mod_override_layer_state = 0;
     mod_override_triggering_key = 0;
-    return PASS_THRU;
+    return true;
   }
 
   if (VIM_START <= keycode && keycode <= VIM_ESC) {
@@ -132,7 +162,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
     if (record->event.pressed) {
       if(keycode == VIM_START) {
         // entry from anywhere
-        layer_on(_CMD);
+        layer_on(vim_cmd_layer());
         vstate = VIM_START;
 
         // reset state
@@ -176,7 +206,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
               break;
             case VIM_D:
               if(SHIFTED) {
-                TAP(KC_K);
+                CTRL(KC_K);
               } else {
                 vstate = VIM_D;
               }
@@ -300,19 +330,8 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
               }
               break;
             case VIM_COMMA:
-              if(SHIFTED) {
-                // indent
-                CMD(KC_LBRACKET);
-              } else {
-                // toggle comment
-                CMD(KC_SLASH);
-              }
-              break;
             case VIM_PERIOD:
-              if(SHIFTED) {
-                // outdent
-                CMD(KC_RBRACKET);
-              }
+              comma_period(keycode);
               break;
           }
           break;
@@ -483,6 +502,10 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
               TAP(KC_RIGHT);
               vstate = VIM_START;
               break;
+            case VIM_COMMA:
+            case VIM_PERIOD:
+              comma_period(keycode);
+              break;
             default:
               // do nothing
               break;
@@ -539,6 +562,10 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
               TAP(KC_RIGHT);
               vstate = VIM_START;
               break;
+            case VIM_COMMA:
+            case VIM_PERIOD:
+              comma_period(keycode);
+              break;
             default:
               // do nothing
               break;
@@ -610,6 +637,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
     }
     return false;
   } else {
-    return PASS_THRU;
+    return true;
   }
 }
+
diff --git a/users/xtonhasvim/xtonhasvim.h b/users/xtonhasvim/xtonhasvim.h
index 21b794c033..5ff4932a48 100644
--- a/users/xtonhasvim/xtonhasvim.h
+++ b/users/xtonhasvim/xtonhasvim.h
@@ -26,6 +26,7 @@ bool process_record_xtonhasvim(uint16_t keycode, keyrecord_t *record);
 
 enum xtonhasvim_keycodes {
   DUMMY = SAFE_RANGE,
+  FIREY_RETURN, // kick off special effects
   VIM_START, // bookend for vim states
   VIM_A,
   VIM_B,
@@ -57,10 +58,10 @@ enum xtonhasvim_keycodes {
   VIM_SAFE_RANGE // start other keycodes here.
 };
 
-enum xtonhasvim_layers {
-  _EDIT = 12,
-  _CMD
-};
+// NOTE: YOU MUST DEFINE THIS
+extern uint8_t vim_cmd_layer(void);
+
+extern uint16_t vstate;
 
 
 #endif