quantum/process_keycode/process_ucis.h

   1 /* Copyright 2017 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
  17 #pragma once
  18
  19 #include "quantum.h"
  20 #include "process_unicode_common.h"
  21
  22 #ifndef UCIS_MAX_SYMBOL_LENGTH
  23 #    define UCIS_MAX_SYMBOL_LENGTH 32
  24 #endif
  25
  26 typedef struct {
  27     char *symbol;
  28     char *code;
  29 } qk_ucis_symbol_t;
  30
  31 typedef struct {
  32     uint8_t  count;
  33     uint16_t codes[UCIS_MAX_SYMBOL_LENGTH];
  34     bool     in_progress : 1;
  35 } qk_ucis_state_t;
  36
  37 extern qk_ucis_state_t qk_ucis_state;
  38
  39 #define UCIS_TABLE(...)             \
  40     {                               \
  41         __VA_ARGS__, { NULL, NULL } \
  42     }
  43 #define UCIS_SYM(name, code) \
  44     { name, #code }
  45
  46 extern const qk_ucis_symbol_t ucis_symbol_table[];
  47
  48 void qk_ucis_start(void);
  49 void qk_ucis_start_user(void);
  50 void qk_ucis_symbol_fallback(void);
  51 void qk_ucis_success(uint8_t symbol_index);
  52 void register_ucis(const char *hex);
  53 bool process_ucis(uint16_t keycode, keyrecord_t *record);