common/layer_switch.h

   1 /*
   2 Copyright 2013 Jun Wako <wakojun@gmail.com>
   3
   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.
   8
   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.
  13
  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 */
  17 #ifndef LAYER_SWITCH_H
  18 #define LAYER_SWITCH_H
  19
  20 #include <stdint.h>
  21 #include "keyboard.h"
  22 #include "action.h"
  23
  24
  25 /* overlays are asigned at layer 16-31 */
  26 #define OVERLAY_BIT      0x10
  27 #define OVERLAY_MASK     0x0F
  28
  29
  30 /*
  31  * Default Layer
  32  */
  33 /* base layer to fall back */
  34 extern uint8_t default_layer;
  35 void default_layer_set(uint8_t layer);
  36
  37
  38 /*
  39  * Keymap Layer
  40  */
  41 extern uint16_t keymap_stat;
  42 /* return current active layer */
  43 uint8_t keymap_get_layer(void);
  44 void keymap_clear(void);
  45 void keymap_set(uint16_t stat);
  46 void keymap_move(uint8_t layer);
  47 void keymap_on(uint8_t layer);
  48 void keymap_off(uint8_t layer);
  49 void keymap_invert(uint8_t layer);
  50 /* bitwise operation */
  51 void keymap_or(uint16_t stat);
  52 void keymap_and(uint16_t stat);
  53 void keymap_xor(uint16_t stat);
  54 void keymap_debug(void);
  55
  56
  57 /*
  58  * Overlay Layer
  59  */
  60 extern uint16_t overlay_stat;
  61 /* return current active layer */
  62 uint8_t overlay_get_layer(void);
  63 void overlay_clear(void);
  64 void overlay_set(uint16_t stat);
  65 void overlay_move(uint8_t layer);
  66 void overlay_on(uint8_t layer);
  67 void overlay_off(uint8_t layer);
  68 void overlay_invert(uint8_t layer);
  69 /* bitwise operation */
  70 void overlay_or(uint16_t stat);
  71 void overlay_and(uint16_t stat);
  72 void overlay_xor(uint16_t stat);
  73 void overlay_debug(void);
  74
  75
  76
  77 /* return action depending on current layer status */
  78 action_t layer_switch_get_action(key_t key);
  79
  80 #endif