1 ;;; x-win.el --- parse switches controlling interface with X window system
3 ;; Copyright (C) 1993, 1994, 2001 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
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)
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.
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., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; X-win.el: this file is loaded from ../lisp/startup.el when it recognizes
28 ;; that X windows are to be used. Command line switches are parsed and those
29 ;; pertaining to X are processed and removed from the command line. The
30 ;; X display is opened and hooks are set for popping up the initial window.
32 ;; startup.el will then examine startup files, and eventually call the hooks
33 ;; which create the first window (s).
37 ;; These are the standard X switches from the Xt Initialize.c file of
40 ;; Command line Resource Manager string
43 ;; +synchronous *synchronous
44 ;; -background *background
47 ;; -bordercolor *borderColor
48 ;; -borderwidth .borderWidth
54 ;; -foreground *foreground
55 ;; -geometry .geometry
60 ;; -reverse *reverseVideo
62 ;; -selectionTimeout .selectionTimeout
63 ;; -synchronous *synchronous
66 ;; An alist of X options and the function which handles them. See
69 (if (not (eq window-system 'x))
70 (error "%s: Loading x-win.el but not compiled for X" (invocation-name)))
78 (if (fboundp 'new-fontset)
81 (defvar x-invocation-args)
83 (defvar x-command-line-resources nil)
85 ;; Handler for switches of the form "-switch value" or "-switch".
86 (defun x-handle-switch (switch)
87 (let ((aelt (assoc switch command-line-x-option-alist)))
89 (let ((param (nth 3 aelt))
92 (setq default-frame-alist
93 (cons (cons param value)
95 (setq default-frame-alist
97 (car x-invocation-args))
99 x-invocation-args (cdr x-invocation-args)))))))
101 ;; Handler for switches of the form "-switch n"
102 (defun x-handle-numeric-switch (switch)
103 (let ((aelt (assoc switch command-line-x-option-alist)))
105 (let ((param (nth 3 aelt)))
106 (setq default-frame-alist
108 (string-to-int (car x-invocation-args)))
111 (cdr x-invocation-args))))))
113 ;; Handle options that apply to initial frame only
114 (defun x-handle-initial-switch (switch)
115 (let ((aelt (assoc switch command-line-x-option-alist)))
117 (let ((param (nth 3 aelt))
118 (value (nth 4 aelt)))
120 (setq initial-frame-alist
121 (cons (cons param value)
122 initial-frame-alist))
123 (setq initial-frame-alist
125 (car x-invocation-args))
127 x-invocation-args (cdr x-invocation-args)))))))
129 ;; Make -iconic apply only to the initial frame!
130 (defun x-handle-iconic (switch)
131 (setq initial-frame-alist
132 (cons '(visibility . icon) initial-frame-alist)))
134 ;; Handle the -xrm option.
135 (defun x-handle-xrm-switch (switch)
136 (unless (consp x-invocation-args)
137 (error "%s: missing argument to `%s' option" (invocation-name) switch))
138 (setq x-command-line-resources
139 (if (null x-command-line-resources)
140 (car x-invocation-args)
141 (concat x-command-line-resources "\n" (car x-invocation-args))))
142 (setq x-invocation-args (cdr x-invocation-args)))
144 ;; Handle the geometry option
145 (defun x-handle-geometry (switch)
146 (let* ((geo (x-parse-geometry (car x-invocation-args)))
147 (left (assq 'left geo))
148 (top (assq 'top geo))
149 (height (assq 'height geo))
150 (width (assq 'width geo)))
151 (if (or height width)
152 (setq default-frame-alist
153 (append default-frame-alist
155 (if height (list height))
156 (if width (list width)))))
158 (setq initial-frame-alist
159 (append initial-frame-alist
160 '((user-position . t))
161 (if left (list left))
162 (if top (list top)))))
163 (setq x-invocation-args (cdr x-invocation-args))))
165 ;; Handle the -name option. Set the variable x-resource-name
166 ;; to the option's operand; set the name of
167 ;; the initial frame, too.
168 (defun x-handle-name-switch (switch)
169 (or (consp x-invocation-args)
170 (error "%s: missing argument to `%s' option" (invocation-name) switch))
171 (setq x-resource-name (car x-invocation-args)
172 x-invocation-args (cdr x-invocation-args))
173 (setq initial-frame-alist (cons (cons 'name x-resource-name)
174 initial-frame-alist)))
176 (defvar x-display-name nil
177 "The X display name specifying server and X frame.")
179 (defun x-handle-display (switch)
180 (setq x-display-name (car x-invocation-args)
181 x-invocation-args (cdr x-invocation-args))
182 ;; Make subshell programs see the same DISPLAY value Emacs really uses.
183 ;; Note that this isn't completely correct, since Emacs can use
184 ;; multiple displays. However, there is no way to tell an already
185 ;; running subshell which display the user is currently typing on.
186 (setenv "DISPLAY" x-display-name))
188 (defun x-handle-args (args)
189 "Process the X-related command line options in ARGS.
190 This is done before the user's startup file is loaded. They are copied to
191 `x-invocation-args', from which the X-related things are extracted, first
192 the switch (e.g., \"-fg\") in the following code, and possible values
193 \(e.g., \"black\") in the option handler code (e.g., x-handle-switch).
194 This function returns ARGS minus the arguments that have been processed."
195 ;; We use ARGS to accumulate the args that we don't handle here, to return.
196 (setq x-invocation-args args
198 (while (and x-invocation-args
199 (not (equal (car x-invocation-args) "--")))
200 (let* ((this-switch (car x-invocation-args))
201 (orig-this-switch this-switch)
202 completion argval aelt handler)
203 (setq x-invocation-args (cdr x-invocation-args))
204 ;; Check for long options with attached arguments
205 ;; and separate out the attached option argument into argval.
206 (if (string-match "^--[^=]*=" this-switch)
207 (setq argval (substring this-switch (match-end 0))
208 this-switch (substring this-switch 0 (1- (match-end 0)))))
209 ;; Complete names of long options.
210 (if (string-match "^--" this-switch)
212 (setq completion (try-completion this-switch command-line-x-option-alist))
213 (if (eq completion t)
214 ;; Exact match for long option.
216 (if (stringp completion)
217 (let ((elt (assoc completion command-line-x-option-alist)))
218 ;; Check for abbreviated long option.
220 (error "Option `%s' is ambiguous" this-switch))
221 (setq this-switch completion))))))
222 (setq aelt (assoc this-switch command-line-x-option-alist))
223 (if aelt (setq handler (nth 2 aelt)))
226 (let ((x-invocation-args
227 (cons argval x-invocation-args)))
228 (funcall handler this-switch))
229 (funcall handler this-switch))
230 (setq args (cons orig-this-switch args)))))
231 (nconc (nreverse args) x-invocation-args))
234 ;; Standard X cursor shapes, courtesy of Mr. Fox, who wanted ALL of them.
237 (defconst x-pointer-X-cursor 0)
238 (defconst x-pointer-arrow 2)
239 (defconst x-pointer-based-arrow-down 4)
240 (defconst x-pointer-based-arrow-up 6)
241 (defconst x-pointer-boat 8)
242 (defconst x-pointer-bogosity 10)
243 (defconst x-pointer-bottom-left-corner 12)
244 (defconst x-pointer-bottom-right-corner 14)
245 (defconst x-pointer-bottom-side 16)
246 (defconst x-pointer-bottom-tee 18)
247 (defconst x-pointer-box-spiral 20)
248 (defconst x-pointer-center-ptr 22)
249 (defconst x-pointer-circle 24)
250 (defconst x-pointer-clock 26)
251 (defconst x-pointer-coffee-mug 28)
252 (defconst x-pointer-cross 30)
253 (defconst x-pointer-cross-reverse 32)
254 (defconst x-pointer-crosshair 34)
255 (defconst x-pointer-diamond-cross 36)
256 (defconst x-pointer-dot 38)
257 (defconst x-pointer-dotbox 40)
258 (defconst x-pointer-double-arrow 42)
259 (defconst x-pointer-draft-large 44)
260 (defconst x-pointer-draft-small 46)
261 (defconst x-pointer-draped-box 48)
262 (defconst x-pointer-exchange 50)
263 (defconst x-pointer-fleur 52)
264 (defconst x-pointer-gobbler 54)
265 (defconst x-pointer-gumby 56)
266 (defconst x-pointer-hand1 58)
267 (defconst x-pointer-hand2 60)
268 (defconst x-pointer-heart 62)
269 (defconst x-pointer-icon 64)
270 (defconst x-pointer-iron-cross 66)
271 (defconst x-pointer-left-ptr 68)
272 (defconst x-pointer-left-side 70)
273 (defconst x-pointer-left-tee 72)
274 (defconst x-pointer-leftbutton 74)
275 (defconst x-pointer-ll-angle 76)
276 (defconst x-pointer-lr-angle 78)
277 (defconst x-pointer-man 80)
278 (defconst x-pointer-middlebutton 82)
279 (defconst x-pointer-mouse 84)
280 (defconst x-pointer-pencil 86)
281 (defconst x-pointer-pirate 88)
282 (defconst x-pointer-plus 90)
283 (defconst x-pointer-question-arrow 92)
284 (defconst x-pointer-right-ptr 94)
285 (defconst x-pointer-right-side 96)
286 (defconst x-pointer-right-tee 98)
287 (defconst x-pointer-rightbutton 100)
288 (defconst x-pointer-rtl-logo 102)
289 (defconst x-pointer-sailboat 104)
290 (defconst x-pointer-sb-down-arrow 106)
291 (defconst x-pointer-sb-h-double-arrow 108)
292 (defconst x-pointer-sb-left-arrow 110)
293 (defconst x-pointer-sb-right-arrow 112)
294 (defconst x-pointer-sb-up-arrow 114)
295 (defconst x-pointer-sb-v-double-arrow 116)
296 (defconst x-pointer-shuttle 118)
297 (defconst x-pointer-sizing 120)
298 (defconst x-pointer-spider 122)
299 (defconst x-pointer-spraycan 124)
300 (defconst x-pointer-star 126)
301 (defconst x-pointer-target 128)
302 (defconst x-pointer-tcross 130)
303 (defconst x-pointer-top-left-arrow 132)
304 (defconst x-pointer-top-left-corner 134)
305 (defconst x-pointer-top-right-corner 136)
306 (defconst x-pointer-top-side 138)
307 (defconst x-pointer-top-tee 140)
308 (defconst x-pointer-trek 142)
309 (defconst x-pointer-ul-angle 144)
310 (defconst x-pointer-umbrella 146)
311 (defconst x-pointer-ur-angle 148)
312 (defconst x-pointer-watch 150)
313 (defconst x-pointer-xterm 152)
319 (defvar x-colors '("LightGreen"
918 "LightGoldenrodYellow"
919 "light goldenrod yellow"
936 "medium spring green"
1071 "The list of X colors from the `rgb.txt' file.
1072 XConsortium: rgb.txt,v 10.41 94/02/20 18:39:36 rws Exp")
1074 (defun xw-defined-colors (&optional frame)
1075 "Internal function called by `defined-colors', which see."
1076 (or frame (setq frame (selected-frame)))
1077 (let ((all-colors x-colors)
1079 (defined-colors nil))
1081 (setq this-color (car all-colors)
1082 all-colors (cdr all-colors))
1083 (and (color-supported-p this-color frame t)
1084 (setq defined-colors (cons this-color defined-colors))))
1089 (defun iconify-or-deiconify-frame ()
1090 "Iconify the selected frame, or deiconify if it's currently an icon."
1092 (if (eq (cdr (assq 'visibility (frame-parameters))) t)
1094 (make-frame-visible)))
1096 (substitute-key-definition 'suspend-emacs 'iconify-or-deiconify-frame
1099 ;; Map certain keypad keys into ASCII characters
1100 ;; that people usually expect.
1101 (define-key function-key-map [backspace] [127])
1102 (define-key function-key-map [delete] [127])
1103 (define-key function-key-map [tab] [?\t])
1104 (define-key function-key-map [linefeed] [?\n])
1105 (define-key function-key-map [clear] [?\C-l])
1106 (define-key function-key-map [return] [?\C-m])
1107 (define-key function-key-map [escape] [?\e])
1108 (define-key function-key-map [M-backspace] [?\M-\d])
1109 (define-key function-key-map [M-delete] [?\M-\d])
1110 (define-key function-key-map [M-tab] [?\M-\t])
1111 (define-key function-key-map [M-linefeed] [?\M-\n])
1112 (define-key function-key-map [M-clear] [?\M-\C-l])
1113 (define-key function-key-map [M-return] [?\M-\C-m])
1114 (define-key function-key-map [M-escape] [?\M-\e])
1115 (define-key function-key-map [iso-lefttab] [backtab])
1117 ;; These tell read-char how to convert
1118 ;; these special chars to ASCII.
1119 (put 'backspace 'ascii-character 127)
1120 (put 'delete 'ascii-character 127)
1121 (put 'tab 'ascii-character ?\t)
1122 (put 'linefeed 'ascii-character ?\n)
1123 (put 'clear 'ascii-character 12)
1124 (put 'return 'ascii-character 13)
1125 (put 'escape 'ascii-character ?\e)
1127 (defun vendor-specific-keysyms (vendor)
1128 "Return the appropriate value of system-key-alist for VENDOR.
1129 VENDOR is a string containing the name of the X Server's vendor,
1130 as returned by (x-server-vendor)."
1131 (cond ((string-equal vendor "Apollo Computer Inc.")
1153 ((or (string-equal vendor "Hewlett-Packard Incorporated")
1154 (string-equal vendor "Hewlett-Packard Company"))
1155 '(( 168 . mute-acute)
1157 ( 170 . mute-asciicircum)
1158 ( 171 . mute-diaeresis)
1159 ( 172 . mute-asciitilde)
1168 (65392 . insertline)
1169 (65393 . deleteline)
1170 (65394 . insertchar)
1171 (65395 . deletechar)
1173 (65397 . kp-backtab)))
1174 ((or (string-equal vendor "X11/NeWS - Sun Microsystems Inc.")
1175 (string-equal vendor "X Consortium"))
1179 ;; These are for Sun under X11R6
1187 ;; This is used by DEC's X server.
1188 '((65280 . remove)))))
1191 ;;;; Selections and cut buffers
1193 ;;; We keep track of the last text selected here, so we can check the
1194 ;;; current selection against it, and avoid passing back our own text
1195 ;;; from x-cut-buffer-or-selection-value.
1196 (defvar x-last-selected-text nil)
1198 ;;; It is said that overlarge strings are slow to put into the cut buffer.
1199 ;;; Note this value is overridden below.
1200 (defvar x-cut-buffer-max 20000
1201 "Max number of characters to put in the cut buffer.")
1203 (defcustom x-select-enable-clipboard nil
1204 "Non-nil means cutting and pasting uses the clipboard.
1205 This is in addition to, but in preference to, the primary selection."
1209 ;;; Make TEXT, a string, the primary X selection.
1210 ;;; Also, set the value of X cut buffer 0, for backward compatibility
1211 ;;; with older X applications.
1212 ;;; gildea@stop.mail-abuse.org says it's not desirable to put kills
1213 ;;; in the clipboard.
1214 (defun x-select-text (text &optional push)
1215 ;; Don't send the cut buffer too much text.
1216 ;; It becomes slow, and if really big it causes errors.
1217 (if (< (length text) x-cut-buffer-max)
1218 (x-set-cut-buffer text push)
1219 (x-set-cut-buffer "" push))
1220 (x-set-selection 'PRIMARY text)
1221 (if x-select-enable-clipboard
1222 (x-set-selection 'CLIPBOARD text))
1223 (setq x-last-selected-text text))
1225 ;;; Return the value of the current X selection.
1226 ;;; Consult the selection, then the cut buffer. Treat empty strings
1227 ;;; as if they were unset.
1228 ;;; If this function is called twice and finds the same text,
1229 ;;; it returns nil the second time. This is so that a single
1230 ;;; selection won't be added to the kill ring over and over.
1231 (defun x-cut-buffer-or-selection-value ()
1233 (when x-select-enable-clipboard
1236 (setq text (x-get-selection 'CLIPBOARD 'COMPOUND_TEXT))
1240 (setq text (x-get-selection 'CLIPBOARD 'STRING))
1242 (if (string= text "") (setq text nil)))
1244 ;; Don't die if x-get-selection signals an error.
1247 (setq text (x-get-selection 'PRIMARY 'COMPOUND_TEXT))
1251 (setq text (x-get-selection 'PRIMARY 'STRING))
1253 (if (string= text "") (setq text nil))
1255 (or text (setq text (x-get-cut-buffer 0)))
1256 (if (string= text "") (setq text nil))
1260 ((eq text x-last-selected-text) nil)
1261 ((string= text x-last-selected-text)
1262 ;; Record the newer string, so subsequent calls can use the `eq' test.
1263 (setq x-last-selected-text text)
1266 (setq x-last-selected-text text)))))
1269 ;;; Do the actual X Windows setup here; the above code just defines
1270 ;;; functions and variables that we use now.
1272 (setq command-line-args (x-handle-args command-line-args))
1274 ;;; Make sure we have a valid resource name.
1275 (or (stringp x-resource-name)
1277 (setq x-resource-name (invocation-name))
1279 ;; Change any . or * characters in x-resource-name to hyphens,
1280 ;; so as not to choke when we use it in X resource queries.
1281 (while (setq i (string-match "[.*]" x-resource-name))
1282 (aset x-resource-name i ?-))))
1284 ;; For the benefit of older Emacses (19.27 and earlier) that are sharing
1285 ;; the same lisp directory, don't pass the third argument unless we seem
1286 ;; to have the multi-display support.
1287 (if (fboundp 'x-close-connection)
1288 (x-open-connection (or x-display-name
1289 (setq x-display-name (getenv "DISPLAY")))
1290 x-command-line-resources
1291 ;; Exit Emacs with fatal error if this fails.
1293 (x-open-connection (or x-display-name
1294 (setq x-display-name (getenv "DISPLAY")))
1295 x-command-line-resources))
1297 (setq frame-creation-function 'x-create-frame-with-faces)
1299 (setq x-cut-buffer-max (min (- (/ (x-server-max-request-size) 2) 100)
1302 (if (fboundp 'new-fontset)
1304 ;; Create the standard fontset.
1305 (create-fontset-from-fontset-spec standard-fontset-spec t)
1307 ;; Create fontset specified in X resources "Fontset-N" (N is 0, 1, ...).
1308 (create-fontset-from-x-resource)
1310 ;; Try to create a fontset from a font specification which comes
1311 ;; from initial-frame-alist, default-frame-alist, or X resource.
1312 ;; A font specification in command line argument (i.e. -fn XXXX)
1313 ;; should be already in default-frame-alist as a `font'
1314 ;; parameter. However, any font specifications in site-start
1315 ;; library, user's init file (.emacs), and default.el are not
1316 ;; yet handled here.
1318 (let ((font (or (cdr (assq 'font initial-frame-alist))
1319 (cdr (assq 'font default-frame-alist))
1320 (x-get-resource "font" "Font")))
1321 xlfd-fields resolved-name)
1323 (not (query-fontset font))
1324 (setq resolved-name (x-resolve-font-name font))
1325 (setq xlfd-fields (x-decompose-font-name font)))
1326 (if (string= "fontset"
1327 (aref xlfd-fields xlfd-regexp-registry-subnum))
1328 (new-fontset font (x-complement-fontset-spec xlfd-fields nil))
1329 ;; Create a fontset from FONT. The fontset name is
1330 ;; generated from FONT.
1331 (create-fontset-from-ascii-font font
1332 resolved-name "startup"))))))
1334 ;; Sun expects the menu bar cut and paste commands to use the clipboard.
1335 ;; This has ,? to match both on Sunos and on Solaris.
1336 (if (string-match "Sun Microsystems,? Inc\\."
1338 (menu-bar-enable-clipboard))
1340 ;; Apply a geometry resource to the initial frame. Put it at the end
1341 ;; of the alist, so that anything specified on the command line takes
1343 (let* ((res-geometry (x-get-resource "geometry" "Geometry"))
1347 (setq parsed (x-parse-geometry res-geometry))
1348 ;; If the resource specifies a position,
1349 ;; call the position and size "user-specified".
1350 (if (or (assq 'top parsed) (assq 'left parsed))
1351 (setq parsed (cons '(user-position . t)
1352 (cons '(user-size . t) parsed))))
1353 ;; All geometry parms apply to the initial frame.
1354 (setq initial-frame-alist (append initial-frame-alist parsed))
1355 ;; The size parms apply to all frames.
1356 (if (assq 'height parsed)
1357 (setq default-frame-alist
1358 (cons (cons 'height (cdr (assq 'height parsed)))
1359 default-frame-alist)))
1360 (if (assq 'width parsed)
1361 (setq default-frame-alist
1362 (cons (cons 'width (cdr (assq 'width parsed)))
1363 default-frame-alist))))))
1365 ;; Check the reverseVideo resource.
1366 (let ((case-fold-search t))
1367 (let ((rv (x-get-resource "reverseVideo" "ReverseVideo")))
1369 (string-match "^\\(true\\|yes\\|on\\)$" rv))
1370 (setq default-frame-alist
1371 (cons '(reverse . t) default-frame-alist)))))
1373 ;; Set x-selection-timeout, measured in milliseconds.
1374 (let ((res-selection-timeout
1375 (x-get-resource "selectionTimeout" "SelectionTimeout")))
1376 (setq x-selection-timeout 20000)
1377 (if res-selection-timeout
1378 (setq x-selection-timeout (string-to-number res-selection-timeout))))
1380 (defun x-win-suspend-error ()
1381 (error "Suspending an emacs running under X makes no sense"))
1382 (add-hook 'suspend-hook 'x-win-suspend-error)
1384 ;;; Arrange for the kill and yank functions to set and check the clipboard.
1385 (setq interprogram-cut-function 'x-select-text)
1386 (setq interprogram-paste-function 'x-cut-buffer-or-selection-value)
1388 ;;; Turn off window-splitting optimization; X is usually fast enough
1389 ;;; that this is only annoying.
1390 (setq split-window-keep-point t)
1392 ;; Don't show the frame name; that's redundant with X.
1393 (setq-default mode-line-frame-identification " ")
1395 ;;; Motif direct handling of f10 wasn't working right,
1396 ;;; So temporarily we've turned it off in lwlib-Xm.c
1397 ;;; and turned the Emacs f10 back on.
1398 ;;; ;; Motif normally handles f10 itself, so don't try to handle it a second time.
1399 ;;; (if (featurep 'motif)
1400 ;;; (global-set-key [f10] 'ignore))
1402 ;;; x-win.el ends here