Do some cleanup for the API

[qmk_firmware.git] / quantum / quantum.h

diff --git a/quantum/quantum.h b/quantum/quantum.h
index e6adf974aba58aa006a876c58d00f2d19d6099c7..534819c818bf9df16b289d197572eded859d4c3f 100644 (file)
--- a/quantum/quantum.h
+++ b/quantum/quantum.h
@@ -1,3 +1,18 @@
+/* Copyright 2016-2017 Erez Zukerman, Jack Humbert
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 #ifndef QUANTUM_H
 #define QUANTUM_H
 
@@ -15,7 +30,6 @@
 #ifdef RGBLIGHT_ENABLE
   #include "rgblight.h"
 #endif
-
 #include "action_layer.h"
 #include "eeconfig.h"
 #include <stddef.h>
@@ -26,7 +40,7 @@
 #include "action_util.h"
 #include <stdlib.h>
 #include "print.h"
-
+#include "send_string_keycodes.h"
 
 extern uint32_t default_layer_state;
 
@@ -36,11 +50,21 @@ extern uint32_t default_layer_state;
 
 #ifdef MIDI_ENABLE
        #include <lufa.h>
+#ifdef MIDI_ADVANCED
        #include "process_midi.h"
 #endif
+#endif // MIDI_ENABLE
 
 #ifdef AUDIO_ENABLE
-       #include "audio.h"
+       #include "audio.h"
+       #include "process_audio.h"
+#endif
+
+#ifdef STENO_ENABLE
+       #include "process_steno.h"
+#endif
+
+#if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
        #include "process_music.h"
 #endif
 
@@ -57,18 +81,64 @@ extern uint32_t default_layer_state;
        #include "process_unicode.h"
 #endif
 
+#ifdef UCIS_ENABLE
+       #include "process_ucis.h"
+#endif
+
+#ifdef UNICODEMAP_ENABLE
+       #include "process_unicodemap.h"
+#endif
+
 #include "process_tap_dance.h"
 
 #ifdef PRINTING_ENABLE
        #include "process_printer.h"
 #endif
 
-#define SEND_STRING(str) send_string(PSTR(str))
+#ifdef AUTO_SHIFT_ENABLE
+       #include "process_auto_shift.h"
+#endif
+
+#ifdef COMBO_ENABLE
+       #include "process_combo.h"
+#endif
+
+#ifdef KEY_LOCK_ENABLE
+       #include "process_key_lock.h"
+#endif
+
+#ifdef TERMINAL_ENABLE
+       #include "process_terminal.h"
+#else
+       #include "process_terminal_nop.h"
+#endif
+
+#define STRINGIZE(z) #z
+#define ADD_SLASH_X(y) STRINGIZE(\x ## y)
+#define SYMBOL_STR(x) ADD_SLASH_X(x)
+
+#define SS_TAP(keycode) "\1" SYMBOL_STR(keycode)
+#define SS_DOWN(keycode) "\2" SYMBOL_STR(keycode)
+#define SS_UP(keycode) "\3" SYMBOL_STR(keycode)
+
+#define SS_LCTRL(string) SS_DOWN(X_LCTRL) string SS_UP(X_LCTRL)
+#define SS_LGUI(string) SS_DOWN(X_LGUI) string SS_UP(X_LGUI)
+#define SS_LALT(string) SS_DOWN(X_LALT) string SS_UP(X_LALT)
+
+#define SEND_STRING(str) send_string_P(PSTR(str))
+extern const bool ascii_to_shift_lut[0x80];
+extern const uint8_t ascii_to_keycode_lut[0x80];
 void send_string(const char *str);
+void send_string_with_delay(const char *str, uint8_t interval);
+void send_string_P(const char *str);
+void send_string_with_delay_P(const char *str, uint8_t interval);
+void send_char(char ascii_code);
 
 // For tri-layer
 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3);
 
+void set_single_persistent_default_layer(uint8_t default_layer);
+
 void tap_random_base64(void);
 
 #define IS_LAYER_ON(layer)  (layer_state & (1UL << (layer)))
@@ -92,6 +162,7 @@ void unregister_code16 (uint16_t code);
 
 #ifdef BACKLIGHT_ENABLE
 void backlight_init_ports(void);
+void backlight_task(void);
 
 #ifdef BACKLIGHT_BREATHING
 void breathing_enable(void);
@@ -114,7 +185,7 @@ void send_dword(uint32_t number);
 void send_word(uint16_t number);
 void send_byte(uint8_t number);
 void send_nibble(uint8_t number);
-
+uint16_t hex_to_keycode(uint8_t hex);
 
 void led_set_user(uint8_t usb_led);
 void led_set_kb(uint8_t usb_led);