Add option to show key under transparent keys, and find the layer name during parsing #67

FancyFurret · 2023-12-12T01:46:16Z

Hi, I needed these two features and implemented them. I think others might want them as well

Added an option to show the keys under transparent keys. Now you can see what key will actually be sent when that transparent key is pressed. If there are multiple ways to get to a layer, and the transparent key could send different things based on the current path, then it will show all the possibilities (I imagine this would be pretty rare, my layout does not do this). The style of these is still set to trans, so they can be styled as such.
During QMK parsing, it will find the layer names from their indexes. This way parsing qmk c2json files will show the correct destination layer for MO/LT/etc.

Let me know if you have any questions!

FancyFurret · 2023-12-12T05:59:24Z

Example of what showing the key under the transparent keys looks like:

caksoylar

Thanks! Looks good to me in general, a few comments and questions noted.

caksoylar · 2023-12-12T06:22:35Z

keymap_drawer/config.py

@@ -237,6 +237,9 @@ class ParseConfig(BaseSettings, env_prefix="KEYMAP_", extra="ignore"):
    # legend to output for transparent keys
    trans_legend: str | dict = {"t": "▽", "type": "trans"}

+    # whether to show the keycode this transparent key will activate
+    trans_show_lower_key: bool = False


Can you add an item to CONFIGURATION.md as well?

caksoylar · 2023-12-12T06:23:20Z

keymap_drawer/parse/parse.py

-        self.layer_activated_from: dict[int, set[int]] = {}  # layer to key positions
+        self.layer_activated_from: dict[
+            int, set[tuple[int, int]]
+        ] = {}  # layer to [layer index, key position] from keys


Suggested change

] = {} # layer to [layer index, key position] from keys

] = {} # layer to (layer index, key position) from keys

caksoylar · 2023-12-12T06:26:12Z

keymap_drawer/parse/parse.py

+            layer_name = self.layer_names[layer_idx]
+            from_layer = layers[layer_name]


Suggested change

layer_name = self.layer_names[layer_idx]

from_layer = layers[layer_name]

from_layer = layers[self.layer_names[layer_idx]]

caksoylar · 2023-12-12T06:27:14Z

keymap_drawer/parse/parse.py

+            layer_name = self.layer_names[layer_idx]
+            from_layer = layers[layer_name]
+            lower_key = from_layer[key]
+            if lower_key == self.trans_key:


Is this comparison why the hash function is necessary?

caksoylar · 2023-12-12T06:29:00Z

keymap_drawer/parse/qmk.py

@@ -17,7 +17,7 @@ class QmkJsonParser(KeymapParser):
    _tog_re = re.compile(r"(TG|TO|DF)\((\d+)\)")
    _mts_re = re.compile(r"([A-Z_]+)_T\((\S+)\)")
    _mtl_re = re.compile(r"MT\((\S+), *(\S+)\)")
-    _lt_re = re.compile(r"LT\((\d+), *(\S+)\)")
+    _lt_re = re.compile(r"LT\((\S+), *(\S+)\)")


I am not sure I understand how this happens, can you actually have layer name defines instead of indices in keymap.json? Do you use it alongside e.g. config.h that contains layer defines?

caksoylar · 2023-12-12T06:32:00Z

keymap_drawer/parse/qmk.py

@@ -50,23 +50,32 @@ def mapped(key: str) -> LayoutKey:
                key = self._prefix_re.sub("", key)
            return LayoutKey.from_key_spec(self.cfg.qmk_keycode_map.get(key, key.replace("_", " ")))

+        def parse_layer(layer: str) -> int:
+            assert self.layer_names is not None


If I am not wrong, the only way we know layer names is still via user input, i.e. --layer-names. If so, I think it would be nice to have an informative error message here, perhaps like below?

Suggested change

assert self.layer_names is not None

assert self.layer_names is not None, "Please provide `--layer-names` if you use layer defines in keymap.json"

caksoylar · 2024-04-25T18:07:13Z

Pinging on this, see my questions above.

FancyFurret added 3 commits December 11, 2023 18:39

feat: Add option to show the key under transparent keys

20470e3

feat: Find layer name from index during parsing

cfc0de0

Fix checks

de5dbec

caksoylar reviewed Dec 12, 2023

View reviewed changes

caksoylar force-pushed the main branch 2 times, most recently from afbdb42 to 140ca43 Compare November 19, 2024 21:36

caksoylar closed this Nov 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to show key under transparent keys, and find the layer name during parsing #67

Add option to show key under transparent keys, and find the layer name during parsing #67

FancyFurret commented Dec 12, 2023 •

edited

Loading

FancyFurret commented Dec 12, 2023

caksoylar left a comment

caksoylar Dec 12, 2023

caksoylar Dec 12, 2023

caksoylar Dec 12, 2023

caksoylar Dec 12, 2023

caksoylar Dec 12, 2023

caksoylar Dec 12, 2023

caksoylar commented Apr 25, 2024

	] = {} # layer to [layer index, key position] from keys
	] = {} # layer to (layer index, key position) from keys

		layer_name = self.layer_names[layer_idx]
		from_layer = layers[layer_name]

	layer_name = self.layer_names[layer_idx]
	from_layer = layers[layer_name]
	from_layer = layers[self.layer_names[layer_idx]]

	assert self.layer_names is not None
	assert self.layer_names is not None, "Please provide `--layer-names` if you use layer defines in keymap.json"

Add option to show key under transparent keys, and find the layer name during parsing #67

Add option to show key under transparent keys, and find the layer name during parsing #67

Conversation

FancyFurret commented Dec 12, 2023 • edited Loading

FancyFurret commented Dec 12, 2023

caksoylar left a comment

Choose a reason for hiding this comment

caksoylar Dec 12, 2023

Choose a reason for hiding this comment

caksoylar Dec 12, 2023

Choose a reason for hiding this comment

caksoylar Dec 12, 2023

Choose a reason for hiding this comment

caksoylar Dec 12, 2023

Choose a reason for hiding this comment

caksoylar Dec 12, 2023

Choose a reason for hiding this comment

caksoylar Dec 12, 2023

Choose a reason for hiding this comment

caksoylar commented Apr 25, 2024

FancyFurret commented Dec 12, 2023 •

edited

Loading