You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
97 lines
3.1 KiB
97 lines
3.1 KiB
/* -*- mode: c++ -*-
|
|
* Kaleidoscope-Ranges -- Common ranges, used by a number of Kaleidoscope plugins.
|
|
* Copyright (C) 2016, 2017, 2019 Keyboard.io, Inc
|
|
*
|
|
* 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, version 3.
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h> // for uint16_t
|
|
|
|
// Included for definition of legacy Macros plugin key range:
|
|
#include "kaleidoscope/key_defs.h"
|
|
|
|
namespace kaleidoscope {
|
|
namespace ranges {
|
|
|
|
// NOTE: We need to keep the ranges stable, and backwards compatible!
|
|
//
|
|
// When adding, removing, or changing ranges, make sure that existing ranges are
|
|
// never accidentally moved. If migrating keycodes that weren't previously using
|
|
// the range system, make sure you don't change the `Key` values. If an existing
|
|
// `Key` value is changed, it won't be a problem for the Kaleidoscope sketch
|
|
// itself, but it will cause problems for keymap entries stored in EEPROM
|
|
// (i.e. Chrysalis keymap layers), which will not get updated by flashing the
|
|
// firmware.
|
|
//
|
|
// When adding new `Key` values for plugins, to keep them backwards-compatible,
|
|
// they must be added at the end of the range below (just before `SAFE_START`),
|
|
// even if those values are logically related to existing ones. This is
|
|
// important for compatibility with existing Chrysalis keymaps, despite the fact
|
|
// that it makes the code more obtuse here.
|
|
|
|
constexpr uint8_t MAX_CS_KEYS = 64;
|
|
|
|
enum : uint16_t {
|
|
// Macro ranges pre-date Kaleidoscope-Ranges, so they're coming before
|
|
// ranges::FIRST, because we want to keep the keycodes backwards compatible.
|
|
// This is undesirable, because it prevents us from making a clear distinction
|
|
// between plugin key values and core key values. The magic number
|
|
// `0b00100000` is the old `IS_MACRO` key flags bit.
|
|
MACRO_FIRST = (SYNTHETIC | 0b00100000) << 8,
|
|
MACRO_LAST = MACRO_FIRST + 255,
|
|
|
|
FIRST = 0xc000,
|
|
KALEIDOSCOPE_FIRST = FIRST,
|
|
OS_FIRST,
|
|
OSM_FIRST = OS_FIRST,
|
|
OSM_LAST = OSM_FIRST + 7,
|
|
OSL_FIRST,
|
|
OSL_LAST = OSL_FIRST + 7,
|
|
OS_LAST = OSL_LAST,
|
|
DU_FIRST,
|
|
DUM_FIRST = DU_FIRST,
|
|
DUM_LAST = DUM_FIRST + (8 << 8),
|
|
DUL_FIRST,
|
|
DUL_LAST = DUL_FIRST + (8 << 8),
|
|
DU_LAST = DUL_LAST,
|
|
TD_FIRST,
|
|
TD_LAST = TD_FIRST + 15,
|
|
LEAD_FIRST,
|
|
LEAD_LAST = LEAD_FIRST + 7,
|
|
CYCLE,
|
|
SYSTER,
|
|
TT_FIRST,
|
|
TT_LAST = TT_FIRST + 255,
|
|
STENO_FIRST,
|
|
STENO_LAST = STENO_FIRST + 42,
|
|
SC_FIRST,
|
|
SC_LAST,
|
|
REDIAL,
|
|
TURBO,
|
|
DYNAMIC_MACRO_FIRST,
|
|
DYNAMIC_MACRO_LAST = DYNAMIC_MACRO_FIRST + 31,
|
|
OS_META_STICKY,
|
|
OS_ACTIVE_STICKY,
|
|
OS_CANCEL,
|
|
CS_FIRST,
|
|
CS_LAST = CS_FIRST + MAX_CS_KEYS,
|
|
|
|
SAFE_START,
|
|
KALEIDOSCOPE_SAFE_START = SAFE_START
|
|
};
|
|
|
|
}
|
|
}
|