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