code.delx.au - gnu-emacs/blob - lisp/term/x-win.el

   1 ;;; x-win.el --- parse switches controlling interface with X window system
   2 ;; Copyright (C) 1993 Free Software Foundation, Inc.
   3
   4 ;; Author: FSF
   5 ;; Keywords: terminals
   6
   7 ;;; This file is part of GNU Emacs.
   8 ;;;
   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.
  13 ;;;
  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.
  18 ;;;
  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.
  22
  23 ;;; Commentary:
  24
  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.
  29
  30 ;; startup.el will then examine startup files, and eventually call the hooks
  31 ;; which create the first window (s).
  32
  33 ;;; Code:
  34 \f
  35 ;; These are the standard X switches from the Xt Initialize.c file of
  36 ;; Release 4.
  37
  38 ;; Command line         Resource Manager string
  39
  40 ;; +rv                  *reverseVideo
  41 ;; +synchronous         *synchronous
  42 ;; -background          *background
  43 ;; -bd                  *borderColor
  44 ;; -bg                  *background
  45 ;; -bordercolor         *borderColor
  46 ;; -borderwidth         .borderWidth
  47 ;; -bw                  .borderWidth
  48 ;; -display             .display
  49 ;; -fg                  *foreground
  50 ;; -fn                  *font
  51 ;; -font                *font
  52 ;; -foreground          *foreground
  53 ;; -geometry            .geometry
  54 ;; -i                   .iconType
  55 ;; -itype               .iconType
  56 ;; -iconic              .iconic
  57 ;; -name                .name
  58 ;; -reverse             *reverseVideo
  59 ;; -rv                  *reverseVideo
  60 ;; -selectionTimeout    .selectionTimeout
  61 ;; -synchronous         *synchronous
  62 ;; -xrm
  63
  64 ;; An alist of X options and the function which handles them.  See
  65 ;; ../startup.el.
  66
  67 (if (not (eq window-system 'x))
  68     (error "%s: Loading x-win.el but not compiled for X" (invocation-name)))
  69
  70 (require 'frame)
  71 (require 'mouse)
  72 (require 'scroll-bar)
  73 (require 'faces)
  74 (require 'select)
  75 (require 'menu-bar)
  76
  77 (defvar x-invocation-args)
  78
  79 (defvar x-command-line-resources nil)
  80
  81 (setq command-switch-alist
  82       (append '(("-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))
 109               command-switch-alist))
 110
 111 (defconst x-switch-definitions
 112   '(("-name" name)
 113     ("-T" name)
 114     ("-r" reverse t)
 115     ("-rv" reverse t)
 116     ("-reverse" reverse t)
 117     ("-fn" font)
 118     ("-font" font)
 119     ("-ib" internal-border-width)
 120     ("-fg" foreground-color)
 121     ("-foreground" foreground-color)
 122     ("-bg" background-color)
 123     ("-background" background-color)
 124     ("-ms" mouse-color)
 125     ("-cr" cursor-color)
 126     ("-itype" icon-type t)
 127     ("-i" icon-type t)
 128     ("-vb" vertical-scroll-bars t)
 129     ("-hb" horizontal-scroll-bars t)
 130     ("-bd" border-color)
 131     ("-bw" border-width)))
 132
 133 ;; Handler for switches of the form "-switch value" or "-switch".
 134 (defun x-handle-switch (switch)
 135   (let ((aelt (assoc switch x-switch-definitions)))
 136     (if aelt
 137         (if (nth 2 aelt)
 138             (setq default-frame-alist
 139                   (cons (cons (nth 1 aelt) (nth 2 aelt))
 140                         default-frame-alist))
 141           (setq default-frame-alist
 142                 (cons (cons (nth 1 aelt)
 143                             (car x-invocation-args))
 144                       default-frame-alist)
 145                 x-invocation-args (cdr x-invocation-args))))))
 146
 147 ;; Make -iconic apply only to the initial frame!
 148 (defun x-handle-iconic (switch)
 149   (setq initial-frame-alist
 150         (cons '(visibility . icon) initial-frame-alist)))
 151
 152 ;; Handler for switches of the form "-switch n"
 153 (defun x-handle-numeric-switch (switch)
 154   (let ((aelt (assoc switch x-switch-definitions)))
 155     (if aelt
 156         (setq default-frame-alist
 157               (cons (cons (nth 1 aelt)
 158                           (string-to-int (car x-invocation-args)))
 159                     default-frame-alist)
 160               x-invocation-args
 161               (cdr x-invocation-args)))))
 162
 163 ;; Handle the -xrm option.
 164 (defun x-handle-xrm-switch (switch)
 165   (or (consp x-invocation-args)
 166       (error "%s: missing argument to `%s' option" (invocation-name) switch))
 167   (setq x-command-line-resources (car x-invocation-args))
 168   (setq x-invocation-args (cdr x-invocation-args)))
 169
 170 ;; Handle the geometry option
 171 (defun x-handle-geometry (switch)
 172   (setq initial-frame-alist
 173         (append initial-frame-alist
 174                 (x-parse-geometry (car x-invocation-args)))
 175         x-invocation-args (cdr x-invocation-args)))
 176
 177 ;; Handle the -name and -rn options.  Set the variable x-resource-name
 178 ;; to the option's operand; if the switch was `-name', set the name of
 179 ;; the initial frame, too.
 180 (defun x-handle-name-rn-switch (switch)
 181   (or (consp x-invocation-args)
 182       (error "%s: missing argument to `%s' option" (invocation-name) switch))
 183   (setq x-resource-name (car x-invocation-args)
 184         x-invocation-args (cdr x-invocation-args))
 185   (if (string= switch "-name")
 186       (setq initial-frame-alist (cons (cons 'name x-resource-name)
 187                                       initial-frame-alist))))
 188
 189 (defvar x-display-name nil
 190   "The X display name specifying server and X frame.")
 191
 192 (defun x-handle-display (switch)
 193   (setq x-display-name (car x-invocation-args)
 194         x-invocation-args (cdr x-invocation-args)))
 195
 196 (defvar x-invocation-args nil)
 197
 198 (defun x-handle-args (args)
 199   "Here the X-related command line options in ARGS are processed,
 200 before the user's startup file is loaded.  They are copied to
 201 x-invocation args from which the X-related things are extracted, first
 202 the switch (e.g., \"-fg\") in the following code, and possible values
 203 (e.g., \"black\") in the option handler code (e.g., x-handle-switch).
 204 This returns ARGS with the arguments that have been processed removed."
 205   (setq x-invocation-args args
 206         args nil)
 207   (while x-invocation-args
 208     (let* ((this-switch (car x-invocation-args))
 209            (aelt (assoc this-switch command-switch-alist)))
 210       (setq x-invocation-args (cdr x-invocation-args))
 211       (if aelt
 212           (funcall (cdr aelt) this-switch)
 213         (setq args (cons this-switch args)))))
 214   (setq args (nreverse args)))
 215
 216
 217 \f
 218 ;;
 219 ;; Standard X cursor shapes, courtesy of Mr. Fox, who wanted ALL of them.
 220 ;;
 221
 222 (defconst x-pointer-X-cursor 0)
 223 (defconst x-pointer-arrow 2)
 224 (defconst x-pointer-based-arrow-down 4)
 225 (defconst x-pointer-based-arrow-up 6)
 226 (defconst x-pointer-boat 8)
 227 (defconst x-pointer-bogosity 10)
 228 (defconst x-pointer-bottom-left-corner 12)
 229 (defconst x-pointer-bottom-right-corner 14)
 230 (defconst x-pointer-bottom-side 16)
 231 (defconst x-pointer-bottom-tee 18)
 232 (defconst x-pointer-box-spiral 20)
 233 (defconst x-pointer-center-ptr 22)
 234 (defconst x-pointer-circle 24)
 235 (defconst x-pointer-clock 26)
 236 (defconst x-pointer-coffee-mug 28)
 237 (defconst x-pointer-cross 30)
 238 (defconst x-pointer-cross-reverse 32)
 239 (defconst x-pointer-crosshair 34)
 240 (defconst x-pointer-diamond-cross 36)
 241 (defconst x-pointer-dot 38)
 242 (defconst x-pointer-dotbox 40)
 243 (defconst x-pointer-double-arrow 42)
 244 (defconst x-pointer-draft-large 44)
 245 (defconst x-pointer-draft-small 46)
 246 (defconst x-pointer-draped-box 48)
 247 (defconst x-pointer-exchange 50)
 248 (defconst x-pointer-fleur 52)
 249 (defconst x-pointer-gobbler 54)
 250 (defconst x-pointer-gumby 56)
 251 (defconst x-pointer-hand1 58)
 252 (defconst x-pointer-hand2 60)
 253 (defconst x-pointer-heart 62)
 254 (defconst x-pointer-icon 64)
 255 (defconst x-pointer-iron-cross 66)
 256 (defconst x-pointer-left-ptr 68)
 257 (defconst x-pointer-left-side 70)
 258 (defconst x-pointer-left-tee 72)
 259 (defconst x-pointer-leftbutton 74)
 260 (defconst x-pointer-ll-angle 76)
 261 (defconst x-pointer-lr-angle 78)
 262 (defconst x-pointer-man 80)
 263 (defconst x-pointer-middlebutton 82)
 264 (defconst x-pointer-mouse 84)
 265 (defconst x-pointer-pencil 86)
 266 (defconst x-pointer-pirate 88)
 267 (defconst x-pointer-plus 90)
 268 (defconst x-pointer-question-arrow 92)
 269 (defconst x-pointer-right-ptr 94)
 270 (defconst x-pointer-right-side 96)
 271 (defconst x-pointer-right-tee 98)
 272 (defconst x-pointer-rightbutton 100)
 273 (defconst x-pointer-rtl-logo 102)
 274 (defconst x-pointer-sailboat 104)
 275 (defconst x-pointer-sb-down-arrow 106)
 276 (defconst x-pointer-sb-h-double-arrow 108)
 277 (defconst x-pointer-sb-left-arrow 110)
 278 (defconst x-pointer-sb-right-arrow 112)
 279 (defconst x-pointer-sb-up-arrow 114)
 280 (defconst x-pointer-sb-v-double-arrow 116)
 281 (defconst x-pointer-shuttle 118)
 282 (defconst x-pointer-sizing 120)
 283 (defconst x-pointer-spider 122)
 284 (defconst x-pointer-spraycan 124)
 285 (defconst x-pointer-star 126)
 286 (defconst x-pointer-target 128)
 287 (defconst x-pointer-tcross 130)
 288 (defconst x-pointer-top-left-arrow 132)
 289 (defconst x-pointer-top-left-corner 134)
 290 (defconst x-pointer-top-right-corner 136)
 291 (defconst x-pointer-top-side 138)
 292 (defconst x-pointer-top-tee 140)
 293 (defconst x-pointer-trek 142)
 294 (defconst x-pointer-ul-angle 144)
 295 (defconst x-pointer-umbrella 146)
 296 (defconst x-pointer-ur-angle 148)
 297 (defconst x-pointer-watch 150)
 298 (defconst x-pointer-xterm 152)
 299 \f
 300 ;;
 301 ;; Available colors
 302 ;;
 303
 304 (defvar x-colors '("aquamarine"
 305                    "Aquamarine"
 306                    "medium aquamarine"
 307                    "MediumAquamarine"
 308                    "black"
 309                    "Black"
 310                    "blue"
 311                    "Blue"
 312                    "cadet blue"
 313                    "CadetBlue"
 314                    "cornflower blue"
 315                    "CornflowerBlue"
 316                    "dark slate blue"
 317                    "DarkSlateBlue"
 318                    "light blue"
 319                    "LightBlue"
 320                    "light steel blue"
 321                    "LightSteelBlue"
 322                    "medium blue"
 323                    "MediumBlue"
 324                    "medium slate blue"
 325                    "MediumSlateBlue"
 326                    "midnight blue"
 327                    "MidnightBlue"
 328                    "navy blue"
 329                    "NavyBlue"
 330                    "navy"
 331                    "Navy"
 332                    "sky blue"
 333                    "SkyBlue"
 334                    "slate blue"
 335                    "SlateBlue"
 336                    "steel blue"
 337                    "SteelBlue"
 338                    "coral"
 339                    "Coral"
 340                    "cyan"
 341                    "Cyan"
 342                    "firebrick"
 343                    "Firebrick"
 344                    "brown"
 345                    "Brown"
 346                    "gold"
 347                    "Gold"
 348                    "goldenrod"
 349                    "Goldenrod"
 350                    "medium goldenrod"
 351                    "MediumGoldenrod"
 352                    "green"
 353                    "Green"
 354                    "dark green"
 355                    "DarkGreen"
 356                    "dark olive green"
 357                    "DarkOliveGreen"
 358                    "forest green"
 359                    "ForestGreen"
 360                    "lime green"
 361                    "LimeGreen"
 362                    "medium forest green"
 363                    "MediumForestGreen"
 364                    "medium sea green"
 365                    "MediumSeaGreen"
 366                    "medium spring green"
 367                    "MediumSpringGreen"
 368                    "pale green"
 369                    "PaleGreen"
 370                    "sea green"
 371                    "SeaGreen"
 372                    "spring green"
 373                    "SpringGreen"
 374                    "yellow green"
 375                    "YellowGreen"
 376                    "dark slate grey"
 377                    "DarkSlateGrey"
 378                    "dark slate gray"
 379                    "DarkSlateGray"
 380                    "dim grey"
 381                    "DimGrey"
 382                    "dim gray"
 383                    "DimGray"
 384                    "light grey"
 385                    "LightGrey"
 386                    "light gray"
 387                    "LightGray"
 388                    "gray"
 389                    "grey"
 390                    "Gray"
 391                    "Grey"
 392                    "khaki"
 393                    "Khaki"
 394                    "magenta"
 395                    "Magenta"
 396                    "maroon"
 397                    "Maroon"
 398                    "orange"
 399                    "Orange"
 400                    "orchid"
 401                    "Orchid"
 402                    "dark orchid"
 403                    "DarkOrchid"
 404                    "medium orchid"
 405                    "MediumOrchid"
 406                    "pink"
 407                    "Pink"
 408                    "plum"
 409                    "Plum"
 410                    "red"
 411                    "Red"
 412                    "indian red"
 413                    "IndianRed"
 414                    "medium violet red"
 415                    "MediumVioletRed"
 416                    "orange red"
 417                    "OrangeRed"
 418                    "violet red"
 419                    "VioletRed"
 420                    "salmon"
 421                    "Salmon"
 422                    "sienna"
 423                    "Sienna"
 424                    "tan"
 425                    "Tan"
 426                    "thistle"
 427                    "Thistle"
 428                    "turquoise"
 429                    "Turquoise"
 430                    "dark turquoise"
 431                    "DarkTurquoise"
 432                    "medium turquoise"
 433                    "MediumTurquoise"
 434                    "violet"
 435                    "Violet"
 436                    "blue violet"
 437                    "BlueViolet"
 438                    "wheat"
 439                    "Wheat"
 440                    "white"
 441                    "White"
 442                    "yellow"
 443                    "Yellow"
 444                    "green yellow"
 445                    "GreenYellow")
 446   "The full list of X colors from the rgb.text file.")
 447
 448 (defun x-defined-colors ()
 449   "Return a list of colors supported by the current X-Display."
 450   (let ((all-colors x-colors)
 451         (this-color nil)
 452         (defined-colors nil))
 453     (while all-colors
 454       (setq this-color (car all-colors)
 455             all-colors (cdr all-colors))
 456       (and (x-color-defined-p this-color)
 457            (setq defined-colors (cons this-color defined-colors))))
 458     defined-colors))
 459 \f
 460 ;;;; Function keys
 461
 462 (defun iconify-or-deiconify-frame ()
 463   "Iconify the selected frame, or deiconify if it's currently an icon."
 464   (interactive)
 465   (if (eq (cdr (assq 'visibility (frame-parameters))) t)
 466       (iconify-frame)
 467     (let ((foo (selected-frame)))
 468       (make-frame-invisible foo)
 469       (make-frame-visible foo))))
 470
 471 (substitute-key-definition 'suspend-emacs 'iconify-or-deiconify-frame
 472                            global-map)
 473
 474 ;; Map certain keypad keys into ASCII characters
 475 ;; that people usually expect.
 476 (define-key function-key-map [backspace] [127])
 477 (define-key function-key-map [delete] [127])
 478 (define-key function-key-map [tab] [?\t])
 479 (define-key function-key-map [linefeed] [?\n])
 480 (define-key function-key-map [clear] [11])
 481 (define-key function-key-map [return] [13])
 482 (define-key function-key-map [escape] [?\e])
 483 (define-key function-key-map [M-backspace] [?\M-\d])
 484 (define-key function-key-map [M-delete] [?\M-\d])
 485 (define-key function-key-map [M-tab] [?\M-\t])
 486 (define-key function-key-map [M-linefeed] [?\M-\n])
 487 (define-key function-key-map [M-clear] [?\M-\013])
 488 (define-key function-key-map [M-return] [?\M-\015])
 489 (define-key function-key-map [M-escape] [?\M-\e])
 490
 491 ;; These tell read-char how to convert
 492 ;; these special chars to ASCII.
 493 (put 'backspace 'ascii-character 127)
 494 (put 'delete 'ascii-character 127)
 495 (put 'tab 'ascii-character ?\t)
 496 (put 'linefeed 'ascii-character ?\n)
 497 (put 'clear 'ascii-character 12)
 498 (put 'return 'ascii-character 13)
 499 (put 'escape 'ascii-character ?\e)
 500 \f
 501 ;;;; Selections and cut buffers
 502
 503 ;;; We keep track of the last text selected here, so we can check the
 504 ;;; current selection against it, and avoid passing back our own text
 505 ;;; from x-cut-buffer-or-selection-value.
 506 (defvar x-last-selected-text nil)
 507
 508 ;;; It is said that overlarge strings are slow to put into the cut buffer.
 509 ;;; Note this value is overridden below.
 510 (defvar x-cut-buffer-max 20000
 511   "Max number of characters to put in the cut buffer.")
 512
 513 ;;; Make TEXT, a string, the primary X selection.
 514 ;;; Also, set the value of X cut buffer 0, for backward compatibility
 515 ;;; with older X applications.
 516 ;;; gildea@lcs.mit.edu says it's not desirable to put kills
 517 ;;; in the clipboard.
 518 (defun x-select-text (text &optional push)
 519   ;; Don't send the cut buffer too much text.
 520   ;; It becomes slow, and if really big it causes errors.
 521   (if (< (length text) x-cut-buffer-max)
 522       (x-set-cut-buffer text push)
 523     (x-set-cut-buffer "" push))
 524   (x-set-selection 'PRIMARY text)
 525   (setq x-last-selected-text text))
 526
 527 ;;; Return the value of the current X selection.  For compatibility
 528 ;;; with older X applications, this checks cut buffer 0 before
 529 ;;; retrieving the value of the primary selection.
 530 (defun x-cut-buffer-or-selection-value ()
 531   (let (text)
 532
 533     ;; Consult the selection, then the cut buffer.  Treat empty strings
 534     ;; as if they were unset.
 535     (setq text (x-get-selection 'PRIMARY))
 536     (if (string= text "") (setq text nil))
 537     (or text (setq text (x-get-cut-buffer 0)))
 538     (if (string= text "") (setq text nil))
 539
 540     (cond
 541      ((not text) nil)
 542      ((eq text x-last-selected-text) nil)
 543      ((string= text x-last-selected-text)
 544       ;; Record the newer string, so subsequent calls can use the `eq' test.
 545       (setq x-last-selected-text text)
 546       nil)
 547      (t
 548       (setq x-last-selected-text text)))))
 549
 550 \f
 551 ;;; Do the actual X Windows setup here; the above code just defines
 552 ;;; functions and variables that we use now.
 553
 554 (setq command-line-args (x-handle-args command-line-args))
 555
 556 ;;; Make sure we have a valid resource name.
 557 (or (stringp x-resource-name)
 558     (let (i)
 559       (setq x-resource-name (invocation-name))
 560
 561       ;; Change any . or * characters in x-resource-name to hyphens,
 562       ;; so as not to choke when we use it in X resource queries.
 563       (while (setq i (string-match "[.*]" x-resource-name))
 564         (aset x-resource-name i ?-))))
 565
 566 (x-open-connection (or x-display-name
 567                        (setq x-display-name (getenv "DISPLAY")))
 568                    x-command-line-resources)
 569
 570 (setq frame-creation-function 'x-create-frame-with-faces)
 571
 572 (setq x-cut-buffer-max (min (- (/ (x-server-max-request-size) 2) 100)
 573                             x-cut-buffer-max))
 574
 575 ;; Apply a geometry resource to the initial frame.  Put it at the end
 576 ;; of the alist, so that anything specified on the command line takes
 577 ;; precedence.
 578 (let ((res-geometry (x-get-resource "geometry" "Geometry")))
 579   (if res-geometry
 580       (setq initial-frame-alist (append initial-frame-alist
 581                                         (x-parse-geometry res-geometry)))))
 582
 583 ;; Check the reverseVideo resource.
 584 (let ((case-fold-search t))
 585   (let ((rv (x-get-resource "reverseVideo" "ReverseVideo")))
 586     (if (and rv
 587              (string-match "^\\(true\\|yes\\|on\\)$" rv))
 588         (setq default-frame-alist
 589               (cons '(reverse . t) default-frame-alist)))))
 590
 591 ;; Set x-selection-timeout, measured in milliseconds.
 592 (let ((res-selection-timeout
 593        (x-get-resource "selectionTimeout" "SelectionTimeout")))
 594   (setq x-selection-timeout 20000)
 595   (if res-selection-timeout
 596       (setq x-selection-timeout (string-to-number res-selection-timeout))))
 597
 598 (defun x-win-suspend-error ()
 599   (error "Suspending an emacs running under X makes no sense"))
 600 (add-hook 'suspend-hook 'x-win-suspend-error)
 601
 602 ;;; Arrange for the kill and yank functions to set and check the clipboard.
 603 (setq interprogram-cut-function 'x-select-text)
 604 (setq interprogram-paste-function 'x-cut-buffer-or-selection-value)
 605
 606 ;;; Turn off window-splitting optimization; X is usually fast enough
 607 ;;; that this is only annoying.
 608 (setq split-window-keep-point t)
 609
 610 ;;; x-win.el ends here