lisp/term/rxvt.el

   1 ;;; rxvt.el --- define function key sequences and standard colors for rxvt
   2
   3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   4
   5 ;; Author: Eli Zaretskii
   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 2, or (at your option)
  13 ;; 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; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23 ;; Boston, MA 02110-1301, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (defvar rxvt-function-map (make-sparse-keymap)
  30   "Function key overrides for rxvt.")
  31
  32 ;; Set up function-key-map entries that termcap and terminfo don't know.
  33 (define-key rxvt-function-map "\e[A" [up])
  34 (define-key rxvt-function-map "\e[B" [down])
  35 (define-key rxvt-function-map "\e[C" [right])
  36 (define-key rxvt-function-map "\e[D" [left])
  37 (define-key rxvt-function-map "\e[2~" [insert])
  38 (define-key rxvt-function-map "\e[3~" [delete])
  39 (define-key rxvt-function-map "\e[4~" [select])
  40 (define-key rxvt-function-map "\e[5~" [prior])
  41 (define-key rxvt-function-map "\e[6~" [next])
  42 (define-key rxvt-function-map "\e[7~" [home])
  43 (define-key rxvt-function-map "\e[8~" [end])
  44 (define-key rxvt-function-map "\e[11~" [f1])
  45 (define-key rxvt-function-map "\e[12~" [f2])
  46 (define-key rxvt-function-map "\e[13~" [f3])
  47 (define-key rxvt-function-map "\e[14~" [f4])
  48 (define-key rxvt-function-map "\e[15~" [f5])
  49 (define-key rxvt-function-map "\e[17~" [f6])
  50 (define-key rxvt-function-map "\e[18~" [f7])
  51 (define-key rxvt-function-map "\e[19~" [f8])
  52 (define-key rxvt-function-map "\e[20~" [f9])
  53 (define-key rxvt-function-map "\e[21~" [f10])
  54 ;; The strings emitted by f11 and f12 are the same as the strings
  55 ;; emitted by S-f1 and S-f2, so don't define f11 and f12.
  56 ;; (define-key rxvt-function-map "\e[23~" [f11])
  57 ;; (define-key rxvt-function-map "\e[24~" [f12])
  58 (define-key rxvt-function-map "\e[29~" [print])
  59
  60 (define-key rxvt-function-map "\e[11^" [C-f1])
  61 (define-key rxvt-function-map "\e[12^" [C-f2])
  62 (define-key rxvt-function-map "\e[13^" [C-f3])
  63 (define-key rxvt-function-map "\e[14^" [C-f4])
  64 (define-key rxvt-function-map "\e[15^" [C-f5])
  65 (define-key rxvt-function-map "\e[17^" [C-f6])
  66 (define-key rxvt-function-map "\e[18^" [C-f7])
  67 (define-key rxvt-function-map "\e[19^" [C-f8])
  68 (define-key rxvt-function-map "\e[20^" [C-f9])
  69 (define-key rxvt-function-map "\e[21^" [C-f10])
  70
  71 (define-key rxvt-function-map "\e[23~" [S-f1])
  72 (define-key rxvt-function-map "\e[24~" [S-f2])
  73 (define-key rxvt-function-map "\e[25~" [S-f3])
  74 (define-key rxvt-function-map "\e[26~" [S-f4])
  75 (define-key rxvt-function-map "\e[28~" [S-f5])
  76 (define-key rxvt-function-map "\e[29~" [S-f6])
  77 (define-key rxvt-function-map "\e[31~" [S-f7])
  78 (define-key rxvt-function-map "\e[32~" [S-f8])
  79 (define-key rxvt-function-map "\e[33~" [S-f9])
  80 (define-key rxvt-function-map "\e[34~" [S-f10])
  81
  82 (define-key rxvt-function-map "\e[23^" [C-S-f1])
  83 (define-key rxvt-function-map "\e[24^" [C-S-f2])
  84 (define-key rxvt-function-map "\e[25^" [C-S-f3])
  85 (define-key rxvt-function-map "\e[26^" [C-S-f4])
  86 (define-key rxvt-function-map "\e[28^" [C-S-f5])
  87 (define-key rxvt-function-map "\e[29^" [C-S-f6])
  88 (define-key rxvt-function-map "\e[31^" [C-S-f7])
  89 (define-key rxvt-function-map "\e[32^" [C-S-f8])
  90 (define-key rxvt-function-map "\e[33^" [C-S-f9])
  91 (define-key rxvt-function-map "\e[34^" [C-S-f10])
  92
  93 (define-key rxvt-function-map "\e[2^" [C-insert])
  94 (define-key rxvt-function-map "\e[3^" [C-delete])
  95 (define-key rxvt-function-map "\e[5^" [C-prior])
  96 (define-key rxvt-function-map "\e[6^" [C-next])
  97 (define-key rxvt-function-map "\e[7^" [C-home])
  98 (define-key rxvt-function-map "\e[8^" [C-end])
  99 (define-key rxvt-function-map "\eOd" [C-left])
 100 (define-key rxvt-function-map "\eOc" [C-right])
 101 (define-key rxvt-function-map "\eOa" [C-up])
 102 (define-key rxvt-function-map "\eOb" [C-down])
 103
 104 (define-key rxvt-function-map "\e[2;2~" [S-insert])
 105 (define-key rxvt-function-map "\e[3$" [S-delete])
 106 (define-key rxvt-function-map "\e[5$" [S-prior])
 107 (define-key rxvt-function-map "\e[6$" [S-next])
 108 (define-key rxvt-function-map "\e[7$" [S-home])
 109 (define-key rxvt-function-map "\e[8$" [S-end])
 110 (define-key rxvt-function-map "\e[d" [S-left])
 111 (define-key rxvt-function-map "\e[c" [S-right])
 112 (define-key rxvt-function-map "\e[a" [S-up])
 113 (define-key rxvt-function-map "\e[b" [S-down])
 114
 115 (defun terminal-init-rxvt ()
 116   "Terminal initialization function for rxvt."
 117
 118   ;; The terminal intialization C code file might have initialized
 119   ;; function keys F11->F42 from the termcap/terminfo information.  On
 120   ;; a PC-style keyboard these keys correspond to
 121   ;; MODIFIER-FUNCTION_KEY, where modifier is S-, C-, C-S-.  The
 122   ;; code here subsitutes the corresponding defintions in
 123   ;; function-key-map.  This substitution is needed because if a key
 124   ;; definition if found in function-key-map, there are no further
 125   ;; lookups in other keymaps.
 126   (substitute-key-definition [f11] [S-f1] local-function-key-map)
 127   (substitute-key-definition [f12] [S-f2] local-function-key-map)
 128   (substitute-key-definition [f13] [S-f3] local-function-key-map)
 129   (substitute-key-definition [f14] [S-f4] local-function-key-map)
 130   (substitute-key-definition [f15] [S-f5] local-function-key-map)
 131   (substitute-key-definition [f16] [S-f6] local-function-key-map)
 132   (substitute-key-definition [f17] [S-f7] local-function-key-map)
 133   (substitute-key-definition [f18] [S-f8] local-function-key-map)
 134   (substitute-key-definition [f19] [S-f9] local-function-key-map)
 135   (substitute-key-definition [f20] [S-f10] local-function-key-map)
 136
 137   (substitute-key-definition [f23] [C-f1] local-function-key-map)
 138   (substitute-key-definition [f24] [C-f2] local-function-key-map)
 139   (substitute-key-definition [f25] [C-f3] local-function-key-map)
 140   (substitute-key-definition [f26] [C-f4] local-function-key-map)
 141   (substitute-key-definition [f27] [C-f5] local-function-key-map)
 142   (substitute-key-definition [f28] [C-f6] local-function-key-map)
 143   (substitute-key-definition [f29] [C-f7] local-function-key-map)
 144   (substitute-key-definition [f30] [C-f8] local-function-key-map)
 145   (substitute-key-definition [f31] [C-f9] local-function-key-map)
 146   (substitute-key-definition [f32] [C-f10] local-function-key-map)
 147
 148   (substitute-key-definition [f33] [C-S-f1] local-function-key-map)
 149   (substitute-key-definition [f34] [C-S-f2] local-function-key-map)
 150   (substitute-key-definition [f35] [C-S-f3] local-function-key-map)
 151   (substitute-key-definition [f36] [C-S-f4] local-function-key-map)
 152   (substitute-key-definition [f37] [C-S-f5] local-function-key-map)
 153   (substitute-key-definition [f38] [C-S-f6] local-function-key-map)
 154   (substitute-key-definition [f39] [C-S-f7] local-function-key-map)
 155   (substitute-key-definition [f40] [C-S-f8] local-function-key-map)
 156   (substitute-key-definition [f41] [C-S-f9] local-function-key-map)
 157   (substitute-key-definition [f42] [C-S-f10] local-function-key-map)
 158
 159   ;; Use inheritance to let the main keymap override those defaults.
 160   ;; This way we don't override terminfo-derived settings or settings
 161   ;; made in the .emacs file.
 162   (let ((m (copy-keymap rxvt-function-map)))
 163     (set-keymap-parent m (keymap-parent local-function-key-map))
 164     (set-keymap-parent local-function-key-map m))
 165
 166   ;; Initialize colors and background mode.
 167   (rxvt-register-default-colors)
 168   (rxvt-set-background-mode)
 169   ;; This recomputes all the default faces given the colors we've just set up.
 170   (tty-set-up-initial-frame-faces))
 171
 172 ;; Set up colors, for those versions of rxvt that support it.
 173 (defvar rxvt-standard-colors
 174   ;; The names of the colors in the comments taken from the rxvt.1 man
 175   ;; page; the corresponding RGB values--from rgb.txt.
 176   '(("black"          0 (  0   0   0))  ; black
 177     ("red"            1 (205   0   0))  ; red3
 178     ("green"          2 (  0 205   0))  ; green3
 179     ("yellow"         3 (205 205   0))  ; yellow3
 180     ("blue"           4 (  0   0 205))  ; blue3
 181     ("magenta"        5 (205   0 205))  ; magenta3
 182     ("cyan"           6 (  0 205 205))  ; cyan3
 183     ("white"          7 (229 229 229))  ; gray90
 184     ("brightblack"    8 ( 77  77  77))  ; gray30
 185     ("brightred"      9 (255   0   0))  ; red
 186     ("brightgreen"   10 (  0 255   0))  ; green
 187     ("brightyellow"  11 (255 255   0))  ; yellow
 188     ("brightblue"    12 (  0   0 255))  ; blue
 189     ("brightmagenta" 13 (255   0 255))  ; magenta
 190     ("brightcyan"    14 (  0 255 255))  ; cyan
 191     ("brightwhite"   15 (255 255 255))) ; white
 192   "Names of 16 standard rxvt colors, their numbers, and RGB values.")
 193
 194 (defun rxvt-rgb-convert-to-16bit (prim)
 195   "Convert an 8-bit primary color value PRIM to a corresponding 16-bit value."
 196   (min 65535 (round (* (/ prim 255.0) 65535.0))))
 197
 198 (defun rxvt-register-default-colors ()
 199   "Register the default set of colors for rxvt or compatible emulator.
 200
 201 This function registers the number of colors returned by `display-color-cells'
 202 for the currently selected frame."
 203   (let* ((ncolors (display-color-cells))
 204          (colors rxvt-standard-colors)
 205          (color (car colors)))
 206     (if (> ncolors 0)
 207         ;; Clear the 8 default tty colors registered by startup.el
 208         (tty-color-clear))
 209     ;; Only register as many colors as are supported by the display.
 210     (while (and (> ncolors 0) colors)
 211       (tty-color-define (car color) (cadr color)
 212                         (mapcar 'rxvt-rgb-convert-to-16bit
 213                                 (car (cddr color))))
 214       (setq colors (cdr colors)
 215             color (car colors)
 216             ncolors (1- ncolors)))
 217     (when (> ncolors 0)
 218       (cond
 219        ((= ncolors 240)                 ; 256-color rxvt
 220         ;; 216 non-gray colors first
 221         (let ((r 0) (g 0) (b 0))
 222           (while (> ncolors 24)
 223             ;; This and other formulae taken from 256colres.pl and
 224             ;; 88colres.pl in the xterm distribution.
 225             (tty-color-define (format "color-%d" (- 256 ncolors))
 226                               (- 256 ncolors)
 227                               (mapcar 'rxvt-rgb-convert-to-16bit
 228                                       (list (round (* r 42.5))
 229                                             (round (* g 42.5))
 230                                             (round (* b 42.5)))))
 231             (setq b (1+ b))
 232             (if (> b 5)
 233                 (setq g (1+ g)
 234                       b 0))
 235             (if (> g 5)
 236                 (setq r (1+ r)
 237                       g 0))
 238             (setq ncolors (1- ncolors))))
 239         ;; Now the 24 gray colors
 240         (while (> ncolors 0)
 241           (setq color (rxvt-rgb-convert-to-16bit (+ 8 (* (- 24 ncolors) 10))))
 242           (tty-color-define (format "color-%d" (- 256 ncolors))
 243                             (- 256 ncolors)
 244                             (list color color color))
 245           (setq ncolors (1- ncolors))))
 246
 247        ((= ncolors 72) ; rxvt-unicode
 248         ;; 64 non-gray colors
 249         (let ((levels '(0 139 205 255))
 250               (r 0) (g 0) (b 0))
 251           (while (> ncolors 8)
 252             (tty-color-define (format "color-%d" (- 88 ncolors))
 253                               (- 88 ncolors)
 254                               (mapcar 'rxvt-rgb-convert-to-16bit
 255                                       (list (nth r levels)
 256                                             (nth g levels)
 257                                             (nth b levels))))
 258             (setq b (1+ b))
 259             (if (> b 3)
 260                 (setq g (1+ g)
 261                       b 0))
 262             (if (> g 3)
 263                 (setq r (1+ r)
 264                       g 0))
 265             (setq ncolors (1- ncolors))))
 266         ;; Now the 8 gray colors
 267         (while (> ncolors 0)
 268           (setq color (rxvt-rgb-convert-to-16bit
 269                        (floor
 270                         (if (= ncolors 8)
 271                             46.36363636
 272                           (+ (* (- 8 ncolors) 23.18181818) 69.54545454)))))
 273           (tty-color-define (format "color-%d" (- 88 ncolors))
 274                             (- 88 ncolors)
 275                             (list color color color))
 276           (setq ncolors (1- ncolors))))
 277        (t (error "Unsupported number of rxvt colors (%d)" (+ 16 ncolors)))))
 278     ;; Modifying color mappings means realized faces don't use the
 279     ;; right colors, so clear them.
 280     (clear-face-cache)))
 281
 282 ;; rxvt puts the default colors into an environment variable
 283 ;; COLORFGBG.  We use this to set the background mode in a more
 284 ;; intelligent way than the default guesswork in startup.el.
 285 (defun rxvt-set-background-mode ()
 286   "Set background mode as appropriate for the default rxvt colors."
 287   (let ((fgbg (getenv "COLORFGBG"))
 288         bg rgb)
 289     (set-terminal-parameter nil 'background-mode 'light)
 290     (when (and fgbg
 291                (string-match ".*;\\([0-9][0-9]?\\)\\'" fgbg))
 292       (setq bg (string-to-number (substring fgbg (match-beginning 1))))
 293       ;; The next line assumes that rxvt-standard-colors are ordered
 294       ;; by the color index in the ascending order!
 295       (setq rgb (car (cddr (nth bg rxvt-standard-colors))))
 296       ;; See the commentary in frame-set-background-mode about the
 297       ;; computation below.
 298       (if (< (apply '+ rgb)
 299              ;; The following line assumes that white is the 15th
 300              ;; color in rxvt-standard-colors.
 301              (* (apply '+ (car (cddr (nth 15 rxvt-standard-colors)))) 0.6))
 302           (set-terminal-parameter nil 'background-mode 'dark)))))
 303
 304 ;; arch-tag: 20cf2fb6-6318-4bab-9dbf-1d15048f2257
 305 ;;; rxvt.el ends here