├── README.org ├── kkp-debug.el ├── kkp.el └── LICENSE /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: kkp.el -- Support for the Kitty Keyboard protocol in Emacs 2 | #+AUTHOR: Benjamin Orthen 3 | #+OPTIONS: ^:{} 4 | 5 | [[https://melpa.org/#/kkp][file:https://melpa.org/packages/kkp-badge.svg]] 6 | 7 | * Overview 8 | 9 | This package provides support for the [[https://sw.kovidgoyal.net/kitty/keyboard-protocol][Kitty Keyboard Protocol]] (KKP). 10 | 11 | KKP defines an alternative way to handle keyboard input for programs running in the terminal. 12 | This allows, if the terminal (and intermediaries such as terminal multiplexers) support the protocol as well, 13 | the transmission of more detailed information about a key event from the terminal to Emacs, e.g., it transmits "C-" and "C-h" differently. 14 | 15 | Currently, there exists another solution which solves the same problem, xterm's "modifyOtherKeys", which is already supported by Emacs (and activated by default if the terminal supports it). 16 | KKP has the advantage of supporting more keys (e.g., "" or ""), more key combinations (e.g., "C-M-S-z") and more modifiers, i.e., the Hyper and Super keys. 17 | It can also dynamically detect if a terminal supports the protocol, whereas Emacs has to deduce "modifyOtherKeys" support from the TERM variable. 18 | 19 | ** Status 20 | This package supports the "Disambiguate escape codes" and "Report 21 | alternate keys" enhancements. I use it on a regular basis and it has 22 | seen some testing from other users. 23 | 24 | ** Installation 25 | *** Melpa 26 | You can install this package from [[https://melpa.org/#/kkp][Melpa]], by first ensuring that you have the melpa source in your package-archives. 27 | #+begin_src emacs-lisp 28 | (require 'package) 29 | (add-to-list 'package-archives 30 | '("melpa" . "http://melpa.org/packages/") t) 31 | (package-initialize) 32 | (package-refresh-contents) 33 | #+end_src 34 | 35 | Once that is done, this package can be installed. 36 | 37 | #+begin_src shell 38 | package-install kkp 39 | #+end_src 40 | *** use-package 41 | 42 | #+begin_src emacs-lisp 43 | (use-package kkp 44 | :ensure t 45 | :config 46 | ;; (setq kkp-alt-modifier 'alt) ;; use this if you want to map the Alt keyboard modifier to Alt in Emacs (and not to Meta) 47 | (global-kkp-mode +1)) 48 | #+end_src 49 | 50 | ** Usage 51 | 52 | kkp.el works out of the box by enabling =global-kkp-mode= and is customizable via the =kkp-*= customization variables. 53 | 54 | If you want to know if your terminal supports kkp, if its activated, and if yes, which enhancements are active, use =kkp-status=. 55 | 56 | You can control the enabled [[https://sw.kovidgoyal.net/kitty/keyboard-protocol/#progressive-enhancement][enhancements]] by setting =kkp-active-enhancements=. 57 | By default, it is set to =(disambiguate-escape-codes report-alternate-keys)=. 58 | 59 | You can run your own functions at kkp terminal setup and teardown by hooking into =kkp-terminal-setup-complete-hook= and =kkp-terminal-teardown-complete-hook=. 60 | This can be helpful in the scenario below where only =disambiguate-escape-codes= is active for some reason. 61 | 62 | *** No =report-alternate-keys= 63 | 64 | Note that when you activate only =disambiguate-escape-codes= (or your terminal does only support this enhancement), 65 | the terminal reports shifted keypresses which involve another modifier by sending the modifiers with the base layout of the key. 66 | This means "M-S-." (Meta-Shift-.) is not translated to "M-:" (on a German keyboard) and Emacs will probably not find the proper keybinding. 67 | =report-alternate-keys= fixes this, but if you do not want to activate it, you can remap keys by using the =key-translation-map=: 68 | 69 | #+begin_src emacs-lisp 70 | (define-key key-translation-map (kbd "M-S-.") (kbd "M-:")) 71 | #+end_src 72 | 73 | For an automated solution, see the code setup in [[https://github.com/benotn/kkp/issues/15#issue-2782693357][this issue]] (and consider using the newly introduced hooks). 74 | 75 | ** Debugging 76 | 77 | If you want to know if your terminal supports kkp, if its activated, and if yes, which enhancements are active, use =kkp-status=. 78 | 79 | If your terminal reports KKP support and KKP is active, don't be confused that =describe-key-briefly= or similar functions sometimes do not report the key you pressed if it involved =Shift=. 80 | If there is no keybinding for a shifted key, Emacs attempts to find a binding for the non-shifted part (controlled by the global variable =translate-upper-case-key-bindings=). 81 | That means for example, if you hit =C-S-g= in the normal case where there exists no binding for this key sequence, 82 | Emacs will fall back to search for a binding for =C-g=. You can verify this yourself if evaluating =(global-set-key (kbd "C-S-g") 'revert-buffer)= and then entering =C-h c= (=describe-key-briefly=) =C-S-g=. 83 | 84 | To determine how your keyboard input is translated, you can use the helper command =kkp-debug-describe-key-translation-chain=. 85 | To use this debugging helper, you can: 86 | #+begin_src emacs-lisp 87 | ;; either 88 | ;; 89 | ;; M-x load-library RET kkp-debug RET 90 | ;; 91 | ;; or add (require 'kkp-debug) to your Emacs init file. 92 | ;; 93 | ;; Then execute M-x kkp-debug-describe-key-translation-chain 94 | #+end_src 95 | 96 | 97 | ** Background 98 | 99 | The standard xterm encoding is quite old and cannot transmit key combinations such as "C-.". 100 | 101 | At the request of an Emacs user, xterm introduced "modifyOtherKeys" in version 216. 102 | This feature encodes 'ordinary (i.e., "other") keys (such as "2") when 103 | modified by Shift-, Control-, Alt- or Meta-modifiers by an escape sequence' ([[https://invisible-island.net/xterm/manpage/xterm.html#VT100-Widget-Resources:modifyOtherKeys][source]]). 104 | By default, it uses a "CSI 27 ; modifier ; code ~" encoding. CSI (Control Sequence Introducer) is the bytes sequence "\e[", i.e., \x1b\x5b. 105 | 106 | By request of Paul Leonerd Evans, xterm introduced an alternative encoding for the same keys, using a CSI-u encoding ("CSI modifier ; code u"). 107 | This is turned on by an xterm setting, [[https://invisible-island.net/xterm/manpage/xterm.html#VT100-Widget-Resources:formatOtherKeys][formatOtherKeys]]. 108 | Paul Leonerd Evans documented this approach in his [[https://www.leonerd.org.uk/hacks/fixterms/][fixterms]] proposals, but does not mention if it differs from the formatOtherKeys implementation in xterm. 109 | 110 | Thomas Dickey documents the "modifyOtherKeys/formatOtherKeys" evolution in more detail [[https://invisible-island.net/xterm/modified-keys.html][here]]. 111 | 112 | On the basis of the fixterms proposal, Kovid Goyal devised the Kitty Keyboard Protocol. 113 | This protocol does not deviate a lot from the fixterms proposal: 114 | - It [[https://sw.kovidgoyal.net/kitty/keyboard-protocol/#bugs-in-fixterms][fixes]] some bugs in fixterms. 115 | - It enables runtime opt-in and opt-out of enhancements (e.g., CSI-u encoding). 116 | - It optionally also supports reporting event types or alternate keys. 117 | 118 | For a complete list of enhancements, read [[https://sw.kovidgoyal.net/kitty/keyboard-protocol/#progressive-enhancement]]. 119 | For Emacs, other enhancements than "Disambiguate escape codes" and "Report alternate keys" do not appear to be relevant. 120 | -------------------------------------------------------------------------------- /kkp-debug.el: -------------------------------------------------------------------------------- 1 | ;;; kkp-debug.el --- Debugging helpers for Kitty Keyboard Protocol -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2025 Benjamin Orthen 4 | ;; Author: Benjamin Orthen 5 | ;; Maintainer: Benjamin Orthen 6 | ;; Version: 0.4 7 | ;; URL: https://github.com/benotn/kkp 8 | ;; Package-Requires: ((emacs "27.1") (compat "29.1.3.4")) 9 | ;; Keywords: terminals, debugging 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;;; Commentary: 14 | ;; 15 | ;; This file provides helper functions for debugging the key translation 16 | ;; of the kitty keyboard protocol. The main interactive command it provides is 17 | ;; `kkp-debug-describe-key-translation-chain'. 18 | ;; 19 | ;; The key translation process is broken into three stages: 20 | ;; 21 | ;; 1. Input decoding via `input-decode-map` (with a fallback to KKP helper functions if needed). 22 | ;; This step converts raw terminal events into a canonical key sequence. 23 | ;; 24 | ;; 2. Normal binding lookup: the input-decoded sequence is checked against the 25 | ;; active keymaps (local, minor, or global). If a normal binding exists, 26 | ;; remapping via `local-function-key-map` is skipped. 27 | ;; 28 | ;; 3. If no normal binding is found, remapping via `local-function-key-map` is 29 | ;; applied, followed by further translation via `key-translation-map`. 30 | ;; 31 | ;; The final key sequence and its associated command binding are then displayed, 32 | ;; with each stage output in aligned columns for clarity. 33 | ;; 34 | ;; To use these debugging helpers, you can either: 35 | ;; 36 | ;; M-x load-library RET kkp-debug RET 37 | ;; 38 | ;; or add (require 'kkp-debug) to your Emacs init file. 39 | ;; 40 | ;;; Code: 41 | 42 | (require 'cl-lib) 43 | (require 'kkp) 44 | 45 | (defvar kkp-debug--key-prompt "Input your key:") 46 | 47 | (defun kkp-debug--key-sequence-has-shift (keyseq) 48 | "Check if any event in KEYSEQ includes the shift modifier." 49 | (seq-some (lambda (key) (member 'shift (event-modifiers key))) keyseq)) 50 | 51 | (defun kkp-debug--remove-shift-from-keyseq (keyseq) 52 | "Return a new key sequence from KEYSEQ with shift removed from all events." 53 | (vconcat (mapcar (lambda (key) 54 | (let ((mods (remove 'shift (event-modifiers key))) 55 | (basic (event-basic-type key))) ;; Get the base character 56 | (event-convert-list (append mods (list basic))))) ;; Rebuild the event 57 | keyseq))) 58 | 59 | (defun kkp-debug--menu-item-binding (binding) 60 | "Return the \"real\" binding behind a menu-item BINDING. 61 | If BINDING is a menu-item form, extract its REAL-BINDING. 62 | If that binding is itself a menu-item, keep unwrapping. 63 | Otherwise, return BINDING unchanged." 64 | (cond 65 | ((and (consp binding) 66 | (eq (car binding) 'menu-item)) 67 | ;; A menu-item looks like (menu-item NAME REAL-BINDING . PROPS) 68 | ;; so the third element is the real binding. 69 | (kkp-debug--menu-item-binding (nth 2 binding))) 70 | (t 71 | binding))) 72 | 73 | (defun kkp-debug--lookup-key-sequence (keymap keyseq) 74 | "Lookup KEYSEQ in KEYMAP using `map-keymap' logic, including menu-item submaps. 75 | Return the \"raw\" binding (which may be a command, a keymap, or a menu-item), 76 | or nil if KEYSEQ is not bound in KEYMAP. 77 | Replicates prefix descent like `lookup-key' but does not actually call it." 78 | (let ((current keymap) 79 | (keys (append keyseq nil))) ; convert vector/string to list of events 80 | (catch 'done 81 | (while t 82 | (when (null keys) 83 | ;; If we ran out of events, then `current` might be the final submap if 84 | ;; we consider a bare submap as a final binding. Return it here. 85 | (throw 'done current)) 86 | (let ((evt (pop keys)) 87 | found-binding) 88 | ;; Search CURRENT for EVT. 89 | (catch 'found 90 | (map-keymap 91 | (lambda (map-key map-val) 92 | (when (equal evt map-key) 93 | (setq found-binding map-val) 94 | (throw 'found nil))) 95 | current)) 96 | (unless found-binding 97 | ;; Nothing matched this event, fail. 98 | (throw 'done nil)) 99 | ;; If found-binding is a menu-item, unwrap it to get the real binding. 100 | (setq found-binding (kkp-debug--menu-item-binding found-binding)) 101 | 102 | (cond 103 | ;; If it's a keymap and we still have leftover events, descend. 104 | ((and (keymapp found-binding) keys) 105 | (setq current found-binding)) 106 | 107 | ;; If it's a keymap but no leftover keys, treat the submap as final. 108 | ((and (keymapp found-binding) (null keys)) 109 | (throw 'done found-binding)) 110 | 111 | ;; If it's not a keymap but we do have leftover events, can't descend. 112 | ((and (not (keymapp found-binding)) keys) 113 | (throw 'done nil)) 114 | 115 | ;; If it's not a keymap and no leftover keys, this is our final binding. 116 | (t 117 | (throw 'done found-binding)))))))) 118 | 119 | 120 | (defun kkp-debug--get-key-events-from-terminal () 121 | "Read a full key sequence from the terminal. 122 | This function uses `read-event' with a short timeout to gather all parts 123 | of the sequence and returns them as a list of events." 124 | (let ((events (list (read-event kkp-debug--key-prompt))) 125 | (timeout 0.1) 126 | evt) 127 | ;; Gather additional events with a short timeout. 128 | (while (setq evt (read-event nil nil timeout)) 129 | (push evt events)) 130 | (nreverse events))) 131 | 132 | (defun kkp-debug--translate-events-with-kkp-fallback (events) 133 | "Translate terminal input EVENTS using `input-decode-map`, with KKP fallback. 134 | Steps: 135 | 1. Build a key sequence from EVENTS and look it up in `input-decode-map`. 136 | 2. If that lookup is not a number, it's a direct binding or nil, so return it. 137 | 3. If it returns a number (partial prefix match): 138 | a) Check if the first three events are 27 (ESC), 91 ([), and something 139 | in `kkp--key-prefixes`. 140 | b) If so, do a second `lookup-key` on exactly those three bytes. 141 | - If it returns a function/closure, log it but do NOT call it. 142 | - Then call `kkp--translate-terminal-input` on the rest of the events. 143 | c) Otherwise, return nil." 144 | (let* ((key-seq (vconcat events)) 145 | (lookup-result (lookup-key input-decode-map key-seq))) 146 | (if (not (numberp lookup-result)) 147 | ;; Case 1 & 2: Direct binding or nil => return as is. 148 | (progn 149 | (message "Mapping found in input-decode-map: %s" lookup-result) 150 | lookup-result) 151 | 152 | ;; Case 3: A number => partial prefix match. 153 | (if (and (>= (length events) 3) 154 | (eq (nth 0 events) 27) ; ESC 155 | (eq (nth 1 events) 91) ; [ 156 | (memq (nth 2 events) kkp--key-prefixes)) 157 | (let* ((prefix (seq-subseq events 0 3)) 158 | ;; Check short prefix in input-decode-map: 159 | (short-prefix-fn (kkp-debug--lookup-key-sequence input-decode-map (vconcat prefix))) 160 | (rest (nthcdr 2 events))) 161 | (when (and (functionp short-prefix-fn) 162 | (let ((fn-text (format "%S" short-prefix-fn))) 163 | (string-match-p "kkp--process-keys" fn-text))) 164 | (message "Short prefix %s mapped to function: %s (not calling it)." 165 | (key-description (vconcat prefix)) short-prefix-fn) 166 | (message "Prefix and KKP closure detected, now calling kkp--translate-terminal-input on remainder: %s" 167 | (key-description (vconcat rest))) 168 | (kkp--translate-terminal-input rest))) 169 | (message "lookup-key returned a prefix %s, but conditions not met." lookup-result) 170 | nil)))) 171 | 172 | 173 | ;;;###autoload 174 | (defun kkp-debug-describe-key-translation-chain () 175 | "Display the key translation chain for a terminal key sequence. 176 | The translation process is performed in the following stages: 177 | 1. Input decoding via `input-decode-map` (with fallback to KKP if needed). 178 | 2. Normal binding lookup: if the input-decoded sequence has a normal binding, 179 | then remapping via `local-function-key-map` is skipped. 180 | 3. If no normal binding is found, remap via `local-function-key-map`. 181 | 4. Finally, `key-translation-map` is applied unconditionally. 182 | The resulting key sequence and its final command binding are displayed. 183 | Output is arranged in aligned columns for clarity." 184 | (interactive) 185 | (with-help-window "*Key Translation Chain*" 186 | (let* ((kkp-is-active (kkp--this-terminal-has-active-kkp-p))) 187 | 188 | (if kkp-is-active 189 | (let* ((events (kkp-debug--get-key-events-from-terminal)) 190 | (raw-key (vconcat events)) 191 | (input-decoded-keys (kkp-debug--translate-events-with-kkp-fallback events)) 192 | ;; Check if the decoded key sequence already has a normal binding. 193 | (normal-binding (key-binding input-decoded-keys)) 194 | ;; Stage 2: Apply local-function-key-map only if no normal binding exists. 195 | (local-result (if normal-binding 196 | nil 197 | (let ((temp (lookup-key local-function-key-map input-decoded-keys))) 198 | (and (not (numberp temp)) temp)))) 199 | (local-output (or local-result input-decoded-keys)) 200 | ;; Stage 3: Always apply key-translation-map. 201 | (translation-result (let ((temp (lookup-key key-translation-map local-output))) 202 | (and (not (numberp temp)) temp))) 203 | (prelim-final-output (or translation-result local-output)) 204 | (prelim-final-binding (key-binding prelim-final-output)) 205 | (prelim-final-output-has-shift (kkp-debug--key-sequence-has-shift prelim-final-output)) 206 | (should-lowercase-binding (and (not prelim-final-binding) prelim-final-output-has-shift translate-upper-case-key-bindings)) 207 | (lowercase-output (kkp-debug--remove-shift-from-keyseq prelim-final-output)) 208 | (final-binding (if should-lowercase-binding 209 | (key-binding lowercase-output) 210 | prelim-final-binding))) 211 | (princ (format "%-45s %s\n" "KKP is active:" (if kkp-is-active "YES" "NO"))) 212 | (princ (format "%-45s %s (key vector: %s)\n" "Raw key events:" (key-description raw-key) raw-key)) 213 | (princ (format "%-45s %s\n" "After input-decode-map:" (key-description input-decoded-keys))) 214 | (princ (format "%-45s %s\n" "Normal binding (if any):" (or normal-binding "none"))) 215 | (princ (format "%-45s %s => %s\n" "After local-function-key-map:" 216 | (if normal-binding "not considered" (if local-result "found" "not found")) 217 | (key-description local-output))) 218 | (princ (format "%-45s %s => %s\n" "After key-translation-map:" 219 | (if translation-result "found" "not found") 220 | (key-description prelim-final-output))) 221 | (when (and should-lowercase-binding final-binding) 222 | (princ (format "%-45s %s => %s\n" "Uppercase to lowercase binding:" (key-description prelim-final-output) (key-description lowercase-output)))) 223 | (princ (format "%-45s %s\n" "Final command binding (in this help buffer):" (or final-binding "undefined")))) 224 | 225 | 226 | ;; KKP is not active 227 | (let ((translated-keys (read-key-sequence-vector kkp-debug--key-prompt)) 228 | (raw-key (this-single-command-raw-keys))) 229 | (princ (format "%-45s %s\n" "KKP is active:" (if kkp-is-active "YES" "NO"))) 230 | (princ (format "%-45s %s (key vector: %s)\n" "Raw key events:" (key-description raw-key) raw-key)) 231 | (princ (format "%-45s %s\n" "After all key translation maps:" (key-description translated-keys))) 232 | (princ (format "%-45s %s\n" "Final command binding (in this help buffer):" (or (key-binding translated-keys) "undefined")))))))) 233 | 234 | (provide 'kkp-debug) 235 | ;;; kkp-debug.el ends here 236 | -------------------------------------------------------------------------------- /kkp.el: -------------------------------------------------------------------------------- 1 | ;;; kkp.el --- Enable support for the Kitty Keyboard Protocol -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2025 Benjamin Orthen 4 | 5 | ;; Author: Benjamin Orthen 6 | ;; Maintainer: Benjamin Orthen 7 | ;; Keywords: terminals 8 | ;; Version: 0.4 9 | ;; URL: https://github.com/benotn/kkp 10 | ;; Package-Requires: ((emacs "27.1") (compat "29.1.3.4")) 11 | 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This program is free software: you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | 29 | ;; kkp.el enables support for the Kitty Keyboard Protocol in Emacs. 30 | ;; This protocol is documented here: 31 | ;; https://sw.kovidgoyal.net/kitty/keyboard-protocol. It provides an 32 | ;; alternative, improved way to transmit keyboard input from a 33 | ;; terminal to Emacs running in that terminal. 34 | 35 | ;; For debugging key translation, see the file `kkp-debug.el`. 36 | ;; 37 | ;; To load the debugging helpers, you can run: 38 | ;; (require 'kkp-debug) 39 | ;; 40 | ;; or M-x load-library RET kkp-debug RET 41 | 42 | 43 | ;;; Code: 44 | 45 | ;; kitty modifier encoding 46 | ;; shift 0b1 (1) 47 | ;; alt 0b10 (2) 48 | ;; ctrl 0b100 (4) 49 | ;; super 0b1000 (8) 50 | ;; hyper 0b10000 (16) 51 | ;; meta 0b100000 (32) 52 | ;; caps_lock 0b1000000 (64) 53 | ;; num_lock 0b10000000 (128) 54 | 55 | ;; Possible format of escape sequences sent to Emacs. 56 | ;; - CSI keycode u 57 | ;; - CSI keycode; modifier u 58 | ;; - CSI number ; modifier ~ 59 | ;; - CSI {ABCDEFHPQRS} 60 | ;; - CSI 1; modifier {ABCDEFHPQRS} 61 | 62 | 63 | (require 'cl-lib) 64 | (require 'compat) 65 | (require 'term/xterm) 66 | 67 | (defgroup kkp nil 68 | "Kitty Keyboard Protocol (KKP) support." 69 | :group 'convenience 70 | :prefix "kkp-") 71 | 72 | (defcustom kkp-terminal-query-timeout 0.1 73 | "Seconds to wait for an answer from the terminal. Nil means no timeout." 74 | :type 'float) 75 | 76 | (defcustom kkp-active-enhancements 77 | '(disambiguate-escape-codes report-alternate-keys) 78 | "List of enhancements which should be enabled. 79 | Possible values are the keys in `kkp--progressive-enhancement-flags'." 80 | :type '(repeat (choice (const disambiguate-escape-codes) (const report-alternate-keys)))) 81 | 82 | (defvar kkp--progressive-enhancement-flags 83 | '((disambiguate-escape-codes . (:bit 1)) 84 | (report-alternate-keys . (:bit 4)))) 85 | 86 | (defconst kkp--modifiers 87 | '(choice (const shift) (const alt) (const control) 88 | (const super) (const hyper) (const meta) 89 | (const caps-lock) (const num-lock))) 90 | 91 | ;; These mirror the behavior of `mac-command-modifier' and friends. 92 | ;; They specify which virtual key the physical key maps to. 93 | (defcustom kkp-shift-modifier 'shift 94 | "This variable describes the behavior of the shift key. 95 | 96 | It is one of the symbols `shift', `alt', `control', `super', 97 | `hyper', `meta', `caps-lock' or `num-lock'." 98 | :type kkp--modifiers) 99 | 100 | (defcustom kkp-alt-modifier 'meta 101 | "This variable describes the behavior of the alt key. 102 | 103 | It is one of the symbols `shift', `alt', `control', `super', 104 | `hyper', `meta', `caps-lock' or `num-lock'." 105 | :type kkp--modifiers) 106 | 107 | (defcustom kkp-control-modifier 'control 108 | "This variable describes the behavior of the ctrl key. 109 | 110 | It is one of the symbols `shift', `alt', `control', `super', 111 | `hyper', `meta', `caps-lock' or `num-lock'." 112 | :type kkp--modifiers) 113 | 114 | (defcustom kkp-super-modifier 'super 115 | "This variable describes the behavior of the super key. 116 | 117 | It is one of the symbols `shift', `alt', `control', `super', 118 | `hyper', `meta', `caps-lock' or `num-lock'." 119 | :type kkp--modifiers) 120 | 121 | (defcustom kkp-hyper-modifier 'hyper 122 | "This variable describes the behavior of the hyper key. 123 | 124 | It is one of the symbols `shift', `alt', `control', `super', 125 | `hyper', `meta', `caps-lock' or `num-lock'." 126 | :type kkp--modifiers) 127 | 128 | (defcustom kkp-meta-modifier 'meta 129 | "This variable describes the behavior of the meta key. 130 | 131 | It is one of the symbols `shift', `alt', `control', `super', 132 | `hyper', `meta', `caps-lock' or `num-lock'." 133 | :type kkp--modifiers) 134 | 135 | (defcustom kkp-caps-lock-modifier 'caps-lock 136 | "This variable describes the behavior of the caps key. 137 | 138 | It is one of the symbols `shift', `alt', `control', `super', 139 | `hyper', `meta', `caps-lock' or `num-lock'." 140 | :type kkp--modifiers) 141 | 142 | (defcustom kkp-num-lock-modifier 'num-lock 143 | "This variable describes the behavior of the num key. 144 | 145 | It is one of the symbols `shift', `alt', `control', `super', 146 | `hyper', `meta', `caps-lock' or `num-lock'." 147 | :type kkp--modifiers) 148 | 149 | ;; kitty modifier encoding 150 | (put 'kkp-shift-modifier :encoding 1) 151 | (put 'kkp-alt-modifier :encoding 2) 152 | (put 'kkp-control-modifier :encoding 4) 153 | (put 'kkp-super-modifier :encoding 8) 154 | (put 'kkp-hyper-modifier :encoding 16) 155 | (put 'kkp-meta-modifier :encoding 32) 156 | (put 'kkp-caps-lock-modifier :encoding 64) 157 | (put 'kkp-num-lock-modifier :encoding 128) 158 | 159 | (defvar kkp--printable-ascii-letters 160 | (cl-loop for c from ?a to ?z collect c)) 161 | 162 | ;; when not found in emacs source code, taken from http://xahlee.info/linux/linux_show_keycode_keysym.html 163 | (defvar kkp--non-printable-keys-with-u-terminator 164 | '((27 . "") 165 | (13 . "") 166 | (?\s . "SPC") 167 | (9 . "") 168 | (127 . "") 169 | (57358 . "") 170 | (57359 . "") 171 | (57360 . "") 172 | (57361 . "") 173 | (57362 . "") 174 | (57363 . "") 175 | (57376 . "") 176 | (57377 . "") 177 | (57378 . "") 178 | (57379 . "") 179 | (57380 . "") 180 | (57381 . "") 181 | (57382 . "") 182 | (57383 . "") 183 | (57384 . "") 184 | (57385 . "") 185 | (57386 . "") 186 | (57387 . "") 187 | (57388 . "") 188 | (57389 . "") 189 | (57390 . "") 190 | (57391 . "") 191 | (57392 . "") 192 | (57393 . "") 193 | (57394 . "") 194 | (57395 . "") 195 | (57396 . "") 196 | (57397 . "") 197 | (57398 . "") 198 | (57399 . "") 199 | (57400 . "") 200 | (57401 . "") 201 | (57402 . "") 202 | (57403 . "") 203 | (57404 . "") 204 | (57405 . "") 205 | (57406 . "") 206 | (57407 . "") 207 | (57408 . "") 208 | (57409 . "") 209 | (57410 . "") 210 | (57411 . "") 211 | (57412 . "") 212 | (57413 . "") 213 | (57414 . "") 214 | (57415 . "") 215 | (57416 . "") 216 | (57417 . "") 217 | (57418 . "") 218 | (57419 . "") 219 | (57420 . "") 220 | (57421 . "") ;; KP_PAGE_UP 221 | (57422 . "") ;; KP_PAGE_DOWN 222 | (57423 . "") 223 | (57424 . "") 224 | (57425 . "") 225 | (57426 . "") 226 | (57428 . "") 227 | (57429 . "") 228 | (57430 . "") 229 | (57431 . "") 230 | (57432 . "") 231 | (57433 . "") 232 | (57434 . "") 233 | (57435 . "") ;; MEDIA_TRACK_NEXT 234 | (57436 . "") ;; MEDIA_TRACK_PREVIOUS 235 | (57437 . "") 236 | (57438 . "") 237 | (57439 . "") 238 | (57440 . "") 239 | 240 | ;; it is rather unlikely Emacs gets this keysequence directly from the terminal 241 | ;; but just for the case... 242 | (57441 . "") 243 | (57442 . "") 244 | (57443 . "") 245 | (57444 . "") 246 | (57445 . "") 247 | (57446 . "") 248 | (57447 . "") 249 | (57448 . "") 250 | (57449 . "") 251 | (57450 . "") 252 | (57451 . "") 253 | (57452 . "") 254 | (57453 . "") 255 | (57454 . ""))) 256 | 257 | (defvar kkp--non-printable-keys-with-tilde-terminator 258 | '((2 . "") 259 | (3 . "") 260 | (5 . "") 261 | (6 . "") 262 | (7 . "") 263 | (8 . "") 264 | (11 . "") 265 | (12 . "") 266 | (13 . "") 267 | (14 . "") 268 | (15 . "") 269 | (17 . "") 270 | (18 . "") 271 | (19 . "") 272 | (20 . "") 273 | (21 . "") 274 | (23 . "") 275 | (24 . "") 276 | (57427 . ""))) 277 | 278 | (defvar kkp--non-printable-keys-with-letter-terminator 279 | '((?A . "") 280 | (?B . "") 281 | (?C . "") 282 | (?D . "") 283 | (?E . "") 284 | (?F . "") 285 | (?H . "") 286 | (?P . "") 287 | (?Q . "") 288 | (?S . ""))) 289 | 290 | (defvar kkp--letter-terminators 291 | (mapcar #'car kkp--non-printable-keys-with-letter-terminator)) 292 | 293 | (defvar kkp--acceptable-terminators 294 | (cl-concatenate 'list '(?u ?~) kkp--letter-terminators)) 295 | 296 | (defvar kkp--key-prefixes 297 | (cl-concatenate 'list 298 | (cl-loop for c from ?1 to ?9 collect c) 299 | kkp--letter-terminators)) 300 | 301 | (defvar kkp--active-terminal-list 302 | nil "Internal variable to track terminals which have enabled KKP.") 303 | 304 | (defvar kkp--setup-visited-terminal-list 305 | nil "Internal variable to track visited terminals after enabling `global-kkp-mode´.") 306 | 307 | (defvar kkp--suspended-terminal-list 308 | nil "Internal variable to track suspended terminals which have enabled KKP in activate state.") 309 | 310 | (defvar kkp-terminal-setup-complete-hook nil 311 | "Hook run after KKP finishes terminal setup in a given terminal.") 312 | 313 | (defvar kkp-terminal-teardown-complete-hook nil 314 | "Hook run after KKP finishes terminal teardown in a given terminal.") 315 | 316 | ;; NOTE this is a copy from x-alternatives-map 317 | (defvar kkp-alternatives-map 318 | (let ((map (make-sparse-keymap))) 319 | ;; Map certain keypad keys into ASCII characters that people usually expect. 320 | (define-key map [M-backspace] [?\M-\d]) 321 | (define-key map [M-delete] [?\M-\d]) 322 | (define-key map [M-tab] [?\M-\t]) 323 | (define-key map [M-linefeed] [?\M-\n]) 324 | (define-key map [M-clear] [?\M-\C-l]) 325 | (define-key map [M-return] [?\M-\C-m]) 326 | (define-key map [M-escape] [?\M-\e]) 327 | (unless (featurep 'ns) 328 | (define-key map [iso-lefttab] [backtab]) 329 | (define-key map [S-iso-lefttab] [backtab])) 330 | (and (or (eq system-type 'windows-nt) 331 | (featurep 'ns)) 332 | (define-key map [S-tab] [backtab])) 333 | map) 334 | "Keymap of possible alternative meanings for some keys.") 335 | 336 | 337 | (defun kkp--mod-bits (modifier) 338 | "Return the KKP encoding bits that should be interpreted as MODIFIER. 339 | 340 | MODIFIER is one of the symbols `shift', `alt', `control', 341 | `super', `hyper', `meta', `caps-lock' or `num-lock'." 342 | (apply #'logior 343 | (cl-map 'sequence 344 | (lambda (sym) 345 | (get sym :encoding)) 346 | (cl-remove-if-not 347 | (lambda (sym) (eq (symbol-value sym) modifier)) 348 | '(kkp-shift-modifier 349 | kkp-alt-modifier 350 | kkp-control-modifier 351 | kkp-super-modifier 352 | kkp-hyper-modifier 353 | kkp-meta-modifier 354 | kkp-caps-lock-modifier 355 | kkp-num-lock-modifier))))) 356 | 357 | (defun kkp--csi-escape (&rest args) 358 | "Prepend the CSI bytes before the ARGS." 359 | (concat "\e[" (apply #'concat args))) 360 | 361 | (defun kkp--selected-terminal () 362 | "Get the terminal that is now selected." 363 | (frame-terminal (selected-frame))) 364 | 365 | (defun kkp--bit-set-p (num bit) 366 | "Check if BIT is set in NUM." 367 | (not (eql (logand num bit) 0))) 368 | 369 | (defun kkp--create-modifiers-string (modifier-num) 370 | "Create a string of Emacs key modifiers according to MODIFIER-NUM." 371 | 372 | ;; add modifiers as defined in key-valid-p 373 | ;; Modifiers have to be specified in this order: 374 | ;; A-C-H-M-S-s which is 375 | ;; Alt-Control-Hyper-Meta-Shift-super 376 | 377 | (let ((key-str "")) 378 | (when (kkp--bit-set-p modifier-num (kkp--mod-bits 'alt)) 379 | (setq key-str (concat key-str "A-"))) 380 | (when (kkp--bit-set-p modifier-num (kkp--mod-bits 'control)) 381 | (setq key-str (concat key-str "C-"))) 382 | (when (kkp--bit-set-p modifier-num (kkp--mod-bits 'hyper)) 383 | (setq key-str (concat key-str "H-"))) 384 | (when (kkp--bit-set-p modifier-num (kkp--mod-bits 'meta)) 385 | (setq key-str (concat key-str "M-"))) 386 | (when (kkp--bit-set-p modifier-num (kkp--mod-bits 'shift)) 387 | (setq key-str (concat key-str "S-"))) 388 | (when (kkp--bit-set-p modifier-num (kkp--mod-bits 'super)) 389 | (setq key-str (concat key-str "s-"))) 390 | key-str)) 391 | 392 | 393 | (defun kkp--get-keycode-representation (keycode mapping) 394 | "Try to lookup the Emacs key representation for KEYCODE in MAPPING. 395 | This is either in the mapping or it is the string representation of the 396 | key codepoint." 397 | (let ((rep (alist-get keycode mapping))) 398 | (if rep 399 | rep 400 | (string keycode)))) 401 | 402 | (defun kkp--handle-bracketed-paste (terminal-input) 403 | "Handle bracketed paste mode sequences. 404 | TERMINAL-INPUT is a list of characters representing the terminal input 405 | sequence. This function checks if TERMINAL-INPUT matches the bracketed 406 | paste mode sequence ('200~') and calls `xterm-translate-bracketed-paste` 407 | if it does." 408 | (when (equal (concat terminal-input) "200~") 409 | (xterm-translate-bracketed-paste nil))) 410 | 411 | 412 | (defun kkp--handle-u-or-tilde-terminators (terminator terminal-input) 413 | "Handle input sequences ending with ?u or ?~ terminators. 414 | TERMINATOR is the last character in the TERMINAL-INPUT sequence, 415 | indicating the end of the sequence. TERMINAL-INPUT is a list of 416 | characters representing the terminal input sequence. This function 417 | contains the specific logic for processing sequences terminated by ?u or 418 | ?~." 419 | (let* ((terminator-alist (pcase terminator 420 | (?u kkp--non-printable-keys-with-u-terminator) 421 | (?~ kkp--non-printable-keys-with-tilde-terminator))) 422 | (input-string (mapconcat 'char-to-string (remq terminator terminal-input) "")) 423 | (input-parts (split-string input-string ";")) 424 | (keycode-parts (split-string (cl-first input-parts) ":")) ;; get keycodes from sequence 425 | (primary-keycode (cl-first keycode-parts)) 426 | (secondary-keycode-str (cl-second keycode-parts)) 427 | (secondary-keycode (and (stringp secondary-keycode-str) 428 | (not (string-empty-p secondary-keycode-str)) 429 | secondary-keycode-str)) 430 | (modifier-parts (split-string (or (cl-second input-parts) "") ":")) ;; list of modifiers and event types 431 | (modifier-string (cl-first modifier-parts)) 432 | (modifier-num (if (not (string-empty-p modifier-string)) 433 | (1- (string-to-number modifier-string)) 434 | 0)) 435 | (has-shift (/= 0 (logand modifier-num (kkp--mod-bits 'shift)))) 436 | (has-ctrl (/= 0 (logand modifier-num (kkp--mod-bits 'control)))) 437 | (is-ascii-letter (member (string-to-number primary-keycode) kkp--printable-ascii-letters)) 438 | ;; ------------------------------------------------------------- 439 | ;; Shift-collapse rule: 440 | ;; • Shift present 441 | ;; • secondary code available 442 | ;; • no Control *when key is an ASCII letter* 443 | ;; ------------------------------------------------------------- 444 | (use-secondary (and secondary-keycode 445 | has-shift 446 | (or (not is-ascii-letter) 447 | (not has-ctrl)))) 448 | (final-key-code (if use-secondary secondary-keycode primary-keycode))) 449 | 450 | ;; if we use the secondary keycode, remove shift from modifier number 451 | (when use-secondary 452 | (setq modifier-num (logand modifier-num (lognot 1)))) 453 | 454 | ;; create keybinding by concatenating the modifier string with the key-name 455 | (let 456 | ((modifier-str (kkp--create-modifiers-string modifier-num)) 457 | (key-name (kkp--get-keycode-representation (string-to-number final-key-code) 458 | terminator-alist))) 459 | (kbd (concat modifier-str key-name))))) 460 | 461 | (defun kkp--handle-letter-terminators (terminator terminal-input) 462 | "Handle input sequences ending with letter terminators. 463 | TERMINATOR is the last character in the TERMINAL-INPUT sequence, 464 | indicating the type of the terminator. TERMINAL-INPUT is a list of 465 | characters representing the terminal input sequence." 466 | (let* ((input-string (mapconcat 'char-to-string (remq terminator terminal-input) "")) 467 | (input-parts (split-string input-string ";")) 468 | (modifier-parts (split-string (or (cl-second input-parts) "") ":")) ;; list of modifiers and event types 469 | (modifier-string (cl-first modifier-parts)) 470 | (modifier-num (if (not (string-empty-p modifier-string)) 471 | (1- (string-to-number modifier-string)) 472 | 0)) 473 | (modifier-str (kkp--create-modifiers-string modifier-num)) 474 | (key-name (alist-get terminator kkp--non-printable-keys-with-letter-terminator))) 475 | 476 | (kbd (concat modifier-str key-name)))) 477 | 478 | (defun kkp--translate-terminal-input (terminal-input) 479 | "Translate TERMINAL-INPUT according to KKP into an Emacs keybinding. 480 | TERMINAL-INPUT is a list of characters representing the terminal input 481 | sequence. This function dispatches the input sequence to the appropriate 482 | handler based on its terminator: 483 | - Bracketed paste mode sequences are 484 | handled by `kkp--handle-bracketed-paste`. 485 | - Sequences ending with ?u or ?~ 486 | are handled by `kkp--handle-u-or-tilde-terminators`. 487 | - Sequences ending with a letter terminator are handled by 488 | `kkp--handle-letter-terminators`. 489 | The function returns the Emacs 490 | keybinding associated with the terminal input sequence." 491 | 492 | ;; input has this form: keycode[:[shifted-key][:base-layout-key]];[modifiers[:event-type]][;text-as-codepoints]{u~} 493 | (let ((terminator (car (last terminal-input)))) 494 | (or (kkp--handle-bracketed-paste terminal-input) 495 | (and (member terminator '(?u ?~)) (kkp--handle-u-or-tilde-terminators terminator terminal-input)) 496 | (and (member terminator kkp--letter-terminators) (kkp--handle-letter-terminators terminator terminal-input))))) 497 | 498 | 499 | (defun kkp--read-terminal-events (initial-byte) 500 | "Read terminal events until an acceptable terminator is found. 501 | INITIAL-BYTE is the first byte of the sequence." 502 | (let ((events (list initial-byte))) 503 | (while (not (member (cl-first events) kkp--acceptable-terminators)) 504 | (push (read-event) events)) 505 | (nreverse events))) 506 | 507 | (defun kkp--process-keys (first-byte) 508 | "Read input from terminal to parse key events to an Emacs keybinding. 509 | FIRST-BYTE is the byte read before this function is called. 510 | This function returns the Emacs keybinding associated with the sequence read." 511 | (let ((terminal-input (kkp--read-terminal-events first-byte))) 512 | (kkp--translate-terminal-input terminal-input))) 513 | 514 | 515 | (defun kkp--get-enhancement-bit (enhancement) 516 | "Get the bitflag which enables the ENHANCEMENT." 517 | (plist-get (cdr enhancement) :bit)) 518 | 519 | 520 | (defun kkp--query-terminal-sync (query) 521 | "Send QUERY to TERMINAL (to current if nil) and return response (if any)." 522 | (discard-input) 523 | (send-string-to-terminal (kkp--csi-escape query)) 524 | (let ((loop-cond t) 525 | (terminal-input nil)) 526 | (while loop-cond 527 | (let ((evt (read-event nil nil kkp-terminal-query-timeout))) 528 | (if (null evt) 529 | (setq loop-cond nil) 530 | (push evt terminal-input)))) 531 | (nreverse terminal-input))) 532 | 533 | 534 | (defun kkp--query-terminal-async (query handlers terminal) 535 | "Send QUERY string to TERMINAL and register HANDLERS for a response. 536 | HANDLERS is an alist with elements of the form (STRING . FUNCTION). 537 | We run the first FUNCTION whose STRING matches the input events. 538 | This function code is copied from `xterm--query'." 539 | (with-selected-frame (car (frames-on-display-list terminal)) 540 | (let ((register 541 | (lambda (handlers) 542 | (dolist (handler handlers) 543 | (define-key input-decode-map (car handler) 544 | (lambda (&optional _prompt) 545 | ;; Unregister the handler, since we don't expect 546 | ;; further answers. 547 | (dolist (handler handlers) 548 | (define-key input-decode-map (car handler) nil)) 549 | (funcall (cdr handler)) 550 | [])))))) 551 | 552 | (funcall register handlers) 553 | (send-string-to-terminal (kkp--csi-escape query) terminal)))) 554 | 555 | 556 | (defun kkp--this-terminal-enabled-enhancements () 557 | "Query the current terminal and return list of currently enabled enhancements." 558 | (let ((reply (kkp--query-terminal-sync "?u"))) 559 | (when (not reply) 560 | (error "Terminal did not reply correctly to query")) 561 | 562 | (let ((enhancement-flag (- (nth 3 reply) ?0)) 563 | (enabled-enhancements nil)) 564 | 565 | (dolist (bind kkp--progressive-enhancement-flags) 566 | (when (> (logand enhancement-flag (kkp--get-enhancement-bit bind)) 0) 567 | (push (car bind) enabled-enhancements))) 568 | enabled-enhancements))) 569 | 570 | 571 | (defun kkp--this-terminal-supports-kkp-p () 572 | "Check if the current terminal supports the Kitty Keyboard Protocol. 573 | This does not work well if checking for another terminal which 574 | does not have focus, as input from this terminal cannot be reliably read." 575 | (let ((reply (kkp--query-terminal-sync "?u"))) 576 | (and 577 | (member (length reply) '(5 6)) 578 | (equal '(27 91 63) (cl-subseq reply 0 3)) 579 | (eql 117 (car (last reply)))))) 580 | 581 | (defun kkp--this-terminal-has-active-kkp-p() 582 | "Check if the current terminal has KKP activated." 583 | (member (kkp--selected-terminal) kkp--active-terminal-list)) 584 | 585 | (defun kkp--calculate-flags-integer () 586 | "Calculate the flag integer to send to the terminal to activate the enhancements." 587 | (cl-reduce (lambda (sum elt) 588 | (+ 589 | sum 590 | (kkp--get-enhancement-bit (assoc elt kkp--progressive-enhancement-flags)))) 591 | kkp-active-enhancements :initial-value 0)) 592 | 593 | 594 | ;; NOTE this is a copy of the x-setup-function-keys function 595 | (defun kkp-setup-function-keys (terminal) 596 | "Activate alternative keypad mappings in TERMINAL. 597 | This function updates the `local-function-key-map` of the first frame on 598 | TERMINAL’s display, reparenting it to `kkp-alternatives-map`. This remapping 599 | causes certain keys, such as [M-backspace], to be interpreted like ASCII 600 | characters (e.g., [?\M-\\d]). Once set, the parameter 601 | `kkp-setup-function-keys` is stored on TERMINAL to avoid repeated setup." 602 | (let ((frame (car (frames-on-display-list terminal)))) 603 | (unless (terminal-parameter terminal 'kkp-setup-function-keys) 604 | ;; Map certain keypad keys into ASCII characters that people usually expect. 605 | (with-selected-frame frame 606 | (set-keymap-parent kkp-alternatives-map (keymap-parent local-function-key-map)) 607 | (set-keymap-parent local-function-key-map kkp-alternatives-map))) 608 | (set-terminal-parameter terminal 'kkp-setup-function-keys t))) 609 | 610 | (defun kkp-teardown-function-keys (terminal) 611 | "Deactivate alternative keypad mappings in TERMINAL. 612 | Restore the original `local-function-key-map` for the first frame on TERMINAL’s 613 | display by removing `kkp-alternatives-map` as a parent. Once done, the parameter 614 | `kkp-setup-function-keys` on TERMINAL is reset so that setup can be applied 615 | again later if needed." 616 | (let ((frame (car (frames-on-display-list terminal)))) 617 | (when (terminal-parameter terminal 'kkp-setup-function-keys) 618 | ;; Map certain keypad keys into ASCII characters that people usually expect. 619 | (with-selected-frame frame 620 | (set-keymap-parent local-function-key-map (keymap-parent kkp-alternatives-map))) 621 | (set-terminal-parameter terminal 'kkp-setup-function-keys nil)))) 622 | 623 | 624 | (defun kkp--terminal-teardown (terminal) 625 | "Run procedures to disable KKP in TERMINAL." 626 | (when 627 | (and 628 | (terminal-live-p terminal) 629 | (member terminal kkp--active-terminal-list)) 630 | (kkp-teardown-function-keys terminal) 631 | (send-string-to-terminal (kkp--csi-escape "u CSI?...c must be in response 660 | ;; CSI? is already in response as it was registered as handler for the async request 661 | ;; thus it is not in terminal-input. 662 | (when (string-match-p (rx line-start 663 | (+ digit) ;; 664 | "u\e[?" 665 | (+ anychar) ;; primary device attributes 666 | eol) terminal-input) 667 | 668 | (unless (member terminal kkp--active-terminal-list) 669 | (let ((enhancement-flag (kkp--calculate-flags-integer))) 670 | (unless (eq enhancement-flag 0) 671 | 672 | (push terminal kkp--active-terminal-list) 673 | (send-string-to-terminal (kkp--csi-escape (format ">%su" enhancement-flag)) terminal) 674 | 675 | (kkp-setup-function-keys terminal) 676 | (set-terminal-parameter terminal 'kkp--previous-normal-erase-is-backspace-val (terminal-parameter terminal 'normal-erase-is-backspace)) 677 | (normal-erase-is-backspace-mode 1) 678 | 679 | ;; we register functions for each prefix to not interfere with e.g., M-[ I 680 | (with-selected-frame (car (frames-on-display-list terminal)) 681 | (dolist (prefix kkp--key-prefixes) 682 | (define-key input-decode-map (kkp--csi-escape (string prefix)) 683 | (lambda (_prompt) (kkp--process-keys prefix)))) 684 | (run-hooks 'kkp-terminal-setup-complete-hook)))))))) 685 | 686 | 687 | (defun kkp--disable-in-active-terminals() 688 | "In all terminals with active KKP, pop the previously pushed enhancement flag." 689 | (dolist (terminal kkp--active-terminal-list) 690 | (kkp--terminal-teardown terminal))) 691 | 692 | 693 | (defun kkp--suspend-in-terminal() 694 | "If the terminal has activate KKP, disable it before suspending." 695 | (let ((terminal (kkp--selected-terminal))) 696 | (when (member terminal kkp--active-terminal-list) 697 | (push terminal kkp--suspended-terminal-list) 698 | (kkp--terminal-teardown terminal)))) 699 | 700 | (defun kkp--resume-in-terminal() 701 | "Restore KKP in resumed terminals where it was active before suspension." 702 | (let ((terminal (kkp--selected-terminal))) 703 | (when (member terminal kkp--suspended-terminal-list) 704 | (setq kkp--suspended-terminal-list (delete terminal kkp--suspended-terminal-list)) 705 | (kkp-enable-in-terminal terminal)))) 706 | 707 | 708 | (cl-defun kkp-enable-in-terminal (&optional (terminal (kkp--selected-terminal))) 709 | "Try to enable KKP support in Emacs running in the TERMINAL." 710 | (interactive) 711 | (when 712 | (and 713 | (terminal-live-p terminal) 714 | (not (display-graphic-p terminal))) 715 | (push terminal kkp--setup-visited-terminal-list) 716 | (unless 717 | (or 718 | (terminal-parameter terminal 'kkp--setup-started) 719 | (member terminal kkp--active-terminal-list)) 720 | 721 | ;; NOTE: to avoid race conditions, we set the custom terminal 722 | ;; parameter here to not send the query multiple times to the 723 | ;; terminal 724 | (set-terminal-parameter terminal 'kkp--setup-started t) 725 | ;; https://sw.kovidgoyal.net/kitty/keyboard-protocol/#detection-of-support-for-this-protocol 726 | ;; query for the current progressive enhancements together with the primary device attributes 727 | (kkp--query-terminal-async "?u\e[c" 728 | '(("\e[?" . kkp--terminal-setup)) terminal)))) 729 | 730 | ;;;###autoload 731 | (defun kkp-disable-in-terminal () 732 | "Disable in this terminal where command is executed, the activated enhancements." 733 | (interactive) 734 | (kkp--terminal-teardown (kkp--selected-terminal))) 735 | 736 | 737 | (defun kkp-focus-change (&rest _) 738 | "Enable KKP when focus on terminal which has not yet enabled it once." 739 | (let* ((frame (selected-frame)) 740 | (terminal (kkp--selected-terminal))) 741 | (when 742 | (and (not (member terminal kkp--setup-visited-terminal-list)) 743 | (frame-focus-state frame)) 744 | (kkp-enable-in-terminal)))) 745 | 746 | (defun kkp--display-symbol-keys-p (orig-fun &rest args) 747 | "Advice function for display-symbols-key-p ORIG-FUN with ARGS. 748 | This ensures display-symbols-key-p returns non nil in a terminal with KKP enabled." 749 | (or 750 | (member (kkp--selected-terminal) kkp--active-terminal-list) 751 | (apply orig-fun args))) 752 | 753 | ;;;###autoload 754 | (define-minor-mode global-kkp-mode 755 | "Toggle KKP support in all terminal frames." 756 | :global t 757 | :lighter nil 758 | :group 'kkp 759 | (cond 760 | (global-kkp-mode 761 | ;; if terminal has KKP enabled, it supports symbol names as keys 762 | (advice-add 'display-symbol-keys-p :around #'kkp--display-symbol-keys-p) 763 | ;; call setup for future terminals to be opened 764 | (add-hook 'tty-setup-hook #'kkp-enable-in-terminal) 765 | ;; call teardown for terminals to be closed 766 | (add-hook 'kill-emacs-hook #'kkp--disable-in-active-terminals) 767 | ;; we call this on each frame teardown, this has no effects if kkp is not enabled 768 | (add-to-list 'delete-terminal-functions #'kkp--terminal-teardown) 769 | (add-hook 'suspend-hook #'kkp--suspend-in-terminal) 770 | (add-hook 'suspend-resume-hook #'kkp--resume-in-terminal) 771 | 772 | ;; this is by far the most reliable method to enable kkp in all associated terminals 773 | ;; trying to switch to each terminal with `with-selected-frame' does not work very well 774 | ;; as input from `read-event' cannot be reliably read from the corresponding terminal 775 | (add-function :after after-focus-change-function #'kkp-focus-change) 776 | (setq kkp--setup-visited-terminal-list nil) 777 | 778 | ;; At startup, this global mode might be called before the 'tty-setup-hook'. 779 | ;; To avoid running 'kkp-enable-in-terminal' before, we only run it if 780 | ;; the 'tty-run-terminal-initialization' already ran. 781 | (when (terminal-parameter (kkp--selected-terminal) 'terminal-initted) 782 | (kkp-enable-in-terminal))) 783 | (t 784 | (advice-remove 'display-symbol-keys-p #'kkp--display-symbol-keys-p) 785 | (kkp--disable-in-active-terminals) 786 | (remove-hook 'tty-setup-hook #'kkp-enable-in-terminal) 787 | (remove-hook 'kill-emacs-hook #'kkp--disable-in-active-terminals) 788 | (remove-hook 'suspend-hook #'kkp--suspend-in-terminal) 789 | (remove-hook 'suspend-resume-hook #'kkp--resume-in-terminal) 790 | (remove-function after-focus-change-function #'kkp-focus-change) 791 | (setq delete-terminal-functions (delete #'kkp--terminal-teardown delete-terminal-functions))))) 792 | 793 | 794 | ;;;###autoload 795 | (defun kkp-status () 796 | "Message, if terminal supports KKP, if yes, currently enabled enhancements." 797 | (interactive) 798 | (if (kkp--this-terminal-supports-kkp-p) 799 | (message "KKP supported in this terminal.\n%s" 800 | (if (kkp--this-terminal-has-active-kkp-p) 801 | (format "KKP active in this terminal. Enabled enhancements: %s" (mapconcat 'symbol-name (kkp--this-terminal-enabled-enhancements) " and ")) 802 | "KKP not active in this terminal.")) 803 | (message "KKP not supported in this terminal."))) 804 | 805 | 806 | (provide 'kkp) 807 | ;;; kkp.el ends here 808 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------