mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-25 12:46:41 +00:00
91 lines
4.2 KiB
C
91 lines
4.2 KiB
C
// Copyright 2022 Nick Brassel (@tzarc)
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Key mapping
|
|
|
|
// Get the number of layers defined in the keymap, stored in firmware rather than any other persistent storage
|
|
uint8_t keymap_layer_count_raw(void);
|
|
// Get the number of layers defined in the keymap, potentially stored dynamically
|
|
uint8_t keymap_layer_count(void);
|
|
|
|
// Get the keycode for the keymap location, stored in firmware rather than any other persistent storage
|
|
uint16_t keycode_at_keymap_location_raw(uint8_t layer_num, uint8_t row, uint8_t column);
|
|
// Get the keycode for the keymap location, potentially stored dynamically
|
|
uint16_t keycode_at_keymap_location(uint8_t layer_num, uint8_t row, uint8_t column);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Encoder mapping
|
|
|
|
#if defined(ENCODER_ENABLE) && defined(ENCODER_MAP_ENABLE)
|
|
|
|
// Get the number of layers defined in the encoder map, stored in firmware rather than any other persistent storage
|
|
uint8_t encodermap_layer_count_raw(void);
|
|
// Get the number of layers defined in the encoder map, potentially stored dynamically
|
|
uint8_t encodermap_layer_count(void);
|
|
|
|
// Get the keycode for the encoder mapping location, stored in firmware rather than any other persistent storage
|
|
uint16_t keycode_at_encodermap_location_raw(uint8_t layer_num, uint8_t encoder_idx, bool clockwise);
|
|
// Get the keycode for the encoder mapping location, potentially stored dynamically
|
|
uint16_t keycode_at_encodermap_location(uint8_t layer_num, uint8_t encoder_idx, bool clockwise);
|
|
|
|
#endif // defined(ENCODER_ENABLE) && defined(ENCODER_MAP_ENABLE)
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Dip Switch mapping
|
|
|
|
#if defined(DIP_SWITCH_ENABLE) && defined(DIP_SWITCH_MAP_ENABLE)
|
|
|
|
// Get the keycode for the dip_switch mapping location, stored in firmware rather than any other persistent storage
|
|
uint16_t keycode_at_dip_switch_map_location_raw(uint8_t switch_idx, bool on);
|
|
// Get the keycode for the dip_switch mapping location, potentially stored dynamically
|
|
uint16_t keycode_at_dip_switch_map_location(uint8_t switch_idx, bool on);
|
|
|
|
#endif // defined(DIP_SWITCH_ENABLE) && defined(DIP_SWITCH_MAP_ENABLE)
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Combos
|
|
|
|
#if defined(COMBO_ENABLE)
|
|
|
|
// Forward declaration of combo_t so we don't need to deal with header reordering
|
|
struct combo_t;
|
|
typedef struct combo_t combo_t;
|
|
|
|
// Get the number of combos defined in the user's keymap, stored in firmware rather than any other persistent storage
|
|
uint16_t combo_count_raw(void);
|
|
// Get the number of combos defined in the user's keymap, potentially stored dynamically
|
|
uint16_t combo_count(void);
|
|
|
|
// Get the combo definition, stored in firmware rather than any other persistent storage
|
|
combo_t* combo_get_raw(uint16_t combo_idx);
|
|
// Get the combo definition, potentially stored dynamically
|
|
combo_t* combo_get(uint16_t combo_idx);
|
|
|
|
#endif // defined(COMBO_ENABLE)
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Tap Dance
|
|
|
|
#if defined(TAP_DANCE_ENABLE)
|
|
|
|
// Forward declaration of tap_dance_action_t so we don't need to deal with header reordering
|
|
struct tap_dance_action_t;
|
|
typedef struct tap_dance_action_t tap_dance_action_t;
|
|
|
|
// Get the number of tap dances defined in the user's keymap, stored in firmware rather than any other persistent storage
|
|
uint16_t tap_dance_count_raw(void);
|
|
// Get the number of tap dances defined in the user's keymap, potentially stored dynamically
|
|
uint16_t tap_dance_count(void);
|
|
|
|
// Get the tap dance definitions, stored in firmware rather than any other persistent storage
|
|
tap_dance_action_t* tap_dance_get_raw(uint16_t tap_dance_idx);
|
|
// Get the tap dance definitions, potentially stored dynamically
|
|
tap_dance_action_t* tap_dance_get(uint16_t tap_dance_idx);
|
|
|
|
#endif // defined(TAP_DANCE_ENABLE)
|