lisp/term/xterm.el

   1 ;;; xterm.el --- define function key sequences and standard colors for xterm  -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 1995, 2001-2016 Free Software Foundation, Inc.
   4
   5 ;; Author: FSF
   6 ;; Keywords: terminals
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 (defgroup xterm nil
  28   "XTerm support."
  29   :version "24.1"
  30   :group 'terminals)
  31
  32 (defconst xterm--extra-capabilities-type
  33   ;; NOTE: If you add entries here, make sure to update
  34   ;; `terminal-init-xterm' as well.
  35   '(set (const :tag "modifyOtherKeys support" modifyOtherKeys)
  36         (const :tag "report background" reportBackground)
  37         (const :tag "get X selection" getSelection)
  38         (const :tag "set X selection" setSelection)))
  39
  40 (defcustom xterm-extra-capabilities 'check
  41   "Whether Xterm supports some additional, more modern, features.
  42 If nil, just assume that it does not.
  43 If `check', try to check if it does.
  44 If a list, assume that the listed features are supported, without checking.
  45
  46 The relevant features are:
  47   modifyOtherKeys  -- if supported, more key bindings work (e.g., \"\\C-,\")
  48   reportBackground -- if supported, Xterm reports its background color
  49   getSelection     -- if supported, Xterm yanks text from the X selection
  50   setSelection     -- if supported, Xterm saves killed text to the X selection"
  51   :version "24.1"
  52   :type `(choice (const :tag "Check" check)
  53                  ,xterm--extra-capabilities-type))
  54
  55 (defcustom xterm-max-cut-length 100000
  56   "Maximum number of bytes to cut into xterm using the OSC 52 sequence.
  57
  58 The OSC 52 sequence requires a terminator byte.  Some terminals will ignore or
  59 mistreat a terminated sequence that is longer than a certain size, usually to
  60 protect users from runaway sequences.
  61
  62 This variable allows you to tweak the maximum number of bytes that will be sent
  63 using the OSC 52 sequence.
  64
  65 If you select a region larger than this size, it won't be copied to your system
  66 clipboard.  Since clipboard data is base 64 encoded, the actual number of
  67 string bytes that can be copied is 3/4 of this value."
  68   :version "25.1"
  69   :type 'integer)
  70
  71 (defconst xterm-paste-ending-sequence "\e[201~"
  72   "Characters send by the terminal to end a bracketed paste.")
  73
  74 (defun xterm--pasted-text ()
  75   "Handle the rest of a terminal paste operation.
  76 Return the pasted text as a string."
  77   (let ((end-marker-length (length xterm-paste-ending-sequence)))
  78     (with-temp-buffer
  79       (set-buffer-multibyte nil)
  80       (while (not (search-backward xterm-paste-ending-sequence
  81                                    (- (point) end-marker-length) t))
  82         (let ((event (read-event nil nil
  83                                  ;; Use finite timeout to avoid glomming the
  84                                  ;; event onto this-command-keys.
  85                                  most-positive-fixnum)))
  86           (when (eql event ?\r)
  87             (setf event ?\n))
  88           (insert event)))
  89       (let ((last-coding-system-used))
  90         (decode-coding-region (point-min) (point) (keyboard-coding-system)
  91                               t)))))
  92
  93 (defun xterm-paste ()
  94   "Handle the start of a terminal paste operation."
  95   (interactive)
  96   (let* ((pasted-text (xterm--pasted-text))
  97          (interprogram-paste-function (lambda () pasted-text)))
  98     (yank)))
  99
 100 (define-key global-map [xterm-paste] #'xterm-paste)
 101
 102 (defvar xterm-rxvt-function-map
 103   (let ((map (make-sparse-keymap)))
 104     (define-key map "\e[2~" [insert])
 105     (define-key map "\e[3~" [delete])
 106     (define-key map "\e[4~" [select])
 107     (define-key map "\e[5~" [prior])
 108     (define-key map "\e[6~" [next])
 109
 110     (define-key map "\e[15~" [f5])
 111     (define-key map "\e[17~" [f6])
 112     (define-key map "\e[18~" [f7])
 113     (define-key map "\e[19~" [f8])
 114     (define-key map "\e[20~" [f9])
 115     (define-key map "\e[21~" [f10])
 116
 117     (define-key map "\e[2;2~" [S-insert])
 118
 119     ;; Other versions of xterm might emit these.
 120     (define-key map "\e[A" [up])
 121     (define-key map "\e[B" [down])
 122     (define-key map "\e[C" [right])
 123     (define-key map "\e[D" [left])
 124
 125     (define-key map "\e[11~" [f1])
 126     (define-key map "\e[12~" [f2])
 127     (define-key map "\e[13~" [f3])
 128     (define-key map "\e[14~" [f4])
 129
 130     ;; Recognize the start of a bracketed paste sequence.  The handler
 131     ;; internally recognizes the end.
 132     (define-key map "\e[200~" [xterm-paste])
 133
 134     map)
 135   "Keymap of escape sequences, shared between xterm and rxvt support.")
 136
 137 (defvar xterm-function-map
 138   (let ((map (make-sparse-keymap)))
 139     (set-keymap-parent map xterm-rxvt-function-map)
 140
 141     ;; xterm from X.org 6.8.2 uses these key definitions.
 142     (define-key map "\eOP" [f1])
 143     (define-key map "\eOQ" [f2])
 144     (define-key map "\eOR" [f3])
 145     (define-key map "\eOS" [f4])
 146     (define-key map "\e[23~" [f11])
 147     (define-key map "\e[24~" [f12])
 148
 149     (define-key map "\eO2P" [S-f1])
 150     (define-key map "\eO2Q" [S-f2])
 151     (define-key map "\eO2R" [S-f3])
 152     (define-key map "\eO2S" [S-f4])
 153     (define-key map "\e[1;2P" [S-f1])
 154     (define-key map "\e[1;2Q" [S-f2])
 155     (define-key map "\e[1;2R" [S-f3])
 156     (define-key map "\e[1;2S" [S-f4])
 157     (define-key map "\e[15;2~" [S-f5])
 158     (define-key map "\e[17;2~" [S-f6])
 159     (define-key map "\e[18;2~" [S-f7])
 160     (define-key map "\e[19;2~" [S-f8])
 161     (define-key map "\e[20;2~" [S-f9])
 162     (define-key map "\e[21;2~" [S-f10])
 163     (define-key map "\e[23;2~" [S-f11])
 164     (define-key map "\e[24;2~" [S-f12])
 165
 166     (define-key map "\eO5P" [C-f1])
 167     (define-key map "\eO5Q" [C-f2])
 168     (define-key map "\eO5R" [C-f3])
 169     (define-key map "\eO5S" [C-f4])
 170     (define-key map "\e[15;5~" [C-f5])
 171     (define-key map "\e[17;5~" [C-f6])
 172     (define-key map "\e[18;5~" [C-f7])
 173     (define-key map "\e[19;5~" [C-f8])
 174     (define-key map "\e[20;5~" [C-f9])
 175     (define-key map "\e[21;5~" [C-f10])
 176     (define-key map "\e[23;5~" [C-f11])
 177     (define-key map "\e[24;5~" [C-f12])
 178
 179     (define-key map "\eO6P" [C-S-f1])
 180     (define-key map "\eO6Q" [C-S-f2])
 181     (define-key map "\eO6R" [C-S-f3])
 182     (define-key map "\eO6S" [C-S-f4])
 183     (define-key map "\e[15;6~" [C-S-f5])
 184     (define-key map "\e[17;6~" [C-S-f6])
 185     (define-key map "\e[18;6~" [C-S-f7])
 186     (define-key map "\e[19;6~" [C-S-f8])
 187     (define-key map "\e[20;6~" [C-S-f9])
 188     (define-key map "\e[21;6~" [C-S-f10])
 189     (define-key map "\e[23;6~" [C-S-f11])
 190     (define-key map "\e[24;6~" [C-S-f12])
 191
 192     (define-key map "\eO3P" [M-f1])
 193     (define-key map "\eO3Q" [M-f2])
 194     (define-key map "\eO3R" [M-f3])
 195     (define-key map "\eO3S" [M-f4])
 196     (define-key map "\e[15;3~" [M-f5])
 197     (define-key map "\e[17;3~" [M-f6])
 198     (define-key map "\e[18;3~" [M-f7])
 199     (define-key map "\e[19;3~" [M-f8])
 200     (define-key map "\e[20;3~" [M-f9])
 201     (define-key map "\e[21;3~" [M-f10])
 202     (define-key map "\e[23;3~" [M-f11])
 203     (define-key map "\e[24;3~" [M-f12])
 204
 205     (define-key map "\eO4P" [M-S-f1])
 206     (define-key map "\eO4Q" [M-S-f2])
 207     (define-key map "\eO4R" [M-S-f3])
 208     (define-key map "\eO4S" [M-S-f4])
 209     (define-key map "\e[15;4~" [M-S-f5])
 210     (define-key map "\e[17;4~" [M-S-f6])
 211     (define-key map "\e[18;4~" [M-S-f7])
 212     (define-key map "\e[19;4~" [M-S-f8])
 213     (define-key map "\e[20;4~" [M-S-f9])
 214     (define-key map "\e[21;4~" [M-S-f10])
 215     (define-key map "\e[23;4~" [M-S-f11])
 216     (define-key map "\e[24;4~" [M-S-f12])
 217
 218     (define-key map "\eOA" [up])
 219     (define-key map "\eOB" [down])
 220     (define-key map "\eOC" [right])
 221     (define-key map "\eOD" [left])
 222     (define-key map "\eOF" [end])
 223     (define-key map "\eOH" [home])
 224
 225     (define-key map "\e[1;2A" [S-up])
 226     (define-key map "\e[1;2B" [S-down])
 227     (define-key map "\e[1;2C" [S-right])
 228     (define-key map "\e[1;2D" [S-left])
 229     (define-key map "\e[1;2F" [S-end])
 230     (define-key map "\e[1;2H" [S-home])
 231
 232     (define-key map "\e[1;4A" [M-S-up])
 233     (define-key map "\e[1;4B" [M-S-down])
 234     (define-key map "\e[1;4C" [M-S-right])
 235     (define-key map "\e[1;4D" [M-S-left])
 236     (define-key map "\e[1;4F" [M-S-end])
 237     (define-key map "\e[1;4H" [M-S-home])
 238
 239     (define-key map "\e[1;5A" [C-up])
 240     (define-key map "\e[1;5B" [C-down])
 241     (define-key map "\e[1;5C" [C-right])
 242     (define-key map "\e[1;5D" [C-left])
 243     (define-key map "\e[1;5F" [C-end])
 244     (define-key map "\e[1;5H" [C-home])
 245
 246     (define-key map "\e[1;6A" [C-S-up])
 247     (define-key map "\e[1;6B" [C-S-down])
 248     (define-key map "\e[1;6C" [C-S-right])
 249     (define-key map "\e[1;6D" [C-S-left])
 250     (define-key map "\e[1;6F" [C-S-end])
 251     (define-key map "\e[1;6H" [C-S-home])
 252
 253     (define-key map "\e[1;7A" [C-M-up])
 254     (define-key map "\e[1;7B" [C-M-down])
 255     (define-key map "\e[1;7C" [C-M-right])
 256     (define-key map "\e[1;7D" [C-M-left])
 257     (define-key map "\e[1;7F" [C-M-end])
 258     (define-key map "\e[1;7H" [C-M-home])
 259
 260     (define-key map "\e[1;8A" [C-M-S-up])
 261     (define-key map "\e[1;8B" [C-M-S-down])
 262     (define-key map "\e[1;8C" [C-M-S-right])
 263     (define-key map "\e[1;8D" [C-M-S-left])
 264     (define-key map "\e[1;8F" [C-M-S-end])
 265     (define-key map "\e[1;8H" [C-M-S-home])
 266
 267     (define-key map "\e[1;3A" [M-up])
 268     (define-key map "\e[1;3B" [M-down])
 269     (define-key map "\e[1;3C" [M-right])
 270     (define-key map "\e[1;3D" [M-left])
 271     (define-key map "\e[1;3F" [M-end])
 272     (define-key map "\e[1;3H" [M-home])
 273
 274     (define-key map "\e[3;2~" [S-delete])
 275     (define-key map "\e[5;2~" [S-prior])
 276     (define-key map "\e[6;2~" [S-next])
 277
 278     (define-key map "\e[2;4~" [M-S-insert])
 279     (define-key map "\e[3;4~" [M-S-delete])
 280     (define-key map "\e[5;4~" [M-S-prior])
 281     (define-key map "\e[6;4~" [M-S-next])
 282
 283     (define-key map "\e[2;5~" [C-insert])
 284     (define-key map "\e[3;5~" [C-delete])
 285     (define-key map "\e[5;5~" [C-prior])
 286     (define-key map "\e[6;5~" [C-next])
 287
 288     (define-key map "\e[2;6~" [C-S-insert])
 289     (define-key map "\e[3;6~" [C-S-delete])
 290     (define-key map "\e[5;6~" [C-S-prior])
 291     (define-key map "\e[6;6~" [C-S-next])
 292
 293     (define-key map "\e[2;7~" [C-M-insert])
 294     (define-key map "\e[3;7~" [C-M-delete])
 295     (define-key map "\e[5;7~" [C-M-prior])
 296     (define-key map "\e[6;7~" [C-M-next])
 297
 298     (define-key map "\e[2;8~" [C-M-S-insert])
 299     (define-key map "\e[3;8~" [C-M-S-delete])
 300     (define-key map "\e[5;8~" [C-M-S-prior])
 301     (define-key map "\e[6;8~" [C-M-S-next])
 302
 303     (define-key map "\e[2;3~" [M-insert])
 304     (define-key map "\e[3;3~" [M-delete])
 305     (define-key map "\e[5;3~" [M-prior])
 306     (define-key map "\e[6;3~" [M-next])
 307
 308     (define-key map "\e[29~" [print])
 309
 310     (define-key map "\eOj" [kp-multiply])
 311     (define-key map "\eOk" [kp-add])
 312     (define-key map "\eOl" [kp-separator])
 313     (define-key map "\eOm" [kp-subtract])
 314     (define-key map "\eOo" [kp-divide])
 315     (define-key map "\eOp" [kp-0])
 316     (define-key map "\eOq" [kp-1])
 317     (define-key map "\eOr" [kp-2])
 318     (define-key map "\eOs" [kp-3])
 319     (define-key map "\eOt" [kp-4])
 320     (define-key map "\eOu" [kp-5])
 321     (define-key map "\eOv" [kp-6])
 322     (define-key map "\eOw" [kp-7])
 323     (define-key map "\eOx" [kp-8])
 324     (define-key map "\eOy" [kp-9])
 325
 326     (define-key map "\eO2j" [S-kp-multiply])
 327     (define-key map "\eO2k" [S-kp-add])
 328     (define-key map "\eO2l" [S-kp-separator])
 329     (define-key map "\eO2m" [S-kp-subtract])
 330     (define-key map "\eO2o" [S-kp-divide])
 331     (define-key map "\eO2p" [S-kp-0])
 332     (define-key map "\eO2q" [S-kp-1])
 333     (define-key map "\eO2r" [S-kp-2])
 334     (define-key map "\eO2s" [S-kp-3])
 335     (define-key map "\eO2t" [S-kp-4])
 336     (define-key map "\eO2u" [S-kp-5])
 337     (define-key map "\eO2v" [S-kp-6])
 338     (define-key map "\eO2w" [S-kp-7])
 339     (define-key map "\eO2x" [S-kp-8])
 340     (define-key map "\eO2y" [S-kp-9])
 341
 342     (define-key map "\eO4j" [M-S-kp-multiply])
 343     (define-key map "\eO4k" [M-S-kp-add])
 344     (define-key map "\eO4l" [M-S-kp-separator])
 345     (define-key map "\eO4m" [M-S-kp-subtract])
 346     (define-key map "\eO4o" [M-S-kp-divide])
 347     (define-key map "\eO4p" [M-S-kp-0])
 348     (define-key map "\eO4q" [M-S-kp-1])
 349     (define-key map "\eO4r" [M-S-kp-2])
 350     (define-key map "\eO4s" [M-S-kp-3])
 351     (define-key map "\eO4t" [M-S-kp-4])
 352     (define-key map "\eO4u" [M-S-kp-5])
 353     (define-key map "\eO4v" [M-S-kp-6])
 354     (define-key map "\eO4w" [M-S-kp-7])
 355     (define-key map "\eO4x" [M-S-kp-8])
 356     (define-key map "\eO4y" [M-S-kp-9])
 357
 358     (define-key map "\eO6j" [C-S-kp-multiply])
 359     (define-key map "\eO6k" [C-S-kp-add])
 360     (define-key map "\eO6l" [C-S-kp-separator])
 361     (define-key map "\eO6m" [C-S-kp-subtract])
 362     (define-key map "\eO6o" [C-S-kp-divide])
 363     (define-key map "\eO6p" [C-S-kp-0])
 364     (define-key map "\eO6q" [C-S-kp-1])
 365     (define-key map "\eO6r" [C-S-kp-2])
 366     (define-key map "\eO6s" [C-S-kp-3])
 367     (define-key map "\eO6t" [C-S-kp-4])
 368     (define-key map "\eO6u" [C-S-kp-5])
 369     (define-key map "\eO6v" [C-S-kp-6])
 370     (define-key map "\eO6w" [C-S-kp-7])
 371     (define-key map "\eO6x" [C-S-kp-8])
 372     (define-key map "\eO6y" [C-S-kp-9])
 373
 374     (define-key map "\eO8j" [C-M-S-kp-multiply])
 375     (define-key map "\eO8k" [C-M-S-kp-add])
 376     (define-key map "\eO8l" [C-M-S-kp-separator])
 377     (define-key map "\eO8m" [C-M-S-kp-subtract])
 378     (define-key map "\eO8o" [C-M-S-kp-divide])
 379     (define-key map "\eO8p" [C-M-S-kp-0])
 380     (define-key map "\eO8q" [C-M-S-kp-1])
 381     (define-key map "\eO8r" [C-M-S-kp-2])
 382     (define-key map "\eO8s" [C-M-S-kp-3])
 383     (define-key map "\eO8t" [C-M-S-kp-4])
 384     (define-key map "\eO8u" [C-M-S-kp-5])
 385     (define-key map "\eO8v" [C-M-S-kp-6])
 386     (define-key map "\eO8w" [C-M-S-kp-7])
 387     (define-key map "\eO8x" [C-M-S-kp-8])
 388     (define-key map "\eO8y" [C-M-S-kp-9])
 389
 390     ;; These keys are available in xterm starting from version 216
 391     ;; if the modifyOtherKeys resource is set to 1.
 392     (dolist (bind '((5 9   [C-tab])
 393                     (5 13  [C-return])
 394                     (5 39  [?\C-\'])
 395                     (5 44  [?\C-,])
 396                     (5 45  [?\C--])
 397                     (5 46  [?\C-.])
 398                     (5 47  [?\C-/])
 399                     (5 48  [?\C-0])
 400                     (5 49  [?\C-1])
 401                     ;; Not all C-DIGIT keys have a distinct binding.
 402                     (5 57  [?\C-9])
 403                     (5 59  [?\C-\;])
 404                     (5 61  [?\C-=])
 405                     (5 92  [?\C-\\])
 406
 407                     (6 33  [?\C-!])
 408                     (6 34  [?\C-\"])
 409                     (6 35  [?\C-#])
 410                     (6 36  [?\C-$])
 411                     (6 37  [?\C-%])
 412                     (6 38  [?\C-&])
 413                     (6 40  [?\C-\(])
 414                     (6 41  [?\C-\)])
 415                     (6 42  [?\C-*])
 416                     (6 43  [?\C-+])
 417                     (6 58  [?\C-:])
 418                     (6 60  [?\C-<])
 419                     (6 62  [?\C->])
 420                     (6 63  [(control ??)])
 421
 422                     ;; These are the strings emitted for various C-M-
 423                     ;; combinations for keyboards whose Meta and Alt
 424                     ;; modifiers are on the same key (usually labeled "Alt").
 425                     (13 9  [C-M-tab])
 426                     (13 13 [C-M-return])
 427
 428                     (13 39 [?\C-\M-\'])
 429                     (13 44 [?\C-\M-,])
 430                     (13 45 [?\C-\M--])
 431                     (13 46 [?\C-\M-.])
 432                     (13 47 [?\C-\M-/])
 433                     (13 48 [?\C-\M-0])
 434                     (13 49 [?\C-\M-1])
 435                     (13 50 [?\C-\M-2])
 436                     (13 51 [?\C-\M-3])
 437                     (13 52 [?\C-\M-4])
 438                     (13 53 [?\C-\M-5])
 439                     (13 54 [?\C-\M-6])
 440                     (13 55 [?\C-\M-7])
 441                     (13 56 [?\C-\M-8])
 442                     (13 57 [?\C-\M-9])
 443                     (13 59 [?\C-\M-\;])
 444                     (13 61 [?\C-\M-=])
 445                     (13 92 [?\C-\M-\\])
 446
 447                     (14 33  [?\C-\M-!])
 448                     (14 34  [?\C-\M-\"])
 449                     (14 35  [?\C-\M-#])
 450                     (14 36  [?\C-\M-$])
 451                     (14 37  [?\C-\M-%])
 452                     (14 38  [?\C-\M-&])
 453                     (14 40  [?\C-\M-\(])
 454                     (14 41  [?\C-\M-\)])
 455                     (14 42  [?\C-\M-*])
 456                     (14 43  [?\C-\M-+])
 457                     (14 58  [?\C-\M-:])
 458                     (14 60  [?\C-\M-<])
 459                     (14 62  [?\C-\M->])
 460                     (14 63  [(control meta ??)])
 461
 462                     (7 9  [C-M-tab])
 463                     (7 13 [C-M-return])
 464
 465                     (7 32 [?\C-\M-\s])
 466                     (7 39 [?\C-\M-\'])
 467                     (7 44 [?\C-\M-,])
 468                     (7 45 [?\C-\M--])
 469                     (7 46 [?\C-\M-.])
 470                     (7 47 [?\C-\M-/])
 471                     (7 48 [?\C-\M-0])
 472                     (7 49 [?\C-\M-1])
 473                     (7 50 [?\C-\M-2])
 474                     (7 51 [?\C-\M-3])
 475                     (7 52 [?\C-\M-4])
 476                     (7 53 [?\C-\M-5])
 477                     (7 54 [?\C-\M-6])
 478                     (7 55 [?\C-\M-7])
 479                     (7 56 [?\C-\M-8])
 480                     (7 57 [?\C-\M-9])
 481                     (7 59 [?\C-\M-\;])
 482                     (7 61 [?\C-\M-=])
 483                     (7 92 [?\C-\M-\\])
 484
 485                     (8 33  [?\C-\M-!])
 486                     (8 34  [?\C-\M-\"])
 487                     (8 35  [?\C-\M-#])
 488                     (8 36  [?\C-\M-$])
 489                     (8 37  [?\C-\M-%])
 490                     (8 38  [?\C-\M-&])
 491                     (8 40  [?\C-\M-\(])
 492                     (8 41  [?\C-\M-\)])
 493                     (8 42  [?\C-\M-*])
 494                     (8 43  [?\C-\M-+])
 495                     (8 58  [?\C-\M-:])
 496                     (8 60  [?\C-\M-<])
 497                     (8 62  [?\C-\M->])
 498                     (8 63  [(control meta ??)])
 499
 500                     (2 9   [S-tab])
 501                     (2 13  [S-return])
 502
 503                     (6 9   [C-S-tab])
 504                     (6 13  [C-S-return])))
 505       (define-key map
 506         (format "\e[27;%d;%d~" (nth 0 bind) (nth 1 bind)) (nth 2 bind))
 507       ;; For formatOtherKeys=1, the sequence is a bit shorter (bug#13839).
 508       (define-key map
 509         (format "\e[%d;%du" (nth 1 bind) (nth 0 bind)) (nth 2 bind)))
 510
 511     ;; Other versions of xterm might emit these.
 512     (define-key map "\e[1~" [home])
 513
 514     (define-key map "\eO2A" [S-up])
 515     (define-key map "\eO2B" [S-down])
 516     (define-key map "\eO2C" [S-right])
 517     (define-key map "\eO2D" [S-left])
 518     (define-key map "\eO2F" [S-end])
 519     (define-key map "\eO2H" [S-home])
 520
 521     (define-key map "\eO5A" [C-up])
 522     (define-key map "\eO5B" [C-down])
 523     (define-key map "\eO5C" [C-right])
 524     (define-key map "\eO5D" [C-left])
 525     (define-key map "\eO5F" [C-end])
 526     (define-key map "\eO5H" [C-home])
 527
 528     map)
 529   "Function key map overrides for xterm.")
 530
 531 (defvar xterm-alternatives-map
 532   (let ((map (make-sparse-keymap)))
 533     ;; The terminal initialization C code file might have initialized
 534     ;; function keys F13->F60 from the termcap/terminfo information.
 535     ;; On a PC-style keyboard these keys correspond to
 536     ;; MODIFIER-FUNCTION_KEY, where modifier is S-, C, A-, C-S-.  The code
 537     ;; here substitutes the corresponding definitions in function-key-map.
 538     ;; The mapping from escape sequences to Fn is done in input-decode-map
 539     ;; whereas this here mapping is done in local-function-key-map so that
 540     ;; bindings to f45 still work, in case your keyboard really has an f45
 541     ;; key rather than C-S-f9.
 542     (define-key map [f13] [S-f1])
 543     (define-key map [f14] [S-f2])
 544     (define-key map [f15] [S-f3])
 545     (define-key map [f16] [S-f4])
 546     (define-key map [f17] [S-f5])
 547     (define-key map [f18] [S-f6])
 548     (define-key map [f19] [S-f7])
 549     (define-key map [f20] [S-f8])
 550     (define-key map [f21] [S-f9])
 551     (define-key map [f22] [S-f10])
 552     (define-key map [f23] [S-f11])
 553     (define-key map [f24] [S-f12])
 554
 555     (define-key map [f25] [C-f1])
 556     (define-key map [f26] [C-f2])
 557     (define-key map [f27] [C-f3])
 558     (define-key map [f28] [C-f4])
 559     (define-key map [f29] [C-f5])
 560     (define-key map [f30] [C-f6])
 561     (define-key map [f31] [C-f7])
 562     (define-key map [f32] [C-f8])
 563     (define-key map [f33] [C-f9])
 564     (define-key map [f34] [C-f10])
 565     (define-key map [f35] [C-f11])
 566     (define-key map [f36] [C-f12])
 567
 568     (define-key map [f37] [C-S-f1])
 569     (define-key map [f38] [C-S-f2])
 570     (define-key map [f39] [C-S-f3])
 571     (define-key map [f40] [C-S-f4])
 572     (define-key map [f41] [C-S-f5])
 573     (define-key map [f42] [C-S-f6])
 574     (define-key map [f43] [C-S-f7])
 575     (define-key map [f44] [C-S-f8])
 576     (define-key map [f45] [C-S-f9])
 577     (define-key map [f46] [C-S-f10])
 578     (define-key map [f47] [C-S-f11])
 579     (define-key map [f48] [C-S-f12])
 580
 581     (define-key map [f49] [M-f1])
 582     (define-key map [f50] [M-f2])
 583     (define-key map [f51] [M-f3])
 584     (define-key map [f52] [M-f4])
 585     (define-key map [f53] [M-f5])
 586     (define-key map [f54] [M-f6])
 587     (define-key map [f55] [M-f7])
 588     (define-key map [f56] [M-f8])
 589     (define-key map [f57] [M-f9])
 590     (define-key map [f58] [M-f10])
 591     (define-key map [f59] [M-f11])
 592     (define-key map [f60] [M-f12])
 593
 594     map)
 595   "Keymap of possible alternative meanings for some keys.")
 596
 597 ;; Set up colors, for those versions of xterm that support it.
 598 (defvar xterm-standard-colors
 599   ;; The names in the comments taken from XTerm-col.ad in the xterm
 600   ;; distribution, see ftp://dickey.his.com/xterm/.  RGB values are
 601   ;; from rgb.txt.
 602   '(("black"          0 (  0   0   0))  ; black
 603     ("red"            1 (205   0   0))  ; red3
 604     ("green"          2 (  0 205   0))  ; green3
 605     ("yellow"         3 (205 205   0))  ; yellow3
 606     ("blue"           4 (  0   0 238))  ; blue2
 607     ("magenta"        5 (205   0 205))  ; magenta3
 608     ("cyan"           6 (  0 205 205))  ; cyan3
 609     ("white"          7 (229 229 229))  ; gray90
 610     ("brightblack"    8 (127 127 127))  ; gray50
 611     ("brightred"      9 (255   0   0))  ; red
 612     ("brightgreen"   10 (  0 255   0))  ; green
 613     ("brightyellow"  11 (255 255   0))  ; yellow
 614     ("brightblue"    12 (92   92 255))  ; rgb:5c/5c/ff
 615     ("brightmagenta" 13 (255   0 255))  ; magenta
 616     ("brightcyan"    14 (  0 255 255))  ; cyan
 617     ("brightwhite"   15 (255 255 255))) ; white
 618   "Names of 16 standard xterm/aixterm colors, their numbers, and RGB values.")
 619
 620 (defun xterm--report-background-handler ()
 621   (let ((str "")
 622         chr)
 623     ;; The reply should be: \e ] 11 ; rgb: NUMBER1 / NUMBER2 / NUMBER3 \e \\
 624     (while (and (setq chr (read-event nil nil 2)) (not (equal chr ?\\)))
 625       (setq str (concat str (string chr))))
 626     (when (string-match
 627            "rgb:\\([a-f0-9]+\\)/\\([a-f0-9]+\\)/\\([a-f0-9]+\\)" str)
 628       (let ((recompute-faces
 629              (xterm-maybe-set-dark-background-mode
 630               (string-to-number (match-string 1 str) 16)
 631               (string-to-number (match-string 2 str) 16)
 632               (string-to-number (match-string 3 str) 16))))
 633
 634         ;; Recompute faces here in case the background mode was
 635         ;; set to dark.  We used to call
 636         ;; `tty-set-up-initial-frame-faces' only once, but that
 637         ;; caused the light background faces to be computed
 638         ;; incorrectly.  See:
 639         ;; http://permalink.gmane.org/gmane.emacs.devel/119627
 640         (when recompute-faces
 641           (tty-set-up-initial-frame-faces))))))
 642
 643 (defun xterm--version-handler ()
 644   (let ((str "")
 645         chr)
 646     ;; The reply should be: \e [ > NUMBER1 ; NUMBER2 ; NUMBER3 c
 647     ;; If the timeout is completely removed for read-event, this
 648     ;; might hang for terminals that pretend to be xterm, but don't
 649     ;; respond to this escape sequence.  RMS' opinion was to remove
 650     ;; it completely.  That might be right, but let's first try to
 651     ;; see if by using a longer timeout we get rid of most issues.
 652     (while (and (setq chr (read-event nil nil 2)) (not (equal chr ?c)))
 653       (setq str (concat str (string chr))))
 654     ;; Since xterm-280, the terminal type (NUMBER1) is now 41 instead of 0.
 655     (when (string-match "\\([0-9]+\\);\\([0-9]+\\);0" str)
 656       (let ((version (string-to-number (match-string 2 str))))
 657         (when (and (> version 2000) (equal (match-string 1 str) "1"))
 658           ;; Hack attack!  bug#16988: gnome-terminal reports "1;NNNN;0"
 659           ;; with a large NNNN but is based on a rather old xterm code.
 660           ;; Gnome terminal 3.6.1 reports 1;3406;0
 661           ;; Gnome terminal 2.32.1 reports 1;2802;0
 662           (setq version 200))
 663         (when (equal (match-string 1 str) "83")
 664           ;; `screen' (which returns 83;40003;0) seems to also lack support for
 665           ;; some of these (bug#17607, bug#20356).
 666           ;; Note: this code path should normally not be used any more
 667           ;; since term/screen.el now binds xterm-extra-capabilities
 668           ;; to a fixed value, rather than using the dynamic checking.
 669           (setq version 200))
 670         ;; If version is 242 or higher, assume the xterm supports
 671         ;; reporting the background color (TODO: maybe earlier
 672         ;; versions do too...)
 673         (when (>= version 242)
 674           (xterm--query "\e]11;?\e\\"
 675                         '(("\e]11;" .  xterm--report-background-handler))))
 676
 677         ;; If version is 216 (the version when modifyOtherKeys was
 678         ;; introduced) or higher, initialize the
 679         ;; modifyOtherKeys support.
 680         (when (>= version 216)
 681           (xterm--init-modify-other-keys))
 682         ;; In version 203 support for accessing the X selection was
 683         ;; added.  Hterm reports itself as version 256 and supports it
 684         ;; as well.  gnome-terminal doesn't and is excluded by this
 685         ;; test.
 686         (when (>= version 203)
 687           ;; Most xterms seem to have it disabled by default, and if it's
 688           ;; disabled, C-y will incur a timeout, so we only use it if the user
 689           ;; explicitly requests it.
 690           ;;(xterm--init-activate-get-selection)
 691           (xterm--init-activate-set-selection))))))
 692
 693 (defvar xterm-query-timeout 2
 694   "Seconds to wait for an answer from the terminal.
 695 Can be nil to mean \"no timeout\".")
 696
 697 (defun xterm--query (query handlers &optional no-async)
 698   "Send QUERY string to the terminal and watch for a response.
 699 HANDLERS is an alist with elements of the form (STRING . FUNCTION).
 700 We run the first FUNCTION whose STRING matches the input events."
 701   ;; We used to query synchronously, but the need to use `discard-input' is
 702   ;; rather annoying (bug#6758).  Maybe we could always use the asynchronous
 703   ;; approach, but it's less tested.
 704   ;; FIXME: Merge the two branches.
 705   (let ((register
 706          (lambda (handlers)
 707            (dolist (handler handlers)
 708              (define-key input-decode-map (car handler)
 709                (lambda (&optional _prompt)
 710                  ;; Unregister the handler, since we don't expect
 711                  ;; further answers.
 712                  (dolist (handler handlers)
 713                    (define-key input-decode-map (car handler) nil))
 714                  (funcall (cdr handler))
 715                  []))))))
 716     (if (and (or (null xterm-query-timeout) (input-pending-p))
 717              (not no-async))
 718         (progn
 719           (funcall register handlers)
 720           (send-string-to-terminal query))
 721       ;; Pending input can be mistakenly returned by the calls to
 722       ;; read-event below: discard it.
 723       (discard-input)
 724       (send-string-to-terminal query)
 725       (while handlers
 726         (let ((handler (pop handlers))
 727               (i 0))
 728           (while (and (< i (length (car handler)))
 729                       (let ((evt (read-event nil nil xterm-query-timeout)))
 730                         (if (and (null evt) (= i 0) (not no-async))
 731                             ;; Timeout on the first event: fallback on async.
 732                             (progn
 733                               (funcall register (cons handler handlers))
 734                               (setq handlers nil)
 735                               nil)
 736                           (or (eq evt (aref (car handler) i))
 737                               (progn (if evt (push evt unread-command-events))
 738                                      nil)))))
 739             (setq i (1+ i)))
 740           (if (= i (length (car handler)))
 741               (progn (setq handlers nil)
 742                      (funcall (cdr handler)))
 743             (while (> i 0)
 744               (push (aref (car handler) (setq i (1- i)))
 745                     unread-command-events))))))))
 746
 747 (defun xterm--push-map (map basemap)
 748   ;; Use inheritance to let the main keymaps override those defaults.
 749   ;; This way we don't override terminfo-derived settings or settings
 750   ;; made in the init file.
 751   (set-keymap-parent
 752    basemap
 753    (make-composed-keymap map (keymap-parent basemap))))
 754
 755 (defun terminal-init-xterm ()
 756   "Terminal initialization function for xterm."
 757   ;; rxvt terminals sometimes set the TERM variable to "xterm", but
 758   ;; rxvt's keybindings are incompatible with xterm's. It is
 759   ;; better in that case to use rxvt's initialization function.
 760   (if (and (getenv "COLORTERM" (selected-frame))
 761            (string-match "\\`rxvt" (getenv "COLORTERM" (selected-frame))))
 762       (tty-run-terminal-initialization (selected-frame) "rxvt")
 763
 764       (xterm--push-map xterm-alternatives-map local-function-key-map)
 765       (xterm--push-map xterm-function-map     input-decode-map))
 766
 767   (xterm-register-default-colors xterm-standard-colors)
 768   (tty-set-up-initial-frame-faces)
 769
 770   (if (eq xterm-extra-capabilities 'check)
 771       ;; Try to find out the type of terminal by sending a "Secondary
 772       ;; Device Attributes (DA)" query.
 773       (xterm--query "\e[>0c"
 774                     ;; Some terminals (like OS X's Terminal.app) respond to
 775                     ;; this query as if it were a "Primary Device Attributes"
 776                     ;; query instead, so we should handle that too.
 777                     '(("\e[?" . xterm--version-handler)
 778                       ("\e[>" . xterm--version-handler)))
 779
 780     (when (memq 'reportBackground xterm-extra-capabilities)
 781       (xterm--query "\e]11;?\e\\"
 782                     '(("\e]11;" .  xterm--report-background-handler))))
 783
 784     (when (memq 'modifyOtherKeys xterm-extra-capabilities)
 785       (xterm--init-modify-other-keys))
 786
 787     (when (memq 'getSelection xterm-extra-capabilities)
 788       (xterm--init-activate-get-selection))
 789     (when (memq 'setSelection xterm-extra-capabilities)
 790       (xterm--init-activate-set-selection)))
 791
 792   ;; Unconditionally enable bracketed paste mode: terminals that don't
 793   ;; support it just ignore the sequence.
 794   (xterm--init-bracketed-paste-mode)
 795
 796   (run-hooks 'terminal-init-xterm-hook))
 797
 798 (defun xterm--init-modify-other-keys ()
 799   "Terminal initialization for xterm's modifyOtherKeys support."
 800   (send-string-to-terminal "\e[>4;1m")
 801   (push "\e[>4m" (terminal-parameter nil 'tty-mode-reset-strings))
 802   (push "\e[>4;1m" (terminal-parameter nil 'tty-mode-set-strings)))
 803
 804 (defun xterm--init-bracketed-paste-mode ()
 805   "Terminal initialization for bracketed paste mode."
 806   (send-string-to-terminal "\e[?2004h")
 807   (push "\e[?2004l" (terminal-parameter nil 'tty-mode-reset-strings))
 808   (push "\e[?2004h" (terminal-parameter nil 'tty-mode-set-strings)))
 809
 810 (defun xterm--init-activate-get-selection ()
 811   "Terminal initialization for `gui-get-selection'."
 812   (set-terminal-parameter nil 'xterm--get-selection t))
 813
 814 (defun xterm--init-activate-set-selection ()
 815   "Terminal initialization for `gui-set-selection'."
 816   (set-terminal-parameter nil 'xterm--set-selection t))
 817
 818 (defun xterm--selection-char (type)
 819   (pcase type
 820     ('PRIMARY "p")
 821     ('CLIPBOARD "c")
 822     (_ (error "Invalid selection type: %S" type))))
 823
 824 (cl-defmethod gui-backend-get-selection
 825     (type data-type
 826      &context (window-system nil)
 827               ;; Only applies to terminals which have it enabled.
 828               ((terminal-parameter nil 'xterm--get-selection) (eql t)))
 829   (unless (eq data-type 'STRING)
 830     (error "Unsupported data type %S" data-type))
 831   (let* ((screen (eq (terminal-parameter nil 'terminal-initted)
 832                      'terminal-init-screen))
 833          (query (concat "\e]52;" (xterm--selection-char type) ";")))
 834     (with-temp-buffer
 835       (set-buffer-multibyte nil)
 836       (xterm--query
 837        (concat (when screen "\eP") query "?\a" (when screen "\e\\"))
 838        (list (cons query (lambda ()
 839                            (while (let ((char (read-char)))
 840                                     (unless (eq char ?\a)
 841                                       (insert char)
 842                                       t))))))
 843        'no-async)
 844       (base64-decode-region (point-min) (point-max))
 845       (decode-coding-region (point-min) (point-max) 'utf-8-unix t))))
 846
 847 (cl-defmethod gui-backend-set-selection
 848     (type data
 849      &context (window-system nil)
 850               ;; Only applies to terminals which have it enabled.
 851               ((terminal-parameter nil 'xterm--set-selection) (eql t)))
 852   "Copy DATA to the X selection using the OSC 52 escape sequence.
 853
 854 TYPE specifies which selection to set; it must be either
 855 `PRIMARY' or `CLIPBOARD'.  DATA must be a string.
 856
 857 This can be used as a `gui-set-selection' method for
 858 xterm-compatible terminal emulators.  Then your system clipboard
 859 will be updated whenever you copy a region of text in Emacs.
 860
 861 If the resulting OSC 52 sequence would be longer than
 862 `xterm-max-cut-length', then the TEXT is not sent to the system
 863 clipboard.
 864
 865 This function either sends a raw OSC 52 sequence or wraps the OSC
 866 52 in a Device Control String sequence.  This way, it will work
 867 on a bare terminal emulators as well as inside the screen
 868 program.  When inside the screen program, this function also
 869 chops long DCS sequences into multiple smaller ones to avoid
 870 hitting screen's max DCS length."
 871   (let* ((screen (eq (terminal-parameter nil 'terminal-initted)
 872                      'terminal-init-screen))
 873          (bytes (encode-coding-string data 'utf-8-unix))
 874          (base-64 (if screen
 875                       (replace-regexp-in-string
 876                        "\n" "\e\\\eP"
 877                        (base64-encode-string bytes)
 878                        :fixedcase :literal)
 879                     (base64-encode-string bytes :no-line-break)))
 880          (length (length base-64)))
 881     (if (> length xterm-max-cut-length)
 882         (progn
 883           (warn "Selection too long to send to terminal: %d bytes" length)
 884           (sit-for 2))
 885       (send-string-to-terminal
 886        (concat
 887         (when screen "\eP")
 888         "\e]52;" (xterm--selection-char type) ";" base-64 "\a"
 889         (when screen "\e\\"))))))
 890
 891 (defun xterm-rgb-convert-to-16bit (prim)
 892   "Convert an 8-bit primary color value PRIM to a corresponding 16-bit value."
 893   (logior prim (lsh prim 8)))
 894
 895 (defun xterm-register-default-colors (colors)
 896   "Register the default set of colors for xterm or compatible emulator.
 897
 898 This function registers the number of colors returned by `display-color-cells'
 899 for the currently selected frame.  The first (16) colors are taken from
 900 COLORS, which see, while the rest are computed assuming
 901 either the 88- or 256-color standard color scheme supported by latest
 902 versions of xterm."
 903   (let* ((ncolors (display-color-cells))
 904          (color (car colors)))
 905     (if (> ncolors 0)
 906         ;; Clear the 8 default tty colors registered by startup.el
 907         (tty-color-clear))
 908     ;; Only register as many colors as are supported by the display.
 909     (while (and (> ncolors 0) colors)
 910       (tty-color-define (car color) (cadr color)
 911                         (mapcar #'xterm-rgb-convert-to-16bit
 912                                 (car (cddr color))))
 913       (setq colors (cdr colors)
 914             color (car colors)
 915             ncolors (1- ncolors)))
 916     ;; We've exhausted the colors from `colors'.  If there
 917     ;; are more colors to support, compute them now.
 918     (when (> ncolors 0)
 919       (cond
 920        ((= ncolors 240) ; 256-color xterm
 921         ;; 216 non-gray colors first
 922         (let ((r 0) (g 0) (b 0))
 923           (while (> ncolors 24)
 924             ;; This and other formulas taken from 256colres.pl and
 925             ;; 88colres.pl in the xterm distribution.
 926             (tty-color-define (format "color-%d" (- 256 ncolors))
 927                               (- 256 ncolors)
 928                               (mapcar #'xterm-rgb-convert-to-16bit
 929                                       (list (if (zerop r) 0 (+ (* r 40) 55))
 930                                             (if (zerop g) 0 (+ (* g 40) 55))
 931                                             (if (zerop b) 0 (+ (* b 40) 55)))))
 932
 933             (setq b (1+ b))
 934             (if (> b 5)
 935                 (setq g (1+ g)
 936                       b 0))
 937             (if (> g 5)
 938                 (setq r (1+ r)
 939                       g 0))
 940             (setq ncolors (1- ncolors))))
 941         ;; Now the 24 gray colors
 942         (while (> ncolors 0)
 943           (setq color (xterm-rgb-convert-to-16bit (+ 8 (* (- 24 ncolors) 10))))
 944           (tty-color-define (format "color-%d" (- 256 ncolors))
 945                             (- 256 ncolors)
 946                             (list color color color))
 947           (setq ncolors (1- ncolors))))
 948        ((= ncolors 72)  ; 88-color xterm
 949         ;; 64 non-gray colors
 950         (let ((levels '(0 139 205 255))
 951               (r 0) (g 0) (b 0))
 952           (while (> ncolors 8)
 953             (tty-color-define (format "color-%d" (- 88 ncolors))
 954                               (- 88 ncolors)
 955                               (mapcar #'xterm-rgb-convert-to-16bit
 956                                       (list (nth r levels)
 957                                             (nth g levels)
 958                                             (nth b levels))))
 959             (setq b (1+ b))
 960             (if (> b 3)
 961                 (setq g (1+ g)
 962                       b 0))
 963             (if (> g 3)
 964                 (setq r (1+ r)
 965                       g 0))
 966             (setq ncolors (1- ncolors))))
 967         ;; Now the 8 gray colors
 968         (while (> ncolors 0)
 969           (setq color (xterm-rgb-convert-to-16bit
 970                        (floor
 971                         (if (= ncolors 8)
 972                             46.36363636
 973                           (+ (* (- 8 ncolors) 23.18181818) 69.54545454)))))
 974           (tty-color-define (format "color-%d" (- 88 ncolors))
 975                             (- 88 ncolors)
 976                             (list color color color))
 977           (setq ncolors (1- ncolors))))
 978        (t (error "Unsupported number of xterm colors (%d)" (+ 16 ncolors)))))
 979     ;; Modifying color mappings means realized faces don't use the
 980     ;; right colors, so clear them.
 981     (clear-face-cache)))
 982
 983 (defun xterm-maybe-set-dark-background-mode (redc greenc bluec)
 984   ;; Use the heuristic in `frame-set-background-mode' to decide if a
 985   ;; frame is dark.
 986   (when (< (+ redc greenc bluec) (* .6 (+ 65535 65535 65535)))
 987     (set-terminal-parameter nil 'background-mode 'dark)
 988     t))
 989
 990 (provide 'xterm)                        ;Backward compatibility.
 991 (provide 'term/xterm)
 992 ;;; xterm.el ends here