summaryrefslogtreecommitdiff
path: root/lib/python/qmk/keymap.py
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-04-15 02:00:59 +0000
committerQMK Bot <hello@qmk.fm>2021-04-15 02:00:59 +0000
commit2c0aa27e6c0db68c026d2e8d1b416bac5e9599a5 (patch)
tree8b0bb8f960c3edb631e30d391eb69443c85c48c2 /lib/python/qmk/keymap.py
parent19b143688fabcad7ffd192e56642232f1a08fdae (diff)
parent588bcdc8ca212b195a428fc43766a59a9252c08d (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'lib/python/qmk/keymap.py')
-rw-r--r--lib/python/qmk/keymap.py56
1 files changed, 52 insertions, 4 deletions
diff --git a/lib/python/qmk/keymap.py b/lib/python/qmk/keymap.py
index d8495c38bc..4ad9ffb591 100644
--- a/lib/python/qmk/keymap.py
+++ b/lib/python/qmk/keymap.py
@@ -1,19 +1,19 @@
"""Functions that help you work with QMK keymaps.
"""
-from pathlib import Path
import json
import subprocess
import sys
+from pathlib import Path
+import argcomplete
+from milc import cli
from pygments.lexers.c_cpp import CLexer
from pygments.token import Token
from pygments import lex
-from milc import cli
-
-from qmk.keyboard import rules_mk
import qmk.path
import qmk.commands
+from qmk.keyboard import find_keyboard_from_dir, rules_mk
# The `keymap.c` template to use when a keyboard doesn't have its own
DEFAULT_KEYMAP_C = """#include QMK_KEYBOARD_H
@@ -74,6 +74,54 @@ def _strip_any(keycode):
return keycode
+def find_keymap_from_dir():
+ """Returns `(keymap_name, source)` for the directory we're currently in.
+
+ """
+ relative_cwd = qmk.path.under_qmk_firmware()
+
+ if relative_cwd and len(relative_cwd.parts) > 1:
+ # If we're in `qmk_firmware/keyboards` and `keymaps` is in our path, try to find the keyboard name.
+ if relative_cwd.parts[0] == 'keyboards' and 'keymaps' in relative_cwd.parts:
+ current_path = Path('/'.join(relative_cwd.parts[1:])) # Strip 'keyboards' from the front
+
+ if 'keymaps' in current_path.parts and current_path.name != 'keymaps':
+ while current_path.parent.name != 'keymaps':
+ current_path = current_path.parent
+
+ return current_path.name, 'keymap_directory'
+
+ # If we're in `qmk_firmware/layouts` guess the name from the community keymap they're in
+ elif relative_cwd.parts[0] == 'layouts' and is_keymap_dir(relative_cwd):
+ return relative_cwd.name, 'layouts_directory'
+
+ # If we're in `qmk_firmware/users` guess the name from the userspace they're in
+ elif relative_cwd.parts[0] == 'users':
+ # Guess the keymap name based on which userspace they're in
+ return relative_cwd.parts[1], 'users_directory'
+
+ return None, None
+
+
+def keymap_completer(prefix, action, parser, parsed_args):
+ """Returns a list of keymaps for tab completion.
+ """
+ try:
+ if parsed_args.keyboard:
+ return list_keymaps(parsed_args.keyboard)
+
+ keyboard = find_keyboard_from_dir()
+
+ if keyboard:
+ return list_keymaps(keyboard)
+
+ except Exception as e:
+ argcomplete.warn(f'Error: {e.__class__.__name__}: {str(e)}')
+ return []
+
+ return []
+
+
def is_keymap_dir(keymap, c=True, json=True, additional_files=None):
"""Return True if Path object `keymap` has a keymap file inside.