Convert Encoder callbacks to be boolean functions

docs/feature_encoders.md

@@ -53,15 +53,15 @@ If you are using different pinouts for the encoders on each half of a split keyb
 The callback functions can be inserted into your `<keyboard>.c`:
 
 ```c
-void encoder_update_kb(uint8_t index, bool clockwise) {
-    encoder_update_user(index, clockwise);
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+    return encoder_update_user(index, clockwise);
 }
 ```
 
 or `keymap.c`:
 
 ```c
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) { /* First encoder */
         if (clockwise) {
             tap_code(KC_PGDN);
@@ -75,9 +75,12 @@ void encoder_update_user(uint8_t index, bool clockwise) {
             tap_code(KC_UP);
         }
     }
+    return true;
 }
 ```
 
+!> If you return `true`, this will allow the keyboard level code to run, as well.  Returning `false` will override the keyboard level code.  Depending on how the keyboard level function is set up. 
+
 ## Hardware
 
 The A an B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground.

keyboards/0xcb/1337/keymaps/default/keymap.c

@@ -50,7 +50,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 /* rotary encoder (SW3) - add more else if blocks for more granular layer control */
 #ifdef ENCODER_ENABLE
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (IS_LAYER_ON(_RGB)) {
         #ifdef RGBLIGHT_ENABLE
             if (clockwise) {
@@ -72,6 +72,7 @@ void encoder_update_user(uint8_t index, bool clockwise) {
             tap_code(KC_VOLD);
         }
     }
+    return true;
 }
 #endif
 

keyboards/0xcb/1337/keymaps/jakob/keymap.c

@@ -50,7 +50,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 /* rotary encoder (SW3) - add more else if blocks for more granular layer control */
 #ifdef ENCODER_ENABLE
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (IS_LAYER_ON(_RGB)) {
         #ifdef RGBLIGHT_ENABLE
             if (clockwise) {
@@ -72,6 +72,7 @@ void encoder_update_user(uint8_t index, bool clockwise) {
             tap_code16(C(A(KC_DOWN)));
         }
     }
+    return true;
 }
 #endif
 

keyboards/0xcb/1337/keymaps/via/keymap.c

@@ -50,7 +50,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 /* rotary encoder (SW3) - add more else if blocks for more granular layer control */
 #ifdef ENCODER_ENABLE
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (IS_LAYER_ON(_RGB)) {
         #ifdef RGBLIGHT_ENABLE
             if (clockwise) {
@@ -72,6 +72,7 @@ void encoder_update_user(uint8_t index, bool clockwise) {
             tap_code(KC_VOLD);
         }
     }
+    return true;
 }
 #endif
 

keyboards/10bleoledhub/keymaps/default/keymap.c

@@ -13,7 +13,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.*/
 /* Keymap _0: (Base Layer) Default Layer
 
    * .-----.
-   * |PGUP | 
+   * |PGUP |
    * |-----------------.
    * |  7  |  8  |  9  |
    * |-----|-----|-----|
@@ -37,12 +37,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.*/
 
 #include QMK_KEYBOARD_H
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    [0] = LAYOUT( 
+    [0] = LAYOUT(
 	    KC_PGUP,
-        KC_KP_7, KC_KP_8, MO(1), 
+        KC_KP_7, KC_KP_8, MO(1),
         KC_P4,   KC_P5,    KC_P6,
         KC_P1,   KC_P2,    KC_P3),
-    [1] = LAYOUT( 
+    [1] = LAYOUT(
         KC_NUMLOCK,
 		RGB_TOG, RGB_MOD, RGB_M_K,
         RGB_SAI, RGB_SAD, RGB_HUI,
@@ -58,14 +58,15 @@ static void render_logo(void) {
 void oled_task_user(void) { render_logo(); }
 #endif
 
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) { /* First encoder */
         if (clockwise) {
             tap_code(KC_PGDN);
         } else {
             tap_code(KC_PGUP);
         }
-  }
+    }
+    return true;
 }
 
 

keyboards/10bleoledhub/keymaps/via/keymap.c

@@ -9,11 +9,11 @@ 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/>.*/ 
+along with this program.  If not, see <http://www.gnu.org/licenses/>.*/
 /* Keymap _0: (Base Layer) Default Layer
 
    * .-----.
-   * |PGUP | 
+   * |PGUP |
    * |-----------------.
    * |  7  |  8  |  9  |
    * |-----|-----|-----|
@@ -37,12 +37,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.*/
 
 #include QMK_KEYBOARD_H
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    [0] = LAYOUT( 
+    [0] = LAYOUT(
 	    KC_PGUP,
-        KC_KP_7, KC_KP_8, MO(1), 
+        KC_KP_7, KC_KP_8, MO(1),
         KC_P4,   KC_P5,    KC_P6,
         KC_P1,   KC_P2,    KC_P3),
-    [1] = LAYOUT( 
+    [1] = LAYOUT(
         KC_NUMLOCK,
 		RGB_TOG, RGB_MOD, RGB_M_K,
         RGB_SAI, RGB_SAD, RGB_HUI,
@@ -58,14 +58,15 @@ static void render_logo(void) {
 void oled_task_user(void) { render_logo(); }
 #endif
 
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) { /* First encoder */
         if (clockwise) {
             tap_code(KC_PGDN);
         } else {
             tap_code(KC_PGUP);
         }
-  }
+    }
+    return true;
 }
 
 

keyboards/1upkeyboards/sweet16/keymaps/default/keymap.c

@@ -27,13 +27,14 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 
 #ifdef ENCODER_ENABLE
 #include "encoder.h"
-void encoder_update_user(int8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
   if (index == 0) { /* First encoder */
     if (clockwise) {
       tap_code(KC_VOLU);
     } else {
       tap_code(KC_VOLD);
     }
   }
+  return true;
 }
 #endif

keyboards/1upkeyboards/sweet16/v2/promicro/promicro.c

@@ -2,7 +2,7 @@
 #include "encoder.h"
 
 #ifdef ENCODER_ENABLED
-void encoder_update_kb(int8_t index, bool clockwise) {
-    encoder_update_user(index, clockwise);
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+    return encoder_update_user(index, clockwise);
 }
 #endif

keyboards/2key2crawl/keymaps/default/keymap.c

@@ -16,13 +16,13 @@ void matrix_init_user(void) {
 
 
 
-void encoder_update_user(int8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
   if (index == 0) {
     if (clockwise) {
       tap_code(KC_PGUP);
     } else {
       tap_code(KC_PGDN);
     }
   }
+  return true;
 }
-

keyboards/2key2crawl/keymaps/tabs/keymap.c

@@ -14,13 +14,13 @@ void matrix_init_user(void) {
   debug_config.enable = 1;
 }
 
-void encoder_update_user(int8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
   if (index == 0) {
     if (clockwise) {
       tap_code16(C(KC_T));
     } else {
       tap_code16(C(KC_W));
     }
   }
+  return true;
 }
-

keyboards/2key2crawl/keymaps/vol/keymap.c

@@ -14,12 +14,13 @@ void matrix_init_user(void) {
   debug_config.enable = 1;
 }
 
-void encoder_update_user(int8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
   if (index == 0) {
     if (clockwise) {
      tap_code(KC_VOLU);
     } else {
       tap_code(KC_VOLD);
     }
   }
+  return true;
 }

keyboards/45_ats/keymaps/default/keymap.c

@@ -1,20 +1,20 @@
- /* 
+ /*
  Copyright 2020 Alec Penland
  Copyright 2020 Garret Gartner
-  
- 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/>. 
- */ 
+
+ 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/>.
+ */
 
 #include QMK_KEYBOARD_H
 
@@ -31,7 +31,7 @@ enum ats_layers{
 #define RS_SLS RSFT_T(KC_SLSH)
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    /* Default QWERTY layer 
+    /* Default QWERTY layer
      * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐   ┌───┐
      * │Esc│ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │Del│BkS│   │PgU│
      * ├───┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴───┤   ├───┤
@@ -96,12 +96,13 @@ layer_state_t layer_state_set_user(layer_state_t state) {
     return state;
 }
 
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) {
         if (clockwise) {
             tap_code(KC_VOLU);
         } else {
             tap_code(KC_VOLD);
         }
     }
+    return true;
 }

keyboards/45_ats/keymaps/via/keymap.c

@@ -1,20 +1,20 @@
- /* 
+ /*
  Copyright 2020 Alec Penland
  Copyright 2020 Garret Gartner
-  
- 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/>. 
- */ 
+
+ 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/>.
+ */
 
 #include QMK_KEYBOARD_H
 
@@ -31,7 +31,7 @@ enum ats_layers{
 #define RS_SLS RSFT_T(KC_SLSH)
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-    /* Default QWERTY layer 
+    /* Default QWERTY layer
      * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐   ┌───┐
      * │Esc│ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │Del│BkS│   │PgU│
      * ├───┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴───┤   ├───┤
@@ -96,12 +96,13 @@ layer_state_t layer_state_set_user(layer_state_t state) {
     return state;
 }
 
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) {
         if (clockwise) {
             tap_code(KC_VOLU);
         } else {
             tap_code(KC_VOLD);
         }
     }
+    return true;
 }

keyboards/7c8/framework/keymaps/default/keymap.c

@@ -73,7 +73,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 )
 };
 
-void encoder_update_user(uint8_t index, bool clockwise) {
+bool encoder_update_user(uint8_t index, bool clockwise) {
     if (index == 0) {
         switch (get_highest_layer(layer_state)) {
             case _BASE:
@@ -93,7 +93,7 @@ void encoder_update_user(uint8_t index, bool clockwise) {
                 break;
 
             case _RAISE:
-                if (clockwise) { 
+                if (clockwise) {
                     tap_code16(LCTL(KC_RGHT));
                 } else {
                     tap_code16(LCTL(KC_LEFT));
@@ -120,6 +120,7 @@ void encoder_update_user(uint8_t index, bool clockwise) {
                 break;
         }
     }
+    return true;
 }
 
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {