logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

action_util.h (3728B)

    

  1. /*
  2. Copyright 2013 Jun Wako <wakojun@gmail.com>
  4. This program is free software: you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation, either version 2 of the License, or
  7. (at your option) any later version.
  9. This program is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12. GNU General Public License for more details.
  14. You should have received a copy of the GNU General Public License
  15. along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16. */
  18. #pragma once
  20. #include <stdint.h>
  21. #include "report.h"
  22. #include "modifiers.h"
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  28. extern report_keyboard_t *keyboard_report;
  29. #ifdef NKRO_ENABLE
  30. extern report_nkro_t *nkro_report;
  31. #endif
  33. void send_keyboard_report(void);
  35. /* key */
  36. inline void add_key(uint8_t key) {
  37.     add_key_to_report(key);
  38. }
  40. inline void del_key(uint8_t key) {
  41.     del_key_from_report(key);
  42. }
  44. inline void clear_keys(void) {
  45.     clear_keys_from_report();
  46. }
  48. /* modifier */
  49. uint8_t get_mods(void);
  50. void    add_mods(uint8_t mods);
  51. void    del_mods(uint8_t mods);
  52. void    set_mods(uint8_t mods);
  53. void    clear_mods(void);
  55. /* weak modifier */
  56. uint8_t get_weak_mods(void);
  57. void    add_weak_mods(uint8_t mods);
  58. void    del_weak_mods(uint8_t mods);
  59. void    set_weak_mods(uint8_t mods);
  60. void    clear_weak_mods(void);
  62. /* oneshot modifier */
  63. uint8_t get_oneshot_mods(void);
  64. void    add_oneshot_mods(uint8_t mods);
  65. void    del_oneshot_mods(uint8_t mods);
  66. void    set_oneshot_mods(uint8_t mods);
  67. void    clear_oneshot_mods(void);
  68. bool    has_oneshot_mods_timed_out(void);
  70. uint8_t get_oneshot_locked_mods(void);
  71. void    add_oneshot_locked_mods(uint8_t mods);
  72. void    set_oneshot_locked_mods(uint8_t mods);
  73. void    clear_oneshot_locked_mods(void);
  74. void    del_oneshot_locked_mods(uint8_t mods);
  76. typedef enum { ONESHOT_PRESSED = 0b01, ONESHOT_OTHER_KEY_PRESSED = 0b10, ONESHOT_START = 0b11, ONESHOT_TOGGLED = 0b100 } oneshot_fullfillment_t;
  77. void    set_oneshot_layer(uint8_t layer, uint8_t state);
  78. uint8_t get_oneshot_layer(void);
  79. void    clear_oneshot_layer_state(oneshot_fullfillment_t state);
  80. void    reset_oneshot_layer(void);
  81. bool    is_oneshot_layer_active(void);
  82. uint8_t get_oneshot_layer_state(void);
  83. bool    has_oneshot_layer_timed_out(void);
  84. bool    has_oneshot_swaphands_timed_out(void);
  86. void oneshot_locked_mods_changed_user(uint8_t mods);
  87. void oneshot_locked_mods_changed_kb(uint8_t mods);
  88. void oneshot_mods_changed_user(uint8_t mods);
  89. void oneshot_mods_changed_kb(uint8_t mods);
  90. void oneshot_layer_changed_user(uint8_t layer);
  91. void oneshot_layer_changed_kb(uint8_t layer);
  93. void oneshot_toggle(void);
  94. void oneshot_enable(void);
  95. void oneshot_disable(void);
  96. bool is_oneshot_enabled(void);
  98. /* inspect */
  99. uint8_t has_anymod(void);
  101. #ifdef SWAP_HANDS_ENABLE
  102. void set_oneshot_swaphands(void);
  103. void release_oneshot_swaphands(void);
  104. void use_oneshot_swaphands(void);
  105. void clear_oneshot_swaphands(void);
  106. #endif
  108. #ifdef DUMMY_MOD_NEUTRALIZER_KEYCODE
  109. // KC_A is used as the lowerbound instead of QK_BASIC because the range QK_BASIC...KC_A includes
  110. // internal keycodes like KC_NO and KC_TRANSPARENT which are unsuitable for use with `tap_code(kc)`.
  111. #    if !(KC_A <= DUMMY_MOD_NEUTRALIZER_KEYCODE && DUMMY_MOD_NEUTRALIZER_KEYCODE <= QK_BASIC_MAX)
  112. #        error "DUMMY_MOD_NEUTRALIZER_KEYCODE must be a basic, unmodified, HID keycode!"
  113. #    endif
  114. void neutralize_flashing_modifiers(uint8_t active_mods);
  115. #endif
  116. #ifndef MODS_TO_NEUTRALIZE
  117. #    define MODS_TO_NEUTRALIZE \
  118.         { MOD_BIT(KC_LEFT_ALT), MOD_BIT(KC_LEFT_GUI) }
  119. #endif
  121. #ifdef __cplusplus
  122. }
  123. #endif