lisp/w32-fns.el

   1 ;;; w32-fns.el --- Lisp routines for Windows NT
   2
   3 ;; Copyright (C) 1994, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Geoff Voelker <voelker@cs.washington.edu>
   7 ;; Keywords: internal
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26
  27 ;;; Code:
  28 (require 'w32-vars)
  29
  30 (defvar explicit-shell-file-name)
  31
  32 ;;;; Function keys
  33
  34 (defvar x-alternatives-map
  35   (let ((map (make-sparse-keymap)))
  36     ;; Map certain keypad keys into ASCII characters that people usually expect.
  37     (define-key map [backspace] [127])
  38     (define-key map [delete] [127])
  39     (define-key map [tab] [?\t])
  40     (define-key map [linefeed] [?\n])
  41     (define-key map [clear] [?\C-l])
  42     (define-key map [return] [?\C-m])
  43     (define-key map [escape] [?\e])
  44     (define-key map [M-backspace] [?\M-\d])
  45     (define-key map [M-delete] [?\M-\d])
  46     (define-key map [M-tab] [?\M-\t])
  47     (define-key map [M-linefeed] [?\M-\n])
  48     (define-key map [M-clear] [?\M-\C-l])
  49     (define-key map [M-return] [?\M-\C-m])
  50     (define-key map [M-escape] [?\M-\e])
  51     (define-key map [iso-lefttab] [backtab])
  52     (define-key map [S-iso-lefttab] [backtab])
  53     (define-key map [S-tab] [backtab])
  54     map)
  55   "Keymap of possible alternative meanings for some keys.")
  56
  57 (defun x-setup-function-keys (frame)
  58   "Set up `function-key-map' on FRAME for w32."
  59   ;; Don't do this twice on the same display, or it would break
  60   ;; normal-erase-is-backspace-mode.
  61   (unless (terminal-parameter frame 'x-setup-function-keys)
  62     ;; Map certain keypad keys into ASCII characters that people usually expect.
  63     (with-selected-frame frame
  64       (let ((map (copy-keymap x-alternatives-map)))
  65         (set-keymap-parent map (keymap-parent local-function-key-map))
  66         (set-keymap-parent local-function-key-map map)))
  67     (set-terminal-parameter frame 'x-setup-function-keys t)))
  68
  69 (declare-function set-message-beep "w32console.c")
  70 (declare-function w32-get-clipboard-data "w32select.c")
  71 (declare-function w32-get-locale-info "w32proc.c")
  72 (declare-function w32-get-valid-locale-ids "w32proc.c")
  73 (declare-function w32-set-clipboard-data "w32select.c")
  74
  75 ;; Map all versions of a filename (8.3, longname, mixed case) to the
  76 ;; same buffer.
  77 (setq find-file-visit-truename t)
  78
  79 (declare-function x-server-version "w32fns.c" (&optional display))
  80
  81 (defun w32-version ()
  82   "Return the MS-Windows version numbers.
  83 The value is a list of three integers: the major and minor version
  84 numbers, and the build number."
  85   (x-server-version))
  86
  87 (defun w32-using-nt ()
  88   "Return non-nil if running on a Windows NT descendant.
  89 That includes all Windows systems except for 9X/Me."
  90   (and (eq system-type 'windows-nt) (getenv "SystemRoot")))
  91
  92 (defun w32-shell-name ()
  93   "Return the name of the shell being used."
  94   (or (bound-and-true-p explicit-shell-file-name)
  95       (getenv "ESHELL")
  96       (getenv "SHELL")
  97       (and (w32-using-nt) "cmd.exe")
  98       "command.com"))
  99
 100 (defun w32-system-shell-p (shell-name)
 101   (and shell-name
 102        (member (downcase (file-name-nondirectory shell-name))
 103                w32-system-shells)))
 104
 105 (defun w32-shell-dos-semantics ()
 106   "Return non-nil if the interactive shell being used expects MS-DOS shell semantics."
 107   (or (w32-system-shell-p (w32-shell-name))
 108       (and (member (downcase (file-name-nondirectory (w32-shell-name)))
 109                    '("cmdproxy" "cmdproxy.exe"))
 110            (w32-system-shell-p (getenv "COMSPEC")))))
 111
 112 (defvar w32-quote-process-args)  ;; defined in w32proc.c
 113
 114 (defun w32-check-shell-configuration ()
 115   "Check the configuration of shell variables on Windows.
 116 This function is invoked after loading the init files and processing
 117 the command line arguments.  It issues a warning if the user or site
 118 has configured the shell with inappropriate settings."
 119   (interactive)
 120   (let ((prev-buffer (current-buffer))
 121         (buffer (get-buffer-create "*Shell Configuration*"))
 122         (system-shell))
 123     (set-buffer buffer)
 124     (erase-buffer)
 125     (if (w32-system-shell-p (getenv "ESHELL"))
 126         (insert (format "Warning! The ESHELL environment variable uses %s.
 127 You probably want to change it so that it uses cmdproxy.exe instead.\n\n"
 128                         (getenv "ESHELL"))))
 129     (if (w32-system-shell-p (getenv "SHELL"))
 130         (insert (format "Warning! The SHELL environment variable uses %s.
 131 You probably want to change it so that it uses cmdproxy.exe instead.\n\n"
 132                         (getenv "SHELL"))))
 133     (if (w32-system-shell-p shell-file-name)
 134         (insert (format "Warning! shell-file-name uses %s.
 135 You probably want to change it so that it uses cmdproxy.exe instead.\n\n"
 136                         shell-file-name)))
 137     (if (and (boundp 'explicit-shell-file-name)
 138              (w32-system-shell-p explicit-shell-file-name))
 139         (insert (format "Warning! explicit-shell-file-name uses %s.
 140 You probably want to change it so that it uses cmdproxy.exe instead.\n\n"
 141                         explicit-shell-file-name)))
 142     (setq system-shell (> (buffer-size) 0))
 143
 144     ;; Allow user to specify that they really do want to use one of the
 145     ;; "system" shells, despite the drawbacks, but still warn if
 146     ;; shell-command-switch doesn't match.
 147     (if w32-allow-system-shell
 148         (erase-buffer))
 149
 150     (cond (system-shell
 151            ;; System shells.
 152            (if (string-equal "-c" shell-command-switch)
 153                (insert "Warning! shell-command-switch is \"-c\".
 154 You should set this to \"/c\" when using a system shell.\n\n"))
 155            (if w32-quote-process-args
 156                (insert "Warning! w32-quote-process-args is t.
 157 You should set this to nil when using a system shell.\n\n")))
 158           ;; Non-system shells.
 159           (t
 160            (if (string-equal "/c" shell-command-switch)
 161                (insert "Warning! shell-command-switch is \"/c\".
 162 You should set this to \"-c\" when using a non-system shell.\n\n"))
 163            (if (not w32-quote-process-args)
 164                (insert "Warning! w32-quote-process-args is nil.
 165 You should set this to t when using a non-system shell.\n\n"))))
 166     (if (> (buffer-size) 0)
 167         (display-buffer buffer)
 168       (kill-buffer buffer))
 169     (set-buffer prev-buffer)))
 170
 171 (add-hook 'after-init-hook 'w32-check-shell-configuration)
 172
 173 ;;; Override setting chosen at startup.
 174 (defun set-default-process-coding-system ()
 175   ;; Most programs on Windows will accept Unix line endings on input
 176   ;; (and some programs ported from Unix require it) but most will
 177   ;; produce DOS line endings on output.
 178   (setq default-process-coding-system
 179         (if default-enable-multibyte-characters
 180             '(undecided-dos . undecided-unix)
 181           '(raw-text-dos . raw-text-unix)))
 182   ;; Make cmdproxy default to using DOS line endings for input,
 183   ;; because some Windows programs (including command.com) require it.
 184   (add-to-list 'process-coding-system-alist
 185                `("[cC][mM][dD][pP][rR][oO][xX][yY]"
 186                  . ,(if default-enable-multibyte-characters
 187                         '(undecided-dos . undecided-dos)
 188                       '(raw-text-dos . raw-text-dos))))
 189   ;; plink needs DOS input when entering the password.
 190   (add-to-list 'process-coding-system-alist
 191                `("[pP][lL][iI][nN][kK]"
 192                  . ,(if default-enable-multibyte-characters
 193                         '(undecided-dos . undecided-dos)
 194                       '(raw-text-dos . raw-text-dos)))))
 195
 196 (add-hook 'before-init-hook 'set-default-process-coding-system)
 197
 198
 199 ;;; Basic support functions for managing Emacs' locale setting
 200
 201 (defvar w32-valid-locales nil
 202   "List of locale ids known to be supported.")
 203
 204 ;;; This is the brute-force version; an efficient version is now
 205 ;;; built-in though.
 206 (if (not (fboundp 'w32-get-valid-locale-ids))
 207     (defun w32-get-valid-locale-ids ()
 208       "Return list of all valid Windows locale ids."
 209       (let ((i 65535)
 210             locales)
 211         (while (> i 0)
 212           (if (w32-get-locale-info i)
 213               (setq locales (cons i locales)))
 214           (setq i (1- i)))
 215         locales)))
 216
 217 (defun w32-list-locales ()
 218   "List the name and id of all locales supported by Windows."
 219   (interactive)
 220   (when (null w32-valid-locales)
 221     (setq w32-valid-locales (sort (w32-get-valid-locale-ids) #'<)))
 222   (switch-to-buffer-other-window (get-buffer-create "*Supported Locales*"))
 223   (erase-buffer)
 224   (insert "LCID\tAbbrev\tFull name\n\n")
 225   (insert (decode-coding-string (mapconcat
 226                                  (lambda (x)
 227                                    (format "%d\t%s\t%s"
 228                                            x
 229                                            (w32-get-locale-info x)
 230                                            (w32-get-locale-info x t)))
 231                                  w32-valid-locales "\n")
 232                                 locale-coding-system))
 233   (insert "\n")
 234   (goto-char (point-min)))
 235
 236
 237 ;;; Setup Info-default-directory-list to include the info directory
 238 ;;; near where Emacs executable was installed.  We used to set INFOPATH,
 239 ;;; but when this is set Info-default-directory-list is ignored.  We
 240 ;;; also cannot rely upon what is set in paths.el because they assume
 241 ;;; that configuration during build time is correct for runtime.
 242 (defun w32-init-info ()
 243   (let* ((instdir (file-name-directory invocation-directory))
 244          (dir1 (expand-file-name "../info/" instdir))
 245          (dir2 (expand-file-name "../../../info/" instdir)))
 246     (if (file-exists-p dir1)
 247         (setq Info-default-directory-list
 248               (append Info-default-directory-list (list dir1)))
 249       (if (file-exists-p dir2)
 250           (setq Info-default-directory-list
 251                 (append Info-default-directory-list (list dir2)))))))
 252
 253 (add-hook 'before-init-hook 'w32-init-info)
 254
 255 ;;; The variable source-directory is used to initialize Info-directory-list.
 256 ;;; However, the common case is that Emacs is being used from a binary
 257 ;;; distribution, and the value of source-directory is meaningless in that
 258 ;;; case.  Even worse, source-directory can refer to a directory on a drive
 259 ;;; on the build machine that happens to be a removable drive on the user's
 260 ;;; machine.  When this happens, Emacs tries to access the removable drive
 261 ;;; and produces the abort/retry/ignore dialog.  Since we do not use
 262 ;;; source-directory, set it to something that is a reasonable approximation
 263 ;;; on the user's machine.
 264
 265 ;(add-hook 'before-init-hook
 266 ;         '(lambda ()
 267 ;            (setq source-directory (file-name-as-directory
 268 ;                                    (expand-file-name ".." exec-directory)))))
 269
 270 (defun convert-standard-filename (filename)
 271   "Convert a standard file's name to something suitable for the current OS.
 272 This means to guarantee valid names and perhaps to canonicalize
 273 certain patterns.
 274
 275 On Windows and DOS, replace invalid characters.  On DOS, make
 276 sure to obey the 8.3 limitations.  On Windows, turn Cygwin names
 277 into native names, and also turn slashes into backslashes if the
 278 shell requires it (see `w32-shell-dos-semantics')."
 279   (save-match-data
 280     (let ((name
 281            (if (string-match "\\`/cygdrive/\\([a-zA-Z]\\)/" filename)
 282                (replace-match "\\1:/" t nil filename)
 283              (copy-sequence filename)))
 284           (start 0))
 285       ;; leave ':' if part of drive specifier
 286       (if (and (> (length name) 1)
 287                (eq (aref name 1) ?:))
 288           (setq start 2))
 289       ;; destructively replace invalid filename characters with !
 290       (while (string-match "[?*:<>|\"\000-\037]" name start)
 291         (aset name (match-beginning 0) ?!)
 292         (setq start (match-end 0)))
 293       ;; convert directory separators to Windows format
 294       ;; (but only if the shell in use requires it)
 295       (when (w32-shell-dos-semantics)
 296         (setq start 0)
 297         (while (string-match "/" name start)
 298           (aset name (match-beginning 0) ?\\)
 299           (setq start (match-end 0))))
 300       name)))
 301
 302 ;;; Fix interface to (X-specific) mouse.el
 303 (defun x-set-selection (type data)
 304   (or type (setq type 'PRIMARY))
 305   (put 'x-selections type data))
 306
 307 (defun x-get-selection (&optional type data-type)
 308   (or type (setq type 'PRIMARY))
 309   (get 'x-selections type))
 310
 311 (defun set-w32-system-coding-system (coding-system)
 312   "Set the coding system used by the Windows system to CODING-SYSTEM.
 313 This is used for things like passing font names with non-ASCII
 314 characters in them to the system.  For a list of possible values of
 315 CODING-SYSTEM, use \\[list-coding-systems].
 316
 317 This function is provided for backward compatibility, since
 318 `w32-system-coding-system' is now an alias for `locale-coding-system'."
 319   (interactive
 320    (list (let ((default locale-coding-system))
 321            (read-coding-system
 322             (format "Coding system for system calls (default %s): "
 323                     default)
 324             default))))
 325   (check-coding-system coding-system)
 326   (setq locale-coding-system coding-system))
 327
 328 ;; locale-coding-system was introduced to do the same thing as
 329 ;; w32-system-coding-system. Use that instead.
 330 (defvaralias 'w32-system-coding-system 'locale-coding-system)
 331
 332 ;;; Set to a system sound if you want a fancy bell.
 333 (set-message-beep nil)
 334
 335 ;;; The "Windows" keys on newer keyboards bring up the Start menu
 336 ;;; whether you want it or not - make Emacs ignore these keystrokes
 337 ;;; rather than beep.
 338 (global-set-key [lwindow] 'ignore)
 339 (global-set-key [rwindow] 'ignore)
 340
 341 ;; These tell read-char how to convert
 342 ;; these special chars to ASCII.
 343 (put 'tab 'ascii-character ?\t)
 344 (put 'linefeed 'ascii-character ?\n)
 345 (put 'clear 'ascii-character 12)
 346 (put 'return 'ascii-character 13)
 347 (put 'escape 'ascii-character ?\e)
 348 (put 'backspace 'ascii-character 127)
 349 (put 'delete 'ascii-character 127)
 350
 351 (defun w32-add-charset-info (xlfd-charset windows-charset codepage)
 352   "Function to add character sets to display with Windows fonts.
 353 Creates entries in `w32-charset-info-alist'.
 354 XLFD-CHARSET is a string which will appear in the XLFD font name to
 355 identify the character set.  WINDOWS-CHARSET is a symbol identifying
 356 the Windows character set this maps to.  For the list of possible
 357 values, see the documentation for `w32-charset-info-alist'.  CODEPAGE
 358 can be a numeric codepage that Windows uses to display the character
 359 set, t for Unicode output with no codepage translation or nil for 8
 360 bit output with no translation."
 361   (add-to-list 'w32-charset-info-alist
 362                (cons xlfd-charset (cons windows-charset codepage))))
 363
 364 ;; The last charset we add becomes the "preferred" charset for the return
 365 ;; value from w32-select-font etc, so list the most important charsets last.
 366 (w32-add-charset-info "iso8859-14" 'w32-charset-ansi  28604)
 367 (w32-add-charset-info "iso8859-15" 'w32-charset-ansi  28605)
 368 ;; The following two are included for pattern matching.
 369 (w32-add-charset-info "jisx0201" 'w32-charset-shiftjis 932)
 370 (w32-add-charset-info "jisx0208" 'w32-charset-shiftjis 932)
 371 (w32-add-charset-info "jisx0201-latin" 'w32-charset-shiftjis 932)
 372 (w32-add-charset-info "jisx0201-katakana" 'w32-charset-shiftjis 932)
 373 (w32-add-charset-info "ksc5601.1989" 'w32-charset-hangeul 949)
 374 (w32-add-charset-info "big5" 'w32-charset-chinesebig5 950)
 375 (w32-add-charset-info "gb2312.1980" 'w32-charset-gb2312 936)
 376 (w32-add-charset-info "ms-symbol" 'w32-charset-symbol nil)
 377 (w32-add-charset-info "ms-oem" 'w32-charset-oem 437)
 378 (w32-add-charset-info "ms-oemlatin" 'w32-charset-oem 850)
 379 (w32-add-charset-info "iso8859-2" 'w32-charset-easteurope 28592)
 380 (w32-add-charset-info "iso8859-3" 'w32-charset-turkish 28593)
 381 (w32-add-charset-info "iso8859-4" 'w32-charset-baltic 28594)
 382 (w32-add-charset-info "iso8859-6" 'w32-charset-arabic 28596)
 383 (w32-add-charset-info "iso8859-7" 'w32-charset-greek 28597)
 384 (w32-add-charset-info "iso8859-8" 'w32-charset-hebrew 1255)
 385 (w32-add-charset-info "iso8859-9" 'w32-charset-turkish 1254)
 386 (w32-add-charset-info "iso8859-13" 'w32-charset-baltic 1257)
 387 (w32-add-charset-info "koi8-r" 'w32-charset-russian 20866)
 388 (w32-add-charset-info "iso8859-5" 'w32-charset-russian 28595)
 389 (w32-add-charset-info "tis620-2533" 'w32-charset-thai 874)
 390 (w32-add-charset-info "windows-1258" 'w32-charset-vietnamese 1258)
 391 (w32-add-charset-info "ksc5601.1992" 'w32-charset-johab 1361)
 392 (w32-add-charset-info "mac-roman" 'w32-charset-mac 10000)
 393 (w32-add-charset-info "iso10646-1" 'w32-charset-default t)
 394
 395 ;;   ;; If unicode windows charset is not defined, use ansi fonts.
 396 ;;   (w32-add-charset-info "iso10646-1" 'w32-charset-ansi t))
 397
 398 ;; Prefered names
 399 (w32-add-charset-info "big5-0" 'w32-charset-chinesebig5 950)
 400 (w32-add-charset-info "gb2312.1980-0" 'w32-charset-gb2312 936)
 401 (w32-add-charset-info "jisx0208-sjis" 'w32-charset-shiftjis 932)
 402 (w32-add-charset-info "ksc5601.1987-0" 'w32-charset-hangeul 949)
 403 (w32-add-charset-info "tis620-0" 'w32-charset-thai 874)
 404 (w32-add-charset-info "iso8859-1" 'w32-charset-ansi 1252)
 405
 406 (make-obsolete-variable 'w32-enable-italics
 407                         'w32-enable-synthesized-fonts "21.1")
 408 (make-obsolete-variable 'w32-charset-to-codepage-alist
 409                         'w32-charset-info-alist "21.1")
 410
 411 \f
 412 ;;;; Selections and cut buffers
 413
 414 ;;; We keep track of the last text selected here, so we can check the
 415 ;;; current selection against it, and avoid passing back our own text
 416 ;;; from x-cut-buffer-or-selection-value.
 417 (defvar x-last-selected-text nil)
 418
 419 ;;; It is said that overlarge strings are slow to put into the cut buffer.
 420 ;;; Note this value is overridden below.
 421 (defvar x-cut-buffer-max 20000
 422   "Max number of characters to put in the cut buffer.")
 423
 424 (defun x-select-text (text &optional push)
 425   "Make TEXT the last selected text.
 426 If `x-select-enable-clipboard' is non-nil, copy the text to the system
 427 clipboard as well.  Optional PUSH is ignored on Windows."
 428   (if x-select-enable-clipboard
 429       (w32-set-clipboard-data text))
 430   (setq x-last-selected-text text))
 431
 432 (defun x-get-selection-value ()
 433   "Return the value of the current selection.
 434 Consult the selection, then the cut buffer.  Treat empty strings as if
 435 they were unset."
 436   (if x-select-enable-clipboard
 437       (let (text)
 438         ;; Don't die if x-get-selection signals an error.
 439         (condition-case c
 440             (setq text (w32-get-clipboard-data))
 441           (error (message "w32-get-clipboard-data:%s" c)))
 442         (if (string= text "") (setq text nil))
 443         (cond
 444          ((not text) nil)
 445          ((eq text x-last-selected-text) nil)
 446          ((string= text x-last-selected-text)
 447           ;; Record the newer string, so subsequent calls can use the 'eq' test.
 448           (setq x-last-selected-text text)
 449           nil)
 450          (t
 451           (setq x-last-selected-text text))))))
 452 \f
 453 (defalias 'x-cut-buffer-or-selection-value 'x-get-selection-value)
 454
 455 ;;; Arrange for the kill and yank functions to set and check the clipboard.
 456 (setq interprogram-cut-function 'x-select-text)
 457 (setq interprogram-paste-function 'x-get-selection-value)
 458
 459 \f
 460 ;;;; Support for build process
 461 (defun w32-batch-update-autoloads ()
 462   "Like `batch-update-autoloads', but takes the name of the autoloads file
 463 from the command line.
 464
 465 This is required because some Windows build environments, such as MSYS,
 466 munge command-line arguments that include file names to a horrible mess
 467 that Emacs is unable to cope with."
 468   (let ((generated-autoload-file
 469          (expand-file-name (pop command-line-args-left))))
 470     (batch-update-autoloads)))
 471
 472 (defun w32-append-code-lines (orig extra)
 473   "Append non-empty non-comment lines in the file EXTRA to the file ORIG.
 474
 475 This function saves all buffers and kills the Emacs session, without asking
 476 for any permissions.
 477
 478 This is required because the Windows build environment is not required
 479 to include Sed, which is used by leim/Makefile.in to do the job."
 480   (find-file orig)
 481   (goto-char (point-max))
 482   (insert-file-contents extra)
 483   (delete-matching-lines "^$\\|^;")
 484   (save-buffers-kill-emacs t))
 485
 486 ;; arch-tag: c49b48cc-0f4f-454f-a274-c2dc34815e14
 487 ;;; w32-fns.el ends here