1 ;;; x-win.el --- parse switches controlling interface with X window system
2 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
7 ;;; This file is part of GNU Emacs.
9 ;;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;;; it under the terms of the GNU General Public License as published by
11 ;;; the Free Software Foundation; either version 2, or (at your option)
12 ;;; any later version.
14 ;;; GNU Emacs is distributed in the hope that it will be useful,
15 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;;; GNU General Public License for more details.
19 ;;; You should have received a copy of the GNU General Public License
20 ;;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;; X-win.el: this file is loaded from ../lisp/startup.el when it recognizes
26 ;; that X windows are to be used. Command line switches are parsed and those
27 ;; pertaining to X are processed and removed from the command line. The
28 ;; X display is opened and hooks are set for popping up the initial window.
30 ;; startup.el will then examine startup files, and eventually call the hooks
31 ;; which create the first window (s).
35 ;; These are the standard X switches from the Xt Initialize.c file of
38 ;; Command line Resource Manager string
41 ;; +synchronous *synchronous
42 ;; -background *background
45 ;; -bordercolor *borderColor
46 ;; -borderwidth .borderWidth
52 ;; -foreground *foreground
53 ;; -geometry .geometry
58 ;; -reverse *reverseVideo
60 ;; -selectionTimeout .selectionTimeout
61 ;; -synchronous *synchronous
64 ;; An alist of X options and the function which handles them. See
67 (if (not (eq window-system 'x))
68 (error "%s: Loading x-win.el but not compiled for X" (invocation-name)))
77 (defvar x-invocation-args)
79 (defvar x-command-line-resources nil)
81 (defconst x-option-alist
82 '(("-bw" . x-handle-numeric-switch)
83 ("-d" . x-handle-display)
84 ("-display" . x-handle-display)
85 ("-name" . x-handle-name-rn-switch)
86 ("-rn" . x-handle-name-rn-switch)
87 ("-T" . x-handle-switch)
88 ("-r" . x-handle-switch)
89 ("-rv" . x-handle-switch)
90 ("-reverse" . x-handle-switch)
91 ("-fn" . x-handle-switch)
92 ("-font" . x-handle-switch)
93 ("-ib" . x-handle-numeric-switch)
94 ("-g" . x-handle-geometry)
95 ("-geometry" . x-handle-geometry)
96 ("-fg" . x-handle-switch)
97 ("-foreground". x-handle-switch)
98 ("-bg" . x-handle-switch)
99 ("-background". x-handle-switch)
100 ("-ms" . x-handle-switch)
101 ("-itype" . x-handle-switch)
102 ("-i" . x-handle-switch)
103 ("-iconic" . x-handle-iconic)
104 ("-xrm" . x-handle-xrm-switch)
105 ("-cr" . x-handle-switch)
106 ("-vb" . x-handle-switch)
107 ("-hb" . x-handle-switch)
108 ("-bd" . x-handle-switch)))
110 (defconst x-long-option-alist
111 '(("--border-width" . "-bw")
115 ("--reverse-video" . "-reverse")
117 ("--internal-border" . "-ib")
118 ("--geometry" . "-geometry")
119 ("--foreground-color" . "-fg")
120 ("--background-color" . "-bg")
121 ("--mouse-color" . "-ms")
122 ("--icon-type" . "-itype")
123 ("--iconic" . "-iconic")
125 ("--cursor-color" . "-cr")
126 ("--vertical-scroll-bars" . "-vb")
127 ("--border-color" . "-bd")))
129 (defconst x-switch-definitions
134 ("-reverse" reverse t)
137 ("-ib" internal-border-width)
138 ("-fg" foreground-color)
139 ("-foreground" foreground-color)
140 ("-bg" background-color)
141 ("-background" background-color)
144 ("-itype" icon-type t)
146 ("-vb" vertical-scroll-bars t)
147 ("-hb" horizontal-scroll-bars t)
149 ("-bw" border-width)))
151 ;; Handler for switches of the form "-switch value" or "-switch".
152 (defun x-handle-switch (switch)
153 (let ((aelt (assoc switch x-switch-definitions)))
156 (setq default-frame-alist
157 (cons (cons (nth 1 aelt) (nth 2 aelt))
158 default-frame-alist))
159 (setq default-frame-alist
160 (cons (cons (nth 1 aelt)
161 (car x-invocation-args))
163 x-invocation-args (cdr x-invocation-args))))))
165 ;; Make -iconic apply only to the initial frame!
166 (defun x-handle-iconic (switch)
167 (setq initial-frame-alist
168 (cons '(visibility . icon) initial-frame-alist)))
170 ;; Handler for switches of the form "-switch n"
171 (defun x-handle-numeric-switch (switch)
172 (let ((aelt (assoc switch x-switch-definitions)))
174 (setq default-frame-alist
175 (cons (cons (nth 1 aelt)
176 (string-to-int (car x-invocation-args)))
179 (cdr x-invocation-args)))))
181 ;; Handle the -xrm option.
182 (defun x-handle-xrm-switch (switch)
183 (or (consp x-invocation-args)
184 (error "%s: missing argument to `%s' option" (invocation-name) switch))
185 (setq x-command-line-resources (car x-invocation-args))
186 (setq x-invocation-args (cdr x-invocation-args)))
188 ;; Handle the geometry option
189 (defun x-handle-geometry (switch)
190 (let ((geo (x-parse-geometry (car x-invocation-args))))
191 (setq initial-frame-alist
192 (append initial-frame-alist
193 (if (or (assq 'left geo) (assq 'top geo))
194 '((user-position . t)))
195 (if (or (assq 'height geo) (assq 'width geo))
198 x-invocation-args (cdr x-invocation-args))))
200 ;; Handle the -name and -rn options. Set the variable x-resource-name
201 ;; to the option's operand; if the switch was `-name', set the name of
202 ;; the initial frame, too.
203 (defun x-handle-name-rn-switch (switch)
204 (or (consp x-invocation-args)
205 (error "%s: missing argument to `%s' option" (invocation-name) switch))
206 (setq x-resource-name (car x-invocation-args)
207 x-invocation-args (cdr x-invocation-args))
208 (if (string= switch "-name")
209 (setq initial-frame-alist (cons (cons 'name x-resource-name)
210 initial-frame-alist))))
212 (defvar x-display-name nil
213 "The X display name specifying server and X frame.")
215 (defun x-handle-display (switch)
216 (setq x-display-name (car x-invocation-args)
217 x-invocation-args (cdr x-invocation-args)))
219 (defvar x-invocation-args nil)
221 (defun x-handle-args (args)
222 "Process the X-related command line options in ARGS.
223 This is done before the user's startup file is loaded. They are copied to
224 x-invocation args from which the X-related things are extracted, first
225 the switch (e.g., \"-fg\") in the following code, and possible values
226 \(e.g., \"black\") in the option handler code (e.g., x-handle-switch).
227 This returns ARGS with the arguments that have been processed removed."
229 (setq x-invocation-args args
231 (while x-invocation-args
232 (let* ((this-switch (car x-invocation-args))
233 (orig-this-switch this-switch)
234 completion argval aelt)
235 (setq x-invocation-args (cdr x-invocation-args))
236 ;; Check for long options with attached arguments
237 ;; and separate out the attached option argument into argval.
238 (if (string-match "^--[^=]*=" this-switch)
239 (setq argval (substring this-switch (match-end 0))
240 this-switch (substring this-switch 0 (1- (match-end 0)))))
241 (setq completion (try-completion this-switch x-long-option-alist))
242 (if (eq completion t)
243 ;; Exact match for long option.
244 (setq this-switch (cdr (assoc this-switch x-long-option-alist)))
245 (if (stringp completion)
246 (let ((elt (assoc completion x-long-option-alist)))
247 ;; Check for abbreviated long option.
249 (error "Option `%s' is ambiguous" this-switch))
250 (setq this-switch (cdr elt)))
251 ;; Check for a short option.
252 (setq argval nil this-switch orig-this-switch)))
253 (setq aelt (assoc this-switch x-option-alist))
256 (let ((x-invocation-args
257 (cons argval x-invocation-args)))
258 (funcall (cdr aelt) this-switch))
259 (funcall (cdr aelt) this-switch))
260 (setq args (cons this-switch args)))))
261 (setq args (nreverse args)))
266 ;; Standard X cursor shapes, courtesy of Mr. Fox, who wanted ALL of them.
269 (defconst x-pointer-X-cursor 0)
270 (defconst x-pointer-arrow 2)
271 (defconst x-pointer-based-arrow-down 4)
272 (defconst x-pointer-based-arrow-up 6)
273 (defconst x-pointer-boat 8)
274 (defconst x-pointer-bogosity 10)
275 (defconst x-pointer-bottom-left-corner 12)
276 (defconst x-pointer-bottom-right-corner 14)
277 (defconst x-pointer-bottom-side 16)
278 (defconst x-pointer-bottom-tee 18)
279 (defconst x-pointer-box-spiral 20)
280 (defconst x-pointer-center-ptr 22)
281 (defconst x-pointer-circle 24)
282 (defconst x-pointer-clock 26)
283 (defconst x-pointer-coffee-mug 28)
284 (defconst x-pointer-cross 30)
285 (defconst x-pointer-cross-reverse 32)
286 (defconst x-pointer-crosshair 34)
287 (defconst x-pointer-diamond-cross 36)
288 (defconst x-pointer-dot 38)
289 (defconst x-pointer-dotbox 40)
290 (defconst x-pointer-double-arrow 42)
291 (defconst x-pointer-draft-large 44)
292 (defconst x-pointer-draft-small 46)
293 (defconst x-pointer-draped-box 48)
294 (defconst x-pointer-exchange 50)
295 (defconst x-pointer-fleur 52)
296 (defconst x-pointer-gobbler 54)
297 (defconst x-pointer-gumby 56)
298 (defconst x-pointer-hand1 58)
299 (defconst x-pointer-hand2 60)
300 (defconst x-pointer-heart 62)
301 (defconst x-pointer-icon 64)
302 (defconst x-pointer-iron-cross 66)
303 (defconst x-pointer-left-ptr 68)
304 (defconst x-pointer-left-side 70)
305 (defconst x-pointer-left-tee 72)
306 (defconst x-pointer-leftbutton 74)
307 (defconst x-pointer-ll-angle 76)
308 (defconst x-pointer-lr-angle 78)
309 (defconst x-pointer-man 80)
310 (defconst x-pointer-middlebutton 82)
311 (defconst x-pointer-mouse 84)
312 (defconst x-pointer-pencil 86)
313 (defconst x-pointer-pirate 88)
314 (defconst x-pointer-plus 90)
315 (defconst x-pointer-question-arrow 92)
316 (defconst x-pointer-right-ptr 94)
317 (defconst x-pointer-right-side 96)
318 (defconst x-pointer-right-tee 98)
319 (defconst x-pointer-rightbutton 100)
320 (defconst x-pointer-rtl-logo 102)
321 (defconst x-pointer-sailboat 104)
322 (defconst x-pointer-sb-down-arrow 106)
323 (defconst x-pointer-sb-h-double-arrow 108)
324 (defconst x-pointer-sb-left-arrow 110)
325 (defconst x-pointer-sb-right-arrow 112)
326 (defconst x-pointer-sb-up-arrow 114)
327 (defconst x-pointer-sb-v-double-arrow 116)
328 (defconst x-pointer-shuttle 118)
329 (defconst x-pointer-sizing 120)
330 (defconst x-pointer-spider 122)
331 (defconst x-pointer-spraycan 124)
332 (defconst x-pointer-star 126)
333 (defconst x-pointer-target 128)
334 (defconst x-pointer-tcross 130)
335 (defconst x-pointer-top-left-arrow 132)
336 (defconst x-pointer-top-left-corner 134)
337 (defconst x-pointer-top-right-corner 136)
338 (defconst x-pointer-top-side 138)
339 (defconst x-pointer-top-tee 140)
340 (defconst x-pointer-trek 142)
341 (defconst x-pointer-ul-angle 144)
342 (defconst x-pointer-umbrella 146)
343 (defconst x-pointer-ur-angle 148)
344 (defconst x-pointer-watch 150)
345 (defconst x-pointer-xterm 152)
351 (defvar x-colors '("aquamarine"
409 "medium forest green"
413 "medium spring green"
493 "The full list of X colors from the rgb.text file.")
495 (defun x-defined-colors ()
496 "Return a list of colors supported by the current X-Display."
497 (let ((all-colors x-colors)
499 (defined-colors nil))
501 (setq this-color (car all-colors)
502 all-colors (cdr all-colors))
503 (and (x-color-defined-p this-color)
504 (setq defined-colors (cons this-color defined-colors))))
509 (defun iconify-or-deiconify-frame ()
510 "Iconify the selected frame, or deiconify if it's currently an icon."
512 (if (eq (cdr (assq 'visibility (frame-parameters))) t)
514 (make-frame-visible)))
516 (substitute-key-definition 'suspend-emacs 'iconify-or-deiconify-frame
519 ;; Map certain keypad keys into ASCII characters
520 ;; that people usually expect.
521 (define-key function-key-map [backspace] [127])
522 (define-key function-key-map [delete] [127])
523 (define-key function-key-map [tab] [?\t])
524 (define-key function-key-map [linefeed] [?\n])
525 (define-key function-key-map [clear] [11])
526 (define-key function-key-map [return] [13])
527 (define-key function-key-map [escape] [?\e])
528 (define-key function-key-map [M-backspace] [?\M-\d])
529 (define-key function-key-map [M-delete] [?\M-\d])
530 (define-key function-key-map [M-tab] [?\M-\t])
531 (define-key function-key-map [M-linefeed] [?\M-\n])
532 (define-key function-key-map [M-clear] [?\M-\013])
533 (define-key function-key-map [M-return] [?\M-\015])
534 (define-key function-key-map [M-escape] [?\M-\e])
536 ;; These tell read-char how to convert
537 ;; these special chars to ASCII.
538 (put 'backspace 'ascii-character 127)
539 (put 'delete 'ascii-character 127)
540 (put 'tab 'ascii-character ?\t)
541 (put 'linefeed 'ascii-character ?\n)
542 (put 'clear 'ascii-character 12)
543 (put 'return 'ascii-character 13)
544 (put 'escape 'ascii-character ?\e)
546 ;; Set up to recognize vendor-specific keysyms.
547 ;; Unless/until there is a real conflict,
548 ;; we need not try to make this list depend on
549 ;; the type of X server in use.
550 (setq system-key-alist
552 ;; These are some HP keys.
555 ( 170 . mute-asciicircum)
556 ( 171 . mute-diaeresis)
557 ( 172 . mute-asciitilde)
572 ;; This is used by DEC's X server.
574 ;; These are for Sun.
575 (392963 . mute-acute)
576 (392960 . mute-grave)
577 (392964 . mute-diaeresis)
578 (392961 . mute-asciicircum)
582 ;; These are for Sun under X11R6
591 ;;;; Selections and cut buffers
593 ;;; We keep track of the last text selected here, so we can check the
594 ;;; current selection against it, and avoid passing back our own text
595 ;;; from x-cut-buffer-or-selection-value.
596 (defvar x-last-selected-text nil)
598 ;;; It is said that overlarge strings are slow to put into the cut buffer.
599 ;;; Note this value is overridden below.
600 (defvar x-cut-buffer-max 20000
601 "Max number of characters to put in the cut buffer.")
603 (defvar x-select-enable-clipboard nil
604 "Non-nil means cutting and pasting uses the clipboard.
605 This is in addition to the primary selection.")
607 ;;; Make TEXT, a string, the primary X selection.
608 ;;; Also, set the value of X cut buffer 0, for backward compatibility
609 ;;; with older X applications.
610 ;;; gildea@lcs.mit.edu says it's not desirable to put kills
611 ;;; in the clipboard.
612 (defun x-select-text (text &optional push)
613 ;; Don't send the cut buffer too much text.
614 ;; It becomes slow, and if really big it causes errors.
615 (if (< (length text) x-cut-buffer-max)
616 (x-set-cut-buffer text push)
617 (x-set-cut-buffer "" push))
618 (x-set-selection 'PRIMARY text)
619 (if x-select-enable-clipboard
620 (x-set-selection 'CLIPBOARD text))
621 (setq x-last-selected-text text))
623 ;;; Return the value of the current X selection.
624 ;;; Consult the selection, then the cut buffer. Treat empty strings
625 ;;; as if they were unset.
626 (defun x-cut-buffer-or-selection-value ()
629 ;; Don't die if x-get-selection signals an error.
631 (setq text (x-get-selection 'PRIMARY))
632 (error (message "%s" c)))
633 (if (string= text "") (setq text nil))
635 (if x-select-enable-clipboard
637 (setq text (x-get-selection 'CLIPBOARD))
638 (error (message "%s" c))))
639 (if (string= text "") (setq text nil))
640 (or text (setq text (x-get-cut-buffer 0)))
641 (if (string= text "") (setq text nil))
645 ((eq text x-last-selected-text) nil)
646 ((string= text x-last-selected-text)
647 ;; Record the newer string, so subsequent calls can use the `eq' test.
648 (setq x-last-selected-text text)
651 (setq x-last-selected-text text)))))
654 ;;; Do the actual X Windows setup here; the above code just defines
655 ;;; functions and variables that we use now.
657 (setq command-line-args (x-handle-args command-line-args))
659 ;;; Make sure we have a valid resource name.
660 (or (stringp x-resource-name)
662 (setq x-resource-name (invocation-name))
664 ;; Change any . or * characters in x-resource-name to hyphens,
665 ;; so as not to choke when we use it in X resource queries.
666 (while (setq i (string-match "[.*]" x-resource-name))
667 (aset x-resource-name i ?-))))
669 ;; For the benefit of older Emacses (19.27 and earlier) that are sharing
670 ;; the same lisp directory, don't pass the third argument unless we seem
671 ;; to have the multi-display support.
672 (if (fboundp 'x-close-connection)
673 (x-open-connection (or x-display-name
674 (setq x-display-name (getenv "DISPLAY")))
675 x-command-line-resources
676 ;; Exit Emacs with fatal error if this fails.
678 (x-open-connection (or x-display-name
679 (setq x-display-name (getenv "DISPLAY")))
680 x-command-line-resources))
682 (setq frame-creation-function 'x-create-frame-with-faces)
684 (setq x-cut-buffer-max (min (- (/ (x-server-max-request-size) 2) 100)
687 ;; Sun expects the menu bar cut and paste commands to use the clipboard.
688 ;; This has ,? to match both on Sunos and on Solaris.
689 (if (string-match " Sun Microsystems,? Inc\\."
691 (menu-bar-enable-clipboard))
693 ;; Apply a geometry resource to the initial frame. Put it at the end
694 ;; of the alist, so that anything specified on the command line takes
696 (let* ((res-geometry (x-get-resource "geometry" "Geometry"))
700 (setq parsed (x-parse-geometry res-geometry))
701 ;; All geometry parms apply to the initial frame.
702 (setq initial-frame-alist (append initial-frame-alist parsed))
703 ;; The size parms apply to all frames.
704 (if (assq 'height parsed)
705 (setq default-frame-alist
706 (cons (cons 'height (cdr (assq 'height parsed)))
707 default-frame-alist)))
708 (if (assq 'width parsed)
709 (setq default-frame-alist
710 (cons (cons 'width (cdr (assq 'width parsed)))
711 default-frame-alist))))))
713 ;; Check the reverseVideo resource.
714 (let ((case-fold-search t))
715 (let ((rv (x-get-resource "reverseVideo" "ReverseVideo")))
717 (string-match "^\\(true\\|yes\\|on\\)$" rv))
718 (setq default-frame-alist
719 (cons '(reverse . t) default-frame-alist)))))
721 ;; Set x-selection-timeout, measured in milliseconds.
722 (let ((res-selection-timeout
723 (x-get-resource "selectionTimeout" "SelectionTimeout")))
724 (setq x-selection-timeout 20000)
725 (if res-selection-timeout
726 (setq x-selection-timeout (string-to-number res-selection-timeout))))
728 (defun x-win-suspend-error ()
729 (error "Suspending an emacs running under X makes no sense"))
730 (add-hook 'suspend-hook 'x-win-suspend-error)
732 ;;; Arrange for the kill and yank functions to set and check the clipboard.
733 (setq interprogram-cut-function 'x-select-text)
734 (setq interprogram-paste-function 'x-cut-buffer-or-selection-value)
736 ;;; Turn off window-splitting optimization; X is usually fast enough
737 ;;; that this is only annoying.
738 (setq split-window-keep-point t)
740 ;; Don't show the frame name; that's redundant with X.
741 (setq mode-line-buffer-identification '("Emacs: %12b"))
743 ;;; x-win.el ends here