mirror of
https://github.com/zsa/qmk_firmware.git
synced 2026-05-04 14:55:29 +00:00
Additional updates for firmware25 (#411)
* add 75_(ansi|iso) Community Layouts to mechlovin/olly/octagon (#22459) * expand mechlovin/olly/octagon * Update info.json * Rename info.json to keyboard.json * correct matrix position for key * remove VIA * [Core] get_keycode_string(): function to format keycodes as strings, for more readable debug logging. (#24787) * keycode_string(): Format keycodes as strings. This adds the `keycode_string()` function described in https://getreuer.info/posts/keyboards/keycode-string/index.html as a core feature. * Fix formatting. * keycode_string review revisions. * Rename keycode_string() -> get_keycode_string() for consistency with existing string utils like get_u8_str(). * Revise custom keycode names with separate _user and _kb tables. * Correct indent in builddefs/generic_features.mk. Co-authored-by: Ryan <fauxpark@gmail.com> * Add KC_NUHS, KC_NUBS, and KC_CAPS. * Fix linking error with custom names. * Attempt at simplifying interface. * Formatting fix. * Several fixes and revisions. * Don't use PSTR in KEYCODE_STRING_NAME, since this fails to build on AVR. Store custom names in RAM. * Revise the internal table of common keycode names to use its own storage representation, still in PROGMEM, and now more efficiently stored flat in 8 bytes per entry. * Support Swap Hands keycodes and a few other keycodes. * Revert "Formatting fix." This reverts commit 2a2771068c7ee545ffac4103aa07e847a9ec3816. * Revert "Attempt at simplifying interface." This reverts commit 8eaf67de76e75bc92d106a8b0decc893fbc65fa5. * Simplify custom names API by sigprof's suggestion. * Support more keycodes. * Add QK_LOCK keycode. * Add Secure keycodes. * Add Joystick keycodes. * Add Programmable Button keycodes. * Add macro MC_ keycodes. * For remaining keys in known code ranges, stringify them as "QK_<feature>+<number>". For instance, "QK_MIDI+7". * Bug fix and a few improvements. * Fix missing right-hand bit when displaying 5-bit mods numerically. * Support KC_HYPR, KC_MEH, HYPR_T(kc), MEH_T(kc). * Exclude one-shot keycodes when NO_ACTION_ONESHOT is defined. --------- Co-authored-by: Ryan <fauxpark@gmail.com> * Align to latest CLI dependencies (#24553) * Align to latest CLI dependencies * Update docs * Add Community Layout support to daskeyboard4 (#23884) add ansi CL * Add the plywrks ply8x hotswap variant. (#23558) * Add hotswap variant * Update RGB matrix * Move files around to target develop * Revert rules.mk for keyboards/jaykeeb/joker/rules.mk * Update keyboards/plywrks/ply8x/hotswap/keyboard.json Co-authored-by: Drashna Jaelre <drashna@live.com> * Apply suggestions from code review Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Add missing community layouts * Delete keyboards/plywrks/ply8x/rules.mk * Update missing keys in RGB matrix * Add missing key in RGB matrix for hotswap ver * Remove via keymaps * Add keyboard alias for plywrks/ply8x to plywrks/ply8x/solder * Fix typo * Fix another typo --------- Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * [Core] use `keycode_string` in unit tests (#25042) * tests: use keycode_string feature With a proper keycode to string implementation in qmk there is no need to use the unit tests only implementation anymore. Signed-off-by: Stefan Kerkmann <karlk90@pm.me> * tests: remove keycode_util feature This feature is no longer used as we switched the tests to the keycode string implementation. Signed-off-by: Stefan Kerkmann <karlk90@pm.me> * Non-volatile memory data repository pattern (#24356) * First batch of eeconfig conversions. * Offset and length for datablocks. * `via`, `dynamic_keymap`. * Fix filename. * Commentary. * wilba leds * satisfaction75 * satisfaction75 * more keyboard whack-a-mole * satisfaction75 * omnikeyish * more whack-a-mole * `generic_features.mk` to automatically pick up nvm repositories * thievery * deferred variable resolve * whitespace * convert api to structs/unions * convert api to structs/unions * convert api to structs/unions * fixups * code-side docs * code size fix * rollback * nvm_xxxxx_erase * Updated location of eeconfig magic numbers so non-EEPROM nvm drivers can use them too. * Fixup build. * Fixup compilation error with encoders. * Build fixes. * Add `via_ci` keymap to onekey to exercise VIA bindings (and thus dynamic keymap et.al.), fixup compilation errors based on preprocessor+sizeof. * Build failure rectification. * Migrate remaining `split.soft_serial_pin` to `split.serial.pin` (#25046) * Migrate keyboards/bastardkb * Migrate keyboards/handwired * Migrate keyboards/helix * Fix duplicate serial key * Fix outdated GPIO control function usage (#25060) * [Modules] Provide access to current path in `rules.mk`. (#25061) * Update keymap for keycult 1800 (#25070) Update keymap Co-authored-by: yiancar <yiancar@gmail.com> * Add handwired/erikpeyronson/erkbd (#25030) Co-authored-by: Erik Peyronson <erik.peyronson@gmail.com> Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> * Add support for Starry FRL (#24626) Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> * Add "Large Lad" keyboard (#24727) Co-authored-by: jack <jack@pngu.org> * Bump vite from 5.4.12 to 5.4.15 in /builddefs/docsgen (#25065) Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 5.4.12 to 5.4.15. - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v5.4.15/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v5.4.15/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Allow AnnePro2 to reboot (#24886) Without this, the QK_REBOOT key did nothing. * Fix path typo related RP2040 (#25069) Fix path typo * Update onekey example for nucleo f446re (#25067) * use accessible pins for nucleo f446re onekey example * remove pin collision with matrix in keyboard.json * use accessible pins for LED * remove pin collision with matrix * Update readme.md to reflect pin changes * Module documentation typo correction (#25073) * Fix lockups on AVR with `qmk/hello_world` module (#25074) Fix lockups on AVR. * At101ish (#25072) * Dell AT101 replacement pcb support * Update keyboards/at101ish/readme.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * remove empty src clause in makefile * feature: Update at101ish to qmk v0.28 * feature: Add osdetecting keymap variant. * refactor: Move at101ish keyboard to handwired folder. * fix: Adjust at101ish readme- * fix: review changes. * chore: Remove unneeded feature. --------- Co-authored-by: fauxpark <fauxpark@gmail.com> * Add "license" field to Community Module JSON schema. (#25085) Add "license" field to community module schema. * Add kt60HS-T v2 PCB (#25080) * Add kt60HS-Tv2 * Update keyboards/keyten/kt60hs_t/readme.md Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Update keyboards/keyten/kt60hs_t/v1/readme.md Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Update keyboards/keyten/kt60hs_t/v2/keyboard.json Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Update keyboards/keyten/kt60hs_t/v2/readme.md Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Update keyboards/keyten/kt60hs_t/info.json Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Change of structure * Moving the keyboard * Update data/mappings/keyboard_aliases.hjson Co-authored-by: Sergey Vlasov <sigprof@gmail.com> * Update keyboards/keyten/kt60hs_t/v1/keyboard.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboards/keyten/kt60hs_t/v2/keyboard.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> --------- Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Make sure that unit tests run on all release versions * [ErgoDox EZ] Fix complication issues due to updates * [ErgoDox EZ] Fix compilication errors and warnings We want all green! * Fix 'qmk lint -kb' argument handling (#25093) * Refactor Deemen17 Works DE60 (#25088) * Add Coban Pad 12A (#25039) Co-authored-by: jack <jack@pngu.org> * [Keyboard] Add PHDesign PH60/Multi Keyboard PCB (#25086) * Add PH60/Multi Support * Add PCB PIcture for README * Remove MO(_FN2) * README Typo Fix * Layout and README Adjustment * Add README for PHDesign Main Folder * Keymap Improvement * Update README.md * [Keyboard] Add Ortho Slayer (#25099) * Add Ortho Slayer * Update keyboards/keyten/ortho_slayer/keymaps/default/keymap.c Co-authored-by: jack <jack@pngu.org> * Update keyboards/keyten/ortho_slayer/readme.md Co-authored-by: jack <jack@pngu.org> --------- Co-authored-by: jack <jack@pngu.org> * Fix coban pad9a wrong layout in keyboard.json (#25100) * Remove `CTPC`/`CONVERT_TO_PROTON_C` options (#25111) * Remove direct docs.qmk.fm links from docs (#25113) * Add warning when deprecated 'promicro_rp2040' is used (#25112) * Add Vida to QMK (#24225) Co-authored-by: jack <jack@pngu.org> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * More Windows->Unix style path fixes. (#25119) * Include `math.h` where necessary. (#25122) * Cater for use of `__errno_r()` in ChibiOS syscalls.c with newer picolibc revisions (#25121) * chore: Allow disabling underglow on Work Louder devices (#25123) (#25120) * Allow disabling Underglow on Work Louder devices Allows disabling Underglow on Work Louder devices by using `RGBLIGHT_ENABLE = no` on rules.mk * Update keyboards/work_louder/rgb_functions.c Suggested by @zvecr on review. Co-authored-by: Joel Challis <git@zvecr.com> --------- Co-authored-by: Joel Challis <git@zvecr.com> * Exclude external userspace from lint checking (#24680) * fix: Fix startup sound for Preonic (#25132) (#25133) Add `AUDIO_INIT_DELAY ` to config.h to resolve * New standard layout for Savage65 (65_ansi_blocker_tsangan_split_bs) (#24690) * Added a default firmware and layout for the WindStudio Wind X R1 keyboard. * Wind X R1: cleaned-up the folders to make clear that this firmware is for the release 1 of this keyboard. * Delete keyboards/windstudio/wind_x/R1 directory Removing the uppercase R1 folder * feat(cannonkeys/savage65): Added layout to keyboard.json - Added the layout LAYOUT_65_ansi_blocker_tsangan_split_bs to the community layouts. * kradoindustries_promenade: add LAYOUT_1x2u (#25090) * Update shuguet/shu89 (#24780) * Update keyboard.json Update mod keys location in RGB layout. * Update keyboard.json * Update keyboards/shuguet/shu89/keyboard.json Co-authored-by: Ryan <fauxpark@gmail.com> --------- Co-authored-by: Ryan <fauxpark@gmail.com> * [Keyboard] Add suika83opti (#24991) * [chore]: move and rename mouse/scroll min/max defines (#25141) * protocol: move {XY/HV}_REPORT_{MIN,MAX} into report.h ..to allow easier re-use in other code implementations. * protocol: rename {XY/HV}_REPORT_{MIN/MAX} to MOUSE_REPORT_{XY/HV}_{MIN/MAX} ..to avoid naming collisions. * [Core] Flow Tap tap-hold option to disable HRMs during fast typing (#25125) aka Global Quick Tap, Require Prior Idle * Add Link keyboard (#25058) Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> * Remove Sofle `rgb_default` keymap & tidy readme's (#25010) * Added Keyboard LumPy27 (#24967) Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> * [Keyboard] Kobold r1 (#25161) * Kobold r1 * Apply suggestions from code review Co-authored-by: jack <jack@pngu.org> * `board_init` => `early_hardware_init_post`. --------- Co-authored-by: jack <jack@pngu.org> * [Docs] Unify lighting step descriptions (#25167) unify lighting step descriptions and defaults across docs * [Keyboard] Add voidhhkb-hotswap (#25007) * Added files for voidhhkb-hotswap * Updated keyboard name to resolve build errors * Implement suggestions from PR. Use 60_hhkb community layout. * Update keyboards/void/voidhhkb_hotswap/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Apply suggestions from code review Co-authored-by: jack <jack@pngu.org> --------- Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: jack <jack@pngu.org> * Remove duplication of RGB Matrix defaults (#25146) * Remove duplication of RGB Matrix defaults * Remove more duplication of defaults * fix * Fix missing and extra commas in JSON schema (#25057) * Remove duplication of RGBLight defaults (#25169) * Ignore the Layer Lock key in Repeat Key and Caps Word. (#25171) * Allow for disabling EEPROM subsystem entirely. (#25173) * [keyboard] ymdk/id75/rp2040 (#25157) Co-authored-by: tao heihei <> * Remove `bluefruit_le_read_battery_voltage` function (#25129) * Fix 'Would you like to clone the submodules?' prompt under msys (#24958) * Fixup eeconfig lighting reset. (#25166) * DOCS: `qmk-hid` missing in bootloaders list? (#25177) * Fix for `.clangd`. (#25180) * Update develop branch to Pico SDK 1.5.1 (#25178) * Add lint warning for empty url (#25182) * Implement connection keycode logic (#25176) * Add handwired/footy (#25151) Co-authored-by: jack <jack@pngu.org> * Decrease firmware size for `anavi/macropad8`. (#25185) Preparation for bootstrapper. * Align ChibiOS `USB_WAIT_FOR_ENUMERATION` implementation (#25184) * [Bug][Core] Fix for Flow Tap: fix handling of distinct taps and timer updates. (#25175) * Flow Tap bug fix. As reported by @amarz45 and @mwpardue, there is a bug where if two tap-hold keys are pressed in distinct taps back to back, then Flow Tap is not applied on the second tap-hold key, but it should be. In a related bug reported by @NikGovorov, if a tap-hold key is held followed by a tap of a tap-hold key, then Flow Tap updates its timer on the release of the held tap-hold key, but it should be ignored. The problem common to both these bugs is that I incorrectly assumed `tapping_key` is cleared to noevent once it is released, when actually `tapping_key` is still maintained for `TAPPING_TERM` ms after release (for Quick Tap). This commit fixes that. Thanks to @amarz45, @mwpardue, and @NikGovorov for reporting! Details: * Logic for converting the current tap-hold event to a tap is extracted to `flow_tap_key_if_within_term()`, which is now invoked also in the post-release "interfered with other tap key" case. This fixes the distinct taps bug. * The Flow Tap timer is now updated at the beginning of each call to `process_record()`, provided that there is no unsettled tap-hold key at that time and that the record is not for a mod or layer switch key. By moving this update logic to `process_record()`, it is conceptually simpler and more robust. * Unit tests extended to cover the reported scenarios. * Fix formatting. * Revision to fix @NikGovorov's scenario. The issue is that when another key is pressed while a layer-tap hasn't been settled yet, the `prev_keycode` remembers the keycode from before the layer switched. This can then enable Flow Tap for the following key when it shouldn't, or vice versa. Thanks to @NikGovorov for reporting! This commit revises Flow Tap in the following ways: * The previous key and timer are both updated from `process_record()`. This is slightly later in the sequence of processing than before, and by this point, a just-settled layer-tap should have taken effect so that the keycode from the correct layer is remembered. * The Flow Tap previous key and timer are updated now also on key release events, except for releases of modifiers and held layer switches. * The Flow Tap previous key and timer are now updated together, for simplicity. This makes the logic easier to think about. * A few additional unit tests, including @NikGovorov's scenario as "layer_tap_ignored_with_disabled_key_complex." * Remove empty `url` fields (#25181) * Prompt for converter when creating new keymap (#25116) * High resolution scrolling (without feature report parsing) (#24423) * hires scrolling without feature report parsing * fix valid range for exponent * fix incorrect minimum exponent value documentation * Avoid duplication in generated community modules `rules.mk` (#25135) * Bump rlespinasse/github-slug-action from 3 to 5 (#25021) * Remove `"console":false` from keyboards (#25190) * Update 'qmk generate-api' to only publish pure DD keymaps (#24782) * Remove more duplication of defaults (#25189) * Align `new-keyboard` template to current standards (#25191) * Bump vite from 5.4.15 to 5.4.18 in /builddefs/docsgen (#25192) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix `boardsource/beiwagon` RGB Matrix coordinates (#25018) * Remove `"command":false` from keyboards (#25193) * Extend lint checks to reject duplication of defaults (#25149) * modelh: add prerequisites for via support (#24932) * First TypeK support (#22876) * Add Lemokey X0 keyboard (#24994) * keyboards/annepro2/ld: Add per-variant linker scripts (#24999) C18 has an MCU with 16K SRAM, up from C15's 8K. Split the linker script into C15 and C18 variants to make use of the larger RAM capacity of C18. * Add new keyboard MirageiX (#25054) Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: jack <0x6a73@protonmail.com> * [Keymap] Sofle RGB - fixed stuck on numpad layer and layout comments (#24942) * Add handwired 4x14 LuMaWing keyboard (#24885) * Add jcpm2 (JC Pro Macro 2) (#24816) Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Joel Challis <git@zvecr.com> * [Keyboard] Add splitkb.com's Halcyon Elora rev2 (#24790) Co-authored-by: Drashna Jaelre <drashna@live.com> * [Keyboard] mzmkb/slimdash/rev1 (#24804) Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: jack <jack@pngu.org> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> * Added new keyboard epssp75 (#24756) Co-authored-by: Drashna Jaelre <drashna@live.com> * Addition of OK-1 (#24646) Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> * Add Umbra keyboard (#24569) Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> * Amptrics 0420 keyboard addition (#24744) Co-authored-by: jack <jack@pngu.org> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> * [Core] Enhance Flow Tap to work better for rolls over multiple tap-hold keys. (#25200) * Flow Tap revision for rolling press. * Remove debugging cruft. * Formatting fix. * amptrics/0422 - Prevent OOB in `update_leds_for_layer` (#25209) * [Keyboard] Add Gravity-45(#25206) * add gravity-45 * readme.md * fix readme * Update keyboards/green_keys/gravity_45/keyboard.json Co-authored-by: jack <0x6a73@protonmail.com> * run qmk format-json -i keyboards/green_keys/gravity_45/keyboard.json * add url * Update keyboards/green_keys/gravity_45/keyboard.json Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> * Update keyboard.json * Update keyboard.json * Update keyboards/green_keys/gravity_45/keyboard.json Co-authored-by: Drashna Jaelre <drashna@live.com> --------- Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> * Remove redundant keyboard headers (#25208) * Fix Spleeb compile when pointing device is enabled (#25016) * [Bug] Minimise force-included files (#25194) * Add additional hooks for Community modules (#25050) * Workaround for resolving keyboard alias for config file values (#25228) * Generate versions to keycode headers (#25219) * Resolve alias for `qmk new-keymap` keyboard prompts (#25210) * [Keyboard] Add Binepad KN01 (#25224) * Add Binepad NeoKnob KN01 * post @waffle87 recommendations * Add battery changed callbacks (#25207) * Ensure `qmk_userspace_paths` maintains detected order (#25204) * Bind Bluetooth driver to `host_driver_t` (#25199) * Deprecate `qmk generate-compilation-database`. (#25237) * Remove force disable of NKRO when Bluetooth enabled (#25201) * Keycult 60 (#25213) Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: jack <jack@pngu.org> * [Keyboard] Add Binepad KnobX1 (#25222) Co-authored-by: Drashna Jaelre <drashna@live.com> * [Keyboard] Update Tractyl Manuform and add F405 (weact) variant (#24764) * Layout corrections: Zed60 (#25003) * Fixed print statement after enabling 32-bit layers (#25027) * Fix Aurora sweep default keymap configuration (#25148) * Docs update for installing qmk with uv (#24995) * CXT Studio 12E3: Fix encoder resolutions not applying (#25242) * add resolution to encoders so they apply * Tweak default keymap * replace KC_UNDO with C(KC_Z) as well * Add debounce to duplicated defaults check (#25246) * [Docs] Fix typos introduced by PR #25050 (#25250) It isn't a drashna PR if there aren't some typos in it somewhere. * Allow LVGL onekey keymap to be able compile for other board (#25005) * [Keyboard] Add Jason Hazel’s Bad Wings v2 (#25252) Co-authored-by: Florent Allard <florent.allard@savoirfairelinux.com> * Add raw_hid support to host driver (#25255) * Fix Wear Leveling compilation (#25254) * [New Feature/Core] New RGB Matrix Animation "Starlight Smooth" (#25203) * Enable community modules to define LED matrix and RGB matrix effects. (#25187) Co-authored-by: Joel Challis <git@zvecr.com> * Fix OS_DETECTION_KEYBOARD_RESET (#25015) Co-authored-by: Nick Brassel <nick@tzarc.org> * Fixes the numlock indicator for Magic Force MF17 numpad (#25260) * Add Harite v2 keyboard (#24975) * dlip/haritev2 - Post merge fixes (#25264) * Remove more USB only branches from NKRO handling (#25263) * Deprecate `usb.force_nkro`/`FORCE_NKRO` (#25262) * Add BDN9 Rev. 3 (#25261) * Remove duplicate of SPI default config from keyboards (#25266) * Resolve miscellaneous keyboard lint warnings (#25268) * Add Zeropad (#24737) Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Joel Challis <git@zvecr.com> * Add Waveshare RP2040-Keyboard-3 support (#25269) * Update PR checklist notes on custom matrix (#25240) * Chew folders (#24785) * gcc15 AVR compilation fixes (#25238) * [Core] STM32G0x1 support (#24301) * Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) * add doio/kb03 (#24815) Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Joel Challis <git@zvecr.com> * Move rookiebwoy to ivndbt (#25142) * [Chore] use {rgblight,rgb_matrix}_hsv_to_rgb overrides (#25271) * Remove outdated `nix` support due to bit-rot. (#25280) * Add `compiler_support.h` (#25274) * Configure boards to use development_board - 0-9 (#25287) * [Fix] lib8tion: enable fixed scale8 and blend functions (#25272) lib8tion: enable fixed scale8 and blend functions These FastLED derived lib8tion functions have been fixed and enabled by default in FastLED. QMK just never set these defines, there is no reason to keep the buggy implementation. It is assumed that nobody relied on the buggy behavior. * Configure boards to use development_board - UVWXYZ (#25288) * [Docs] Fix tap_hold code blocks (#25298) * salicylic_acid3/getta25 - Fix oled keymap (#25295) * Configure boards to use development_board - S (#25293) * Configure boards to use development_board - T (#25294) * 2025 Q2 changelog (#25297) Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Nick Brassel <nick@tzarc.org> * Update Oryx module for newer code * Soft reset matrix * Use improved i2c reset for voyager and moonlander matrix * Fix formatting * Remove labeler action (unneeded) * Fix module API version for Oryx module * Use i2cStop instead of trying to work around --------- Signed-off-by: Stefan Kerkmann <karlk90@pm.me> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com> Co-authored-by: QMK Bot <hello@qmk.fm> Co-authored-by: Pascal Getreuer <50221757+getreuer@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ramon Imbao <ramonimbao@gmail.com> Co-authored-by: Stefan Kerkmann <karlk90@pm.me> Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: jack <jack@pngu.org> Co-authored-by: yiancar <yiangosyiangou@cytanet.com.cy> Co-authored-by: yiancar <yiancar@gmail.com> Co-authored-by: Erik Peyronson <erikpeyronson@gmail.com> Co-authored-by: Erik Peyronson <erik.peyronson@gmail.com> Co-authored-by: Sắn <59417802+MaiTheSan@users.noreply.github.com> Co-authored-by: Hyphen-ated <Hyphen-ated@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Geoffrey Frogeye <s+github@frogeye.fr> Co-authored-by: lsh4711 <120231876+lsh4711@users.noreply.github.com> Co-authored-by: Ben Green <bengreen.uk@gmail.com> Co-authored-by: フィルターペーパー <76888457+filterpaper@users.noreply.github.com> Co-authored-by: henrikosorensen <henrik.sorensen@gmail.com> Co-authored-by: Ivan Gromov <38141348+key10iq@users.noreply.github.com> Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: Pham Duc Minh <95753855+Deemen17@users.noreply.github.com> Co-authored-by: Dam Vu Duy <RyanDam@users.noreply.github.com> Co-authored-by: nonameCCC <79012391+nonameCCC@users.noreply.github.com> Co-authored-by: sudo pacman -Syu <hauvipapro@gmail.com> Co-authored-by: Andrew Kannan <andrew.kannan@gmail.com> Co-authored-by: Luis Garcia <luis@bitjester.com> Co-authored-by: Christian C. Berclaz <christian.berclaz@mac.com> Co-authored-by: Olivier Mehani <shtrom-github@ssji.net> Co-authored-by: Sylvain Huguet <sylvain@huguet.me> Co-authored-by: suikagiken <115451678+suikagiken@users.noreply.github.com> Co-authored-by: Daniel Reisch <danieljreisch@gmail.com> Co-authored-by: ClownFish <177758267+clownfish-og@users.noreply.github.com> Co-authored-by: JamesWilson1996 <47866504+JamesWilson1996@users.noreply.github.com> Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: Jan Bláha <blaha.j502@gmail.com> Co-authored-by: Eric Molitor <534583+emolitor@users.noreply.github.com> Co-authored-by: CJ Pais <cj@cjpais.com> Co-authored-by: eynsai <47629346+eynsai@users.noreply.github.com> Co-authored-by: Joel Beckmeyer <joel@beckmeyer.us> Co-authored-by: Álvaro A. Volpato <alvaro.augusto.volpato@gmail.com> Co-authored-by: Aidan Gauland <aidalgol@users.noreply.github.com> Co-authored-by: Michał Kopeć <michal@nozomi.space> Co-authored-by: takashicompany <t@kashi.company> Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Matheus Marques <matheusmbar@gmail.com> Co-authored-by: LucasMateijsen <l.mateijsen@outlook.com> Co-authored-by: Jeremy Cook <jscook55@gmail.com> Co-authored-by: VeyPatch <126267034+VeyPatch@users.noreply.github.com> Co-authored-by: mizma <omoikane@path-works.net> Co-authored-by: hen-des <141591967+hen-des@users.noreply.github.com> Co-authored-by: Cipulot <40441626+Cipulot@users.noreply.github.com> Co-authored-by: josephawilliamsiv <31166673+josephawilliamsiv@users.noreply.github.com> Co-authored-by: vchowl <vchowl@outlook.com> Co-authored-by: Christopher Hoage <iam@chrishoage.com> Co-authored-by: Silvino R. <366673+silvinor@users.noreply.github.com> Co-authored-by: dabstractor <dustindschultz@gmail.com> Co-authored-by: Nathan Cain <13713501+nathanscain@users.noreply.github.com> Co-authored-by: muge <221161+muge@users.noreply.github.com> Co-authored-by: HorrorTroll <sonicvipduc@gmail.com> Co-authored-by: cyxae <cyxae@amphitryon.nrst.fr> Co-authored-by: Florent Allard <florent.allard@savoirfairelinux.com> Co-authored-by: art-was-here <mail@buckles.email> Co-authored-by: Matti Hiljanen <170205+qvr@users.noreply.github.com> Co-authored-by: Wasteland Fluttershy <ingvardm@gmail.com> Co-authored-by: Dane Lipscombe <danelipscombe@gmail.com> Co-authored-by: Danny <nooges@users.noreply.github.com> Co-authored-by: Infos <136488157+diffrentGuesser@users.noreply.github.com> Co-authored-by: Florent Linguenheld <f@linguenheld.fr> Co-authored-by: ivan <81021475+ivndbt@users.noreply.github.com> Co-authored-by: Pablo Martínez <58857054+elpekenin@users.noreply.github.com>
This commit is contained in:
Drashna Jaelre
GitHub
@@ -1,14 +1,15 @@
|
||||
// Copyright 2022 Nick Brassel (@tzarc)
|
||||
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||
#include "fnv.h"
|
||||
#include "compiler_support.h"
|
||||
|
||||
// This library was originally sourced from:
|
||||
// http://www.isthe.com/chongo/tech/comp/fnv/index.html
|
||||
//
|
||||
// Version at the time of retrieval on 2022-06-26: v5.0.3
|
||||
|
||||
_Static_assert(sizeof(long long) == 8, "long long should be 64 bits");
|
||||
_Static_assert(sizeof(unsigned long long) == 8, "unsigned long long should be 64 bits");
|
||||
STATIC_ASSERT(sizeof(long long) == 8, "long long should be 64 bits");
|
||||
STATIC_ASSERT(sizeof(unsigned long long) == 8, "unsigned long long should be 64 bits");
|
||||
|
||||
_Static_assert(sizeof(Fnv32_t) == 4, "Fnv32_t should be 32 bits");
|
||||
_Static_assert(sizeof(Fnv64_t) == 8, "Fnv64_t should be 64 bits");
|
||||
STATIC_ASSERT(sizeof(Fnv32_t) == 4, "Fnv32_t should be 32 bits");
|
||||
STATIC_ASSERT(sizeof(Fnv64_t) == 8, "Fnv64_t should be 64 bits");
|
||||
|
||||
Submodule lib/pico-sdk updated: a3398d8d3a...d0c5cac430
@@ -11,7 +11,8 @@ from qmk.commands import find_make, get_make_parallel_args, parse_configurator_j
|
||||
from qmk.keyboard import keyboard_folder
|
||||
from qmk.info import keymap_json
|
||||
from qmk.keymap import locate_keymap
|
||||
from qmk.path import is_under_qmk_firmware, is_under_qmk_userspace
|
||||
from qmk.path import is_under_qmk_firmware, is_under_qmk_userspace, unix_style_path
|
||||
from qmk.compilation_database import write_compilation_database
|
||||
|
||||
# These must be kept in the order in which they're applied to $(TARGET) in the makefiles in order to ensure consistency.
|
||||
TARGET_FILENAME_MODIFIERS = ['FORCE_LAYOUT', 'CONVERT_TO']
|
||||
@@ -150,7 +151,6 @@ class BuildTarget:
|
||||
def generate_compilation_database(self, build_target: str = None, skip_clean: bool = False, **env_vars) -> None:
|
||||
self.prepare_build(build_target=build_target, **env_vars)
|
||||
command = self.compile_command(build_target=build_target, dry_run=True, **env_vars)
|
||||
from qmk.cli.generate.compilation_database import write_compilation_database # Lazy load due to circular references
|
||||
output_path = QMK_FIRMWARE / 'compile_commands.json'
|
||||
ret = write_compilation_database(command=command, output_path=output_path, skip_clean=skip_clean, **env_vars)
|
||||
if ret and output_path.exists() and HAS_QMK_USERSPACE:
|
||||
@@ -204,11 +204,11 @@ class KeyboardKeymapBuildTarget(BuildTarget):
|
||||
if is_under_qmk_userspace(keymap_location) and not is_under_qmk_firmware(keymap_location):
|
||||
keymap_directory = keymap_location.parent
|
||||
compile_args.extend([
|
||||
f'MAIN_KEYMAP_PATH_1={keymap_directory}',
|
||||
f'MAIN_KEYMAP_PATH_2={keymap_directory}',
|
||||
f'MAIN_KEYMAP_PATH_3={keymap_directory}',
|
||||
f'MAIN_KEYMAP_PATH_4={keymap_directory}',
|
||||
f'MAIN_KEYMAP_PATH_5={keymap_directory}',
|
||||
f'MAIN_KEYMAP_PATH_1={unix_style_path(keymap_directory)}',
|
||||
f'MAIN_KEYMAP_PATH_2={unix_style_path(keymap_directory)}',
|
||||
f'MAIN_KEYMAP_PATH_3={unix_style_path(keymap_directory)}',
|
||||
f'MAIN_KEYMAP_PATH_4={unix_style_path(keymap_directory)}',
|
||||
f'MAIN_KEYMAP_PATH_5={unix_style_path(keymap_directory)}',
|
||||
])
|
||||
|
||||
return compile_args
|
||||
@@ -267,11 +267,11 @@ class JsonKeymapBuildTarget(BuildTarget):
|
||||
generated_files_path = intermediate_output / 'src'
|
||||
keymap_json = generated_files_path / 'keymap.json'
|
||||
compile_args.extend([
|
||||
f'MAIN_KEYMAP_PATH_1={intermediate_output}',
|
||||
f'MAIN_KEYMAP_PATH_2={intermediate_output}',
|
||||
f'MAIN_KEYMAP_PATH_3={intermediate_output}',
|
||||
f'MAIN_KEYMAP_PATH_4={intermediate_output}',
|
||||
f'MAIN_KEYMAP_PATH_5={intermediate_output}',
|
||||
f'MAIN_KEYMAP_PATH_1={unix_style_path(intermediate_output)}',
|
||||
f'MAIN_KEYMAP_PATH_2={unix_style_path(intermediate_output)}',
|
||||
f'MAIN_KEYMAP_PATH_3={unix_style_path(intermediate_output)}',
|
||||
f'MAIN_KEYMAP_PATH_4={unix_style_path(intermediate_output)}',
|
||||
f'MAIN_KEYMAP_PATH_5={unix_style_path(intermediate_output)}',
|
||||
f'KEYMAP_JSON={keymap_json}',
|
||||
f'KEYMAP_PATH={generated_files_path}',
|
||||
])
|
||||
|
||||
@@ -58,7 +58,6 @@ subcommands = [
|
||||
'qmk.cli.generate.keyboard_c',
|
||||
'qmk.cli.generate.keyboard_h',
|
||||
'qmk.cli.generate.keycodes',
|
||||
'qmk.cli.generate.keycodes_tests',
|
||||
'qmk.cli.generate.keymap_h',
|
||||
'qmk.cli.generate.make_dependencies',
|
||||
'qmk.cli.generate.rgb_breathe_table',
|
||||
@@ -215,7 +214,7 @@ if sys.version_info[0] != 3 or sys.version_info[1] < 9:
|
||||
|
||||
milc_version = __VERSION__.split('.')
|
||||
|
||||
if int(milc_version[0]) < 2 and int(milc_version[1]) < 4:
|
||||
if int(milc_version[0]) < 2 and int(milc_version[1]) < 9:
|
||||
requirements = Path('requirements.txt').resolve()
|
||||
|
||||
_eprint(f'Your MILC library is too old! Please upgrade: python3 -m pip install -U -r {str(requirements)}')
|
||||
|
||||
@@ -54,10 +54,13 @@ def _check_arm_gcc_installation():
|
||||
"""Returns OK if the arm-none-eabi-gcc is fully installed and can produce binaries.
|
||||
"""
|
||||
with TemporaryDirectory() as temp_dir:
|
||||
temp_file = Path(temp_dir) / 'test.elf'
|
||||
temp_in = Path(temp_dir) / 'test.c'
|
||||
temp_out = Path(temp_dir) / 'test.elf'
|
||||
|
||||
args = ['arm-none-eabi-gcc', '-mcpu=cortex-m0', '-mthumb', '-mno-thumb-interwork', '--specs=nosys.specs', '--specs=nano.specs', '-x', 'c', '-o', str(temp_file), '-']
|
||||
result = cli.run(args, stdin=None, stdout=None, stderr=None, input='#include <newlib.h>\nint main() { return __NEWLIB__ * __NEWLIB_MINOR__ * __NEWLIB_PATCHLEVEL__; }')
|
||||
temp_in.write_text('#include <newlib.h>\nint main() { return __NEWLIB__ * __NEWLIB_MINOR__ * __NEWLIB_PATCHLEVEL__; }', encoding='utf-8')
|
||||
|
||||
args = ['arm-none-eabi-gcc', '-mcpu=cortex-m0', '-mthumb', '-mno-thumb-interwork', '--specs=nosys.specs', '--specs=nano.specs', '-x', 'c', '-o', str(temp_out), str(temp_in)]
|
||||
result = cli.run(args, stdout=None, stderr=None)
|
||||
if result.returncode == 0:
|
||||
cli.log.info('Successfully compiled using arm-none-eabi-gcc')
|
||||
else:
|
||||
@@ -65,8 +68,8 @@ def _check_arm_gcc_installation():
|
||||
cli.log.error(f'Command: {" ".join(args)}')
|
||||
return CheckStatus.ERROR
|
||||
|
||||
args = ['arm-none-eabi-size', str(temp_file)]
|
||||
result = cli.run(args, stdin=None, stdout=None, stderr=None)
|
||||
args = ['arm-none-eabi-size', str(temp_out)]
|
||||
result = cli.run(args, stdout=None, stderr=None)
|
||||
if result.returncode == 0:
|
||||
cli.log.info('Successfully tested arm-none-eabi-binutils using arm-none-eabi-size')
|
||||
else:
|
||||
@@ -91,10 +94,13 @@ def _check_avr_gcc_installation():
|
||||
"""Returns OK if the avr-gcc is fully installed and can produce binaries.
|
||||
"""
|
||||
with TemporaryDirectory() as temp_dir:
|
||||
temp_file = Path(temp_dir) / 'test.elf'
|
||||
temp_in = Path(temp_dir) / 'test.c'
|
||||
temp_out = Path(temp_dir) / 'test.elf'
|
||||
|
||||
args = ['avr-gcc', '-mmcu=atmega32u4', '-x', 'c', '-o', str(temp_file), '-']
|
||||
result = cli.run(args, stdin=None, stdout=None, stderr=None, input='int main() { return 0; }')
|
||||
temp_in.write_text('int main() { return 0; }', encoding='utf-8')
|
||||
|
||||
args = ['avr-gcc', '-mmcu=atmega32u4', '-x', 'c', '-o', str(temp_out), str(temp_in)]
|
||||
result = cli.run(args, stdout=None, stderr=None)
|
||||
if result.returncode == 0:
|
||||
cli.log.info('Successfully compiled using avr-gcc')
|
||||
else:
|
||||
@@ -102,8 +108,8 @@ def _check_avr_gcc_installation():
|
||||
cli.log.error(f'Command: {" ".join(args)}')
|
||||
return CheckStatus.ERROR
|
||||
|
||||
args = ['avr-size', str(temp_file)]
|
||||
result = cli.run(args, stdin=None, stdout=None, stderr=None)
|
||||
args = ['avr-size', str(temp_out)]
|
||||
result = cli.run(args, stdout=None, stderr=None)
|
||||
if result.returncode == 0:
|
||||
cli.log.info('Successfully tested avr-binutils using avr-size')
|
||||
else:
|
||||
|
||||
@@ -131,6 +131,11 @@ def generate_api(cli):
|
||||
if keymap_rel is None:
|
||||
cli.log.debug('Skipping keymap %s (not in qmk_firmware)', keymap)
|
||||
continue
|
||||
|
||||
if (keymap_rel / 'keymap.c').exists():
|
||||
cli.log.debug('Skipping keymap %s (not pure dd keymap)', keymap)
|
||||
continue
|
||||
|
||||
kb_json['keymaps'][keymap.name] = {
|
||||
# TODO: deprecate 'url' as consumer needs to know its potentially hjson
|
||||
'url': f'https://raw.githubusercontent.com/qmk/qmk_firmware/master/{keymap_rel}/keymap.json',
|
||||
|
||||
@@ -8,7 +8,7 @@ import qmk.path
|
||||
from qmk.info import get_modules
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder
|
||||
from qmk.commands import dump_lines
|
||||
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
|
||||
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE
|
||||
from qmk.community_modules import module_api_list, load_module_jsons, find_module_path
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ def _render_keycodes(module_jsons):
|
||||
lines.append('')
|
||||
lines.append(' LAST_COMMUNITY_MODULE_KEY')
|
||||
lines.append('};')
|
||||
lines.append('_Static_assert((int)LAST_COMMUNITY_MODULE_KEY <= (int)(QK_COMMUNITY_MODULE_MAX+1), "Too many community module keycodes");')
|
||||
lines.append('STATIC_ASSERT((int)LAST_COMMUNITY_MODULE_KEY <= (int)(QK_COMMUNITY_MODULE_MAX+1), "Too many community module keycodes");')
|
||||
return lines
|
||||
|
||||
|
||||
@@ -131,6 +131,69 @@ def _render_core_implementation(api, modules):
|
||||
return lines
|
||||
|
||||
|
||||
def _generate_features_rules(features_dict):
|
||||
lines = []
|
||||
for feature, enabled in features_dict.items():
|
||||
feature = feature.upper()
|
||||
enabled = 'yes' if enabled else 'no'
|
||||
lines.append(f'{feature}_ENABLE={enabled}')
|
||||
return lines
|
||||
|
||||
|
||||
def _generate_modules_rules(keyboard, filename):
|
||||
lines = []
|
||||
modules = get_modules(keyboard, filename)
|
||||
if len(modules) > 0:
|
||||
lines.append('')
|
||||
lines.append('OPT_DEFS += -DCOMMUNITY_MODULES_ENABLE=TRUE')
|
||||
for module in modules:
|
||||
module_path = qmk.path.unix_style_path(find_module_path(module))
|
||||
if not module_path:
|
||||
raise FileNotFoundError(f"Module '{module}' not found.")
|
||||
lines.append('')
|
||||
lines.append(f'COMMUNITY_MODULES += {module_path.name}') # use module_path here instead of module as it may be a subdirectory
|
||||
lines.append(f'OPT_DEFS += -DCOMMUNITY_MODULE_{module_path.name.upper()}_ENABLE=TRUE')
|
||||
lines.append(f'COMMUNITY_MODULE_PATHS += {module_path}')
|
||||
lines.append(f'VPATH += {module_path}')
|
||||
lines.append(f'SRC += $(wildcard {module_path}/{module_path.name}.c)')
|
||||
lines.append(f'MODULE_NAME_{module_path.name.upper()} := {module_path.name}')
|
||||
lines.append(f'MODULE_PATH_{module_path.name.upper()} := {module_path}')
|
||||
lines.append(f'-include {module_path}/rules.mk')
|
||||
|
||||
module_jsons = load_module_jsons(modules)
|
||||
for module_json in module_jsons:
|
||||
if 'features' in module_json:
|
||||
lines.append('')
|
||||
lines.append(f'# Module: {module_json["module_name"]}')
|
||||
lines.extend(_generate_features_rules(module_json['features']))
|
||||
return lines
|
||||
|
||||
|
||||
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@cli.argument('-e', '--escape', arg_only=True, action='store_true', help="Escape spaces in quiet mode")
|
||||
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate rules.mk for.')
|
||||
@cli.argument('filename', nargs='?', arg_only=True, type=qmk.path.FileType('r'), completer=FilesCompleter('.json'), help='A configurator export JSON to be compiled and flashed or a pre-compiled binary firmware file (bin/hex) to be flashed.')
|
||||
@cli.subcommand('Creates a community_modules_rules_mk from a keymap.json file.')
|
||||
def generate_community_modules_rules_mk(cli):
|
||||
|
||||
rules_mk_lines = [GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE]
|
||||
|
||||
rules_mk_lines.extend(_generate_modules_rules(cli.args.keyboard, cli.args.filename))
|
||||
|
||||
# Show the results
|
||||
dump_lines(cli.args.output, rules_mk_lines)
|
||||
|
||||
if cli.args.output:
|
||||
if cli.args.quiet:
|
||||
if cli.args.escape:
|
||||
print(cli.args.output.as_posix().replace(' ', '\\ '))
|
||||
else:
|
||||
print(cli.args.output)
|
||||
else:
|
||||
cli.log.info('Wrote rules.mk to %s.', cli.args.output)
|
||||
|
||||
|
||||
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate community_modules.h for.')
|
||||
@@ -152,9 +215,11 @@ def generate_community_modules_h(cli):
|
||||
'#include <stdbool.h>',
|
||||
'#include <keycodes.h>',
|
||||
'',
|
||||
'#include "compiler_support.h"',
|
||||
'',
|
||||
'#define COMMUNITY_MODULES_API_VERSION_BUILDER(ver_major,ver_minor,ver_patch) (((((uint32_t)(ver_major))&0xFF) << 24) | ((((uint32_t)(ver_minor))&0xFF) << 16) | (((uint32_t)(ver_patch))&0xFF))',
|
||||
f'#define COMMUNITY_MODULES_API_VERSION COMMUNITY_MODULES_API_VERSION_BUILDER({ver_major},{ver_minor},{ver_patch})',
|
||||
f'#define ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(ver_major,ver_minor,ver_patch) _Static_assert(COMMUNITY_MODULES_API_VERSION_BUILDER(ver_major,ver_minor,ver_patch) <= COMMUNITY_MODULES_API_VERSION, "Community module requires a newer version of QMK modules API -- needs: " #ver_major "." #ver_minor "." #ver_patch ", current: {api_version}.")',
|
||||
f'#define ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(ver_major,ver_minor,ver_patch) STATIC_ASSERT(COMMUNITY_MODULES_API_VERSION_BUILDER(ver_major,ver_minor,ver_patch) <= COMMUNITY_MODULES_API_VERSION, "Community module requires a newer version of QMK modules API -- needs: " #ver_major "." #ver_minor "." #ver_patch ", current: {api_version}.")',
|
||||
'',
|
||||
'typedef struct keyrecord_t keyrecord_t; // forward declaration so we don\'t need to include quantum.h',
|
||||
'',
|
||||
@@ -215,33 +280,32 @@ def generate_community_modules_c(cli):
|
||||
dump_lines(cli.args.output, lines, cli.args.quiet, remove_repeated_newlines=True)
|
||||
|
||||
|
||||
def _generate_include_per_module(cli, include_file_name):
|
||||
"""Generates C code to include "<module_path>/include_file_name" for each module."""
|
||||
if cli.args.output and cli.args.output.name == '-':
|
||||
cli.args.output = None
|
||||
|
||||
lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE]
|
||||
|
||||
for module in get_modules(cli.args.keyboard, cli.args.filename):
|
||||
full_path = f'{find_module_path(module)}/{include_file_name}'
|
||||
lines.append('')
|
||||
lines.append(f'#if __has_include("{full_path}")')
|
||||
lines.append(f'#include "{full_path}"')
|
||||
lines.append(f'#endif // __has_include("{full_path}")')
|
||||
|
||||
dump_lines(cli.args.output, lines, cli.args.quiet, remove_repeated_newlines=True)
|
||||
|
||||
|
||||
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate community_modules.c for.')
|
||||
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate community_modules_introspection.h for.')
|
||||
@cli.argument('filename', nargs='?', type=qmk.path.FileType('r'), arg_only=True, completer=FilesCompleter('.json'), help='Configurator JSON file')
|
||||
@cli.subcommand('Creates a community_modules_introspection.h from a keymap.json file.')
|
||||
def generate_community_modules_introspection_h(cli):
|
||||
"""Creates a community_modules_introspection.h from a keymap.json file
|
||||
"""
|
||||
if cli.args.output and cli.args.output.name == '-':
|
||||
cli.args.output = None
|
||||
|
||||
lines = [
|
||||
GPL2_HEADER_C_LIKE,
|
||||
GENERATED_HEADER_C_LIKE,
|
||||
'',
|
||||
]
|
||||
|
||||
modules = get_modules(cli.args.keyboard, cli.args.filename)
|
||||
if len(modules) > 0:
|
||||
for module in modules:
|
||||
module_path = find_module_path(module)
|
||||
lines.append(f'#if __has_include("{module_path}/introspection.h")')
|
||||
lines.append(f'#include "{module_path}/introspection.h"')
|
||||
lines.append(f'#endif // __has_include("{module_path}/introspection.h")')
|
||||
lines.append('')
|
||||
|
||||
dump_lines(cli.args.output, lines, cli.args.quiet, remove_repeated_newlines=True)
|
||||
_generate_include_per_module(cli, 'introspection.h')
|
||||
|
||||
|
||||
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
|
||||
@@ -252,22 +316,26 @@ def generate_community_modules_introspection_h(cli):
|
||||
def generate_community_modules_introspection_c(cli):
|
||||
"""Creates a community_modules_introspection.c from a keymap.json file
|
||||
"""
|
||||
if cli.args.output and cli.args.output.name == '-':
|
||||
cli.args.output = None
|
||||
_generate_include_per_module(cli, 'introspection.c')
|
||||
|
||||
lines = [
|
||||
GPL2_HEADER_C_LIKE,
|
||||
GENERATED_HEADER_C_LIKE,
|
||||
'',
|
||||
]
|
||||
|
||||
modules = get_modules(cli.args.keyboard, cli.args.filename)
|
||||
if len(modules) > 0:
|
||||
for module in modules:
|
||||
module_path = find_module_path(module)
|
||||
lines.append(f'#if __has_include("{module_path}/introspection.c")')
|
||||
lines.append(f'#include "{module_path}/introspection.c"')
|
||||
lines.append(f'#endif // __has_include("{module_path}/introspection.c")')
|
||||
lines.append('')
|
||||
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate led_matrix_community_modules.inc for.')
|
||||
@cli.argument('filename', nargs='?', type=qmk.path.FileType('r'), arg_only=True, completer=FilesCompleter('.json'), help='Configurator JSON file')
|
||||
@cli.subcommand('Creates an led_matrix_community_modules.inc from a keymap.json file.')
|
||||
def generate_led_matrix_community_modules_inc(cli):
|
||||
"""Creates an led_matrix_community_modules.inc from a keymap.json file
|
||||
"""
|
||||
_generate_include_per_module(cli, 'led_matrix_module.inc')
|
||||
|
||||
dump_lines(cli.args.output, lines, cli.args.quiet, remove_repeated_newlines=True)
|
||||
|
||||
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate rgb_matrix_community_modules.inc for.')
|
||||
@cli.argument('filename', nargs='?', type=qmk.path.FileType('r'), arg_only=True, completer=FilesCompleter('.json'), help='Configurator JSON file')
|
||||
@cli.subcommand('Creates an rgb_matrix_community_modules.inc from a keymap.json file.')
|
||||
def generate_rgb_matrix_community_modules_inc(cli):
|
||||
"""Creates an rgb_matrix_community_modules.inc from a keymap.json file
|
||||
"""
|
||||
_generate_include_per_module(cli, 'rgb_matrix_module.inc')
|
||||
|
||||
174
lib/python/qmk/cli/generate/compilation_database.py
Executable file → Normal file
174
lib/python/qmk/cli/generate/compilation_database.py
Executable file → Normal file
@@ -1,169 +1,9 @@
|
||||
"""Creates a compilation database for the given keyboard build.
|
||||
"""
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import shlex
|
||||
import shutil
|
||||
from functools import lru_cache
|
||||
from pathlib import Path
|
||||
from typing import Dict, Iterator, List, Union
|
||||
|
||||
from milc import cli, MILC
|
||||
|
||||
from qmk.commands import find_make
|
||||
from qmk.constants import QMK_FIRMWARE
|
||||
from qmk.decorators import automagic_keyboard, automagic_keymap
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder
|
||||
from qmk.keymap import keymap_completer
|
||||
from qmk.build_targets import KeyboardKeymapBuildTarget
|
||||
from milc import cli
|
||||
|
||||
|
||||
@lru_cache(maxsize=10)
|
||||
def system_libs(binary: str) -> List[Path]:
|
||||
"""Find the system include directory that the given build tool uses.
|
||||
"""
|
||||
cli.log.debug("searching for system library directory for binary: %s", binary)
|
||||
|
||||
# Actually query xxxxxx-gcc to find its include paths.
|
||||
if binary.endswith("gcc") or binary.endswith("g++"):
|
||||
# (TODO): Remove 'stdin' once 'input' no longer causes issues under MSYS
|
||||
result = cli.run([binary, '-E', '-Wp,-v', '-'], capture_output=True, check=True, stdin=None, input='\n')
|
||||
paths = []
|
||||
for line in result.stderr.splitlines():
|
||||
if line.startswith(" "):
|
||||
paths.append(Path(line.strip()).resolve())
|
||||
return paths
|
||||
|
||||
return list(Path(binary).resolve().parent.parent.glob("*/include")) if binary else []
|
||||
|
||||
|
||||
@lru_cache(maxsize=10)
|
||||
def cpu_defines(binary: str, compiler_args: str) -> List[str]:
|
||||
cli.log.debug("gathering definitions for compilation: %s %s", binary, compiler_args)
|
||||
if binary.endswith("gcc") or binary.endswith("g++"):
|
||||
invocation = [binary, '-dM', '-E']
|
||||
if binary.endswith("gcc"):
|
||||
invocation.extend(['-x', 'c'])
|
||||
elif binary.endswith("g++"):
|
||||
invocation.extend(['-x', 'c++'])
|
||||
compiler_args = shlex.split(compiler_args)
|
||||
invocation.extend(compiler_args)
|
||||
invocation.append('-')
|
||||
result = cli.run(invocation, capture_output=True, check=True, stdin=None, input='\n')
|
||||
define_args = []
|
||||
for line in result.stdout.splitlines():
|
||||
line_args = line.split(' ', 2)
|
||||
if len(line_args) == 3 and line_args[0] == '#define':
|
||||
define_args.append(f'-D{line_args[1]}={line_args[2]}')
|
||||
elif len(line_args) == 2 and line_args[0] == '#define':
|
||||
define_args.append(f'-D{line_args[1]}')
|
||||
return list(sorted(set(define_args)))
|
||||
return []
|
||||
|
||||
|
||||
file_re = re.compile(r'printf "Compiling: ([^"]+)')
|
||||
cmd_re = re.compile(r'LOG=\$\((.+?)&&')
|
||||
|
||||
|
||||
def parse_make_n(f: Iterator[str]) -> List[Dict[str, str]]:
|
||||
"""parse the output of `make -n <target>`
|
||||
|
||||
This function makes many assumptions about the format of your build log.
|
||||
This happens to work right now for qmk.
|
||||
"""
|
||||
|
||||
state = 'start'
|
||||
this_file = None
|
||||
records = []
|
||||
for line in f:
|
||||
if state == 'start':
|
||||
m = file_re.search(line)
|
||||
if m:
|
||||
this_file = m.group(1)
|
||||
state = 'cmd'
|
||||
|
||||
if state == 'cmd':
|
||||
assert this_file
|
||||
m = cmd_re.search(line)
|
||||
if m:
|
||||
# we have a hit!
|
||||
this_cmd = m.group(1)
|
||||
args = shlex.split(this_cmd)
|
||||
binary = shutil.which(args[0])
|
||||
compiler_args = set(filter(lambda x: x.startswith('-m') or x.startswith('-f'), args))
|
||||
for s in system_libs(binary):
|
||||
args += ['-isystem', '%s' % s]
|
||||
args.extend(cpu_defines(binary, ' '.join(shlex.quote(s) for s in compiler_args)))
|
||||
new_cmd = ' '.join(shlex.quote(s) for s in args)
|
||||
records.append({"directory": str(QMK_FIRMWARE.resolve()), "command": new_cmd, "file": this_file})
|
||||
state = 'start'
|
||||
|
||||
return records
|
||||
|
||||
|
||||
def write_compilation_database(keyboard: str = None, keymap: str = None, output_path: Path = QMK_FIRMWARE / 'compile_commands.json', skip_clean: bool = False, command: List[str] = None, **env_vars) -> bool:
|
||||
# Generate the make command for a specific keyboard/keymap.
|
||||
if not command:
|
||||
from qmk.build_targets import KeyboardKeymapBuildTarget # Lazy load due to circular references
|
||||
target = KeyboardKeymapBuildTarget(keyboard, keymap)
|
||||
command = target.compile_command(dry_run=True, **env_vars)
|
||||
|
||||
if not command:
|
||||
cli.log.error('You must supply both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')
|
||||
cli.echo('usage: qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]')
|
||||
return False
|
||||
|
||||
# remove any environment variable overrides which could trip us up
|
||||
env = os.environ.copy()
|
||||
env.pop("MAKEFLAGS", None)
|
||||
|
||||
# re-use same executable as the main make invocation (might be gmake)
|
||||
if not skip_clean:
|
||||
clean_command = [find_make(), "clean"]
|
||||
cli.log.info('Making clean with {fg_cyan}%s', ' '.join(clean_command))
|
||||
cli.run(clean_command, capture_output=False, check=True, env=env)
|
||||
|
||||
cli.log.info('Gathering build instructions from {fg_cyan}%s', ' '.join(command))
|
||||
|
||||
result = cli.run(command, capture_output=True, check=True, env=env)
|
||||
db = parse_make_n(result.stdout.splitlines())
|
||||
if not db:
|
||||
cli.log.error("Failed to parse output from make output:\n%s", result.stdout)
|
||||
return False
|
||||
|
||||
cli.log.info("Found %s compile commands", len(db))
|
||||
|
||||
cli.log.info(f"Writing build database to {output_path}")
|
||||
output_path.write_text(json.dumps(db, indent=4))
|
||||
|
||||
return True
|
||||
|
||||
|
||||
@cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='The keyboard\'s name')
|
||||
@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap\'s name')
|
||||
@cli.subcommand('Create a compilation database.')
|
||||
@automagic_keyboard
|
||||
@automagic_keymap
|
||||
def generate_compilation_database(cli: MILC) -> Union[bool, int]:
|
||||
"""Creates a compilation database for the given keyboard build.
|
||||
|
||||
Does a make clean, then a make -n for this target and uses the dry-run output to create
|
||||
a compilation database (compile_commands.json). This file can help some IDEs and
|
||||
IDE-like editors work better. For more information about this:
|
||||
|
||||
https://clang.llvm.org/docs/JSONCompilationDatabase.html
|
||||
"""
|
||||
# check both config domains: the magic decorator fills in `generate_compilation_database` but the user is
|
||||
# more likely to have set `compile` in their config file.
|
||||
current_keyboard = cli.config.generate_compilation_database.keyboard or cli.config.user.keyboard
|
||||
current_keymap = cli.config.generate_compilation_database.keymap or cli.config.user.keymap
|
||||
|
||||
if not current_keyboard:
|
||||
cli.log.error('Could not determine keyboard!')
|
||||
elif not current_keymap:
|
||||
cli.log.error('Could not determine keymap!')
|
||||
|
||||
target = KeyboardKeymapBuildTarget(current_keyboard, current_keymap)
|
||||
return target.generate_compilation_database()
|
||||
@cli.argument('-kb', '--keyboard', help='[unused] The keyboard\'s name')
|
||||
@cli.argument('-km', '--keymap', help='[unused] The keymap\'s name')
|
||||
@cli.subcommand('[deprecated] Create a compilation database.')
|
||||
def generate_compilation_database(cli):
|
||||
cli.log.error('This command is deprecated and has effectively been removed. Please use the `--compiledb` flag with `qmk compile` instead.')
|
||||
return False
|
||||
|
||||
@@ -125,6 +125,20 @@ def _generate_aliases(lines, keycodes):
|
||||
lines.append(f'#define {alias} {value.get("key")}')
|
||||
|
||||
|
||||
def _generate_version(lines, keycodes, prefix=''):
|
||||
version = keycodes['version']
|
||||
major, minor, patch = map(int, version.split('.'))
|
||||
|
||||
bcd = f'0x{major:02d}{minor:02d}{patch:04d}'
|
||||
|
||||
lines.append('')
|
||||
lines.append(f'#define QMK_{prefix}KEYCODES_VERSION "{version}"')
|
||||
lines.append(f'#define QMK_{prefix}KEYCODES_VERSION_BCD {bcd}')
|
||||
lines.append(f'#define QMK_{prefix}KEYCODES_VERSION_MAJOR {major}')
|
||||
lines.append(f'#define QMK_{prefix}KEYCODES_VERSION_MINOR {minor}')
|
||||
lines.append(f'#define QMK_{prefix}KEYCODES_VERSION_PATCH {patch}')
|
||||
|
||||
|
||||
@cli.argument('-v', '--version', arg_only=True, required=True, help='Version of keycodes to generate.')
|
||||
@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@@ -138,6 +152,7 @@ def generate_keycodes(cli):
|
||||
|
||||
keycodes = load_spec(cli.args.version)
|
||||
|
||||
_generate_version(keycodes_h_lines, keycodes)
|
||||
_generate_ranges(keycodes_h_lines, keycodes)
|
||||
_generate_defines(keycodes_h_lines, keycodes)
|
||||
_generate_helpers(keycodes_h_lines, keycodes)
|
||||
@@ -160,6 +175,7 @@ def generate_keycode_extras(cli):
|
||||
|
||||
keycodes = load_spec(cli.args.version, cli.args.lang)
|
||||
|
||||
_generate_version(keycodes_h_lines, keycodes, f'{cli.args.lang.upper()}_')
|
||||
_generate_aliases(keycodes_h_lines, keycodes)
|
||||
|
||||
# Show the results
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
"""Used by the make system to generate a keycode lookup table from keycodes_{version}.json
|
||||
"""
|
||||
from milc import cli
|
||||
|
||||
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
|
||||
from qmk.commands import dump_lines
|
||||
from qmk.path import normpath
|
||||
from qmk.keycodes import load_spec
|
||||
|
||||
|
||||
def _generate_defines(lines, keycodes):
|
||||
lines.append('')
|
||||
lines.append('std::map<uint16_t, std::string> KEYCODE_ID_TABLE = {')
|
||||
for key, value in keycodes["keycodes"].items():
|
||||
lines.append(f' {{{value.get("key")}, "{value.get("key")}"}},')
|
||||
lines.append('};')
|
||||
|
||||
|
||||
@cli.argument('-v', '--version', arg_only=True, required=True, help='Version of keycodes to generate.')
|
||||
@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@cli.subcommand('Used by the make system to generate a keycode lookup table from keycodes_{version}.json', hidden=True)
|
||||
def generate_keycodes_tests(cli):
|
||||
"""Generates a keycode to identifier lookup table for unit test output.
|
||||
"""
|
||||
|
||||
# Build the keycodes.h file.
|
||||
keycodes_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '// clang-format off']
|
||||
keycodes_h_lines.append('extern "C" {\n#include <keycode.h>\n}')
|
||||
keycodes_h_lines.append('#include <map>')
|
||||
keycodes_h_lines.append('#include <string>')
|
||||
keycodes_h_lines.append('#include <cstdint>')
|
||||
|
||||
keycodes = load_spec(cli.args.version)
|
||||
|
||||
_generate_defines(keycodes_h_lines, keycodes)
|
||||
|
||||
# Show the results
|
||||
dump_lines(cli.args.output, keycodes_h_lines, cli.args.quiet)
|
||||
@@ -8,7 +8,7 @@ from argcomplete.completers import FilesCompleter
|
||||
from qmk.commands import dump_lines
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder
|
||||
from qmk.keymap import keymap_completer, locate_keymap
|
||||
from qmk.path import normpath, FileType
|
||||
from qmk.path import normpath, FileType, unix_style_path
|
||||
|
||||
|
||||
@cli.argument('filename', nargs='?', arg_only=True, type=FileType('r'), completer=FilesCompleter('.json'), help='A configurator export JSON.')
|
||||
@@ -53,4 +53,4 @@ def generate_make_dependencies(cli):
|
||||
for file in interesting_files:
|
||||
check_files.append(Path('users') / cli.args.keymap / file)
|
||||
|
||||
dump_lines(cli.args.output, [f'generated-files: $(wildcard {found})\n' for found in check_files])
|
||||
dump_lines(cli.args.output, [f'generated-files: $(wildcard {unix_style_path(found)})\n' for found in check_files])
|
||||
|
||||
@@ -6,13 +6,12 @@ from dotty_dict import dotty
|
||||
from argcomplete.completers import FilesCompleter
|
||||
from milc import cli
|
||||
|
||||
from qmk.info import info_json, get_modules
|
||||
from qmk.info import info_json
|
||||
from qmk.json_schema import json_load
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder
|
||||
from qmk.commands import dump_lines, parse_configurator_json
|
||||
from qmk.path import normpath, unix_style_path, FileType
|
||||
from qmk.path import normpath, FileType
|
||||
from qmk.constants import GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE
|
||||
from qmk.community_modules import find_module_path, load_module_jsons
|
||||
|
||||
|
||||
def generate_rule(rules_key, rules_value):
|
||||
@@ -56,33 +55,6 @@ def generate_features_rules(features_dict):
|
||||
return lines
|
||||
|
||||
|
||||
def generate_modules_rules(keyboard, filename):
|
||||
lines = []
|
||||
modules = get_modules(keyboard, filename)
|
||||
if len(modules) > 0:
|
||||
lines.append('')
|
||||
lines.append('OPT_DEFS += -DCOMMUNITY_MODULES_ENABLE=TRUE')
|
||||
for module in modules:
|
||||
module_path = unix_style_path(find_module_path(module))
|
||||
if not module_path:
|
||||
raise FileNotFoundError(f"Module '{module}' not found.")
|
||||
lines.append('')
|
||||
lines.append(f'COMMUNITY_MODULES += {module_path.name}') # use module_path here instead of module as it may be a subdirectory
|
||||
lines.append(f'OPT_DEFS += -DCOMMUNITY_MODULE_{module_path.name.upper()}_ENABLE=TRUE')
|
||||
lines.append(f'COMMUNITY_MODULE_PATHS += {module_path}')
|
||||
lines.append(f'VPATH += {module_path}')
|
||||
lines.append(f'SRC += $(wildcard {module_path}/{module_path.name}.c)')
|
||||
lines.append(f'-include {module_path}/rules.mk')
|
||||
|
||||
module_jsons = load_module_jsons(modules)
|
||||
for module_json in module_jsons:
|
||||
if 'features' in module_json:
|
||||
lines.append('')
|
||||
lines.append(f'# Module: {module_json["module_name"]}')
|
||||
lines.extend(generate_features_rules(module_json['features']))
|
||||
return lines
|
||||
|
||||
|
||||
@cli.argument('filename', nargs='?', arg_only=True, type=FileType('r'), completer=FilesCompleter('.json'), help='A configurator export JSON to be compiled and flashed or a pre-compiled binary firmware file (bin/hex) to be flashed.')
|
||||
@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
|
||||
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
|
||||
@@ -133,8 +105,6 @@ def generate_rules_mk(cli):
|
||||
if converter:
|
||||
rules_mk_lines.append(generate_rule('CONVERT_TO', converter))
|
||||
|
||||
rules_mk_lines.extend(generate_modules_rules(cli.args.keyboard, cli.args.filename))
|
||||
|
||||
# Show the results
|
||||
dump_lines(cli.args.output, rules_mk_lines)
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
"""Command to look over a keyboard/keymap and check for common mistakes.
|
||||
"""
|
||||
from dotty_dict import dotty
|
||||
from pathlib import Path
|
||||
|
||||
from milc import cli
|
||||
@@ -11,6 +12,7 @@ from qmk.keymap import locate_keymap, list_keymaps
|
||||
from qmk.path import keyboard
|
||||
from qmk.git import git_get_ignored_files
|
||||
from qmk.c_parse import c_source_files, preprocess_c_file
|
||||
from qmk.json_schema import json_load
|
||||
|
||||
CHIBIOS_CONF_CHECKS = ['chconf.h', 'halconf.h', 'mcuconf.h', 'board.h']
|
||||
INVALID_KB_FEATURES = set(['encoder_map', 'dip_switch_map', 'combo', 'tap_dance', 'via'])
|
||||
@@ -26,7 +28,7 @@ def _list_defaultish_keymaps(kb):
|
||||
defaultish.extend(INVALID_KM_NAMES)
|
||||
|
||||
keymaps = set()
|
||||
for x in list_keymaps(kb):
|
||||
for x in list_keymaps(kb, include_userspace=False):
|
||||
if x in defaultish or x.startswith('default'):
|
||||
keymaps.add(x)
|
||||
|
||||
@@ -171,6 +173,14 @@ def _handle_invalid_features(kb, info):
|
||||
return ok
|
||||
|
||||
|
||||
def _handle_invalid_config(kb, info):
|
||||
"""Check for invalid keyboard level config
|
||||
"""
|
||||
if info.get('url') == "":
|
||||
cli.log.warning(f'{kb}: Invalid keyboard level config detected - Optional field "url" should not be empty.')
|
||||
return True
|
||||
|
||||
|
||||
def _chibios_conf_includenext_check(target):
|
||||
"""Check the ChibiOS conf.h for the correct inclusion of the next conf.h
|
||||
"""
|
||||
@@ -206,6 +216,32 @@ def _rules_mk_assignment_only(rules_mk):
|
||||
return errors
|
||||
|
||||
|
||||
def _handle_duplicating_code_defaults(kb, info):
|
||||
def _collect_dotted_output(kb_info_json, prefix=''):
|
||||
"""Print the info.json in a plain text format with dot-joined keys.
|
||||
"""
|
||||
for key in sorted(kb_info_json):
|
||||
new_prefix = f'{prefix}.{key}' if prefix else key
|
||||
|
||||
if isinstance(kb_info_json[key], dict):
|
||||
yield from _collect_dotted_output(kb_info_json[key], new_prefix)
|
||||
elif isinstance(kb_info_json[key], list):
|
||||
# TODO: handle non primitives?
|
||||
yield (new_prefix, kb_info_json[key])
|
||||
else:
|
||||
yield (new_prefix, kb_info_json[key])
|
||||
|
||||
defaults_map = json_load(Path('data/mappings/info_defaults.hjson'))
|
||||
dotty_info = dotty(info)
|
||||
|
||||
for key, v_default in _collect_dotted_output(defaults_map):
|
||||
v_info = dotty_info.get(key)
|
||||
if v_default == v_info:
|
||||
cli.log.warning(f'{kb}: Option "{key}" duplicates default value of "{v_default}"')
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def keymap_check(kb, km):
|
||||
"""Perform the keymap level checks.
|
||||
"""
|
||||
@@ -255,6 +291,12 @@ def keyboard_check(kb): # noqa C901
|
||||
if not _handle_invalid_features(kb, kb_info):
|
||||
ok = False
|
||||
|
||||
if not _handle_invalid_config(kb, kb_info):
|
||||
ok = False
|
||||
|
||||
if not _handle_duplicating_code_defaults(kb, kb_info):
|
||||
ok = False
|
||||
|
||||
invalid_files = git_get_ignored_files(f'keyboards/{kb}/')
|
||||
for file in invalid_files:
|
||||
if 'keymap' in file:
|
||||
@@ -317,10 +359,10 @@ def lint(cli):
|
||||
if isinstance(cli.config.lint.keyboard, str):
|
||||
# if provided via config - string not array
|
||||
keyboard_list = [cli.config.lint.keyboard]
|
||||
elif is_all_keyboards(cli.args.keyboard[0]):
|
||||
elif any(is_all_keyboards(kb) for kb in cli.args.keyboard):
|
||||
keyboard_list = list_keyboards()
|
||||
else:
|
||||
keyboard_list = cli.config.lint.keyboard
|
||||
keyboard_list = list(set(cli.config.lint.keyboard))
|
||||
|
||||
failed = []
|
||||
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
"""This script automates the copying of the default keymap into your own keymap.
|
||||
"""
|
||||
import re
|
||||
import json
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
|
||||
from milc import cli
|
||||
from milc.questions import question
|
||||
from milc.questions import question, choice
|
||||
|
||||
from qmk.constants import HAS_QMK_USERSPACE, QMK_USERSPACE
|
||||
from qmk.path import is_keyboard, keymaps, keymap
|
||||
@@ -12,6 +14,34 @@ from qmk.git import git_get_username
|
||||
from qmk.decorators import automagic_keyboard, automagic_keymap
|
||||
from qmk.keyboard import keyboard_completer, keyboard_folder
|
||||
from qmk.userspace import UserspaceDefs
|
||||
from qmk.json_schema import json_load
|
||||
from qmk.json_encoders import KeymapJSONEncoder
|
||||
from qmk.info import info_json
|
||||
|
||||
|
||||
def _list_available_converters(kb_name):
|
||||
"""Search for converters that can be applied to a given keyboard
|
||||
"""
|
||||
if not is_keyboard(kb_name):
|
||||
return None
|
||||
|
||||
info = info_json(kb_name)
|
||||
pin_compatible = info.get('pin_compatible')
|
||||
if not pin_compatible:
|
||||
return None
|
||||
|
||||
return sorted(folder.name.split('_to_')[-1] for folder in Path('platforms').glob(f'*/converters/{pin_compatible}_to_*'))
|
||||
|
||||
|
||||
def _set_converter(file, converter):
|
||||
"""add/overwrite any existing converter specified in keymap.json
|
||||
"""
|
||||
json_data = json_load(file) if file.exists() else {}
|
||||
|
||||
json_data['converter'] = converter
|
||||
|
||||
output = json.dumps(json_data, cls=KeymapJSONEncoder, sort_keys=True)
|
||||
file.write_text(output + '\n', encoding='utf-8')
|
||||
|
||||
|
||||
def validate_keymap_name(name):
|
||||
@@ -37,8 +67,28 @@ Keymap name? """
|
||||
return question(prompt, default=git_get_username())
|
||||
|
||||
|
||||
def prompt_converter(kb_name):
|
||||
prompt = """
|
||||
{fg_yellow}Configure Development Board{style_reset_all}
|
||||
For more information, see:
|
||||
https://docs.qmk.fm/feature_converters
|
||||
|
||||
Use converter? """
|
||||
|
||||
converters = _list_available_converters(kb_name)
|
||||
if not converters:
|
||||
return None
|
||||
|
||||
choices = ['No (default)', *converters]
|
||||
|
||||
answer = choice(prompt, options=choices, default=0)
|
||||
return None if choices.index(answer) == 0 else answer
|
||||
|
||||
|
||||
@cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='Specify keyboard name. Example: 1upkeyboards/1up60hse')
|
||||
@cli.argument('-km', '--keymap', help='Specify the name for the new keymap directory')
|
||||
@cli.argument('--converter', help='Specify the name of a converter to configure')
|
||||
@cli.argument('--skip-converter', arg_only=True, action='store_true', help='Skip converter')
|
||||
@cli.subcommand('Creates a new keymap for the keyboard of your choosing')
|
||||
@automagic_keyboard
|
||||
@automagic_keymap
|
||||
@@ -51,9 +101,12 @@ def new_keymap(cli):
|
||||
# ask for user input if keyboard or keymap was not provided in the command line
|
||||
kb_name = cli.config.new_keymap.keyboard if cli.config.new_keymap.keyboard else prompt_keyboard()
|
||||
user_name = cli.config.new_keymap.keymap if cli.config.new_keymap.keymap else prompt_user()
|
||||
converter = cli.config.new_keymap.converter if cli.args.skip_converter or cli.config.new_keymap.converter else prompt_converter(kb_name)
|
||||
|
||||
# check directories
|
||||
if not is_keyboard(kb_name):
|
||||
try:
|
||||
kb_name = keyboard_folder(kb_name)
|
||||
except ValueError:
|
||||
cli.log.error(f'Keyboard {{fg_cyan}}{kb_name}{{fg_reset}} does not exist! Please choose a valid name.')
|
||||
return False
|
||||
|
||||
@@ -77,6 +130,9 @@ def new_keymap(cli):
|
||||
# create user directory with default keymap files
|
||||
shutil.copytree(keymap_path_default, keymap_path_new, symlinks=True)
|
||||
|
||||
if converter:
|
||||
_set_converter(keymap_path_new / 'keymap.json', converter)
|
||||
|
||||
# end message to user
|
||||
cli.log.info(f'{{fg_green}}Created a new keymap called {{fg_cyan}}{user_name}{{fg_green}} in: {{fg_cyan}}{keymap_path_new}.{{fg_reset}}')
|
||||
cli.log.info(f"Compile a firmware with your new keymap by typing: {{fg_yellow}}qmk compile -kb {kb_name} -km {user_name}{{fg_reset}}.")
|
||||
|
||||
@@ -12,6 +12,7 @@ from qmk.constants import QMK_USERSPACE, HAS_QMK_USERSPACE
|
||||
from qmk.json_schema import json_load, validate
|
||||
from qmk.keyboard import keyboard_alias_definitions
|
||||
from qmk.util import maybe_exit
|
||||
from qmk.path import unix_style_path
|
||||
|
||||
|
||||
def find_make():
|
||||
@@ -85,7 +86,7 @@ def build_environment(args):
|
||||
envs = parse_env_vars(args)
|
||||
|
||||
if HAS_QMK_USERSPACE:
|
||||
envs['QMK_USERSPACE'] = Path(QMK_USERSPACE).resolve()
|
||||
envs['QMK_USERSPACE'] = unix_style_path(Path(QMK_USERSPACE).resolve())
|
||||
|
||||
return envs
|
||||
|
||||
|
||||
137
lib/python/qmk/compilation_database.py
Executable file
137
lib/python/qmk/compilation_database.py
Executable file
@@ -0,0 +1,137 @@
|
||||
"""Creates a compilation database for the given keyboard build.
|
||||
"""
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import shlex
|
||||
import shutil
|
||||
from functools import lru_cache
|
||||
from pathlib import Path
|
||||
from typing import Dict, Iterator, List
|
||||
|
||||
from milc import cli
|
||||
|
||||
from qmk.commands import find_make
|
||||
from qmk.constants import QMK_FIRMWARE
|
||||
|
||||
|
||||
@lru_cache(maxsize=10)
|
||||
def system_libs(binary: str) -> List[Path]:
|
||||
"""Find the system include directory that the given build tool uses.
|
||||
"""
|
||||
cli.log.debug("searching for system library directory for binary: %s", binary)
|
||||
|
||||
# Actually query xxxxxx-gcc to find its include paths.
|
||||
if binary.endswith("gcc") or binary.endswith("g++"):
|
||||
# (TODO): Remove 'stdin' once 'input' no longer causes issues under MSYS
|
||||
result = cli.run([binary, '-E', '-Wp,-v', '-'], capture_output=True, check=True, stdin=None, input='\n')
|
||||
paths = []
|
||||
for line in result.stderr.splitlines():
|
||||
if line.startswith(" "):
|
||||
paths.append(Path(line.strip()).resolve())
|
||||
return paths
|
||||
|
||||
return list(Path(binary).resolve().parent.parent.glob("*/include")) if binary else []
|
||||
|
||||
|
||||
@lru_cache(maxsize=10)
|
||||
def cpu_defines(binary: str, compiler_args: str) -> List[str]:
|
||||
cli.log.debug("gathering definitions for compilation: %s %s", binary, compiler_args)
|
||||
if binary.endswith("gcc") or binary.endswith("g++"):
|
||||
invocation = [binary, '-dM', '-E']
|
||||
if binary.endswith("gcc"):
|
||||
invocation.extend(['-x', 'c'])
|
||||
elif binary.endswith("g++"):
|
||||
invocation.extend(['-x', 'c++'])
|
||||
compiler_args = shlex.split(compiler_args)
|
||||
invocation.extend(compiler_args)
|
||||
invocation.append('-')
|
||||
result = cli.run(invocation, capture_output=True, check=True, stdin=None, input='\n')
|
||||
define_args = []
|
||||
for line in result.stdout.splitlines():
|
||||
line_args = line.split(' ', 2)
|
||||
if len(line_args) == 3 and line_args[0] == '#define':
|
||||
define_args.append(f'-D{line_args[1]}={line_args[2]}')
|
||||
elif len(line_args) == 2 and line_args[0] == '#define':
|
||||
define_args.append(f'-D{line_args[1]}')
|
||||
return list(sorted(set(define_args)))
|
||||
return []
|
||||
|
||||
|
||||
file_re = re.compile(r'printf "Compiling: ([^"]+)')
|
||||
cmd_re = re.compile(r'LOG=\$\((.+?)&&')
|
||||
|
||||
|
||||
def parse_make_n(f: Iterator[str]) -> List[Dict[str, str]]:
|
||||
"""parse the output of `make -n <target>`
|
||||
|
||||
This function makes many assumptions about the format of your build log.
|
||||
This happens to work right now for qmk.
|
||||
"""
|
||||
|
||||
state = 'start'
|
||||
this_file = None
|
||||
records = []
|
||||
for line in f:
|
||||
if state == 'start':
|
||||
m = file_re.search(line)
|
||||
if m:
|
||||
this_file = m.group(1)
|
||||
state = 'cmd'
|
||||
|
||||
if state == 'cmd':
|
||||
assert this_file
|
||||
m = cmd_re.search(line)
|
||||
if m:
|
||||
# we have a hit!
|
||||
this_cmd = m.group(1)
|
||||
args = shlex.split(this_cmd)
|
||||
binary = shutil.which(args[0])
|
||||
compiler_args = set(filter(lambda x: x.startswith('-m') or x.startswith('-f'), args))
|
||||
for s in system_libs(binary):
|
||||
args += ['-isystem', '%s' % s]
|
||||
args.extend(cpu_defines(binary, ' '.join(shlex.quote(s) for s in compiler_args)))
|
||||
new_cmd = ' '.join(shlex.quote(s) for s in args)
|
||||
records.append({"directory": str(QMK_FIRMWARE.resolve()), "command": new_cmd, "file": this_file})
|
||||
state = 'start'
|
||||
|
||||
return records
|
||||
|
||||
|
||||
def write_compilation_database(keyboard: str = None, keymap: str = None, output_path: Path = QMK_FIRMWARE / 'compile_commands.json', skip_clean: bool = False, command: List[str] = None, **env_vars) -> bool:
|
||||
# Generate the make command for a specific keyboard/keymap.
|
||||
if not command:
|
||||
from qmk.build_targets import KeyboardKeymapBuildTarget # Lazy load due to circular references
|
||||
target = KeyboardKeymapBuildTarget(keyboard, keymap)
|
||||
command = target.compile_command(dry_run=True, **env_vars)
|
||||
|
||||
if not command:
|
||||
cli.log.error('You must supply both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')
|
||||
cli.echo('usage: qmk generate-compilation-database [-kb KEYBOARD] [-km KEYMAP]')
|
||||
return False
|
||||
|
||||
# remove any environment variable overrides which could trip us up
|
||||
env = os.environ.copy()
|
||||
env.pop("MAKEFLAGS", None)
|
||||
|
||||
# re-use same executable as the main make invocation (might be gmake)
|
||||
if not skip_clean:
|
||||
clean_command = [find_make(), "clean"]
|
||||
cli.log.info('Making clean with {fg_cyan}%s', ' '.join(clean_command))
|
||||
cli.run(clean_command, capture_output=False, check=True, env=env)
|
||||
|
||||
cli.log.info('Gathering build instructions from {fg_cyan}%s', ' '.join(command))
|
||||
|
||||
result = cli.run(command, capture_output=True, check=True, env=env)
|
||||
db = parse_make_n(result.stdout.splitlines())
|
||||
if not db:
|
||||
cli.log.error("Failed to parse output from make output:\n%s", result.stdout)
|
||||
return False
|
||||
|
||||
cli.log.info("Found %s compile commands", len(db))
|
||||
|
||||
cli.log.info(f"Writing build database to {output_path}")
|
||||
output_path.write_text(json.dumps(db, indent=4))
|
||||
|
||||
return True
|
||||
@@ -22,7 +22,7 @@ QMK_FIRMWARE_UPSTREAM = 'qmk/qmk_firmware'
|
||||
MAX_KEYBOARD_SUBFOLDERS = 5
|
||||
|
||||
# Supported processor types
|
||||
CHIBIOS_PROCESSORS = 'cortex-m0', 'cortex-m0plus', 'cortex-m3', 'cortex-m4', 'MKL26Z64', 'MK20DX128', 'MK20DX256', 'MK64FX512', 'MK66FX1M0', 'RP2040', 'STM32F042', 'STM32F072', 'STM32F103', 'STM32F303', 'STM32F401', 'STM32F405', 'STM32F407', 'STM32F411', 'STM32F446', 'STM32G431', 'STM32G474', 'STM32H723', 'STM32H733', 'STM32L412', 'STM32L422', 'STM32L432', 'STM32L433', 'STM32L442', 'STM32L443', 'GD32VF103', 'WB32F3G71', 'WB32FQ95', 'AT32F415'
|
||||
CHIBIOS_PROCESSORS = 'cortex-m0', 'cortex-m0plus', 'cortex-m3', 'cortex-m4', 'MKL26Z64', 'MK20DX128', 'MK20DX256', 'MK64FX512', 'MK66FX1M0', 'RP2040', 'STM32F042', 'STM32F072', 'STM32F103', 'STM32F303', 'STM32F401', 'STM32F405', 'STM32F407', 'STM32F411', 'STM32F446', 'STM32G0B1', 'STM32G431', 'STM32G474', 'STM32H723', 'STM32H733', 'STM32L412', 'STM32L422', 'STM32L432', 'STM32L433', 'STM32L442', 'STM32L443', 'GD32VF103', 'WB32F3G71', 'WB32FQ95', 'AT32F415'
|
||||
LUFA_PROCESSORS = 'at90usb162', 'atmega16u2', 'atmega32u2', 'atmega16u4', 'atmega32u4', 'at90usb646', 'at90usb647', 'at90usb1286', 'at90usb1287', None
|
||||
VUSB_PROCESSORS = 'atmega32a', 'atmega328p', 'atmega328', 'attiny85'
|
||||
|
||||
@@ -42,6 +42,7 @@ MCU2BOOTLOADER = {
|
||||
"STM32F407": "stm32-dfu",
|
||||
"STM32F411": "stm32-dfu",
|
||||
"STM32F446": "stm32-dfu",
|
||||
"STM32G0B1": "stm32-dfu",
|
||||
"STM32G431": "stm32-dfu",
|
||||
"STM32G474": "stm32-dfu",
|
||||
"STM32H723": "stm32-dfu",
|
||||
|
||||
@@ -5,7 +5,7 @@ from time import monotonic
|
||||
|
||||
from milc import cli
|
||||
|
||||
from qmk.keyboard import find_keyboard_from_dir
|
||||
from qmk.keyboard import find_keyboard_from_dir, keyboard_folder
|
||||
from qmk.keymap import find_keymap_from_dir
|
||||
|
||||
|
||||
@@ -27,6 +27,11 @@ def automagic_keyboard(func):
|
||||
def wrapper(*args, **kwargs):
|
||||
cmd = _get_subcommand_name()
|
||||
|
||||
# TODO: Workaround for if config file contains "old" keyboard name
|
||||
# Potential long-term fix needs to be within global cli or milc
|
||||
if cli.config_source[cmd]['keyboard'] == 'config_file':
|
||||
cli.config[cmd]['keyboard'] = keyboard_folder(cli.config[cmd]['keyboard'])
|
||||
|
||||
# Ensure that `--keyboard` was not passed and CWD is under `qmk_firmware/keyboards`
|
||||
if cli.config_source[cmd]['keyboard'] != 'argument':
|
||||
keyboard = find_keyboard_from_dir()
|
||||
|
||||
@@ -1066,23 +1066,13 @@ def get_modules(keyboard, keymap_filename):
|
||||
"""
|
||||
modules = []
|
||||
|
||||
kb_info_json = info_json(keyboard)
|
||||
modules.extend(kb_info_json.get('modules', []))
|
||||
|
||||
if keymap_filename:
|
||||
keymap_json = parse_configurator_json(keymap_filename)
|
||||
|
||||
if keymap_json:
|
||||
kb = keymap_json.get('keyboard', None)
|
||||
if not kb:
|
||||
kb = keyboard
|
||||
|
||||
if kb:
|
||||
kb_info_json = info_json(kb)
|
||||
if kb_info_json:
|
||||
modules.extend(kb_info_json.get('modules', []))
|
||||
|
||||
modules.extend(keymap_json.get('modules', []))
|
||||
|
||||
elif keyboard:
|
||||
kb_info_json = info_json(keyboard)
|
||||
modules.extend(kb_info_json.get('modules', []))
|
||||
|
||||
return list(dict.fromkeys(modules)) # remove dupes
|
||||
|
||||
@@ -250,12 +250,14 @@ class CommunityModuleJSONEncoder(QMKJSONEncoder):
|
||||
return '00module_name'
|
||||
if key == 'maintainer':
|
||||
return '01maintainer'
|
||||
if key == 'license':
|
||||
return '02license'
|
||||
if key == 'url':
|
||||
return '02url'
|
||||
return '03url'
|
||||
if key == 'features':
|
||||
return '03features'
|
||||
return '04features'
|
||||
if key == 'keycodes':
|
||||
return '04keycodes'
|
||||
return '05keycodes'
|
||||
elif self.indentation_level == 3: # keycodes
|
||||
if key == 'key':
|
||||
return '00key'
|
||||
|
||||
@@ -76,8 +76,13 @@ def compile_schema_store():
|
||||
if not isinstance(schema_data, dict):
|
||||
cli.log.debug('Skipping schema file %s', schema_file)
|
||||
continue
|
||||
|
||||
# `$id`-based references
|
||||
schema_store[schema_data['$id']] = schema_data
|
||||
|
||||
# Path-based references
|
||||
schema_store[Path(schema_file).name] = schema_data
|
||||
|
||||
return schema_store
|
||||
|
||||
|
||||
|
||||
@@ -89,6 +89,7 @@ def load_spec(version, lang=None):
|
||||
spec = _process_files(_locate_files(path, prefix, versions))
|
||||
|
||||
# Sort?
|
||||
spec['version'] = version
|
||||
spec['keycodes'] = dict(sorted(spec.get('keycodes', {}).items()))
|
||||
spec['ranges'] = dict(sorted(spec.get('ranges', {}).items()))
|
||||
|
||||
|
||||
@@ -399,7 +399,7 @@ def is_keymap_target(keyboard, keymap):
|
||||
return False
|
||||
|
||||
|
||||
def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=False):
|
||||
def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=False, include_userspace=True):
|
||||
"""List the available keymaps for a keyboard.
|
||||
|
||||
Args:
|
||||
@@ -418,14 +418,19 @@ def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=Fa
|
||||
fullpath
|
||||
When set to True the full path of the keymap relative to the `qmk_firmware` root will be provided.
|
||||
|
||||
include_userspace
|
||||
When set to True, also search userspace for available keymaps
|
||||
|
||||
Returns:
|
||||
a sorted list of valid keymap names.
|
||||
"""
|
||||
names = set()
|
||||
|
||||
has_userspace = HAS_QMK_USERSPACE and include_userspace
|
||||
|
||||
# walk up the directory tree until keyboards_dir
|
||||
# and collect all directories' name with keymap.c file in it
|
||||
for search_dir in [QMK_FIRMWARE, QMK_USERSPACE] if HAS_QMK_USERSPACE else [QMK_FIRMWARE]:
|
||||
for search_dir in [QMK_FIRMWARE, QMK_USERSPACE] if has_userspace else [QMK_FIRMWARE]:
|
||||
keyboards_dir = search_dir / Path('keyboards')
|
||||
kb_path = keyboards_dir / keyboard
|
||||
|
||||
@@ -443,7 +448,7 @@ def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=Fa
|
||||
info = info_json(keyboard)
|
||||
|
||||
community_parents = list(Path('layouts').glob('*/'))
|
||||
if HAS_QMK_USERSPACE and (Path(QMK_USERSPACE) / "layouts").exists():
|
||||
if has_userspace and (Path(QMK_USERSPACE) / "layouts").exists():
|
||||
community_parents.append(Path(QMK_USERSPACE) / "layouts")
|
||||
|
||||
for community_parent in community_parents:
|
||||
|
||||
@@ -12,29 +12,30 @@ from qmk.json_encoders import UserspaceJSONEncoder
|
||||
|
||||
|
||||
def qmk_userspace_paths():
|
||||
test_dirs = set()
|
||||
test_dirs = []
|
||||
|
||||
# If we're already in a directory with a qmk.json and a keyboards or layouts directory, interpret it as userspace
|
||||
if environ.get('ORIG_CWD') is not None:
|
||||
current_dir = Path(environ['ORIG_CWD'])
|
||||
while len(current_dir.parts) > 1:
|
||||
if (current_dir / 'qmk.json').is_file():
|
||||
test_dirs.add(current_dir)
|
||||
test_dirs.append(current_dir)
|
||||
current_dir = current_dir.parent
|
||||
|
||||
# If we have a QMK_USERSPACE environment variable, use that
|
||||
if environ.get('QMK_USERSPACE') is not None:
|
||||
current_dir = Path(environ['QMK_USERSPACE']).expanduser()
|
||||
if current_dir.is_dir():
|
||||
test_dirs.add(current_dir)
|
||||
test_dirs.append(current_dir)
|
||||
|
||||
# If someone has configured a directory, use that
|
||||
if cli.config.user.overlay_dir is not None:
|
||||
current_dir = Path(cli.config.user.overlay_dir).expanduser().resolve()
|
||||
if current_dir.is_dir():
|
||||
test_dirs.add(current_dir)
|
||||
test_dirs.append(current_dir)
|
||||
|
||||
return list(test_dirs)
|
||||
# remove duplicates while maintaining the current order
|
||||
return list(dict.fromkeys(test_dirs))
|
||||
|
||||
|
||||
def qmk_userspace_validate(path):
|
||||
|
||||
Reference in New Issue
Block a user