action_layer.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. /*
  2. Copyright 2013 Jun Wako <wakojun@gmail.com>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. #ifndef ACTION_LAYER_H
  15. #define ACTION_LAYER_H
  16. #include <stdint.h>
  17. #include "keyboard.h"
  18. #include "action.h"
  19. #if defined(LAYER_STATE_8BIT)
  20. typedef uint8_t layer_state_t;
  21. # define get_highest_layer(state) biton8(state)
  22. #elif defined(LAYER_STATE_16BIT)
  23. typedef uint16_t layer_state_t;
  24. # define get_highest_layer(state) biton16(state)
  25. #else
  26. typedef uint32_t layer_state_t;
  27. # define get_highest_layer(state) biton32(state)
  28. #endif
  29. /*
  30. * Default Layer
  31. */
  32. extern layer_state_t default_layer_state;
  33. void default_layer_debug(void);
  34. void default_layer_set(layer_state_t state);
  35. __attribute__((weak)) layer_state_t default_layer_state_set_kb(layer_state_t state);
  36. __attribute__((weak)) layer_state_t default_layer_state_set_user(layer_state_t state);
  37. #ifndef NO_ACTION_LAYER
  38. /* bitwise operation */
  39. void default_layer_or(layer_state_t state);
  40. void default_layer_and(layer_state_t state);
  41. void default_layer_xor(layer_state_t state);
  42. #else
  43. # define default_layer_or(state)
  44. # define default_layer_and(state)
  45. # define default_layer_xor(state)
  46. #endif
  47. /*
  48. * Keymap Layer
  49. */
  50. #ifndef NO_ACTION_LAYER
  51. extern layer_state_t layer_state;
  52. void layer_state_set(layer_state_t state);
  53. bool layer_state_is(uint8_t layer);
  54. bool layer_state_cmp(layer_state_t layer1, uint8_t layer2);
  55. void layer_debug(void);
  56. void layer_clear(void);
  57. void layer_move(uint8_t layer);
  58. void layer_on(uint8_t layer);
  59. void layer_off(uint8_t layer);
  60. void layer_invert(uint8_t layer);
  61. /* bitwise operation */
  62. void layer_or(layer_state_t state);
  63. void layer_and(layer_state_t state);
  64. void layer_xor(layer_state_t state);
  65. #else
  66. # define layer_state 0
  67. # define layer_state_set(layer)
  68. # define layer_state_is(layer) (layer == 0)
  69. # define layer_state_cmp(state, layer) (state == 0 ? layer == 0 : (state & 1UL << layer) != 0)
  70. # define layer_debug()
  71. # define layer_clear()
  72. # define layer_move(layer)
  73. # define layer_on(layer)
  74. # define layer_off(layer)
  75. # define layer_invert(layer)
  76. # define layer_or(state)
  77. # define layer_and(state)
  78. # define layer_xor(state)
  79. #endif
  80. layer_state_t layer_state_set_user(layer_state_t state);
  81. layer_state_t layer_state_set_kb(layer_state_t state);
  82. /* pressed actions cache */
  83. #if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
  84. /* The number of bits needed to represent the layer number: log2(32). */
  85. # define MAX_LAYER_BITS 5
  86. void update_source_layers_cache(keypos_t key, uint8_t layer);
  87. uint8_t read_source_layers_cache(keypos_t key);
  88. #endif
  89. action_t store_or_get_action(bool pressed, keypos_t key);
  90. /* return the topmost non-transparent layer currently associated with key */
  91. uint8_t layer_switch_get_layer(keypos_t key);
  92. /* return action depending on current layer status */
  93. action_t layer_switch_get_action(keypos_t key);
  94. #endif