quantum/quantum.h

   1 #ifndef QUANTUM_H
   2 #define QUANTUM_H
   3
   4 #include <avr/pgmspace.h>
   5 #include "matrix.h"
   6 #include "keymap.h"
   7 #ifdef BACKLIGHT_ENABLE
   8     #include "backlight.h"
   9 #endif
  10 #ifdef RGBLIGHT_ENABLE
  11   #include "rgblight.h"
  12 #endif
  13 #ifdef AUDIO_ENABLE
  14   #include "audio.h"
  15 #endif
  16 #ifdef MIDI_ENABLE
  17         #include <lufa.h>
  18 #endif
  19 #ifdef UNICODE_ENABLE
  20         #include "unicode.h"
  21 #endif
  22
  23 #include "action_layer.h"
  24 #include "eeconfig.h"
  25 #include <stddef.h>
  26 #include <avr/io.h>
  27 #include <util/delay.h>
  28 #include "bootloader.h"
  29 #include "timer.h"
  30 #include "config_common.h"
  31 #include <avr/interrupt.h>
  32 #include "led.h"
  33 #include "action_util.h"
  34
  35 extern uint32_t default_layer_state;
  36
  37 #ifndef NO_ACTION_LAYER
  38         extern uint32_t layer_state;
  39 #endif
  40
  41 #ifdef AUDIO_ENABLE
  42         bool music_activated;
  43 #endif
  44
  45 #ifdef UNICODE_ENABLE
  46         #define UC_OSX 0
  47         #define UC_LNX 1
  48         #define UC_WIN 2
  49         #define UC_BSD 3
  50
  51         void set_unicode_input_mode(uint8_t os_target);
  52 #endif
  53
  54 #ifndef DISABLE_LEADER
  55         void leader_start(void);
  56         void leader_end(void);
  57
  58         #ifndef LEADER_TIMEOUT
  59                 #define LEADER_TIMEOUT 200
  60         #endif
  61         #define SEQ_ONE_KEY(key) if (leader_sequence[0] == (key) && leader_sequence[1] == 0 && leader_sequence[2] == 0 && leader_sequence[3] == 0 && leader_sequence[4] == 0)
  62         #define SEQ_TWO_KEYS(key1, key2) if (leader_sequence[0] == (key1) && leader_sequence[1] == (key2) && leader_sequence[2] == 0 && leader_sequence[3] == 0 && leader_sequence[4] == 0)
  63         #define SEQ_THREE_KEYS(key1, key2, key3) if (leader_sequence[0] == (key1) && leader_sequence[1] == (key2) && leader_sequence[2] == (key3) && leader_sequence[3] == 0 && leader_sequence[4] == 0)
  64         #define SEQ_FOUR_KEYS(key1, key2, key3, key4) if (leader_sequence[0] == (key1) && leader_sequence[1] == (key2) && leader_sequence[2] == (key3) && leader_sequence[3] == (key4) && leader_sequence[4] == 0)
  65         #define SEQ_FIVE_KEYS(key1, key2, key3, key4, key5) if (leader_sequence[0] == (key1) && leader_sequence[1] == (key2) && leader_sequence[2] == (key3) && leader_sequence[3] == (key4) && leader_sequence[4] == (key5))
  66
  67         #define LEADER_EXTERNS() extern bool leading; extern uint16_t leader_time; extern uint16_t leader_sequence[5]; extern uint8_t leader_sequence_size
  68         #define LEADER_DICTIONARY() if (leading && timer_elapsed(leader_time) > LEADER_TIMEOUT)
  69 #endif
  70
  71 #define SEND_STRING(str) send_string(PSTR(str))
  72 void send_string(const char *str);
  73
  74 // For tri-layer
  75 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3);
  76 #define IS_LAYER_ON(layer)  (layer_state & (1UL << (layer)))
  77 #define IS_LAYER_OFF(layer) (~layer_state & (1UL << (layer)))
  78
  79 void matrix_init_kb(void);
  80 void matrix_scan_kb(void);
  81 void matrix_init_user(void);
  82 void matrix_scan_user(void);
  83 bool process_action_kb(keyrecord_t *record);
  84 bool process_record_kb(uint16_t keycode, keyrecord_t *record);
  85 bool process_record_user(uint16_t keycode, keyrecord_t *record);
  86
  87 bool is_music_on(void);
  88 void music_toggle(void);
  89 void music_on(void);
  90 void music_off(void);
  91
  92 void startup_user(void);
  93 void shutdown_user(void);
  94 void audio_on_user(void);
  95 void music_on_user(void);
  96 void music_scale_user(void);
  97
  98 #ifdef BACKLIGHT_ENABLE
  99 void backlight_init_ports(void);
 100
 101 #ifdef BACKLIGHT_BREATHING
 102 void breathing_enable(void);
 103 void breathing_pulse(void);
 104 void breathing_disable(void);
 105 void breathing_self_disable(void);
 106 void breathing_toggle(void);
 107 bool is_breathing(void);
 108
 109 void breathing_defaults(void);
 110 void breathing_intensity_default(void);
 111 void breathing_speed_default(void);
 112 void breathing_speed_set(uint8_t value);
 113 void breathing_speed_inc(uint8_t value);
 114 void breathing_speed_dec(uint8_t value);
 115 #endif
 116
 117 #endif
 118
 119 void led_set_user(uint8_t usb_led);
 120 void led_set_kb(uint8_t usb_led);
 121
 122 #endif