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, 2009 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   (with-output-to-temp-buffer "*Supported Locales*"
 223     (princ "LCID\tAbbrev\tFull name\n\n")
 224     (dolist (locale w32-valid-locales)
 225       (princ (format "%d\t%s\t%s\n"
 226                      locale
 227                      (w32-get-locale-info locale)
 228                      (w32-get-locale-info locale t))))))
 229
 230 ;;; Setup Info-default-directory-list to include the info directory
 231 ;;; near where Emacs executable was installed.  We used to set INFOPATH,
 232 ;;; but when this is set Info-default-directory-list is ignored.  We
 233 ;;; also cannot rely upon what is set in paths.el because they assume
 234 ;;; that configuration during build time is correct for runtime.
 235 (defun w32-init-info ()
 236   (let* ((instdir (file-name-directory invocation-directory))
 237          (dir1 (expand-file-name "../info/" instdir))
 238          (dir2 (expand-file-name "../../../info/" instdir)))
 239     (if (file-exists-p dir1)
 240         (setq Info-default-directory-list
 241               (append Info-default-directory-list (list dir1)))
 242       (if (file-exists-p dir2)
 243           (setq Info-default-directory-list
 244                 (append Info-default-directory-list (list dir2)))))))
 245
 246 (add-hook 'before-init-hook 'w32-init-info)
 247
 248 ;;; The variable source-directory is used to initialize Info-directory-list.
 249 ;;; However, the common case is that Emacs is being used from a binary
 250 ;;; distribution, and the value of source-directory is meaningless in that
 251 ;;; case.  Even worse, source-directory can refer to a directory on a drive
 252 ;;; on the build machine that happens to be a removable drive on the user's
 253 ;;; machine.  When this happens, Emacs tries to access the removable drive
 254 ;;; and produces the abort/retry/ignore dialog.  Since we do not use
 255 ;;; source-directory, set it to something that is a reasonable approximation
 256 ;;; on the user's machine.
 257
 258 ;(add-hook 'before-init-hook
 259 ;         '(lambda ()
 260 ;            (setq source-directory (file-name-as-directory
 261 ;                                    (expand-file-name ".." exec-directory)))))
 262
 263 (defun convert-standard-filename (filename)
 264   "Convert a standard file's name to something suitable for the current OS.
 265 This means to guarantee valid names and perhaps to canonicalize
 266 certain patterns.
 267
 268 On Windows and DOS, replace invalid characters.  On DOS, make
 269 sure to obey the 8.3 limitations.  On Windows, turn Cygwin names
 270 into native names, and also turn slashes into backslashes if the
 271 shell requires it (see `w32-shell-dos-semantics')."
 272   (save-match-data
 273     (let ((name
 274            (if (string-match "\\`/cygdrive/\\([a-zA-Z]\\)/" filename)
 275                (replace-match "\\1:/" t nil filename)
 276              (copy-sequence filename)))
 277           (start 0))
 278       ;; leave ':' if part of drive specifier
 279       (if (and (> (length name) 1)
 280                (eq (aref name 1) ?:))
 281           (setq start 2))
 282       ;; destructively replace invalid filename characters with !
 283       (while (string-match "[?*:<>|\"\000-\037]" name start)
 284         (aset name (match-beginning 0) ?!)
 285         (setq start (match-end 0)))
 286       ;; convert directory separators to Windows format
 287       ;; (but only if the shell in use requires it)
 288       (when (w32-shell-dos-semantics)
 289         (setq start 0)
 290         (while (string-match "/" name start)
 291           (aset name (match-beginning 0) ?\\)
 292           (setq start (match-end 0))))
 293       name)))
 294
 295 ;;; Fix interface to (X-specific) mouse.el
 296 (defun x-set-selection (type data)
 297   (or type (setq type 'PRIMARY))
 298   (put 'x-selections type data))
 299
 300 (defun x-get-selection (&optional type data-type)
 301   (or type (setq type 'PRIMARY))
 302   (get 'x-selections type))
 303
 304 (defun set-w32-system-coding-system (coding-system)
 305   "Set the coding system used by the Windows system to CODING-SYSTEM.
 306 This is used for things like passing font names with non-ASCII
 307 characters in them to the system.  For a list of possible values of
 308 CODING-SYSTEM, use \\[list-coding-systems].
 309
 310 This function is provided for backward compatibility, since
 311 `w32-system-coding-system' is now an alias for `locale-coding-system'."
 312   (interactive
 313    (list (let ((default locale-coding-system))
 314            (read-coding-system
 315             (format "Coding system for system calls (default %s): "
 316                     default)
 317             default))))
 318   (check-coding-system coding-system)
 319   (setq locale-coding-system coding-system))
 320
 321 ;; locale-coding-system was introduced to do the same thing as
 322 ;; w32-system-coding-system. Use that instead.
 323 (defvaralias 'w32-system-coding-system 'locale-coding-system)
 324
 325 ;;; Set to a system sound if you want a fancy bell.
 326 (set-message-beep nil)
 327
 328 ;;; The "Windows" keys on newer keyboards bring up the Start menu
 329 ;;; whether you want it or not - make Emacs ignore these keystrokes
 330 ;;; rather than beep.
 331 (global-set-key [lwindow] 'ignore)
 332 (global-set-key [rwindow] 'ignore)
 333
 334 ;; These tell read-char how to convert
 335 ;; these special chars to ASCII.
 336 (put 'tab 'ascii-character ?\t)
 337 (put 'linefeed 'ascii-character ?\n)
 338 (put 'clear 'ascii-character 12)
 339 (put 'return 'ascii-character 13)
 340 (put 'escape 'ascii-character ?\e)
 341 (put 'backspace 'ascii-character 127)
 342 (put 'delete 'ascii-character 127)
 343
 344 (defun w32-add-charset-info (xlfd-charset windows-charset codepage)
 345   "Function to add character sets to display with Windows fonts.
 346 Creates entries in `w32-charset-info-alist'.
 347 XLFD-CHARSET is a string which will appear in the XLFD font name to
 348 identify the character set.  WINDOWS-CHARSET is a symbol identifying
 349 the Windows character set this maps to.  For the list of possible
 350 values, see the documentation for `w32-charset-info-alist'.  CODEPAGE
 351 can be a numeric codepage that Windows uses to display the character
 352 set, t for Unicode output with no codepage translation or nil for 8
 353 bit output with no translation."
 354   (add-to-list 'w32-charset-info-alist
 355                (cons xlfd-charset (cons windows-charset codepage))))
 356
 357 ;; The last charset we add becomes the "preferred" charset for the return
 358 ;; value from w32-select-font etc, so list the most important charsets last.
 359 (w32-add-charset-info "iso8859-14" 'w32-charset-ansi  28604)
 360 (w32-add-charset-info "iso8859-15" 'w32-charset-ansi  28605)
 361 ;; The following two are included for pattern matching.
 362 (w32-add-charset-info "jisx0201" 'w32-charset-shiftjis 932)
 363 (w32-add-charset-info "jisx0208" 'w32-charset-shiftjis 932)
 364 (w32-add-charset-info "jisx0201-latin" 'w32-charset-shiftjis 932)
 365 (w32-add-charset-info "jisx0201-katakana" 'w32-charset-shiftjis 932)
 366 (w32-add-charset-info "ksc5601.1989" 'w32-charset-hangeul 949)
 367 (w32-add-charset-info "big5" 'w32-charset-chinesebig5 950)
 368 (w32-add-charset-info "gb2312.1980" 'w32-charset-gb2312 936)
 369 (w32-add-charset-info "ms-symbol" 'w32-charset-symbol nil)
 370 (w32-add-charset-info "ms-oem" 'w32-charset-oem 437)
 371 (w32-add-charset-info "ms-oemlatin" 'w32-charset-oem 850)
 372 (w32-add-charset-info "iso8859-2" 'w32-charset-easteurope 28592)
 373 (w32-add-charset-info "iso8859-3" 'w32-charset-turkish 28593)
 374 (w32-add-charset-info "iso8859-4" 'w32-charset-baltic 28594)
 375 (w32-add-charset-info "iso8859-6" 'w32-charset-arabic 28596)
 376 (w32-add-charset-info "iso8859-7" 'w32-charset-greek 28597)
 377 (w32-add-charset-info "iso8859-8" 'w32-charset-hebrew 1255)
 378 (w32-add-charset-info "iso8859-9" 'w32-charset-turkish 1254)
 379 (w32-add-charset-info "iso8859-13" 'w32-charset-baltic 1257)
 380 (w32-add-charset-info "koi8-r" 'w32-charset-russian 20866)
 381 (w32-add-charset-info "iso8859-5" 'w32-charset-russian 28595)
 382 (w32-add-charset-info "tis620-2533" 'w32-charset-thai 874)
 383 (w32-add-charset-info "windows-1258" 'w32-charset-vietnamese 1258)
 384 (w32-add-charset-info "ksc5601.1992" 'w32-charset-johab 1361)
 385 (w32-add-charset-info "mac-roman" 'w32-charset-mac 10000)
 386 (w32-add-charset-info "iso10646-1" 'w32-charset-default t)
 387
 388 ;;   ;; If unicode windows charset is not defined, use ansi fonts.
 389 ;;   (w32-add-charset-info "iso10646-1" 'w32-charset-ansi t))
 390
 391 ;; Prefered names
 392 (w32-add-charset-info "big5-0" 'w32-charset-chinesebig5 950)
 393 (w32-add-charset-info "gb2312.1980-0" 'w32-charset-gb2312 936)
 394 (w32-add-charset-info "jisx0208-sjis" 'w32-charset-shiftjis 932)
 395 (w32-add-charset-info "ksc5601.1987-0" 'w32-charset-hangeul 949)
 396 (w32-add-charset-info "tis620-0" 'w32-charset-thai 874)
 397 (w32-add-charset-info "iso8859-1" 'w32-charset-ansi 1252)
 398
 399 (make-obsolete-variable 'w32-enable-italics
 400                         'w32-enable-synthesized-fonts "21.1")
 401 (make-obsolete-variable 'w32-charset-to-codepage-alist
 402                         'w32-charset-info-alist "21.1")
 403
 404 \f
 405 ;;;; Selections and cut buffers
 406
 407 ;;; We keep track of the last text selected here, so we can check the
 408 ;;; current selection against it, and avoid passing back our own text
 409 ;;; from x-cut-buffer-or-selection-value.
 410 (defvar x-last-selected-text nil)
 411
 412 ;;; It is said that overlarge strings are slow to put into the cut buffer.
 413 ;;; Note this value is overridden below.
 414 (defvar x-cut-buffer-max 20000
 415   "Max number of characters to put in the cut buffer.")
 416
 417 (defun x-select-text (text &optional push)
 418   "Make TEXT the last selected text.
 419 If `x-select-enable-clipboard' is non-nil, copy the text to the system
 420 clipboard as well.  Optional PUSH is ignored on Windows."
 421   (if x-select-enable-clipboard
 422       (w32-set-clipboard-data text))
 423   (setq x-last-selected-text text))
 424
 425 (defun x-get-selection-value ()
 426   "Return the value of the current selection.
 427 Consult the selection, then the cut buffer.  Treat empty strings as if
 428 they were unset."
 429   (if x-select-enable-clipboard
 430       (let (text)
 431         ;; Don't die if x-get-selection signals an error.
 432         (condition-case c
 433             (setq text (w32-get-clipboard-data))
 434           (error (message "w32-get-clipboard-data:%s" c)))
 435         (if (string= text "") (setq text nil))
 436         (cond
 437          ((not text) nil)
 438          ((eq text x-last-selected-text) nil)
 439          ((string= text x-last-selected-text)
 440           ;; Record the newer string, so subsequent calls can use the 'eq' test.
 441           (setq x-last-selected-text text)
 442           nil)
 443          (t
 444           (setq x-last-selected-text text))))))
 445 \f
 446 (defalias 'x-cut-buffer-or-selection-value 'x-get-selection-value)
 447
 448 ;;; Arrange for the kill and yank functions to set and check the clipboard.
 449 (setq interprogram-cut-function 'x-select-text)
 450 (setq interprogram-paste-function 'x-get-selection-value)
 451
 452 \f
 453 ;;;; Support for build process
 454 (defun w32-batch-update-autoloads ()
 455   "Like `batch-update-autoloads', but takes the name of the autoloads file
 456 from the command line.
 457
 458 This is required because some Windows build environments, such as MSYS,
 459 munge command-line arguments that include file names to a horrible mess
 460 that Emacs is unable to cope with."
 461   (let ((generated-autoload-file
 462          (expand-file-name (pop command-line-args-left))))
 463     (batch-update-autoloads)))
 464
 465 (defun w32-append-code-lines (orig extra)
 466   "Append non-empty non-comment lines in the file EXTRA to the file ORIG.
 467
 468 This function saves all buffers and kills the Emacs session, without asking
 469 for any permissions.
 470
 471 This is required because the Windows build environment is not required
 472 to include Sed, which is used by leim/Makefile.in to do the job."
 473   (find-file orig)
 474   (goto-char (point-max))
 475   (insert-file-contents extra)
 476   (delete-matching-lines "^$\\|^;")
 477   (save-buffers-kill-emacs t))
 478
 479 ;; arch-tag: c49b48cc-0f4f-454f-a274-c2dc34815e14
 480 ;;; w32-fns.el ends here