quantum/quantum.h

   1 /* Copyright 2016-2017 Erez Zukerman, Jack Humbert
   2  *
   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  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #ifndef QUANTUM_H
  17 #define QUANTUM_H
  18
  19 #if defined(__AVR__)
  20 #include <avr/pgmspace.h>
  21 #include <avr/io.h>
  22 #include <avr/interrupt.h>
  23 #endif
  24 #include "wait.h"
  25 #include "matrix.h"
  26 #include "keymap.h"
  27 #ifdef BACKLIGHT_ENABLE
  28     #include "backlight.h"
  29 #endif
  30 #ifdef RGBLIGHT_ENABLE
  31   #include "rgblight.h"
  32 #endif
  33 #include "action_layer.h"
  34 #include "eeconfig.h"
  35 #include <stddef.h>
  36 #include "bootloader.h"
  37 #include "timer.h"
  38 #include "config_common.h"
  39 #include "led.h"
  40 #include "action_util.h"
  41 #include <stdlib.h>
  42 #include "print.h"
  43 #include "send_string_keycodes.h"
  44
  45 extern uint32_t default_layer_state;
  46
  47 #ifndef NO_ACTION_LAYER
  48         extern uint32_t layer_state;
  49 #endif
  50
  51 #ifdef MIDI_ENABLE
  52         #include <lufa.h>
  53 #ifdef MIDI_ADVANCED
  54         #include "process_midi.h"
  55 #endif
  56 #endif // MIDI_ENABLE
  57
  58 #ifdef AUDIO_ENABLE
  59         #include "audio.h"
  60         #include "process_audio.h"
  61 #endif
  62
  63 #ifdef STENO_ENABLE
  64         #include "process_steno.h"
  65 #endif
  66
  67 #if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
  68         #include "process_music.h"
  69 #endif
  70
  71 #ifndef DISABLE_LEADER
  72         #include "process_leader.h"
  73 #endif
  74
  75 #define DISABLE_CHORDING
  76 #ifndef DISABLE_CHORDING
  77         #include "process_chording.h"
  78 #endif
  79
  80 #ifdef UNICODE_ENABLE
  81         #include "process_unicode.h"
  82 #endif
  83
  84 #ifdef UCIS_ENABLE
  85         #include "process_ucis.h"
  86 #endif
  87
  88 #ifdef UNICODEMAP_ENABLE
  89         #include "process_unicodemap.h"
  90 #endif
  91
  92 #include "process_tap_dance.h"
  93
  94 #ifdef PRINTING_ENABLE
  95         #include "process_printer.h"
  96 #endif
  97
  98 #ifdef AUTO_SHIFT_ENABLE
  99         #include "process_auto_shift.h"
 100 #endif
 101
 102 #ifdef COMBO_ENABLE
 103         #include "process_combo.h"
 104 #endif
 105
 106 #ifdef KEY_LOCK_ENABLE
 107         #include "process_key_lock.h"
 108 #endif
 109
 110 #ifdef TERMINAL_ENABLE
 111         #include "process_terminal.h"
 112 #else
 113         #include "process_terminal_nop.h"
 114 #endif
 115
 116 #define STRINGIZE(z) #z
 117 #define ADD_SLASH_X(y) STRINGIZE(\x ## y)
 118 #define SYMBOL_STR(x) ADD_SLASH_X(x)
 119
 120 #define SS_TAP(keycode) "\1" SYMBOL_STR(keycode)
 121 #define SS_DOWN(keycode) "\2" SYMBOL_STR(keycode)
 122 #define SS_UP(keycode) "\3" SYMBOL_STR(keycode)
 123
 124 #define SS_LCTRL(string) SS_DOWN(X_LCTRL) string SS_UP(X_LCTRL)
 125 #define SS_LGUI(string) SS_DOWN(X_LGUI) string SS_UP(X_LGUI)
 126 #define SS_LALT(string) SS_DOWN(X_LALT) string SS_UP(X_LALT)
 127 #define SS_LSFT(string) SS_DOWN(X_LSHIFT) string SS_UP(X_LSHIFT)
 128
 129 #define SEND_STRING(str) send_string_P(PSTR(str))
 130 extern const bool ascii_to_shift_lut[0x80];
 131 extern const uint8_t ascii_to_keycode_lut[0x80];
 132 void send_string(const char *str);
 133 void send_string_with_delay(const char *str, uint8_t interval);
 134 void send_string_P(const char *str);
 135 void send_string_with_delay_P(const char *str, uint8_t interval);
 136 void send_char(char ascii_code);
 137
 138 // For tri-layer
 139 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3);
 140
 141 void set_single_persistent_default_layer(uint8_t default_layer);
 142
 143 void tap_random_base64(void);
 144
 145 #define IS_LAYER_ON(layer)  (layer_state & (1UL << (layer)))
 146 #define IS_LAYER_OFF(layer) (~layer_state & (1UL << (layer)))
 147
 148 void matrix_init_kb(void);
 149 void matrix_scan_kb(void);
 150 void matrix_init_user(void);
 151 void matrix_scan_user(void);
 152 bool process_action_kb(keyrecord_t *record);
 153 bool process_record_kb(uint16_t keycode, keyrecord_t *record);
 154 bool process_record_user(uint16_t keycode, keyrecord_t *record);
 155
 156 void reset_keyboard(void);
 157
 158 void startup_user(void);
 159 void shutdown_user(void);
 160
 161 void register_code16 (uint16_t code);
 162 void unregister_code16 (uint16_t code);
 163
 164 #ifdef BACKLIGHT_ENABLE
 165 void backlight_init_ports(void);
 166 void backlight_task(void);
 167
 168 #ifdef BACKLIGHT_BREATHING
 169 void breathing_enable(void);
 170 void breathing_pulse(void);
 171 void breathing_disable(void);
 172 void breathing_self_disable(void);
 173 void breathing_toggle(void);
 174 bool is_breathing(void);
 175
 176 void breathing_defaults(void);
 177 void breathing_intensity_default(void);
 178 void breathing_speed_default(void);
 179 void breathing_speed_set(uint8_t value);
 180 void breathing_speed_inc(uint8_t value);
 181 void breathing_speed_dec(uint8_t value);
 182 #endif
 183
 184 #endif
 185 void send_dword(uint32_t number);
 186 void send_word(uint16_t number);
 187 void send_byte(uint8_t number);
 188 void send_nibble(uint8_t number);
 189 uint16_t hex_to_keycode(uint8_t hex);
 190
 191 void led_set_user(uint8_t usb_led);
 192 void led_set_kb(uint8_t usb_led);
 193
 194 void api_send_unicode(uint32_t unicode);
 195
 196 #endif