lisp/w32-fns.el

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