;;; xterm.el --- define function key sequences and standard colors for xterm
-;; Copyright (C) 1995, 2001-2011 Free Software Foundation, Inc.
+;; Copyright (C) 1995, 2001-2012 Free Software Foundation, Inc.
;; Author: FSF
;; Keywords: terminals
(defgroup xterm nil
"XTerm support."
:version "24.1"
- :group 'emacs)
+ :group 'environment)
(defcustom xterm-extra-capabilities 'check
- "Set to a list if the XTerm supports modifyOtherKeys or
-reporting the background color. Set to 'check to check for those
-features. Set to nil to skip the checks."
+ "Whether Xterm supports some additional, more modern, features.
+If nil, just assume that it does not.
+If `check', try to check if it does.
+If a list, assume that the listed features are supported, without checking.
+
+The relevant features are:
+ modifyOtherKeys -- if supported, more key bindings work (e.g, \"\\C-,\")
+ reportBackground -- if supported, Xterm reports its background color
+"
+ :version "24.1"
:group 'xterm
:type '(choice (const :tag "No" nil)
(const :tag "Check" check)
"Terminal initialization function for xterm."
;; rxvt terminals sometimes set the TERM variable to "xterm", but
;; rxvt's keybindings are incompatible with xterm's. It is
- ;; better in that case to use rxvt's initializion function.
+ ;; better in that case to use rxvt's initialization function.
(if (and (getenv "COLORTERM" (selected-frame))
(string-match "\\`rxvt" (getenv "COLORTERM" (selected-frame))))
(tty-run-terminal-initialization (selected-frame) "rxvt")
;; When it is turned on many more key bindings work: things like
;; C-. C-, etc.
;; To do that we need to find out if the current terminal supports
- ;; modifyOtherKeys. At this time only xterm does.
+ ;; modifyOtherKeys. At this time only xterm does.
(when xterm-extra-capabilities
(let ((coding-system-for-read 'binary)
(chr nil)
- (str nil)
- (background-regex
- "11;rgb:\\([a-f0-9]+\\)/\\([a-f0-9]+\\)/\\([a-f0-9]+\\)")
+ (str "")
(recompute-faces nil)
;; If `xterm-extra-capabilities' is 'check, we don't know
;; the capabilities. We need to check for those defined
;; we don't need to check for any capabilities because
;; they are given by setting `xterm-extra-capabilities' to
;; a list (which could be empty).
- (tocheck-capabilities (when (eq 'check xterm-extra-capabilities)
- '(modifyOtherKeys reportBackground)))
+ (tocheck-capabilities (if (eq 'check xterm-extra-capabilities)
+ '(modifyOtherKeys reportBackground)))
;; The given capabilities are either the contents of
- ;; `xterm-extra-capabilities', if it's a list, or an empty
- ;; list.
- (given-capabilities (when (consp xterm-extra-capabilities)
- xterm-extra-capabilities))
+ ;; `xterm-extra-capabilities', if it's a list, or an empty list.
+ (given-capabilities (if (consp xterm-extra-capabilities)
+ xterm-extra-capabilities))
version)
-
- ;; Do the following if `xterm-extra-capabilities' is anything but nil.
- (when xterm-extra-capabilities
- ;; 1. Set `version'
-
- ;; Pending input can be mistakenly returned by the calls to
- ;; read-event below. Discard it.
- (discard-input)
- ;; Try to find out the type of terminal by sending a "Secondary
- ;; Device Attributes (DA)" query.
- (send-string-to-terminal "\e[>0c")
-
- ;; The reply should be: \e [ > NUMBER1 ; NUMBER2 ; NUMBER3 c
- ;; If the timeout is completely removed for read-event, this
- ;; might hang for terminals that pretend to be xterm, but don't
- ;; respond to this escape sequence. RMS' opinion was to remove
- ;; it completely. That might be right, but let's first try to
- ;; see if by using a longer timeout we get rid of most issues.
- (when (equal (read-event nil nil 2) ?\e)
- (when (equal (read-event nil nil 2) ?\[)
- (while (not (equal (setq chr (read-event nil nil 2)) ?c))
- (setq str (concat str (string chr))))
- (when (string-match ">0;\\([0-9]+\\);0" str)
- (setq version
- (string-to-number
- (substring str (match-beginning 1) (match-end 1)))))))
-
- ;; 2. If reportBackground is known to be supported, or the
- ;; version is 242 or higher, assume the xterm supports
- ;; reporting the background color (TODO: maybe earlier
- ;; versions do too...)
- (when (or (memq 'reportBackground given-capabilities)
- (and (memq 'reportBackground tocheck-capabilities)
- version
- (>= version 242)))
- (send-string-to-terminal "\e]11;?\e\\")
- (when (equal (read-event nil nil 2) ?\e)
- (when (equal (read-event nil nil 2) ?\])
- (setq str "")
- (while (not (equal (setq chr (read-event nil nil 2)) ?\\))
- (setq str (concat str (string chr))))
- (when (string-match background-regex str)
- (setq recompute-faces
- (xterm-maybe-set-dark-background-mode
- (string-to-number (match-string 1 str) 16)
- (string-to-number (match-string 2 str) 16)
- (string-to-number (match-string 3 str) 16)))))))
-
- ;; 3. If modifyOtherKeys is known to be supported or the
- ;; version is 216 (the version when modifyOtherKeys was
- ;; introduced) or higher, initialize the modifyOtherKeys
- ;; support.
- (when (or (memq 'modifyOtherKeys given-capabilities)
- (and (memq 'modifyOtherKeys tocheck-capabilities)
- version
- (>= version 216)))
+ ;; 1. Set `version'
+
+ ;; Pending input can be mistakenly returned by the calls to
+ ;; read-event below. Discard it.
+ (discard-input)
+ ;; Try to find out the type of terminal by sending a "Secondary
+ ;; Device Attributes (DA)" query.
+ (send-string-to-terminal "\e[>0c")
+
+ ;; The reply should be: \e [ > NUMBER1 ; NUMBER2 ; NUMBER3 c
+ ;; If the timeout is completely removed for read-event, this
+ ;; might hang for terminals that pretend to be xterm, but don't
+ ;; respond to this escape sequence. RMS' opinion was to remove
+ ;; it completely. That might be right, but let's first try to
+ ;; see if by using a longer timeout we get rid of most issues.
+ (when (and (equal (read-event nil nil 2) ?\e)
+ (equal (read-event nil nil 2) ?\[))
+ (while (not (equal (setq chr (read-event nil nil 2)) ?c))
+ (setq str (concat str (string chr))))
+ (if (string-match ">0;\\([0-9]+\\);0" str)
+ (setq version (string-to-number (match-string 1 str)))))
+ ;; 2. If reportBackground is known to be supported, or the
+ ;; version is 242 or higher, assume the xterm supports
+ ;; reporting the background color (TODO: maybe earlier
+ ;; versions do too...)
+ (when (or (memq 'reportBackground given-capabilities)
+ (and (memq 'reportBackground tocheck-capabilities)
+ version
+ (>= version 242)))
+ (send-string-to-terminal "\e]11;?\e\\")
+ (when (and (equal (read-event nil nil 2) ?\e)
+ (equal (read-event nil nil 2) ?\]))
+ (setq str "")
+ (while (not (equal (setq chr (read-event nil nil 2)) ?\\))
+ (setq str (concat str (string chr))))
+ (if (string-match
+ "11;rgb:\\([a-f0-9]+\\)/\\([a-f0-9]+\\)/\\([a-f0-9]+\\)" str)
+ (setq recompute-faces
+ (xterm-maybe-set-dark-background-mode
+ (string-to-number (match-string 1 str) 16)
+ (string-to-number (match-string 2 str) 16)
+ (string-to-number (match-string 3 str) 16))))))
+
+ ;; 3. If modifyOtherKeys is known to be supported or the
+ ;; version is 216 (the version when modifyOtherKeys was
+ ;; introduced) or higher, initialize the modifyOtherKeys support.
+ (if (or (memq 'modifyOtherKeys given-capabilities)
+ (and (memq 'modifyOtherKeys tocheck-capabilities)
+ version
+ (>= version 216)))
(terminal-init-xterm-modify-other-keys))
- ;; Recompute faces here in case the background mode was
- ;; set to dark. We used to call
- ;; `tty-set-up-initial-frame-faces' only once, but that
- ;; caused the light background faces to be computed
- ;; incorrectly. See:
- ;; http://permalink.gmane.org/gmane.emacs.devel/119627
- (when recompute-faces
- (tty-set-up-initial-frame-faces)))))
+ ;; Recompute faces here in case the background mode was
+ ;; set to dark. We used to call
+ ;; `tty-set-up-initial-frame-faces' only once, but that
+ ;; caused the light background faces to be computed
+ ;; incorrectly. See:
+ ;; http://permalink.gmane.org/gmane.emacs.devel/119627
+ (when recompute-faces
+ (tty-set-up-initial-frame-faces))))
(run-hooks 'terminal-init-xterm-hook))
;; 216 non-gray colors first
(let ((r 0) (g 0) (b 0))
(while (> ncolors 24)
- ;; This and other formulae taken from 256colres.pl and
+ ;; This and other formulas taken from 256colres.pl and
;; 88colres.pl in the xterm distribution.
(tty-color-define (format "color-%d" (- 256 ncolors))
(- 256 ncolors)