File: keymatrix.py

package info (click to toggle)
python-blessed 1.25-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,812 kB
  • sloc: python: 14,645; makefile: 13; sh: 7
file content (463 lines) | stat: -rwxr-xr-x 16,284 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
#!/usr/bin/env python
"""
Advanced keyboard and special modes interaction example.

Usage:
- F1-F11: Toggle DEC private modes (bracketed paste, mouse, etc.)
- Shift+F1-F5: Toggle Kitty keyboard protocol flags
- 'q': Exit

All modes that elicit responses are activated for demonstration.
"""
# std imports
import sys
from typing import Dict, List, Tuple, Optional, Any
import functools
from collections import deque

# local
from blessed import Terminal

# For convenience in type hints and initialization
DecPrivateMode = Terminal.DecPrivateMode


class DecModeManager:
    """Manages DEC Private Mode probing, tracking, and toggling."""

    def __init__(self, term: Terminal, test_modes: Tuple[DecPrivateMode, ...]):
        self.term = term
        self.test_modes = test_modes
        self.available_modes: Dict[DecPrivateMode, bool] = {}
        self.active_contexts: Dict[DecPrivateMode, Any] = {}

    def probe(self) -> List[str]:
        """Probe terminal for DEC mode support and return log messages."""
        messages = ["Checking DEC Private Mode status:"]

        for mode in self.test_modes:
            mode = DecPrivateMode(mode)
            response = self.term.get_dec_mode(mode)

            if not response.supported:
                messages.append(f'{mode}: no support')
                continue

            status = "enabled" if response.enabled else "disabled"
            if response.permanent:
                messages.append(f'{mode}: permanent, enabled={response.enabled}')
                continue

            messages.append(f'{mode}: {status}')
            self.available_modes[mode] = response.enabled

        if not self.available_modes:
            messages.append("All DEC Private Modes fail support")

        return messages

    def entries(self) -> List[Tuple[DecPrivateMode, bool]]:
        """Return list of (mode, enabled) pairs for display."""
        return [(mode, enabled) for mode, enabled in self.available_modes.items()]

    def toggle_by_index(self, f_key_idx: int) -> str:
        """Toggle DEC mode by F-key index and return log message."""
        if f_key_idx >= len(self.test_modes):
            return ""

        mode = self.test_modes[f_key_idx]
        if mode not in self.available_modes:
            return ""

        old_enabled = self.available_modes[mode]
        new_enabled = not old_enabled
        self.available_modes[mode] = new_enabled

        try:
            if new_enabled and mode not in self.active_contexts:
                cm = self.term.dec_modes_enabled(mode)
                cm.__enter__()
                self.active_contexts[mode] = cm
                return f'Enabled {mode}'
            elif not new_enabled and mode in self.active_contexts:
                cm = self.active_contexts.pop(mode)
                cm.__exit__(None, None, None)
                return f'Disabled {mode}'
        except Exception as e:
            self.available_modes[mode] = old_enabled
            return f'Failed to toggle {mode}: {e}'

        return ""

    def toggle_keynames(self) -> List[str]:
        """Return list of key names that toggle DEC modes."""
        return [f'KEY_F{i}' for i in range(1, 12)]

    def get_index_by_key(self, key_name: str) -> int:
        """Convert key name to toggle index."""
        f_num = int(key_name.split('_')[-1][1:])
        return f_num - 1

    def cleanup(self) -> None:
        """Clean up all active context managers."""
        for cm in self.active_contexts.values():
            try:
                cm.__exit__(None, None, None)
            except BaseException:
                pass


class KittyKeyboardManager:
    """Manages Kitty keyboard protocol probing and toggling."""

    def __init__(self, term: Terminal):
        self.term = term
        self.kitty_flags: Optional[Any] = None
        self.active_context: Optional[Any] = None
        self.flag_masks = [1, 2, 4, 8, 16]

    def probe(self) -> Tuple[bool, Optional[str], Optional[str]]:
        """Probe kitty keyboard support."""
        self.kitty_flags = self.term.get_kitty_keyboard_state()

        if self.kitty_flags is None:
            return ["Kitty Keyboard Protocol not supported!"]

        return [f'Kitty Keyboard Protocol is {self.kitty_flags!r}']

    def toggle_by_index(self, shift_f_idx: int) -> str:
        """Toggle kitty flag by Shift+F index and return log message."""
        if self.kitty_flags is None or shift_f_idx >= len(self.flag_masks):
            return ""

        mask = self.flag_masks[shift_f_idx]
        self.kitty_flags.value ^= mask

        try:
            if self.active_context is not None:
                self.active_context.__exit__(None, None, None)
                self.active_context = None

            args = self.kitty_flags.make_arguments()
            if any(args.values()):
                self.active_context = self.term.enable_kitty_keyboard(**args)
                self.active_context.__enter__()
                return f'Kitty: {self.kitty_flags!r}'
            else:
                return 'Kitty: disabled'
        except Exception as e:
            return f'Kitty error: {e}'

    def header_msg(self) -> str:
        return f"{self.repr_flags()} [Shift+F1..F5] to toggle"

    def repr_flags(self) -> str:
        """Return string representation of current flags."""
        return f"{self.kitty_flags!r}" if self.kitty_flags else ""

    def toggle_keynames(self) -> List[str]:
        """Return list of key names that toggle Kitty keyboard flags."""
        return [f'KEY_SHIFT_F{i}' for i in range(1, 6)]

    def get_index_by_key(self, key_name: str) -> int:
        """Convert key name to toggle index."""
        f_num = int(key_name.split('_')[-1][1:])
        return f_num - 1

    def cleanup(self) -> None:
        """Clean up active context manager."""
        if self.active_context is not None:
            try:
                self.active_context.__exit__(None, None, None)
            except BaseException:
                pass


class MouseModeManager:
    """Manages mouse mode probing and toggling."""

    def __init__(self, term: Terminal):
        self.term = term
        self.supported: bool = False
        self.active_context: Optional[Any] = None
        self.report_drag: bool = False
        self.report_motion: bool = False
        self.report_pixels: bool = False
        self.mode_names = ['drag', 'motion', 'pixels']

    def probe(self) -> List[str]:
        """Probe terminal for mouse support and return log messages."""
        self.supported = self.term.does_mouse()
        if self.supported:
            return ["Mouse support detected!"]
        return ["Mouse support not available!"]

    def toggle_by_index(self, f_idx: int) -> str:
        """Toggle mouse mode by F-key index and return log message."""
        if not self.supported or f_idx >= len(self.mode_names):
            return ""

        mode_name = self.mode_names[f_idx]

        # Toggle the flag
        if mode_name == 'drag':
            self.report_drag = not self.report_drag
        elif mode_name == 'motion':
            self.report_motion = not self.report_motion
        elif mode_name == 'pixels':
            self.report_pixels = not self.report_pixels

        # Clean up old context
        if self.active_context is not None:
            self.active_context.__exit__(None, None, None)
            self.active_context = None

        # Create new context if any mode is enabled
        if self.report_drag or self.report_motion or self.report_pixels:
            self.active_context = self.term.mouse_enabled(
                report_drag=self.report_drag,
                report_motion=self.report_motion,
                report_pixels=self.report_pixels
            )
            self.active_context.__enter__()  # pylint: disable=unnecessary-dunder-call

        return (
            f'Mouse: drag={self.report_drag} '
            f'motion={self.report_motion} pixels={self.report_pixels}'
        )

    def header_msg(self) -> str:
        """Return header message showing current mouse modes."""
        if not self.supported:
            return "Mouse: not supported"
        status = []
        if self.report_drag:
            status.append("drag")
        if self.report_motion:
            status.append("motion")
        if self.report_pixels:
            status.append("pixels")
        status_str = "+".join(status) if status else "disabled"
        return f"Mouse: {status_str} [F9=drag F10=motion F11=pixels]"

    def toggle_keynames(self) -> List[str]:
        """Return list of key names that toggle mouse modes."""
        return ['KEY_F9', 'KEY_F10', 'KEY_F11']

    def get_index_by_key(self, key_name: str) -> int:
        """Convert key name to toggle index."""
        f_num = int(key_name.split('_')[-1][1:])
        return f_num - 9  # F9 -> index 0, F10 -> index 1, F11 -> index 2

    def cleanup(self) -> None:
        """Clean up active context manager."""
        if self.active_context is not None:
            self.active_context.__exit__(None, None, None)


def get_test_modes() -> Tuple[DecPrivateMode, ...]:
    """Return the tuple of DEC private modes to test."""
    return (
        DecPrivateMode.DECCKM,
        DecPrivateMode.DECSCNM,
        DecPrivateMode.DECKANAM,
        DecPrivateMode.FOCUS_IN_OUT_EVENTS,
        DecPrivateMode.META_SENDS_ESC,
        DecPrivateMode.ALT_SENDS_ESC,
        DecPrivateMode.BRACKETED_PASTE
    )


def render_header(term: Terminal, dec_manager: DecModeManager, kitty_manager:
                  KittyKeyboardManager, mouse_manager: MouseModeManager) -> int:
    """
    Render the header section.

    Returns number of rows used.
    """
    header = ["Press ^C to quit."]
    if kitty_manager.kitty_flags is not None:
        header.append(f"{kitty_manager.repr_flags()} [Shift+F1..F5] to toggle")

    if mouse_manager.supported:
        header.append(mouse_manager.header_msg())

    # Display DEC modes table
    if dec_manager.entries():
        maxlen = max(len(repr(m)) for m, _ in dec_manager.entries())
        for mode, enabled in dec_manager.entries():
            idx = dec_manager.test_modes.index(mode)
            status = "  IS  " if enabled else "IS NOT"
            f_key = f"F{idx + 1}"
            mode_description = (
                f"{repr(mode):<{maxlen}} "
                f"{term.reverse(status)} Enabled, "
                f"[{term.reverse(f_key)}] toggles")
            header.append(mode_description)

    # Display, Separators, headers, return row count
    echo = functools.partial(print, end=term.clear_eol + '\r\n', flush=False)
    echo(term.home, end='')
    echo('-' * term.width)
    row_count = 1
    for line in header:
        echo(line)
        row_count += 1
    echo('-' * term.width, flush=True)
    row_count += 1
    return row_count


def render_keymatrix(term: Terminal, n_header_rows: int, raw_sequences: deque,
                     formatted_events: deque) -> None:
    """Render the key matrix display with raw sequences bar and formatted table."""
    # Calculate bar width (1/3 of terminal width)
    bar_width = term.width // 3
    bar_y = n_header_rows + 3

    # remove raw sequences tracked until they fit
    def _fmt(i, sequence):
        if sequence.is_sequence:
            rs = repr(str(sequence))
        else:
            rs = repr(sequence)
        if rs.startswith("'") and rs.endswith("'"):
            rs = rs.strip("'")
        elif rs.startswith('"') and rs.endswith('"'):
            rs = rs.strip('"')

        if i % 2 == 0:
            return term.reverse(rs)
        return rs

    while True:
        bar_content = ''.join(_fmt(len(raw_sequences) - i, sequence)
                              for i, sequence in
                              enumerate(raw_sequences))
        if term.length(bar_content) < bar_width:
            break
        raw_sequences.popleft()

    echo = functools.partial(print, end=term.clear_eol + '\r\n', flush=False)
    bar_line = ' ' * ((term.width // 3) - 3) + f'[ {bar_content} ]'
    echo(term.move_yx(bar_y - 3, 0))
    echo()
    echo(bar_line)
    echo()

    # Calculate available space for formatted events table
    max_event_rows = term.height - bar_y - 5

    # Render formatted events table
    events_to_display = list(formatted_events)[-max_event_rows:]

    echo()
    echo(f"{'value':<6} {'repr':<20} {'Name':<25} extra:")
    echo()
    for event_line in events_to_display:
        echo(event_line)
    echo('', end=term.clear_eos, flush=True)


def format_key_event(term, keystroke) -> str:
    """Format a key event for columnar display."""
    # Build columns: sequence | value | name | modifiers/mode_values
    value_repr = repr(keystroke.value)[:6]
    seq_repr = repr(str(keystroke))[:20]
    name_repr = repr(keystroke.name)[:25]

    if keystroke.mode and int(keystroke.mode) > 0:
        extra = f'{keystroke.mode}:{keystroke._mode_values!r}'
    else:
        events = []
        for event_name in ('pressed', 'released', 'repeated'):
            if getattr(keystroke, event_name):
                events.append(event_name)
        assert len(events) == 1, events
        modifiers = []
        for modifier_name in (
            # possible with most terminals
            'shift', 'alt', 'ctrl',
            # kitty, only
                'super', 'hyper', 'meta', 'caps_lock', 'num_lock'):
            if getattr(keystroke, f'_{modifier_name}'):
                modifiers.append(modifier_name.upper())
        extra = f'{events[0]} {"+".join(modifiers)}'
    trim_mode = max(10, term.width - 25 - 20 - 6 - 3)
    return f"{value_repr:<6} {seq_repr:<20} {name_repr:<25} {extra[:trim_mode]}"


def main():
    """Main application orchestrator."""
    term = Terminal()
    test_modes = get_test_modes()

    # Initialize managers

    # Key event storage
    raw_sequences = deque(maxlen=100)  # Store raw sequences
    formatted_events = deque(maxlen=50)  # Store formatted event lines

    # Probe terminal capabilities
    dec_manager = DecModeManager(term, test_modes)
    formatted_events.extend(dec_manager.probe())

    kitty_manager = KittyKeyboardManager(term)
    formatted_events.extend(kitty_manager.probe())

    mouse_manager = MouseModeManager(term)
    formatted_events.extend(mouse_manager.probe())

    # Ensure clean input state
    inp = term.flushinp(0.1)
    assert not inp, "Expected no input after automatic sequence negotiation"

    # Main interaction loop
    input_mode = term.cbreak if '--cbreak' in sys.argv else term.raw
    oldsize = (term.height, term.width)
    with input_mode(), term.fullscreen():
        message = None
        n_header_rows = 0

        # Initial full render
        n_header_rows = render_header(term, dec_manager, kitty_manager, mouse_manager)
        render_keymatrix(term, n_header_rows, raw_sequences, formatted_events)

        do_exit = False
        while not do_exit:
            # Handle user input
            inp = term.inkey()
            for mgr in (dec_manager, kitty_manager, mouse_manager):
                if inp.name in mgr.toggle_keynames():
                    index = mgr.get_index_by_key(inp.name)
                    message = mgr.toggle_by_index(index)
                    break

            if inp == 'q' or inp.name == 'KEY_CTRL_C':
                do_exit = True

            if inp:
                raw_sequences.append(inp)
                formatted_events.append(format_key_event(term, inp))

            # If mode was toggled, screen was resized, or CTRL^L pressed,
            # re-render header
            if (message
                    or oldsize != (term.height, term.width)
                    or inp.name == 'KEY_CTRL_L'):
                if message:
                    formatted_events.append(f">> {message}")
                    message = None
                n_header_rows = render_header(term, dec_manager, kitty_manager, mouse_manager)
                oldsize = (term.height, term.width)

            # Always render key matrix (efficient, only updates changed area)
            render_keymatrix(term, n_header_rows, raw_sequences, formatted_events)

        dec_manager.cleanup()
        kitty_manager.cleanup()
        mouse_manager.cleanup()


if __name__ == '__main__':
    main()