]> code.delx.au - gnu-emacs/blob - lisp/files.el
Changes from arch/CVS synchronization
[gnu-emacs] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007 Free Software Foundation, Inc.
6
7 ;; Maintainer: FSF
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 2, or (at your option)
14 ;; 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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
31
32 ;;; Code:
33
34 (defvar font-lock-keywords)
35
36
37 (defgroup backup nil
38 "Backups of edited data files."
39 :group 'files)
40
41 (defgroup find-file nil
42 "Finding files."
43 :group 'files)
44
45
46 (defcustom delete-auto-save-files t
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
48
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
51 :type 'boolean
52 :group 'auto-save)
53
54 (defcustom directory-abbrev-alist
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
61
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
64
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
68 :type '(repeat (cons :format "%v"
69 :value ("" . "")
70 (regexp :tag "From")
71 (regexp :tag "To")))
72 :group 'abbrev
73 :group 'find-file)
74
75 ;; Turn off backup files on VMS since it has version numbers.
76 (defcustom make-backup-files (not (eq system-type 'vax-vms))
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
79
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
84
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
89
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 :type 'boolean
95 :group 'backup)
96
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
99 (defvar backup-inhibited nil
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
102 But it is local only if you make it local.")
103 (put 'backup-inhibited 'permanent-local t)
104
105 (defcustom backup-by-copying nil
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
108 :type 'boolean
109 :group 'backup)
110
111 (defcustom backup-by-copying-when-linked nil
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
115 :type 'boolean
116 :group 'backup)
117
118 (defcustom backup-by-copying-when-mismatch nil
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
125 :type 'boolean
126 :group 'backup)
127
128 (defcustom backup-by-copying-when-privileged-mismatch 200
129 "Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
137 :type '(choice (const nil) integer)
138 :group 'backup)
139
140 (defvar backup-enable-predicate 'normal-backup-enable-predicate
141 "Predicate that looks at a file name and decides whether to make backups.
142 Called with an absolute file name as argument, it returns t to enable backup.")
143
144 (defcustom buffer-offer-save nil
145 "Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
148 :type 'boolean
149 :group 'backup)
150 (make-variable-buffer-local 'buffer-offer-save)
151
152 (defcustom find-file-existing-other-name t
153 "Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
156 :type 'boolean
157 :group 'find-file)
158
159 (defcustom find-file-visit-truename nil
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
163 :type 'boolean
164 :group 'find-file)
165 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
166
167 (defcustom revert-without-query nil
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
173 :type '(repeat regexp)
174 :group 'find-file)
175
176 (defvar buffer-file-number nil
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
180 If the buffer is visiting a new file, the value is nil.")
181 (make-variable-buffer-local 'buffer-file-number)
182 (put 'buffer-file-number 'permanent-local t)
183
184 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
185 "Non-nil means that `buffer-file-number' uniquely identifies files.")
186
187 (defvar buffer-file-read-only nil
188 "Non-nil if visited file was read-only when visited.")
189 (make-variable-buffer-local 'buffer-file-read-only)
190
191 (defcustom temporary-file-directory
192 (file-name-as-directory
193 (cond ((memq system-type '(ms-dos windows-nt))
194 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
195 ((memq system-type '(vax-vms axp-vms))
196 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
197 (t
198 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
199 "The directory for writing temporary files."
200 :group 'files
201 :type 'directory)
202
203 (defcustom small-temporary-file-directory
204 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
205 "The directory for writing small temporary files.
206 If non-nil, this directory is used instead of `temporary-file-directory'
207 by programs that create small temporary files. This is for systems that
208 have fast storage with limited space, such as a RAM disk."
209 :group 'files
210 :type '(choice (const nil) directory))
211
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
213 (defvar null-device "/dev/null" "The system null device.")
214
215 (defvar file-name-invalid-regexp
216 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
217 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
218 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
219 "[\000-\031]\\|" ; control characters
220 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
221 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
222 ((memq system-type '(ms-dos windows-nt cygwin))
223 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
224 "[|<>\"?*\000-\031]")) ; invalid characters
225 (t "[\000]"))
226 "Regexp recognizing file names which aren't allowed by the filesystem.")
227
228 (defcustom file-precious-flag nil
229 "Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
231
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
236
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files."
240 :type 'boolean
241 :group 'backup)
242
243 (defcustom version-control nil
244 "Control use of version numbers for backup files.
245 When t, make numeric backup versions unconditionally.
246 When nil, make them for files that have some already.
247 The value `never' means do not make them."
248 :type '(choice (const :tag "Never" never)
249 (const :tag "If existing" nil)
250 (other :tag "Always" t))
251 :group 'backup
252 :group 'vc)
253 (put 'version-control 'safe-local-variable
254 '(lambda (x) (or (booleanp x) (equal x 'never))))
255
256 (defcustom dired-kept-versions 2
257 "When cleaning directory, number of versions to keep."
258 :type 'integer
259 :group 'backup
260 :group 'dired)
261
262 (defcustom delete-old-versions nil
263 "If t, delete excess backup versions silently.
264 If nil, ask confirmation. Any other value prevents any trimming."
265 :type '(choice (const :tag "Delete" t)
266 (const :tag "Ask" nil)
267 (other :tag "Leave" other))
268 :group 'backup)
269
270 (defcustom kept-old-versions 2
271 "Number of oldest versions to keep when a new numbered backup is made."
272 :type 'integer
273 :group 'backup)
274 (put 'kept-old-versions 'safe-local-variable 'integerp)
275
276 (defcustom kept-new-versions 2
277 "Number of newest versions to keep when a new numbered backup is made.
278 Includes the new backup. Must be > 0"
279 :type 'integer
280 :group 'backup)
281 (put 'kept-new-versions 'safe-local-variable 'integerp)
282
283 (defcustom require-final-newline nil
284 "Whether to add a newline automatically at the end of the file.
285
286 A value of t means do this only when the file is about to be saved.
287 A value of `visit' means do this right after the file is visited.
288 A value of `visit-save' means do it at both of those times.
289 Any other non-nil value means ask user whether to add a newline, when saving.
290 A value of nil means don't add newlines.
291
292 Certain major modes set this locally to the value obtained
293 from `mode-require-final-newline'."
294 :type '(choice (const :tag "When visiting" visit)
295 (const :tag "When saving" t)
296 (const :tag "When visiting or saving" visit-save)
297 (const :tag "Don't add newlines" nil)
298 (other :tag "Ask each time" ask))
299 :group 'editing-basics)
300
301 (defcustom mode-require-final-newline t
302 "Whether to add a newline at end of file, in certain major modes.
303 Those modes set `require-final-newline' to this value when you enable them.
304 They do so because they are often used for files that are supposed
305 to end in newlines, and the question is how to arrange that.
306
307 A value of t means do this only when the file is about to be saved.
308 A value of `visit' means do this right after the file is visited.
309 A value of `visit-save' means do it at both of those times.
310 Any other non-nil value means ask user whether to add a newline, when saving.
311
312 A value of nil means do not add newlines. That is a risky choice in this
313 variable since this value is used for modes for files that ought to have
314 final newlines. So if you set this to nil, you must explicitly check and
315 add a final newline, whenever you save a file that really needs one."
316 :type '(choice (const :tag "When visiting" visit)
317 (const :tag "When saving" t)
318 (const :tag "When visiting or saving" visit-save)
319 (const :tag "Don't add newlines" nil)
320 (other :tag "Ask each time" ask))
321 :group 'editing-basics
322 :version "22.1")
323
324 (defcustom auto-save-default t
325 "Non-nil says by default do auto-saving of every file-visiting buffer."
326 :type 'boolean
327 :group 'auto-save)
328
329 (defcustom auto-save-visited-file-name nil
330 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
331 Normally auto-save files are written under other names."
332 :type 'boolean
333 :group 'auto-save)
334
335 (defcustom auto-save-file-name-transforms
336 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
337 ;; Don't put "\\2" inside expand-file-name, since it will be
338 ;; transformed to "/2" on DOS/Windows.
339 ,(concat temporary-file-directory "\\2") t))
340 "Transforms to apply to buffer file name before making auto-save file name.
341 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
342 REGEXP is a regular expression to match against the file name.
343 If it matches, `replace-match' is used to replace the
344 matching part with REPLACEMENT.
345 If the optional element UNIQUIFY is non-nil, the auto-save file name is
346 constructed by taking the directory part of the replaced file-name,
347 concatenated with the buffer file name with all directory separators
348 changed to `!' to prevent clashes. This will not work
349 correctly if your filesystem truncates the resulting name.
350
351 All the transforms in the list are tried, in the order they are listed.
352 When one transform applies, its result is final;
353 no further transforms are tried.
354
355 The default value is set up to put the auto-save file into the
356 temporary directory (see the variable `temporary-file-directory') for
357 editing a remote file.
358
359 On MS-DOS filesystems without long names this variable is always
360 ignored."
361 :group 'auto-save
362 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
363 (boolean :tag "Uniquify")))
364 :version "21.1")
365
366 (defcustom save-abbrevs t
367 "Non-nil means save word abbrevs too when files are saved.
368 If `silently', don't ask the user before saving."
369 :type '(choice (const t) (const nil) (const silently))
370 :group 'abbrev)
371
372 (defcustom find-file-run-dired t
373 "Non-nil means allow `find-file' to visit directories.
374 To visit the directory, `find-file' runs `find-directory-functions'."
375 :type 'boolean
376 :group 'find-file)
377
378 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
379 "List of functions to try in sequence to visit a directory.
380 Each function is called with the directory name as the sole argument
381 and should return either a buffer or nil."
382 :type '(hook :options (cvs-dired-noselect dired-noselect))
383 :group 'find-file)
384
385 ;;;It is not useful to make this a local variable.
386 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
387 (defvar find-file-not-found-functions nil
388 "List of functions to be called for `find-file' on nonexistent file.
389 These functions are called as soon as the error is detected.
390 Variable `buffer-file-name' is already set up.
391 The functions are called in the order given until one of them returns non-nil.")
392 (define-obsolete-variable-alias 'find-file-not-found-hooks
393 'find-file-not-found-functions "22.1")
394
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-hooks 'permanent-local t)
397 (defcustom find-file-hook nil
398 "List of functions to be called after a buffer is loaded from a file.
399 The buffer's local variables (if any) will have been processed before the
400 functions are called."
401 :group 'find-file
402 :type 'hook
403 :options '(auto-insert)
404 :version "22.1")
405 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
406
407 (defvar write-file-functions nil
408 "List of functions to be called before writing out a buffer to a file.
409 If one of them returns non-nil, the file is considered already written
410 and the rest are not called.
411 These hooks are considered to pertain to the visited file.
412 So any buffer-local binding of this variable is discarded if you change
413 the visited file name with \\[set-visited-file-name], but not when you
414 change the major mode.
415
416 This hook is not run if any of the functions in
417 `write-contents-functions' returns non-nil. Both hooks pertain
418 to how to save a buffer to file, for instance, choosing a suitable
419 coding system and setting mode bits. (See Info
420 node `(elisp)Saving Buffers'.) To perform various checks or
421 updates before the buffer is saved, use `before-save-hook'.")
422 (put 'write-file-functions 'permanent-local t)
423 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
424
425 (defvar local-write-file-hooks nil)
426 (make-variable-buffer-local 'local-write-file-hooks)
427 (put 'local-write-file-hooks 'permanent-local t)
428 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
429
430 (defvar write-contents-functions nil
431 "List of functions to be called before writing out a buffer to a file.
432 If one of them returns non-nil, the file is considered already written
433 and the rest are not called and neither are the functions in
434 `write-file-functions'.
435
436 This variable is meant to be used for hooks that pertain to the
437 buffer's contents, not to the particular visited file; thus,
438 `set-visited-file-name' does not clear this variable; but changing the
439 major mode does clear it.
440
441 For hooks that _do_ pertain to the particular visited file, use
442 `write-file-functions'. Both this variable and
443 `write-file-functions' relate to how a buffer is saved to file.
444 To perform various checks or updates before the buffer is saved,
445 use `before-save-hook'.")
446 (make-variable-buffer-local 'write-contents-functions)
447 (define-obsolete-variable-alias 'write-contents-hooks
448 'write-contents-functions "22.1")
449
450 (defcustom enable-local-variables t
451 "Control use of local variables in files you visit.
452 The value can be t, nil, :safe, or something else.
453
454 A value of t means file local variables specifications are obeyed
455 if all the specified variable values are safe; if any values are
456 not safe, Emacs queries you, once, whether to set them all.
457 \(When you say yes to certain values, they are remembered as safe.)
458
459 :safe means set the safe variables, and ignore the rest.
460 :all means set all variables, whether safe or not.
461 (Don't set it permanently to :all.)
462 A value of nil means always ignore the file local variables.
463
464 Any other value means always query you once whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe, but
466 this has no effect when `enable-local-variables' is \"something else\".)
467
468 This variable also controls use of major modes specified in
469 a -*- line.
470
471 The command \\[normal-mode], when used interactively,
472 always obeys file local variable specifications and the -*- line,
473 and ignores this variable."
474 :type '(choice (const :tag "Query Unsafe" t)
475 (const :tag "Safe Only" :safe)
476 (const :tag "Do all" :all)
477 (const :tag "Ignore" nil)
478 (other :tag "Query" other))
479 :group 'find-file)
480
481 (defvar local-enable-local-variables t
482 "Like `enable-local-variables' but meant for buffer-local bindings.
483 The meaningful values are nil and non-nil. The default is non-nil.
484 If a major mode sets this to nil, buffer-locally, then any local
485 variables list in the file will be ignored.
486
487 This variable does not affect the use of major modes
488 specified in a -*- line.")
489
490 (defcustom enable-local-eval 'maybe
491 "Control processing of the \"variable\" `eval' in a file's local variables.
492 The value can be t, nil or something else.
493 A value of t means obey `eval' variables;
494 A value of nil means ignore them; anything else means query."
495 :type '(choice (const :tag "Obey" t)
496 (const :tag "Ignore" nil)
497 (other :tag "Query" other))
498 :group 'find-file)
499
500 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
501 (or (fboundp 'lock-buffer)
502 (defalias 'lock-buffer 'ignore))
503 (or (fboundp 'unlock-buffer)
504 (defalias 'unlock-buffer 'ignore))
505 (or (fboundp 'file-locked-p)
506 (defalias 'file-locked-p 'ignore))
507
508 (defcustom view-read-only nil
509 "Non-nil means buffers visiting files read-only do so in view mode.
510 In fact, this means that all read-only buffers normally have
511 View mode enabled, including buffers that are read-only because
512 you visit a file you cannot alter, and buffers you make read-only
513 using \\[toggle-read-only]."
514 :type 'boolean
515 :group 'view)
516
517 (defvar file-name-history nil
518 "History list of file names entered in the minibuffer.")
519 \f
520 (put 'ange-ftp-completion-hook-function 'safe-magic t)
521 (defun ange-ftp-completion-hook-function (op &rest args)
522 "Provides support for ange-ftp host name completion.
523 Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
525 ;; really in use.
526 (if (memq op '(file-name-completion file-name-all-completions))
527 (apply 'ange-ftp-hook-function op args)
528 (let ((inhibit-file-name-handlers
529 (cons 'ange-ftp-completion-hook-function
530 (and (eq inhibit-file-name-operation op)
531 inhibit-file-name-handlers)))
532 (inhibit-file-name-operation op))
533 (apply op args))))
534
535 (defun convert-standard-filename (filename)
536 "Convert a standard file's name to something suitable for the OS.
537 This means to guarantee valid names and perhaps to canonicalize
538 certain patterns.
539
540 FILENAME should be an absolute file name since the conversion rules
541 sometimes vary depending on the position in the file name. E.g. c:/foo
542 is a valid DOS file name, but c:/bar/c:/foo is not.
543
544 This function's standard definition is trivial; it just returns
545 the argument. However, on Windows and DOS, replace invalid
546 characters. On DOS, make sure to obey the 8.3 limitations.
547 In the native Windows build, turn Cygwin names into native names,
548 and also turn slashes into backslashes if the shell requires it (see
549 `w32-shell-dos-semantics').
550
551 See Info node `(elisp)Standard File Names' for more details."
552 (if (eq system-type 'cygwin)
553 (let ((name (copy-sequence filename))
554 (start 0))
555 ;; Replace invalid filename characters with !
556 (while (string-match "[?*:<>|\"\000-\037]" name start)
557 (aset name (match-beginning 0) ?!)
558 (setq start (match-end 0)))
559 name)
560 filename))
561
562 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564 Value is not expanded---you must call `expand-file-name' yourself.
565 Default name to DEFAULT-DIRNAME if user exits with the same
566 non-empty string that was inserted by this function.
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
569 If the user exits with an empty minibuffer, this function returns
570 an empty string. (This can only happen if the user erased the
571 pre-inserted contents or if `insert-default-directory' is nil.)
572 Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574 Fifth arg INITIAL specifies text to start with.
575 DIR should be an absolute directory name. It defaults to
576 the value of `default-directory'."
577 (unless dir
578 (setq dir default-directory))
579 (read-file-name prompt dir (or default-dirname
580 (if initial (expand-file-name initial dir)
581 dir))
582 mustmatch initial
583 'file-directory-p))
584
585 \f
586 (defun pwd ()
587 "Show the current default directory."
588 (interactive nil)
589 (message "Directory %s" default-directory))
590
591 (defvar cd-path nil
592 "Value of the CDPATH environment variable, as a list.
593 Not actually set up until the first time you use it.")
594
595 (defun parse-colon-path (cd-path)
596 "Explode a search path into a list of directory names.
597 Directories are separated by occurrences of `path-separator'
598 \(which is colon in GNU and GNU-like systems)."
599 ;; We could use split-string here.
600 (and cd-path
601 (let (cd-list (cd-start 0) cd-colon)
602 (setq cd-path (concat cd-path path-separator))
603 (while (setq cd-colon (string-match path-separator cd-path cd-start))
604 (setq cd-list
605 (nconc cd-list
606 (list (if (= cd-start cd-colon)
607 nil
608 (substitute-in-file-name
609 (file-name-as-directory
610 (substring cd-path cd-start cd-colon)))))))
611 (setq cd-start (+ cd-colon 1)))
612 cd-list)))
613
614 (defun cd-absolute (dir)
615 "Change current directory to given absolute file name DIR."
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
618 (if (not (eq system-type 'vax-vms))
619 (setq dir (file-name-as-directory dir)))
620 (setq dir (abbreviate-file-name (expand-file-name dir)))
621 (if (not (file-directory-p dir))
622 (if (file-exists-p dir)
623 (error "%s is not a directory" dir)
624 (error "%s: no such directory" dir))
625 (if (file-executable-p dir)
626 (setq default-directory dir)
627 (error "Cannot cd to %s: Permission denied" dir))))
628
629 (defun cd (dir)
630 "Make DIR become the current buffer's default directory.
631 If your environment includes a `CDPATH' variable, try each one of
632 that list of directories (separated by occurrences of
633 `path-separator') when resolving a relative directory name.
634 The path separator is colon in GNU and GNU-like systems."
635 (interactive
636 (list (read-directory-name "Change default directory: "
637 default-directory default-directory
638 (and (member cd-path '(nil ("./")))
639 (null (getenv "CDPATH"))))))
640 (if (file-name-absolute-p dir)
641 (cd-absolute (expand-file-name dir))
642 (if (null cd-path)
643 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
644 (setq cd-path (or trypath (list "./")))))
645 (if (not (catch 'found
646 (mapcar
647 (function (lambda (x)
648 (let ((f (expand-file-name (concat x dir))))
649 (if (file-directory-p f)
650 (progn
651 (cd-absolute f)
652 (throw 'found t))))))
653 cd-path)
654 nil))
655 (error "No such directory found via CDPATH environment variable"))))
656
657 (defun load-file (file)
658 "Load the Lisp file named FILE."
659 ;; This is a case where .elc makes a lot of sense.
660 (interactive (list (let ((completion-ignored-extensions
661 (remove ".elc" completion-ignored-extensions)))
662 (read-file-name "Load file: "))))
663 (load (expand-file-name file) nil nil t))
664
665 (defun locate-file (filename path &optional suffixes predicate)
666 "Search for FILENAME through PATH.
667 If found, return the absolute file name of FILENAME, with its suffixes;
668 otherwise return nil.
669 PATH should be a list of directories to look in, like the lists in
670 `exec-path' or `load-path'.
671 If SUFFIXES is non-nil, it should be a list of suffixes to append to
672 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
673 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
674 If non-nil, PREDICATE is used instead of `file-readable-p'.
675 PREDICATE can also be an integer to pass to the `access' system call,
676 in which case file-name handlers are ignored. This usage is deprecated.
677
678 For compatibility, PREDICATE can also be one of the symbols
679 `executable', `readable', `writable', or `exists', or a list of
680 one or more of those symbols."
681 (if (and predicate (symbolp predicate) (not (functionp predicate)))
682 (setq predicate (list predicate)))
683 (when (and (consp predicate) (not (functionp predicate)))
684 (setq predicate
685 (logior (if (memq 'executable predicate) 1 0)
686 (if (memq 'writable predicate) 2 0)
687 (if (memq 'readable predicate) 4 0))))
688 (locate-file-internal filename path suffixes predicate))
689
690 (defun locate-file-completion (string path-and-suffixes action)
691 "Do completion for file names passed to `locate-file'.
692 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
693 (if (file-name-absolute-p string)
694 (read-file-name-internal string nil action)
695 (let ((names nil)
696 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
697 (string-dir (file-name-directory string)))
698 (dolist (dir (car path-and-suffixes))
699 (unless dir
700 (setq dir default-directory))
701 (if string-dir (setq dir (expand-file-name string-dir dir)))
702 (when (file-directory-p dir)
703 (dolist (file (file-name-all-completions
704 (file-name-nondirectory string) dir))
705 (add-to-list 'names (if string-dir (concat string-dir file) file))
706 (when (string-match suffix file)
707 (setq file (substring file 0 (match-beginning 0)))
708 (push (if string-dir (concat string-dir file) file) names)))))
709 (cond
710 ((eq action t) (all-completions string names))
711 ((null action) (try-completion string names))
712 (t (test-completion string names))))))
713
714 (defun executable-find (command)
715 "Search for COMMAND in `exec-path' and return the absolute file name.
716 Return nil if COMMAND is not found anywhere in `exec-path'."
717 ;; Use 1 rather than file-executable-p to better match the behavior of
718 ;; call-process.
719 (locate-file command exec-path exec-suffixes 1))
720
721 (defun load-library (library)
722 "Load the library named LIBRARY.
723 This is an interface to the function `load'."
724 (interactive
725 (list (completing-read "Load library: "
726 'locate-file-completion
727 (cons load-path (get-load-suffixes)))))
728 (load library))
729
730 (defun file-remote-p (file &optional connected)
731 "Test whether FILE specifies a location on a remote system.
732 Return an identification of the system if the location is indeed
733 remote. The identification of the system may comprise a method
734 to access the system and its hostname, amongst other things.
735
736 For example, the filename \"/user@host:/foo\" specifies a location
737 on the system \"/user@host:\".
738
739 If CONNECTED is non-nil, the function returns an identification only
740 if FILE is located on a remote system, and a connection is established
741 to that remote system.
742
743 `file-remote-p' will never open a connection on its own."
744 (let ((handler (find-file-name-handler file 'file-remote-p)))
745 (if handler
746 (funcall handler 'file-remote-p file connected)
747 nil)))
748
749 (defun file-local-copy (file)
750 "Copy the file FILE into a temporary file on this machine.
751 Returns the name of the local copy, or nil, if FILE is directly
752 accessible."
753 ;; This formerly had an optional BUFFER argument that wasn't used by
754 ;; anything.
755 (let ((handler (find-file-name-handler file 'file-local-copy)))
756 (if handler
757 (funcall handler 'file-local-copy file)
758 nil)))
759
760 (defun file-truename (filename &optional counter prev-dirs)
761 "Return the truename of FILENAME, which should be absolute.
762 The truename of a file name is found by chasing symbolic links
763 both at the level of the file and at the level of the directories
764 containing it, until no links are left at any level.
765
766 \(fn FILENAME)" ;; Don't document the optional arguments.
767 ;; COUNTER and PREV-DIRS are only used in recursive calls.
768 ;; COUNTER can be a cons cell whose car is the count of how many
769 ;; more links to chase before getting an error.
770 ;; PREV-DIRS can be a cons cell whose car is an alist
771 ;; of truenames we've just recently computed.
772 (cond ((or (string= filename "") (string= filename "~"))
773 (setq filename (expand-file-name filename))
774 (if (string= filename "")
775 (setq filename "/")))
776 ((and (string= (substring filename 0 1) "~")
777 (string-match "~[^/]*/?" filename))
778 (let ((first-part
779 (substring filename 0 (match-end 0)))
780 (rest (substring filename (match-end 0))))
781 (setq filename (concat (expand-file-name first-part) rest)))))
782
783 (or counter (setq counter (list 100)))
784 (let (done
785 ;; For speed, remove the ange-ftp completion handler from the list.
786 ;; We know it's not needed here.
787 ;; For even more speed, do this only on the outermost call.
788 (file-name-handler-alist
789 (if prev-dirs file-name-handler-alist
790 (let ((tem (copy-sequence file-name-handler-alist)))
791 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
792 (or prev-dirs (setq prev-dirs (list nil)))
793
794 ;; andrewi@harlequin.co.uk - none of the following code (except for
795 ;; invoking the file-name handler) currently applies on Windows
796 ;; (ie. there are no native symlinks), but there is an issue with
797 ;; case differences being ignored by the OS, and short "8.3 DOS"
798 ;; name aliases existing for all files. (The short names are not
799 ;; reported by directory-files, but can be used to refer to files.)
800 ;; It seems appropriate for file-truename to resolve these issues in
801 ;; the most natural way, which on Windows is to call the function
802 ;; `w32-long-file-name' - this returns the exact name of a file as
803 ;; it is stored on disk (expanding short name aliases with the full
804 ;; name in the process).
805 (if (eq system-type 'windows-nt)
806 (let ((handler (find-file-name-handler filename 'file-truename)))
807 ;; For file name that has a special handler, call handler.
808 ;; This is so that ange-ftp can save time by doing a no-op.
809 (if handler
810 (setq filename (funcall handler 'file-truename filename))
811 ;; If filename contains a wildcard, newname will be the old name.
812 (unless (string-match "[[*?]" filename)
813 ;; If filename exists, use the long name
814 (setq filename (or (w32-long-file-name filename) filename))))
815 (setq done t)))
816
817 ;; If this file directly leads to a link, process that iteratively
818 ;; so that we don't use lots of stack.
819 (while (not done)
820 (setcar counter (1- (car counter)))
821 (if (< (car counter) 0)
822 (error "Apparent cycle of symbolic links for %s" filename))
823 (let ((handler (find-file-name-handler filename 'file-truename)))
824 ;; For file name that has a special handler, call handler.
825 ;; This is so that ange-ftp can save time by doing a no-op.
826 (if handler
827 (setq filename (funcall handler 'file-truename filename)
828 done t)
829 (let ((dir (or (file-name-directory filename) default-directory))
830 target dirfile)
831 ;; Get the truename of the directory.
832 (setq dirfile (directory-file-name dir))
833 ;; If these are equal, we have the (or a) root directory.
834 (or (string= dir dirfile)
835 ;; If this is the same dir we last got the truename for,
836 ;; save time--don't recalculate.
837 (if (assoc dir (car prev-dirs))
838 (setq dir (cdr (assoc dir (car prev-dirs))))
839 (let ((old dir)
840 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
841 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
842 (setq dir new))))
843 (if (equal ".." (file-name-nondirectory filename))
844 (setq filename
845 (directory-file-name (file-name-directory (directory-file-name dir)))
846 done t)
847 (if (equal "." (file-name-nondirectory filename))
848 (setq filename (directory-file-name dir)
849 done t)
850 ;; Put it back on the file name.
851 (setq filename (concat dir (file-name-nondirectory filename)))
852 ;; Is the file name the name of a link?
853 (setq target (file-symlink-p filename))
854 (if target
855 ;; Yes => chase that link, then start all over
856 ;; since the link may point to a directory name that uses links.
857 ;; We can't safely use expand-file-name here
858 ;; since target might look like foo/../bar where foo
859 ;; is itself a link. Instead, we handle . and .. above.
860 (setq filename
861 (if (file-name-absolute-p target)
862 target
863 (concat dir target))
864 done nil)
865 ;; No, we are done!
866 (setq done t))))))))
867 filename))
868
869 (defun file-chase-links (filename &optional limit)
870 "Chase links in FILENAME until a name that is not a link.
871 Unlike `file-truename', this does not check whether a parent
872 directory name is a symbolic link.
873 If the optional argument LIMIT is a number,
874 it means chase no more than that many links and then stop."
875 (let (tem (newname filename)
876 (count 0))
877 (while (and (or (null limit) (< count limit))
878 (setq tem (file-symlink-p newname)))
879 (save-match-data
880 (if (and (null limit) (= count 100))
881 (error "Apparent cycle of symbolic links for %s" filename))
882 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
883 (while (string-match "//+" tem)
884 (setq tem (replace-match "/" nil nil tem)))
885 ;; Handle `..' by hand, since it needs to work in the
886 ;; target of any directory symlink.
887 ;; This code is not quite complete; it does not handle
888 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
889 (while (string-match "\\`\\.\\./" tem)
890 (setq tem (substring tem 3))
891 (setq newname (expand-file-name newname))
892 ;; Chase links in the default dir of the symlink.
893 (setq newname
894 (file-chase-links
895 (directory-file-name (file-name-directory newname))))
896 ;; Now find the parent of that dir.
897 (setq newname (file-name-directory newname)))
898 (setq newname (expand-file-name tem (file-name-directory newname)))
899 (setq count (1+ count))))
900 newname))
901
902 (defun make-temp-file (prefix &optional dir-flag suffix)
903 "Create a temporary file.
904 The returned file name (created by appending some random characters at the end
905 of PREFIX, and expanding against `temporary-file-directory' if necessary),
906 is guaranteed to point to a newly created empty file.
907 You can then use `write-region' to write new data into the file.
908
909 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
910
911 If SUFFIX is non-nil, add that at the end of the file name."
912 (let ((umask (default-file-modes))
913 file)
914 (unwind-protect
915 (progn
916 ;; Create temp files with strict access rights. It's easy to
917 ;; loosen them later, whereas it's impossible to close the
918 ;; time-window of loose permissions otherwise.
919 (set-default-file-modes ?\700)
920 (while (condition-case ()
921 (progn
922 (setq file
923 (make-temp-name
924 (expand-file-name prefix temporary-file-directory)))
925 (if suffix
926 (setq file (concat file suffix)))
927 (if dir-flag
928 (make-directory file)
929 (write-region "" nil file nil 'silent nil 'excl))
930 nil)
931 (file-already-exists t))
932 ;; the file was somehow created by someone else between
933 ;; `make-temp-name' and `write-region', let's try again.
934 nil)
935 file)
936 ;; Reset the umask.
937 (set-default-file-modes umask))))
938
939 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
940 "Change the encoding of FILE's name from CODING to NEW-CODING.
941 The value is a new name of FILE.
942 Signals a `file-already-exists' error if a file of the new name
943 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
944 is non-nil. A number as fourth arg means request confirmation if
945 the new name already exists. This is what happens in interactive
946 use with M-x."
947 (interactive
948 (let ((default-coding (or file-name-coding-system
949 default-file-name-coding-system))
950 (filename (read-file-name "Recode filename: " nil nil t))
951 from-coding to-coding)
952 (if (and default-coding
953 ;; We provide the default coding only when it seems that
954 ;; the filename is correctly decoded by the default
955 ;; coding.
956 (let ((charsets (find-charset-string filename)))
957 (and (not (memq 'eight-bit-control charsets))
958 (not (memq 'eight-bit-graphic charsets)))))
959 (setq from-coding (read-coding-system
960 (format "Recode filename %s from (default %s): "
961 filename default-coding)
962 default-coding))
963 (setq from-coding (read-coding-system
964 (format "Recode filename %s from: " filename))))
965
966 ;; We provide the default coding only when a user is going to
967 ;; change the encoding not from the default coding.
968 (if (eq from-coding default-coding)
969 (setq to-coding (read-coding-system
970 (format "Recode filename %s from %s to: "
971 filename from-coding)))
972 (setq to-coding (read-coding-system
973 (format "Recode filename %s from %s to (default %s): "
974 filename from-coding default-coding)
975 default-coding)))
976 (list filename from-coding to-coding)))
977
978 (let* ((default-coding (or file-name-coding-system
979 default-file-name-coding-system))
980 ;; FILE should have been decoded by DEFAULT-CODING.
981 (encoded (encode-coding-string file default-coding))
982 (newname (decode-coding-string encoded coding))
983 (new-encoded (encode-coding-string newname new-coding))
984 ;; Suppress further encoding.
985 (file-name-coding-system nil)
986 (default-file-name-coding-system nil)
987 (locale-coding-system nil))
988 (rename-file encoded new-encoded ok-if-already-exists)
989 newname))
990 \f
991 (defun switch-to-buffer-other-window (buffer &optional norecord)
992 "Select buffer BUFFER in another window.
993 If BUFFER does not identify an existing buffer, then this function
994 creates a buffer with that name.
995
996 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
997 or nil. If BUFFER is nil, then this function chooses a buffer
998 using `other-buffer'.
999 Optional second arg NORECORD non-nil means
1000 do not put this buffer at the front of the list of recently selected ones.
1001 This function returns the buffer it switched to.
1002
1003 This uses the function `display-buffer' as a subroutine; see its
1004 documentation for additional customization information."
1005 (interactive "BSwitch to buffer in other window: ")
1006 (let ((pop-up-windows t)
1007 ;; Don't let these interfere.
1008 same-window-buffer-names same-window-regexps)
1009 (pop-to-buffer buffer t norecord)))
1010
1011 (defun switch-to-buffer-other-frame (buffer &optional norecord)
1012 "Switch to buffer BUFFER in another frame.
1013 Optional second arg NORECORD non-nil means
1014 do not put this buffer at the front of the list of recently selected ones.
1015
1016 This uses the function `display-buffer' as a subroutine; see its
1017 documentation for additional customization information."
1018 (interactive "BSwitch to buffer in other frame: ")
1019 (let ((pop-up-frames t)
1020 same-window-buffer-names same-window-regexps)
1021 (pop-to-buffer buffer t norecord)
1022 (raise-frame (window-frame (selected-window)))))
1023
1024 (defun display-buffer-other-frame (buffer)
1025 "Switch to buffer BUFFER in another frame.
1026 This uses the function `display-buffer' as a subroutine; see its
1027 documentation for additional customization information."
1028 (interactive "BDisplay buffer in other frame: ")
1029 (let ((pop-up-frames t)
1030 same-window-buffer-names same-window-regexps
1031 (old-window (selected-window))
1032 new-window)
1033 (setq new-window (display-buffer buffer t))
1034 (lower-frame (window-frame new-window))
1035 (make-frame-invisible (window-frame old-window))
1036 (make-frame-visible (window-frame old-window))))
1037
1038 (defvar find-file-default nil
1039 "Used within `find-file-read-args'.")
1040
1041 (defmacro minibuffer-with-setup-hook (fun &rest body)
1042 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1043 BODY should use the minibuffer at most once.
1044 Recursive uses of the minibuffer will not be affected."
1045 (declare (indent 1) (debug t))
1046 (let ((hook (make-symbol "setup-hook")))
1047 `(let (,hook)
1048 (setq ,hook
1049 (lambda ()
1050 ;; Clear out this hook so it does not interfere
1051 ;; with any recursive minibuffer usage.
1052 (remove-hook 'minibuffer-setup-hook ,hook)
1053 (,fun)))
1054 (unwind-protect
1055 (progn
1056 (add-hook 'minibuffer-setup-hook ,hook)
1057 ,@body)
1058 (remove-hook 'minibuffer-setup-hook ,hook)))))
1059
1060 (defcustom find-file-confirm-nonexistent-file nil
1061 "If non-nil, `find-file' requires confirmation before visiting a new file."
1062 :group 'find-file
1063 :version "23.1"
1064 :type 'boolean)
1065
1066 (defun find-file-read-args (prompt mustmatch)
1067 (list (let ((find-file-default
1068 (and buffer-file-name
1069 (abbreviate-file-name buffer-file-name))))
1070 (minibuffer-with-setup-hook
1071 (lambda () (setq minibuffer-default find-file-default))
1072 (read-file-name prompt nil default-directory mustmatch)))
1073 t))
1074
1075 (defun find-file (filename &optional wildcards)
1076 "Edit file FILENAME.
1077 Switch to a buffer visiting file FILENAME,
1078 creating one if none already exists.
1079 Interactively, the default if you just type RET is the current directory,
1080 but the visited file name is available through the minibuffer history:
1081 type M-n to pull it into the minibuffer.
1082
1083 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1084 expand wildcards (if any) and visit multiple files. You can
1085 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1086
1087 To visit a file without any kind of conversion and without
1088 automatically choosing a major mode, use \\[find-file-literally]."
1089 (interactive
1090 (find-file-read-args "Find file: "
1091 (if find-file-confirm-nonexistent-file 'confirm-only)))
1092 (let ((value (find-file-noselect filename nil nil wildcards)))
1093 (if (listp value)
1094 (mapcar 'switch-to-buffer (nreverse value))
1095 (switch-to-buffer value))))
1096
1097 (defun find-file-other-window (filename &optional wildcards)
1098 "Edit file FILENAME, in another window.
1099 May create a new window, or reuse an existing one.
1100 See the function `display-buffer'.
1101
1102 Interactively, the default if you just type RET is the current directory,
1103 but the visited file name is available through the minibuffer history:
1104 type M-n to pull it into the minibuffer.
1105
1106 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1107 expand wildcards (if any) and visit multiple files."
1108 (interactive
1109 (find-file-read-args "Find file in other window: "
1110 (if find-file-confirm-nonexistent-file 'confirm-only)))
1111 (let ((value (find-file-noselect filename nil nil wildcards)))
1112 (if (listp value)
1113 (progn
1114 (setq value (nreverse value))
1115 (cons (switch-to-buffer-other-window (car value))
1116 (mapcar 'switch-to-buffer (cdr value))))
1117 (switch-to-buffer-other-window value))))
1118
1119 (defun find-file-other-frame (filename &optional wildcards)
1120 "Edit file FILENAME, in another frame.
1121 May create a new frame, or reuse an existing one.
1122 See the function `display-buffer'.
1123
1124 Interactively, the default if you just type RET is the current directory,
1125 but the visited file name is available through the minibuffer history:
1126 type M-n to pull it into the minibuffer.
1127
1128 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1129 expand wildcards (if any) and visit multiple files."
1130 (interactive
1131 (find-file-read-args "Find file in other frame: "
1132 (if find-file-confirm-nonexistent-file 'confirm-only)))
1133 (let ((value (find-file-noselect filename nil nil wildcards)))
1134 (if (listp value)
1135 (progn
1136 (setq value (nreverse value))
1137 (cons (switch-to-buffer-other-frame (car value))
1138 (mapcar 'switch-to-buffer (cdr value))))
1139 (switch-to-buffer-other-frame value))))
1140
1141 (defun find-file-existing (filename)
1142 "Edit the existing file FILENAME.
1143 Like \\[find-file] but only allow a file that exists, and do not allow
1144 file names with wildcards."
1145 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1146 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1147 (error "%s does not exist" filename)
1148 (find-file filename)
1149 (current-buffer)))
1150
1151 (defun find-file-read-only (filename &optional wildcards)
1152 "Edit file FILENAME but don't allow changes.
1153 Like \\[find-file] but marks buffer as read-only.
1154 Use \\[toggle-read-only] to permit editing."
1155 (interactive
1156 (find-file-read-args "Find file read-only: "
1157 (if find-file-confirm-nonexistent-file 'confirm-only)))
1158 (unless (or (and wildcards find-file-wildcards
1159 (not (string-match "\\`/:" filename))
1160 (string-match "[[*?]" filename))
1161 (file-exists-p filename))
1162 (error "%s does not exist" filename))
1163 (let ((value (find-file filename wildcards)))
1164 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1165 (if (listp value) value (list value)))
1166 value))
1167
1168 (defun find-file-read-only-other-window (filename &optional wildcards)
1169 "Edit file FILENAME in another window but don't allow changes.
1170 Like \\[find-file-other-window] but marks buffer as read-only.
1171 Use \\[toggle-read-only] to permit editing."
1172 (interactive
1173 (find-file-read-args "Find file read-only other window: "
1174 (if find-file-confirm-nonexistent-file 'confirm-only)))
1175 (unless (or (and wildcards find-file-wildcards
1176 (not (string-match "\\`/:" filename))
1177 (string-match "[[*?]" filename))
1178 (file-exists-p filename))
1179 (error "%s does not exist" filename))
1180 (let ((value (find-file-other-window filename wildcards)))
1181 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1182 (if (listp value) value (list value)))
1183 value))
1184
1185 (defun find-file-read-only-other-frame (filename &optional wildcards)
1186 "Edit file FILENAME in another frame but don't allow changes.
1187 Like \\[find-file-other-frame] but marks buffer as read-only.
1188 Use \\[toggle-read-only] to permit editing."
1189 (interactive
1190 (find-file-read-args "Find file read-only other frame: "
1191 (if find-file-confirm-nonexistent-file 'confirm-only)))
1192 (unless (or (and wildcards find-file-wildcards
1193 (not (string-match "\\`/:" filename))
1194 (string-match "[[*?]" filename))
1195 (file-exists-p filename))
1196 (error "%s does not exist" filename))
1197 (let ((value (find-file-other-frame filename wildcards)))
1198 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1199 (if (listp value) value (list value)))
1200 value))
1201
1202 (defun find-alternate-file-other-window (filename &optional wildcards)
1203 "Find file FILENAME as a replacement for the file in the next window.
1204 This command does not select that window.
1205
1206 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1207 expand wildcards (if any) and replace the file with multiple files."
1208 (interactive
1209 (save-selected-window
1210 (other-window 1)
1211 (let ((file buffer-file-name)
1212 (file-name nil)
1213 (file-dir nil))
1214 (and file
1215 (setq file-name (file-name-nondirectory file)
1216 file-dir (file-name-directory file)))
1217 (list (read-file-name
1218 "Find alternate file: " file-dir nil nil file-name)
1219 t))))
1220 (if (one-window-p)
1221 (find-file-other-window filename wildcards)
1222 (save-selected-window
1223 (other-window 1)
1224 (find-alternate-file filename wildcards))))
1225
1226 (defun find-alternate-file (filename &optional wildcards)
1227 "Find file FILENAME, select its buffer, kill previous buffer.
1228 If the current buffer now contains an empty file that you just visited
1229 \(presumably by mistake), use this command to visit the file you really want.
1230
1231 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1232 expand wildcards (if any) and replace the file with multiple files.
1233
1234 If the current buffer is an indirect buffer, or the base buffer
1235 for one or more indirect buffers, the other buffer(s) are not
1236 killed."
1237 (interactive
1238 (let ((file buffer-file-name)
1239 (file-name nil)
1240 (file-dir nil))
1241 (and file
1242 (setq file-name (file-name-nondirectory file)
1243 file-dir (file-name-directory file)))
1244 (list (read-file-name
1245 "Find alternate file: " file-dir nil nil file-name)
1246 t)))
1247 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1248 (error "Aborted"))
1249 (when (and (buffer-modified-p) (buffer-file-name))
1250 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1251 (buffer-name)))
1252 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1253 (error "Aborted"))
1254 (save-buffer)))
1255 (let ((obuf (current-buffer))
1256 (ofile buffer-file-name)
1257 (onum buffer-file-number)
1258 (odir dired-directory)
1259 (otrue buffer-file-truename)
1260 (oname (buffer-name)))
1261 (if (get-buffer " **lose**")
1262 (kill-buffer " **lose**"))
1263 (rename-buffer " **lose**")
1264 (unwind-protect
1265 (progn
1266 (unlock-buffer)
1267 ;; This prevents us from finding the same buffer
1268 ;; if we specified the same file again.
1269 (setq buffer-file-name nil)
1270 (setq buffer-file-number nil)
1271 (setq buffer-file-truename nil)
1272 ;; Likewise for dired buffers.
1273 (setq dired-directory nil)
1274 (find-file filename wildcards))
1275 (when (eq obuf (current-buffer))
1276 ;; This executes if find-file gets an error
1277 ;; and does not really find anything.
1278 ;; We put things back as they were.
1279 ;; If find-file actually finds something, we kill obuf below.
1280 (setq buffer-file-name ofile)
1281 (setq buffer-file-number onum)
1282 (setq buffer-file-truename otrue)
1283 (setq dired-directory odir)
1284 (lock-buffer)
1285 (rename-buffer oname)))
1286 (unless (eq (current-buffer) obuf)
1287 (with-current-buffer obuf
1288 ;; We already asked; don't ask again.
1289 (let ((kill-buffer-query-functions))
1290 (kill-buffer obuf))))))
1291 \f
1292 (defun create-file-buffer (filename)
1293 "Create a suitably named buffer for visiting FILENAME, and return it.
1294 FILENAME (sans directory) is used unchanged if that name is free;
1295 otherwise a string <2> or <3> or ... is appended to get an unused name."
1296 (let ((lastname (file-name-nondirectory filename)))
1297 (if (string= lastname "")
1298 (setq lastname filename))
1299 (generate-new-buffer lastname)))
1300
1301 (defun generate-new-buffer (name)
1302 "Create and return a buffer with a name based on NAME.
1303 Choose the buffer's name using `generate-new-buffer-name'."
1304 (get-buffer-create (generate-new-buffer-name name)))
1305
1306 (defcustom automount-dir-prefix "^/tmp_mnt/"
1307 "Regexp to match the automounter prefix in a directory name."
1308 :group 'files
1309 :type 'regexp)
1310
1311 (defvar abbreviated-home-dir nil
1312 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1313
1314 (defun abbreviate-file-name (filename)
1315 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1316 This also substitutes \"~\" for the user's home directory (unless the
1317 home directory is a root directory) and removes automounter prefixes
1318 \(see the variable `automount-dir-prefix')."
1319 ;; Get rid of the prefixes added by the automounter.
1320 (save-match-data
1321 (if (and automount-dir-prefix
1322 (string-match automount-dir-prefix filename)
1323 (file-exists-p (file-name-directory
1324 (substring filename (1- (match-end 0))))))
1325 (setq filename (substring filename (1- (match-end 0)))))
1326 (let ((tail directory-abbrev-alist))
1327 ;; If any elt of directory-abbrev-alist matches this name,
1328 ;; abbreviate accordingly.
1329 (while tail
1330 (if (string-match (car (car tail)) filename)
1331 (setq filename
1332 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1333 (setq tail (cdr tail)))
1334 ;; Compute and save the abbreviated homedir name.
1335 ;; We defer computing this until the first time it's needed, to
1336 ;; give time for directory-abbrev-alist to be set properly.
1337 ;; We include a slash at the end, to avoid spurious matches
1338 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1339 (or abbreviated-home-dir
1340 (setq abbreviated-home-dir
1341 (let ((abbreviated-home-dir "$foo"))
1342 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1343 "\\(/\\|\\'\\)"))))
1344
1345 ;; If FILENAME starts with the abbreviated homedir,
1346 ;; make it start with `~' instead.
1347 (if (and (string-match abbreviated-home-dir filename)
1348 ;; If the home dir is just /, don't change it.
1349 (not (and (= (match-end 0) 1)
1350 (= (aref filename 0) ?/)))
1351 ;; MS-DOS root directories can come with a drive letter;
1352 ;; Novell Netware allows drive letters beyond `Z:'.
1353 (not (and (or (eq system-type 'ms-dos)
1354 (eq system-type 'cygwin)
1355 (eq system-type 'windows-nt))
1356 (save-match-data
1357 (string-match "^[a-zA-`]:/$" filename)))))
1358 (setq filename
1359 (concat "~"
1360 (match-string 1 filename)
1361 (substring filename (match-end 0)))))
1362 filename)))
1363
1364 (defcustom find-file-not-true-dirname-list nil
1365 "List of logical names for which visiting shouldn't save the true dirname.
1366 On VMS, when you visit a file using a logical name that searches a path,
1367 you may or may not want the visited file name to record the specific
1368 directory where the file was found. If you *do not* want that, add the logical
1369 name to this list as a string."
1370 :type '(repeat (string :tag "Name"))
1371 :group 'find-file)
1372
1373 (defun find-buffer-visiting (filename &optional predicate)
1374 "Return the buffer visiting file FILENAME (a string).
1375 This is like `get-file-buffer', except that it checks for any buffer
1376 visiting the same file, possibly under a different name.
1377 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1378 and others are ignored.
1379 If there is no such live buffer, return nil."
1380 (let ((predicate (or predicate #'identity))
1381 (truename (abbreviate-file-name (file-truename filename))))
1382 (or (let ((buf (get-file-buffer filename)))
1383 (when (and buf (funcall predicate buf)) buf))
1384 (let ((list (buffer-list)) found)
1385 (while (and (not found) list)
1386 (save-excursion
1387 (set-buffer (car list))
1388 (if (and buffer-file-name
1389 (string= buffer-file-truename truename)
1390 (funcall predicate (current-buffer)))
1391 (setq found (car list))))
1392 (setq list (cdr list)))
1393 found)
1394 (let* ((attributes (file-attributes truename))
1395 (number (nthcdr 10 attributes))
1396 (list (buffer-list)) found)
1397 (and buffer-file-numbers-unique
1398 (car-safe number) ;Make sure the inode is not just nil.
1399 (while (and (not found) list)
1400 (with-current-buffer (car list)
1401 (if (and buffer-file-name
1402 (equal buffer-file-number number)
1403 ;; Verify this buffer's file number
1404 ;; still belongs to its file.
1405 (file-exists-p buffer-file-name)
1406 (equal (file-attributes buffer-file-truename)
1407 attributes)
1408 (funcall predicate (current-buffer)))
1409 (setq found (car list))))
1410 (setq list (cdr list))))
1411 found))))
1412 \f
1413 (defcustom find-file-wildcards t
1414 "Non-nil means file-visiting commands should handle wildcards.
1415 For example, if you specify `*.c', that would visit all the files
1416 whose names match the pattern."
1417 :group 'files
1418 :version "20.4"
1419 :type 'boolean)
1420
1421 (defcustom find-file-suppress-same-file-warnings nil
1422 "Non-nil means suppress warning messages for symlinked files.
1423 When nil, Emacs prints a warning when visiting a file that is already
1424 visited, but with a different name. Setting this option to t
1425 suppresses this warning."
1426 :group 'files
1427 :version "21.1"
1428 :type 'boolean)
1429
1430 (defcustom large-file-warning-threshold 10000000
1431 "Maximum size of file above which a confirmation is requested.
1432 When nil, never request confirmation."
1433 :group 'files
1434 :group 'find-file
1435 :version "22.1"
1436 :type '(choice integer (const :tag "Never request confirmation" nil)))
1437
1438 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1439 "Read file FILENAME into a buffer and return the buffer.
1440 If a buffer exists visiting FILENAME, return that one, but
1441 verify that the file has not changed since visited or saved.
1442 The buffer is not selected, just returned to the caller.
1443 Optional second arg NOWARN non-nil means suppress any warning messages.
1444 Optional third arg RAWFILE non-nil means the file is read literally.
1445 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1446 and visit all the matching files. When wildcards are actually
1447 used and expanded, return a list of buffers that are visiting
1448 the various files."
1449 (setq filename
1450 (abbreviate-file-name
1451 (expand-file-name filename)))
1452 (if (file-directory-p filename)
1453 (or (and find-file-run-dired
1454 (run-hook-with-args-until-success
1455 'find-directory-functions
1456 (if find-file-visit-truename
1457 (abbreviate-file-name (file-truename filename))
1458 filename)))
1459 (error "%s is a directory" filename))
1460 (if (and wildcards
1461 find-file-wildcards
1462 (not (string-match "\\`/:" filename))
1463 (string-match "[[*?]" filename))
1464 (let ((files (condition-case nil
1465 (file-expand-wildcards filename t)
1466 (error (list filename))))
1467 (find-file-wildcards nil))
1468 (if (null files)
1469 (find-file-noselect filename)
1470 (mapcar #'find-file-noselect files)))
1471 (let* ((buf (get-file-buffer filename))
1472 (truename (abbreviate-file-name (file-truename filename)))
1473 (attributes (file-attributes truename))
1474 (number (nthcdr 10 attributes))
1475 ;; Find any buffer for a file which has same truename.
1476 (other (and (not buf) (find-buffer-visiting filename))))
1477 ;; Let user know if there is a buffer with the same truename.
1478 (if other
1479 (progn
1480 (or nowarn
1481 find-file-suppress-same-file-warnings
1482 (string-equal filename (buffer-file-name other))
1483 (message "%s and %s are the same file"
1484 filename (buffer-file-name other)))
1485 ;; Optionally also find that buffer.
1486 (if (or find-file-existing-other-name find-file-visit-truename)
1487 (setq buf other))))
1488 ;; Check to see if the file looks uncommonly large.
1489 (when (and large-file-warning-threshold (nth 7 attributes)
1490 ;; Don't ask again if we already have the file or
1491 ;; if we're asked to be quiet.
1492 (not (or buf nowarn))
1493 (> (nth 7 attributes) large-file-warning-threshold)
1494 (not (y-or-n-p
1495 (format "File %s is large (%dMB), really open? "
1496 (file-name-nondirectory filename)
1497 (/ (nth 7 attributes) 1048576)))))
1498 (error "Aborted"))
1499 (if buf
1500 ;; We are using an existing buffer.
1501 (let (nonexistent)
1502 (or nowarn
1503 (verify-visited-file-modtime buf)
1504 (cond ((not (file-exists-p filename))
1505 (setq nonexistent t)
1506 (message "File %s no longer exists!" filename))
1507 ;; Certain files should be reverted automatically
1508 ;; if they have changed on disk and not in the buffer.
1509 ((and (not (buffer-modified-p buf))
1510 (let ((tail revert-without-query)
1511 (found nil))
1512 (while tail
1513 (if (string-match (car tail) filename)
1514 (setq found t))
1515 (setq tail (cdr tail)))
1516 found))
1517 (with-current-buffer buf
1518 (message "Reverting file %s..." filename)
1519 (revert-buffer t t)
1520 (message "Reverting file %s...done" filename)))
1521 ((yes-or-no-p
1522 (if (string= (file-name-nondirectory filename)
1523 (buffer-name buf))
1524 (format
1525 (if (buffer-modified-p buf)
1526 "File %s changed on disk. Discard your edits? "
1527 "File %s changed on disk. Reread from disk? ")
1528 (file-name-nondirectory filename))
1529 (format
1530 (if (buffer-modified-p buf)
1531 "File %s changed on disk. Discard your edits in %s? "
1532 "File %s changed on disk. Reread from disk into %s? ")
1533 (file-name-nondirectory filename)
1534 (buffer-name buf))))
1535 (with-current-buffer buf
1536 (revert-buffer t t)))))
1537 (with-current-buffer buf
1538
1539 ;; Check if a formerly read-only file has become
1540 ;; writable and vice versa, but if the buffer agrees
1541 ;; with the new state of the file, that is ok too.
1542 (let ((read-only (not (file-writable-p buffer-file-name))))
1543 (unless (or nonexistent
1544 (eq read-only buffer-file-read-only)
1545 (eq read-only buffer-read-only))
1546 (when (or nowarn
1547 (let ((question
1548 (format "File %s is %s on disk. Change buffer mode? "
1549 buffer-file-name
1550 (if read-only "read-only" "writable"))))
1551 (y-or-n-p question)))
1552 (setq buffer-read-only read-only)))
1553 (setq buffer-file-read-only read-only))
1554
1555 (when (and (not (eq (not (null rawfile))
1556 (not (null find-file-literally))))
1557 (not nonexistent)
1558 ;; It is confusing to ask whether to visit
1559 ;; non-literally if they have the file in
1560 ;; hexl-mode.
1561 (not (eq major-mode 'hexl-mode)))
1562 (if (buffer-modified-p)
1563 (if (y-or-n-p
1564 (format
1565 (if rawfile
1566 "The file %s is already visited normally,
1567 and you have edited the buffer. Now you have asked to visit it literally,
1568 meaning no coding system handling, format conversion, or local variables.
1569 Emacs can only visit a file in one way at a time.
1570
1571 Do you want to save the file, and visit it literally instead? "
1572 "The file %s is already visited literally,
1573 meaning no coding system handling, format conversion, or local variables.
1574 You have edited the buffer. Now you have asked to visit the file normally,
1575 but Emacs can only visit a file in one way at a time.
1576
1577 Do you want to save the file, and visit it normally instead? ")
1578 (file-name-nondirectory filename)))
1579 (progn
1580 (save-buffer)
1581 (find-file-noselect-1 buf filename nowarn
1582 rawfile truename number))
1583 (if (y-or-n-p
1584 (format
1585 (if rawfile
1586 "\
1587 Do you want to discard your changes, and visit the file literally now? "
1588 "\
1589 Do you want to discard your changes, and visit the file normally now? ")))
1590 (find-file-noselect-1 buf filename nowarn
1591 rawfile truename number)
1592 (error (if rawfile "File already visited non-literally"
1593 "File already visited literally"))))
1594 (if (y-or-n-p
1595 (format
1596 (if rawfile
1597 "The file %s is already visited normally.
1598 You have asked to visit it literally,
1599 meaning no coding system decoding, format conversion, or local variables.
1600 But Emacs can only visit a file in one way at a time.
1601
1602 Do you want to revisit the file literally now? "
1603 "The file %s is already visited literally,
1604 meaning no coding system decoding, format conversion, or local variables.
1605 You have asked to visit it normally,
1606 but Emacs can only visit a file in one way at a time.
1607
1608 Do you want to revisit the file normally now? ")
1609 (file-name-nondirectory filename)))
1610 (find-file-noselect-1 buf filename nowarn
1611 rawfile truename number)
1612 (error (if rawfile "File already visited non-literally"
1613 "File already visited literally"))))))
1614 ;; Return the buffer we are using.
1615 buf)
1616 ;; Create a new buffer.
1617 (setq buf (create-file-buffer filename))
1618 ;; find-file-noselect-1 may use a different buffer.
1619 (find-file-noselect-1 buf filename nowarn
1620 rawfile truename number))))))
1621
1622 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1623 (let (error)
1624 (with-current-buffer buf
1625 (kill-local-variable 'find-file-literally)
1626 ;; Needed in case we are re-visiting the file with a different
1627 ;; text representation.
1628 (kill-local-variable 'buffer-file-coding-system)
1629 (kill-local-variable 'cursor-type)
1630 (let ((inhibit-read-only t))
1631 (erase-buffer))
1632 (and (default-value 'enable-multibyte-characters)
1633 (not rawfile)
1634 (set-buffer-multibyte t))
1635 (if rawfile
1636 (condition-case ()
1637 (let ((inhibit-read-only t))
1638 (insert-file-contents-literally filename t))
1639 (file-error
1640 (when (and (file-exists-p filename)
1641 (not (file-readable-p filename)))
1642 (kill-buffer buf)
1643 (signal 'file-error (list "File is not readable"
1644 filename)))
1645 ;; Unconditionally set error
1646 (setq error t)))
1647 (condition-case ()
1648 (let ((inhibit-read-only t))
1649 (insert-file-contents filename t))
1650 (file-error
1651 (when (and (file-exists-p filename)
1652 (not (file-readable-p filename)))
1653 (kill-buffer buf)
1654 (signal 'file-error (list "File is not readable"
1655 filename)))
1656 ;; Run find-file-not-found-functions until one returns non-nil.
1657 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1658 ;; If they fail too, set error.
1659 (setq error t)))))
1660 ;; Record the file's truename, and maybe use that as visited name.
1661 (if (equal filename buffer-file-name)
1662 (setq buffer-file-truename truename)
1663 (setq buffer-file-truename
1664 (abbreviate-file-name (file-truename buffer-file-name))))
1665 (setq buffer-file-number number)
1666 ;; On VMS, we may want to remember which directory in a search list
1667 ;; the file was found in.
1668 (and (eq system-type 'vax-vms)
1669 (let (logical)
1670 (if (string-match ":" (file-name-directory filename))
1671 (setq logical (substring (file-name-directory filename)
1672 0 (match-beginning 0))))
1673 (not (member logical find-file-not-true-dirname-list)))
1674 (setq buffer-file-name buffer-file-truename))
1675 (if find-file-visit-truename
1676 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1677 ;; Set buffer's default directory to that of the file.
1678 (setq default-directory (file-name-directory buffer-file-name))
1679 ;; Turn off backup files for certain file names. Since
1680 ;; this is a permanent local, the major mode won't eliminate it.
1681 (and backup-enable-predicate
1682 (not (funcall backup-enable-predicate buffer-file-name))
1683 (progn
1684 (make-local-variable 'backup-inhibited)
1685 (setq backup-inhibited t)))
1686 (if rawfile
1687 (progn
1688 (set-buffer-multibyte nil)
1689 (setq buffer-file-coding-system 'no-conversion)
1690 (set-buffer-major-mode buf)
1691 (make-local-variable 'find-file-literally)
1692 (setq find-file-literally t))
1693 (after-find-file error (not nowarn)))
1694 (current-buffer))))
1695 \f
1696 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1697 "Like `insert-file-contents', but only reads in the file literally.
1698 A buffer may be modified in several ways after reading into the buffer,
1699 to Emacs features such as format decoding, character code
1700 conversion, `find-file-hook', automatic uncompression, etc.
1701
1702 This function ensures that none of these modifications will take place."
1703 (let ((format-alist nil)
1704 (after-insert-file-functions nil)
1705 (coding-system-for-read 'no-conversion)
1706 (coding-system-for-write 'no-conversion)
1707 (find-buffer-file-type-function
1708 (if (fboundp 'find-buffer-file-type)
1709 (symbol-function 'find-buffer-file-type)
1710 nil))
1711 (inhibit-file-name-handlers
1712 (append '(jka-compr-handler image-file-handler)
1713 inhibit-file-name-handlers))
1714 (inhibit-file-name-operation 'insert-file-contents))
1715 (unwind-protect
1716 (progn
1717 (fset 'find-buffer-file-type (lambda (filename) t))
1718 (insert-file-contents filename visit beg end replace))
1719 (if find-buffer-file-type-function
1720 (fset 'find-buffer-file-type find-buffer-file-type-function)
1721 (fmakunbound 'find-buffer-file-type)))))
1722
1723 (defun insert-file-1 (filename insert-func)
1724 (if (file-directory-p filename)
1725 (signal 'file-error (list "Opening input file" "file is a directory"
1726 filename)))
1727 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1728 #'buffer-modified-p))
1729 (tem (funcall insert-func filename)))
1730 (push-mark (+ (point) (car (cdr tem))))
1731 (when buffer
1732 (message "File %s already visited and modified in buffer %s"
1733 filename (buffer-name buffer)))))
1734
1735 (defun insert-file-literally (filename)
1736 "Insert contents of file FILENAME into buffer after point with no conversion.
1737
1738 This function is meant for the user to run interactively.
1739 Don't call it from programs! Use `insert-file-contents-literally' instead.
1740 \(Its calling sequence is different; see its documentation)."
1741 (interactive "*fInsert file literally: ")
1742 (insert-file-1 filename #'insert-file-contents-literally))
1743
1744 (defvar find-file-literally nil
1745 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1746 This is a permanent local.")
1747 (put 'find-file-literally 'permanent-local t)
1748
1749 (defun find-file-literally (filename)
1750 "Visit file FILENAME with no conversion of any kind.
1751 Format conversion and character code conversion are both disabled,
1752 and multibyte characters are disabled in the resulting buffer.
1753 The major mode used is Fundamental mode regardless of the file name,
1754 and local variable specifications in the file are ignored.
1755 Automatic uncompression and adding a newline at the end of the
1756 file due to `require-final-newline' is also disabled.
1757
1758 You cannot absolutely rely on this function to result in
1759 visiting the file literally. If Emacs already has a buffer
1760 which is visiting the file, you get the existing buffer,
1761 regardless of whether it was created literally or not.
1762
1763 In a Lisp program, if you want to be sure of accessing a file's
1764 contents literally, you should create a temporary buffer and then read
1765 the file contents into it using `insert-file-contents-literally'."
1766 (interactive "FFind file literally: ")
1767 (switch-to-buffer (find-file-noselect filename nil t)))
1768 \f
1769 (defvar after-find-file-from-revert-buffer nil)
1770
1771 (defun after-find-file (&optional error warn noauto
1772 after-find-file-from-revert-buffer
1773 nomodes)
1774 "Called after finding a file and by the default revert function.
1775 Sets buffer mode, parses local variables.
1776 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1777 error in reading the file. WARN non-nil means warn if there
1778 exists an auto-save file more recent than the visited file.
1779 NOAUTO means don't mess with auto-save mode.
1780 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1781 means this call was from `revert-buffer'.
1782 Fifth arg NOMODES non-nil means don't alter the file's modes.
1783 Finishes by calling the functions in `find-file-hook'
1784 unless NOMODES is non-nil."
1785 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1786 (if noninteractive
1787 nil
1788 (let* (not-serious
1789 (msg
1790 (cond
1791 ((not warn) nil)
1792 ((and error (file-attributes buffer-file-name))
1793 (setq buffer-read-only t)
1794 "File exists, but cannot be read")
1795 ((not buffer-read-only)
1796 (if (and warn
1797 ;; No need to warn if buffer is auto-saved
1798 ;; under the name of the visited file.
1799 (not (and buffer-file-name
1800 auto-save-visited-file-name))
1801 (file-newer-than-file-p (or buffer-auto-save-file-name
1802 (make-auto-save-file-name))
1803 buffer-file-name))
1804 (format "%s has auto save data; consider M-x recover-this-file"
1805 (file-name-nondirectory buffer-file-name))
1806 (setq not-serious t)
1807 (if error "(New file)" nil)))
1808 ((not error)
1809 (setq not-serious t)
1810 "Note: file is write protected")
1811 ((file-attributes (directory-file-name default-directory))
1812 "File not found and directory write-protected")
1813 ((file-exists-p (file-name-directory buffer-file-name))
1814 (setq buffer-read-only nil))
1815 (t
1816 (setq buffer-read-only nil)
1817 "Use M-x make-directory RET RET to create the directory and its parents"))))
1818 (when msg
1819 (message "%s" msg)
1820 (or not-serious (sit-for 1 t))))
1821 (when (and auto-save-default (not noauto))
1822 (auto-save-mode t)))
1823 ;; Make people do a little extra work (C-x C-q)
1824 ;; before altering a backup file.
1825 (when (backup-file-name-p buffer-file-name)
1826 (setq buffer-read-only t))
1827 ;; When a file is marked read-only,
1828 ;; make the buffer read-only even if root is looking at it.
1829 (when (and (file-modes (buffer-file-name))
1830 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1831 (setq buffer-read-only t))
1832 (unless nomodes
1833 (when (and view-read-only view-mode)
1834 (view-mode-disable))
1835 (normal-mode t)
1836 ;; If requested, add a newline at the end of the file.
1837 (and (memq require-final-newline '(visit visit-save))
1838 (> (point-max) (point-min))
1839 (/= (char-after (1- (point-max))) ?\n)
1840 (not (and (eq selective-display t)
1841 (= (char-after (1- (point-max))) ?\r)))
1842 (save-excursion
1843 (goto-char (point-max))
1844 (insert "\n")))
1845 (when (and buffer-read-only
1846 view-read-only
1847 (not (eq (get major-mode 'mode-class) 'special)))
1848 (view-mode-enter))
1849 (run-hooks 'find-file-hook)))
1850
1851 (defmacro report-errors (format &rest body)
1852 "Eval BODY and turn any error into a FORMAT message.
1853 FORMAT can have a %s escape which will be replaced with the actual error.
1854 If `debug-on-error' is set, errors are not caught, so that you can
1855 debug them.
1856 Avoid using a large BODY since it is duplicated."
1857 (declare (debug t) (indent 1))
1858 `(if debug-on-error
1859 (progn . ,body)
1860 (condition-case err
1861 (progn . ,body)
1862 (error (message ,format (prin1-to-string err))))))
1863
1864 (defun normal-mode (&optional find-file)
1865 "Choose the major mode for this buffer automatically.
1866 Also sets up any specified local variables of the file.
1867 Uses the visited file name, the -*- line, and the local variables spec.
1868
1869 This function is called automatically from `find-file'. In that case,
1870 we may set up the file-specified mode and local variables,
1871 depending on the value of `enable-local-variables'.
1872 In addition, if `local-enable-local-variables' is nil, we do
1873 not set local variables (though we do notice a mode specified with -*-.)
1874
1875 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1876 or from Lisp without specifying the optional argument FIND-FILE;
1877 in that case, this function acts as if `enable-local-variables' were t."
1878 (interactive)
1879 (funcall (or default-major-mode 'fundamental-mode))
1880 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1881 (report-errors "File mode specification error: %s"
1882 (set-auto-mode))
1883 (report-errors "File local-variables error: %s"
1884 (hack-local-variables)))
1885 ;; Turn font lock off and on, to make sure it takes account of
1886 ;; whatever file local variables are relevant to it.
1887 (when (and font-lock-mode
1888 ;; Font-lock-mode (now in font-core.el) can be ON when
1889 ;; font-lock.el still hasn't been loaded.
1890 (boundp 'font-lock-keywords)
1891 (eq (car font-lock-keywords) t))
1892 (setq font-lock-keywords (cadr font-lock-keywords))
1893 (font-lock-mode 1))
1894
1895 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1896 (ucs-set-table-for-input)))
1897
1898 (defcustom auto-mode-case-fold nil
1899 "Non-nil means to try second pass through `auto-mode-alist'.
1900 This means that if the first case-sensitive search through the alist fails
1901 to find a matching major mode, a second case-insensitive search is made.
1902 On systems with case-insensitive file names, this variable is ignored,
1903 since only a single case-insensitive search through the alist is made."
1904 :group 'files
1905 :version "22.1"
1906 :type 'boolean)
1907
1908 (defvar auto-mode-alist
1909 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1910 ;; c++-mode, java-mode and more) are added through autoload
1911 ;; directives in that file. That way is discouraged since it
1912 ;; spreads out the definition of the initial value.
1913 (mapc
1914 (lambda (elt)
1915 (cons (purecopy (car elt)) (cdr elt)))
1916 `(;; do this first, so that .html.pl is Polish html, not Perl
1917 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1918 ("\\.te?xt\\'" . text-mode)
1919 ("\\.[tT]e[xX]\\'" . tex-mode)
1920 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1921 ("\\.ltx\\'" . latex-mode)
1922 ("\\.dtx\\'" . doctex-mode)
1923 ("\\.el\\'" . emacs-lisp-mode)
1924 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
1925 ("\\.l\\'" . lisp-mode)
1926 ("\\.li?sp\\'" . lisp-mode)
1927 ("\\.[fF]\\'" . fortran-mode)
1928 ("\\.for\\'" . fortran-mode)
1929 ("\\.p\\'" . pascal-mode)
1930 ("\\.pas\\'" . pascal-mode)
1931 ("\\.ad[abs]\\'" . ada-mode)
1932 ("\\.ad[bs].dg\\'" . ada-mode)
1933 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
1934 ("Imakefile\\'" . makefile-imake-mode)
1935 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
1936 ("\\.makepp\\'" . makefile-makepp-mode)
1937 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
1938 '(("\\.mk\\'" . makefile-bsdmake-mode)
1939 ("GNUmakefile\\'" . makefile-gmake-mode)
1940 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
1941 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
1942 ("[Mm]akefile\\'" . makefile-gmake-mode)))
1943 ("\\.am\\'" . makefile-automake-mode)
1944 ;; Less common extensions come here
1945 ;; so more common ones above are found faster.
1946 ("\\.texinfo\\'" . texinfo-mode)
1947 ("\\.te?xi\\'" . texinfo-mode)
1948 ("\\.[sS]\\'" . asm-mode)
1949 ("\\.asm\\'" . asm-mode)
1950 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
1951 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
1952 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1953 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1954 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1955 ("\\.bash\\'" . sh-mode)
1956 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1957 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1958 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1959 ("\\.m?spec\\'" . sh-mode)
1960 ("\\.m[mes]\\'" . nroff-mode)
1961 ("\\.man\\'" . nroff-mode)
1962 ("\\.sty\\'" . latex-mode)
1963 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
1964 ("\\.bbl\\'" . latex-mode)
1965 ("\\.bib\\'" . bibtex-mode)
1966 ("\\.sql\\'" . sql-mode)
1967 ("\\.m[4c]\\'" . m4-mode)
1968 ("\\.mf\\'" . metafont-mode)
1969 ("\\.mp\\'" . metapost-mode)
1970 ("\\.vhdl?\\'" . vhdl-mode)
1971 ("\\.article\\'" . text-mode)
1972 ("\\.letter\\'" . text-mode)
1973 ("\\.i?tcl\\'" . tcl-mode)
1974 ("\\.exp\\'" . tcl-mode)
1975 ("\\.itk\\'" . tcl-mode)
1976 ("\\.icn\\'" . icon-mode)
1977 ("\\.sim\\'" . simula-mode)
1978 ("\\.mss\\'" . scribe-mode)
1979 ("\\.f9[05]\\'" . f90-mode)
1980 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1981 ("\\.pro\\'" . idlwave-mode)
1982 ("\\.prolog\\'" . prolog-mode)
1983 ("\\.tar\\'" . tar-mode)
1984 ;; The list of archive file extensions should be in sync with
1985 ;; `auto-coding-alist' with `no-conversion' coding system.
1986 ("\\.\\(arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\)\\'" . archive-mode)
1987 ("\\.\\(ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . archive-mode)
1988 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
1989 ;; Mailer puts message to be edited in
1990 ;; /tmp/Re.... or Message
1991 ("\\`/tmp/Re" . text-mode)
1992 ("/Message[0-9]*\\'" . text-mode)
1993 ("\\.zone\\'" . zone-mode)
1994 ;; some news reader is reported to use this
1995 ("\\`/tmp/fol/" . text-mode)
1996 ("\\.oak\\'" . scheme-mode)
1997 ("\\.sgml?\\'" . sgml-mode)
1998 ("\\.x[ms]l\\'" . xml-mode)
1999 ("\\.dtd\\'" . sgml-mode)
2000 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2001 ("\\.js\\'" . java-mode) ; javascript-mode would be better
2002 ("\\.x[bp]m\\'" . c-mode)
2003 ;; .emacs or .gnus or .viper following a directory delimiter in
2004 ;; Unix, MSDOG or VMS syntax.
2005 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2006 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2007 ;; _emacs following a directory delimiter
2008 ;; in MsDos syntax
2009 ("[:/]_emacs\\'" . emacs-lisp-mode)
2010 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2011 ("\\.ml\\'" . lisp-mode)
2012 ;; Common Lisp ASDF package system.
2013 ("\\.asd\\'" . lisp-mode)
2014 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2015 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2016 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2017 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2018 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2019 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2020 ("BROWSE\\'" . ebrowse-tree-mode)
2021 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2022 ("#\\*mail\\*" . mail-mode)
2023 ("\\.g\\'" . antlr-mode)
2024 ("\\.ses\\'" . ses-mode)
2025 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2026 ("\\.docbook\\'" . sgml-mode)
2027 ("\\.com\\'" . dcl-mode)
2028 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2029 ;; Windows candidates may be opened case sensitively on Unix
2030 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2031 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2032 ("\\.ppd\\'" . conf-ppd-mode)
2033 ("java.+\\.conf\\'" . conf-javaprop-mode)
2034 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2035 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2036 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
2037 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2038 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2039 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2040 ;; this has lower priority to avoid matching changelog.sgml etc.
2041 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2042 ;; either user's dot-files or under /etc or some such
2043 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2044 ;; alas not all ~/.*rc files are like this
2045 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2046 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2047 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2048 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2049 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2050 ;; this contains everything twice, with space and with colon :-(
2051 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2052 ;; Get rid of any trailing .n.m and try again.
2053 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2054 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2055 ;; Using mode nil rather than `ignore' would let the search continue
2056 ;; through this list (with the shortened name) rather than start over.
2057 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2058 ;; The following should come after the ChangeLog pattern
2059 ;; for the sake of ChangeLog.1, etc.
2060 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2061 ("\\.[1-9]\\'" . nroff-mode)
2062 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2063 "Alist of filename patterns vs corresponding major mode functions.
2064 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2065 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2066 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2067 mode function to use. FUNCTION will be called, unless it is nil.
2068
2069 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2070 calling FUNCTION (if it's not nil), we delete the suffix that matched
2071 REGEXP and search the list again for another match.
2072
2073 If the file name matches `inhibit-first-line-modes-regexps',
2074 then `auto-mode-alist' is not processed.
2075
2076 The extensions whose FUNCTION is `archive-mode' should also
2077 appear in `auto-coding-alist' with `no-conversion' coding system.
2078
2079 See also `interpreter-mode-alist', which detects executable script modes
2080 based on the interpreters they specify to run,
2081 and `magic-mode-alist', which determines modes based on file contents.")
2082
2083 (defvar interpreter-mode-alist
2084 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2085 ;; and pike-mode) are added through autoload directives in that
2086 ;; file. That way is discouraged since it spreads out the
2087 ;; definition of the initial value.
2088 (mapc
2089 (lambda (l)
2090 (cons (purecopy (car l)) (cdr l)))
2091 '(("perl" . perl-mode)
2092 ("perl5" . perl-mode)
2093 ("miniperl" . perl-mode)
2094 ("wish" . tcl-mode)
2095 ("wishx" . tcl-mode)
2096 ("tcl" . tcl-mode)
2097 ("tclsh" . tcl-mode)
2098 ("scm" . scheme-mode)
2099 ("ash" . sh-mode)
2100 ("bash" . sh-mode)
2101 ("bash2" . sh-mode)
2102 ("csh" . sh-mode)
2103 ("dtksh" . sh-mode)
2104 ("es" . sh-mode)
2105 ("itcsh" . sh-mode)
2106 ("jsh" . sh-mode)
2107 ("ksh" . sh-mode)
2108 ("oash" . sh-mode)
2109 ("pdksh" . sh-mode)
2110 ("rc" . sh-mode)
2111 ("rpm" . sh-mode)
2112 ("sh" . sh-mode)
2113 ("sh5" . sh-mode)
2114 ("tcsh" . sh-mode)
2115 ("wksh" . sh-mode)
2116 ("wsh" . sh-mode)
2117 ("zsh" . sh-mode)
2118 ("tail" . text-mode)
2119 ("more" . text-mode)
2120 ("less" . text-mode)
2121 ("pg" . text-mode)
2122 ("make" . makefile-gmake-mode) ; Debian uses this
2123 ("guile" . scheme-mode)
2124 ("clisp" . lisp-mode)))
2125 "Alist mapping interpreter names to major modes.
2126 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2127 Each element looks like (INTERPRETER . MODE).
2128 If INTERPRETER matches the name of the interpreter specified in the first line
2129 of a script, mode MODE is enabled.
2130
2131 See also `auto-mode-alist'.")
2132
2133 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2134 "List of regexps; if one matches a file name, don't look for `-*-'.")
2135
2136 (defvar inhibit-first-line-modes-suffixes nil
2137 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2138 When checking `inhibit-first-line-modes-regexps', we first discard
2139 from the end of the file name anything that matches one of these regexps.")
2140
2141 (defvar auto-mode-interpreter-regexp
2142 "#![ \t]?\\([^ \t\n]*\
2143 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2144 "Regexp matching interpreters, for file mode determination.
2145 This regular expression is matched against the first line of a file
2146 to determine the file's mode in `set-auto-mode'. If it matches, the file
2147 is assumed to be interpreted by the interpreter matched by the second group
2148 of the regular expression. The mode is then determined as the mode
2149 associated with that interpreter in `interpreter-mode-alist'.")
2150
2151 (defvar magic-mode-alist nil
2152 "Alist of buffer beginnings vs. corresponding major mode functions.
2153 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2154 After visiting a file, if REGEXP matches the text at the beginning of the
2155 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2156 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2157 major mode.
2158
2159 If FUNCTION is nil, then it is not called. (That is a way of saying
2160 \"allow `auto-mode-alist' to decide for these files.\")")
2161 (put 'magic-mode-alist 'risky-local-variable t)
2162
2163 (defvar magic-fallback-mode-alist
2164 `((image-type-auto-detected-p . image-mode)
2165 ;; The < comes before the groups (but the first) to reduce backtracking.
2166 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2167 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2168 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2169 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2170 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2171 comment-re "*"
2172 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2173 "[Hh][Tt][Mm][Ll]"))
2174 . html-mode)
2175 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2176 ;; These two must come after html, because they are more general:
2177 ("<\\?xml " . xml-mode)
2178 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2179 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2180 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2181 . sgml-mode)
2182 ("%!PS" . ps-mode)
2183 ("# xmcd " . conf-unix-mode))
2184 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2185 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2186 After visiting a file, if REGEXP matches the text at the beginning of the
2187 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2188 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2189 have not specified a mode for this file.
2190
2191 If FUNCTION is nil, then it is not called.")
2192 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2193
2194 (defvar magic-mode-regexp-match-limit 4000
2195 "Upper limit on `magic-mode-alist' regexp matches.
2196 Also applies to `magic-fallback-mode-alist'.")
2197
2198 (defun set-auto-mode (&optional keep-mode-if-same)
2199 "Select major mode appropriate for current buffer.
2200
2201 To find the right major mode, this function checks for a -*- mode tag,
2202 checks if it uses an interpreter listed in `interpreter-mode-alist',
2203 matches the buffer beginning against `magic-mode-alist',
2204 compares the filename against the entries in `auto-mode-alist',
2205 then matches the buffer beginning against `magic-fallback-mode-alist'.
2206
2207 It does not check for the `mode:' local variable in the
2208 Local Variables section of the file; for that, use `hack-local-variables'.
2209
2210 If `enable-local-variables' is nil, this function does not check for a
2211 -*- mode tag.
2212
2213 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2214 set the major mode only if that would change it. In other words
2215 we don't actually set it to the same mode the buffer already has."
2216 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2217 (let (end done mode modes)
2218 ;; Find a -*- mode tag
2219 (save-excursion
2220 (goto-char (point-min))
2221 (skip-chars-forward " \t\n")
2222 (and enable-local-variables
2223 (setq end (set-auto-mode-1))
2224 (if (save-excursion (search-forward ":" end t))
2225 ;; Find all specifications for the `mode:' variable
2226 ;; and execute them left to right.
2227 (while (let ((case-fold-search t))
2228 (or (and (looking-at "mode:")
2229 (goto-char (match-end 0)))
2230 (re-search-forward "[ \t;]mode:" end t)))
2231 (skip-chars-forward " \t")
2232 (let ((beg (point)))
2233 (if (search-forward ";" end t)
2234 (forward-char -1)
2235 (goto-char end))
2236 (skip-chars-backward " \t")
2237 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2238 modes)))
2239 ;; Simple -*-MODE-*- case.
2240 (push (intern (concat (downcase (buffer-substring (point) end))
2241 "-mode"))
2242 modes))))
2243 ;; If we found modes to use, invoke them now, outside the save-excursion.
2244 (if modes
2245 (catch 'nop
2246 (dolist (mode (nreverse modes))
2247 (if (not (functionp mode))
2248 (message "Ignoring unknown mode `%s'" mode)
2249 (setq done t)
2250 (or (set-auto-mode-0 mode keep-mode-if-same)
2251 ;; continuing would call minor modes again, toggling them off
2252 (throw 'nop nil))))))
2253 ;; If we didn't, look for an interpreter specified in the first line.
2254 ;; As a special case, allow for things like "#!/bin/env perl", which
2255 ;; finds the interpreter anywhere in $PATH.
2256 (unless done
2257 (setq mode (save-excursion
2258 (goto-char (point-min))
2259 (if (looking-at auto-mode-interpreter-regexp)
2260 (match-string 2)
2261 ""))
2262 ;; Map interpreter name to a mode, signalling we're done at the
2263 ;; same time.
2264 done (assoc (file-name-nondirectory mode)
2265 interpreter-mode-alist))
2266 ;; If we found an interpreter mode to use, invoke it now.
2267 (if done
2268 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2269 ;; Next try matching the buffer beginning against magic-mode-alist.
2270 (unless done
2271 (if (setq done (save-excursion
2272 (goto-char (point-min))
2273 (save-restriction
2274 (narrow-to-region (point-min)
2275 (min (point-max)
2276 (+ (point-min) magic-mode-regexp-match-limit)))
2277 (assoc-default nil magic-mode-alist
2278 (lambda (re dummy)
2279 (if (functionp re)
2280 (funcall re)
2281 (looking-at re)))))))
2282 (set-auto-mode-0 done keep-mode-if-same)))
2283 ;; Next compare the filename against the entries in auto-mode-alist.
2284 (unless done
2285 (if buffer-file-name
2286 (let ((name buffer-file-name))
2287 ;; Remove backup-suffixes from file name.
2288 (setq name (file-name-sans-versions name))
2289 (while name
2290 ;; Find first matching alist entry.
2291 (setq mode
2292 (if (memq system-type '(vax-vms windows-nt cygwin))
2293 ;; System is case-insensitive.
2294 (let ((case-fold-search t))
2295 (assoc-default name auto-mode-alist
2296 'string-match))
2297 ;; System is case-sensitive.
2298 (or
2299 ;; First match case-sensitively.
2300 (let ((case-fold-search nil))
2301 (assoc-default name auto-mode-alist
2302 'string-match))
2303 ;; Fallback to case-insensitive match.
2304 (and auto-mode-case-fold
2305 (let ((case-fold-search t))
2306 (assoc-default name auto-mode-alist
2307 'string-match))))))
2308 (if (and mode
2309 (consp mode)
2310 (cadr mode))
2311 (setq mode (car mode)
2312 name (substring name 0 (match-beginning 0)))
2313 (setq name))
2314 (when mode
2315 (set-auto-mode-0 mode keep-mode-if-same)
2316 (setq done t))))))
2317 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2318 (unless done
2319 (if (setq done (save-excursion
2320 (goto-char (point-min))
2321 (save-restriction
2322 (narrow-to-region (point-min)
2323 (min (point-max)
2324 (+ (point-min) magic-mode-regexp-match-limit)))
2325 (assoc-default nil magic-fallback-mode-alist
2326 (lambda (re dummy)
2327 (if (functionp re)
2328 (funcall re)
2329 (looking-at re)))))))
2330 (set-auto-mode-0 done keep-mode-if-same)))))
2331
2332 ;; When `keep-mode-if-same' is set, we are working on behalf of
2333 ;; set-visited-file-name. In that case, if the major mode specified is the
2334 ;; same one we already have, don't actually reset it. We don't want to lose
2335 ;; minor modes such as Font Lock.
2336 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2337 "Apply MODE and return it.
2338 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2339 any aliases and compared to current major mode. If they are the
2340 same, do nothing and return nil."
2341 (unless (and keep-mode-if-same
2342 (eq (indirect-function mode)
2343 (indirect-function major-mode)))
2344 (when mode
2345 (funcall mode)
2346 mode)))
2347
2348 (defun set-auto-mode-1 ()
2349 "Find the -*- spec in the buffer.
2350 Call with point at the place to start searching from.
2351 If one is found, set point to the beginning
2352 and return the position of the end.
2353 Otherwise, return nil; point may be changed."
2354 (let (beg end)
2355 (and
2356 ;; Don't look for -*- if this file name matches any
2357 ;; of the regexps in inhibit-first-line-modes-regexps.
2358 (let ((temp inhibit-first-line-modes-regexps)
2359 (name (if buffer-file-name
2360 (file-name-sans-versions buffer-file-name)
2361 (buffer-name))))
2362 (while (let ((sufs inhibit-first-line-modes-suffixes))
2363 (while (and sufs (not (string-match (car sufs) name)))
2364 (setq sufs (cdr sufs)))
2365 sufs)
2366 (setq name (substring name 0 (match-beginning 0))))
2367 (while (and temp
2368 (not (string-match (car temp) name)))
2369 (setq temp (cdr temp)))
2370 (not temp))
2371
2372 (search-forward "-*-" (line-end-position
2373 ;; If the file begins with "#!"
2374 ;; (exec interpreter magic), look
2375 ;; for mode frobs in the first two
2376 ;; lines. You cannot necessarily
2377 ;; put them in the first line of
2378 ;; such a file without screwing up
2379 ;; the interpreter invocation.
2380 (and (looking-at "^#!") 2)) t)
2381 (progn
2382 (skip-chars-forward " \t")
2383 (setq beg (point))
2384 (search-forward "-*-" (line-end-position) t))
2385 (progn
2386 (forward-char -3)
2387 (skip-chars-backward " \t")
2388 (setq end (point))
2389 (goto-char beg)
2390 end))))
2391 \f
2392 ;;; Handling file local variables
2393
2394 (defvar ignored-local-variables
2395 '(ignored-local-variables safe-local-variable-values)
2396 "Variables to be ignored in a file's local variable spec.")
2397
2398 (defvar hack-local-variables-hook nil
2399 "Normal hook run after processing a file's local variables specs.
2400 Major modes can use this to examine user-specified local variables
2401 in order to initialize other data structure based on them.")
2402
2403 (defcustom safe-local-variable-values nil
2404 "List variable-value pairs that are considered safe.
2405 Each element is a cons cell (VAR . VAL), where VAR is a variable
2406 symbol and VAL is a value that is considered safe."
2407 :group 'find-file
2408 :type 'alist)
2409
2410 (defcustom safe-local-eval-forms nil
2411 "Expressions that are considered safe in an `eval:' local variable.
2412 Add expressions to this list if you want Emacs to evaluate them, when
2413 they appear in an `eval' local variable specification, without first
2414 asking you for confirmation."
2415 :group 'find-file
2416 :version "22.1"
2417 :type '(repeat sexp))
2418
2419 ;; Risky local variables:
2420 (mapc (lambda (var) (put var 'risky-local-variable t))
2421 '(after-load-alist
2422 auto-mode-alist
2423 buffer-auto-save-file-name
2424 buffer-file-name
2425 buffer-file-truename
2426 buffer-undo-list
2427 dabbrev-case-fold-search
2428 dabbrev-case-replace
2429 debugger
2430 default-text-properties
2431 display-time-string
2432 enable-local-eval
2433 enable-local-variables
2434 eval
2435 exec-directory
2436 exec-path
2437 file-name-handler-alist
2438 font-lock-defaults
2439 format-alist
2440 frame-title-format
2441 global-mode-string
2442 header-line-format
2443 icon-title-format
2444 ignored-local-variables
2445 imenu--index-alist
2446 imenu-generic-expression
2447 inhibit-quit
2448 input-method-alist
2449 load-path
2450 max-lisp-eval-depth
2451 max-specpdl-size
2452 minor-mode-alist
2453 minor-mode-map-alist
2454 minor-mode-overriding-map-alist
2455 mode-line-buffer-identification
2456 mode-line-format
2457 mode-line-modes
2458 mode-line-modified
2459 mode-line-mule-info
2460 mode-line-position
2461 mode-line-process
2462 mode-name
2463 outline-level
2464 overriding-local-map
2465 overriding-terminal-local-map
2466 parse-time-rules
2467 process-environment
2468 rmail-output-file-alist
2469 safe-local-variable-values
2470 safe-local-eval-forms
2471 save-some-buffers-action-alist
2472 special-display-buffer-names
2473 standard-input
2474 standard-output
2475 unread-command-events
2476 vc-mode))
2477
2478 ;; Safe local variables:
2479 ;;
2480 ;; For variables defined by major modes, the safety declarations can go into
2481 ;; the major mode's file, since that will be loaded before file variables are
2482 ;; processed.
2483 ;;
2484 ;; For variables defined by minor modes, put the safety declarations in the
2485 ;; file defining the minor mode after the defcustom/defvar using an autoload
2486 ;; cookie, e.g.:
2487 ;;
2488 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2489 ;;
2490 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2491 ;; minor mode file may not be loaded yet.
2492 ;;
2493 ;; For variables defined in the C source code the declaration should go here:
2494
2495 (mapc (lambda (pair)
2496 (put (car pair) 'safe-local-variable (cdr pair)))
2497 '((buffer-read-only . booleanp) ;; C source code
2498 (default-directory . stringp) ;; C source code
2499 (fill-column . integerp) ;; C source code
2500 (indent-tabs-mode . booleanp) ;; C source code
2501 (left-margin . integerp) ;; C source code
2502 (no-update-autoloads . booleanp)
2503 (tab-width . integerp) ;; C source code
2504 (truncate-lines . booleanp))) ;; C source code
2505
2506 (put 'c-set-style 'safe-local-eval-function t)
2507
2508 (defun hack-local-variables-confirm (vars unsafe-vars risky-vars)
2509 (if noninteractive
2510 nil
2511 (let ((name (if buffer-file-name
2512 (file-name-nondirectory buffer-file-name)
2513 (concat "buffer " (buffer-name))))
2514 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2515 prompt char)
2516 (save-window-excursion
2517 (let ((buf (get-buffer-create "*Local Variables*")))
2518 (pop-to-buffer buf)
2519 (set (make-local-variable 'cursor-type) nil)
2520 (erase-buffer)
2521 (if unsafe-vars
2522 (insert "The local variables list in " name
2523 "\ncontains values that may not be safe (*)"
2524 (if risky-vars
2525 ", and variables that are risky (**)."
2526 "."))
2527 (if risky-vars
2528 (insert "The local variables list in " name
2529 "\ncontains variables that are risky (**).")
2530 (insert "A local variables list is specified in " name ".")))
2531 (insert "\n\nDo you want to apply it? You can type
2532 y -- to apply the local variables list.
2533 n -- to ignore the local variables list.")
2534 (if offer-save
2535 (insert "
2536 ! -- to apply the local variables list, and permanently mark these
2537 values (*) as safe (in the future, they will be set automatically.)\n\n")
2538 (insert "\n\n"))
2539 (dolist (elt vars)
2540 (cond ((member elt unsafe-vars)
2541 (insert " * "))
2542 ((member elt risky-vars)
2543 (insert " ** "))
2544 (t
2545 (insert " ")))
2546 (princ (car elt) buf)
2547 (insert " : ")
2548 ;; Make strings with embedded whitespace easier to read.
2549 (let ((print-escape-newlines t))
2550 (prin1 (cdr elt) buf))
2551 (insert "\n"))
2552 (setq prompt
2553 (format "Please type %s%s: "
2554 (if offer-save "y, n, or !" "y or n")
2555 (if (< (line-number-at-pos) (window-body-height))
2556 ""
2557 ", or C-v to scroll")))
2558 (goto-char (point-min))
2559 (let ((cursor-in-echo-area t)
2560 (executing-kbd-macro executing-kbd-macro)
2561 (exit-chars
2562 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2563 done)
2564 (while (not done)
2565 (message prompt)
2566 (setq char (read-event))
2567 (if (numberp char)
2568 (cond ((eq char ?\C-v)
2569 (condition-case nil
2570 (scroll-up)
2571 (error (goto-char (point-min)))))
2572 ;; read-event returns -1 if we are in a kbd
2573 ;; macro and there are no more events in the
2574 ;; macro. In that case, attempt to get an
2575 ;; event interactively.
2576 ((and executing-kbd-macro (= char -1))
2577 (setq executing-kbd-macro nil))
2578 (t (setq done (memq (downcase char) exit-chars)))))))
2579 (setq char (downcase char))
2580 (when (and offer-save (= char ?!) unsafe-vars)
2581 (dolist (elt unsafe-vars)
2582 (add-to-list 'safe-local-variable-values elt))
2583 ;; When this is called from desktop-restore-file-buffer,
2584 ;; coding-system-for-read may be non-nil. Reset it before
2585 ;; writing to .emacs.
2586 (if (or custom-file user-init-file)
2587 (let ((coding-system-for-read nil))
2588 (customize-save-variable
2589 'safe-local-variable-values
2590 safe-local-variable-values))))
2591 (kill-buffer buf)
2592 (or (= char ?!)
2593 (= char ?\s)
2594 (= char ?y)))))))
2595
2596 (defun hack-local-variables-prop-line (&optional mode-only)
2597 "Return local variables specified in the -*- line.
2598 Ignore any specification for `mode:' and `coding:';
2599 `set-auto-mode' should already have handled `mode:',
2600 `set-auto-coding' should already have handled `coding:'.
2601
2602 If MODE-ONLY is non-nil, all we do is check whether the major
2603 mode is specified, returning t if it is specified. Otherwise,
2604 return an alist of elements (VAR . VAL), where VAR is a variable
2605 and VAL is the specified value."
2606 (save-excursion
2607 (goto-char (point-min))
2608 (let ((end (set-auto-mode-1))
2609 result mode-specified)
2610 ;; Parse the -*- line into the RESULT alist.
2611 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2612 (cond ((not end)
2613 nil)
2614 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2615 ;; Simple form: "-*- MODENAME -*-". Already handled.
2616 (setq mode-specified t)
2617 nil)
2618 (t
2619 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2620 ;; (last ";" is optional).
2621 (while (< (point) end)
2622 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2623 (error "Malformed -*- line"))
2624 (goto-char (match-end 0))
2625 ;; There used to be a downcase here,
2626 ;; but the manual didn't say so,
2627 ;; and people want to set var names that aren't all lc.
2628 (let ((key (intern (match-string 1)))
2629 (val (save-restriction
2630 (narrow-to-region (point) end)
2631 (read (current-buffer)))))
2632 ;; It is traditional to ignore
2633 ;; case when checking for `mode' in set-auto-mode,
2634 ;; so we must do that here as well.
2635 ;; That is inconsistent, but we're stuck with it.
2636 ;; The same can be said for `coding' in set-auto-coding.
2637 (or (and (equal (downcase (symbol-name key)) "mode")
2638 (setq mode-specified t))
2639 (equal (downcase (symbol-name key)) "coding")
2640 (condition-case nil
2641 (push (cons (if (eq key 'eval)
2642 'eval
2643 (indirect-variable key))
2644 val) result)
2645 (error nil)))
2646 (skip-chars-forward " \t;")))))
2647
2648 (if mode-only
2649 mode-specified
2650 result))))
2651
2652 (defun hack-local-variables (&optional mode-only)
2653 "Parse and put into effect this buffer's local variables spec.
2654 If MODE-ONLY is non-nil, all we do is check whether the major mode
2655 is specified, returning t if it is specified."
2656 (let ((enable-local-variables
2657 (and local-enable-local-variables enable-local-variables))
2658 result)
2659 (when (or mode-only enable-local-variables)
2660 (setq result (hack-local-variables-prop-line mode-only))
2661 ;; Look for "Local variables:" line in last page.
2662 (save-excursion
2663 (goto-char (point-max))
2664 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2665 'move)
2666 (when (let ((case-fold-search t))
2667 (search-forward "Local Variables:" nil t))
2668 (skip-chars-forward " \t")
2669 ;; suffix is what comes after "local variables:" in its line.
2670 ;; prefix is what comes before "local variables:" in its line.
2671 (let ((suffix
2672 (concat
2673 (regexp-quote (buffer-substring (point)
2674 (line-end-position)))
2675 "$"))
2676 (prefix
2677 (concat "^" (regexp-quote
2678 (buffer-substring (line-beginning-position)
2679 (match-beginning 0)))))
2680 beg)
2681
2682 (forward-line 1)
2683 (let ((startpos (point))
2684 endpos
2685 (thisbuf (current-buffer)))
2686 (save-excursion
2687 (unless (let ((case-fold-search t))
2688 (re-search-forward
2689 (concat prefix "[ \t]*End:[ \t]*" suffix)
2690 nil t))
2691 (error "Local variables list is not properly terminated"))
2692 (beginning-of-line)
2693 (setq endpos (point)))
2694
2695 (with-temp-buffer
2696 (insert-buffer-substring thisbuf startpos endpos)
2697 (goto-char (point-min))
2698 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2699 (while (not (eobp))
2700 ;; Discard the prefix.
2701 (if (looking-at prefix)
2702 (delete-region (point) (match-end 0))
2703 (error "Local variables entry is missing the prefix"))
2704 (end-of-line)
2705 ;; Discard the suffix.
2706 (if (looking-back suffix)
2707 (delete-region (match-beginning 0) (point))
2708 (error "Local variables entry is missing the suffix"))
2709 (forward-line 1))
2710 (goto-char (point-min))
2711
2712 (while (not (eobp))
2713 ;; Find the variable name; strip whitespace.
2714 (skip-chars-forward " \t")
2715 (setq beg (point))
2716 (skip-chars-forward "^:\n")
2717 (if (eolp) (error "Missing colon in local variables entry"))
2718 (skip-chars-backward " \t")
2719 (let* ((str (buffer-substring beg (point)))
2720 (var (read str))
2721 val)
2722 ;; Read the variable value.
2723 (skip-chars-forward "^:")
2724 (forward-char 1)
2725 (setq val (read (current-buffer)))
2726 (if mode-only
2727 (if (eq var 'mode)
2728 (setq result t))
2729 (unless (eq var 'coding)
2730 (condition-case nil
2731 (push (cons (if (eq var 'eval)
2732 'eval
2733 (indirect-variable var))
2734 val) result)
2735 (error nil)))))
2736 (forward-line 1)))))))
2737
2738 ;; We've read all the local variables. Now, return whether the
2739 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2740 ;; variables (if MODE-ONLY is nil.)
2741 (if mode-only
2742 result
2743 (dolist (ignored ignored-local-variables)
2744 (setq result (assq-delete-all ignored result)))
2745 (if (null enable-local-eval)
2746 (setq result (assq-delete-all 'eval result)))
2747 (when result
2748 (setq result (nreverse result))
2749 ;; Find those variables that we may want to save to
2750 ;; `safe-local-variable-values'.
2751 (let (risky-vars unsafe-vars)
2752 (dolist (elt result)
2753 (let ((var (car elt))
2754 (val (cdr elt)))
2755 (or (eq var 'mode)
2756 (and (eq var 'eval)
2757 (or (eq enable-local-eval t)
2758 (hack-one-local-variable-eval-safep
2759 (eval (quote val)))))
2760 (safe-local-variable-p var val)
2761 (and (risky-local-variable-p var val)
2762 (push elt risky-vars))
2763 (push elt unsafe-vars))))
2764 (if (eq enable-local-variables :safe)
2765 ;; If caller wants only the safe variables,
2766 ;; install only them.
2767 (dolist (elt result)
2768 (unless (or (memq (car elt) unsafe-vars)
2769 (memq (car elt) risky-vars))
2770 (hack-one-local-variable (car elt) (cdr elt))))
2771 ;; Query, except in the case where all are known safe
2772 ;; if the user wants no quuery in that case.
2773 (if (or (and (eq enable-local-variables t)
2774 (null unsafe-vars)
2775 (null risky-vars))
2776 (eq enable-local-variables :all)
2777 (hack-local-variables-confirm
2778 result unsafe-vars risky-vars))
2779 (dolist (elt result)
2780 (hack-one-local-variable (car elt) (cdr elt)))))))
2781 (run-hooks 'hack-local-variables-hook)))))
2782
2783 (defun safe-local-variable-p (sym val)
2784 "Non-nil if SYM is safe as a file-local variable with value VAL.
2785 It is safe if any of these conditions are met:
2786
2787 * There is a matching entry (SYM . VAL) in the
2788 `safe-local-variable-values' user option.
2789
2790 * The `safe-local-variable' property of SYM is a function that
2791 evaluates to a non-nil value with VAL as an argument."
2792 (or (member (cons sym val) safe-local-variable-values)
2793 (let ((safep (get sym 'safe-local-variable)))
2794 (and (functionp safep) (funcall safep val)))))
2795
2796 (defun risky-local-variable-p (sym &optional ignored)
2797 "Non-nil if SYM could be dangerous as a file-local variable.
2798 It is dangerous if either of these conditions are met:
2799
2800 * Its `risky-local-variable' property is non-nil.
2801
2802 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2803 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
2804 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2805 \"map-alist\", or \"bindat-spec\"."
2806 ;; If this is an alias, check the base name.
2807 (condition-case nil
2808 (setq sym (indirect-variable sym))
2809 (error nil))
2810 (or (get sym 'risky-local-variable)
2811 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2812 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2813 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
2814 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
2815
2816 (defun hack-one-local-variable-quotep (exp)
2817 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2818
2819 (defun hack-one-local-variable-constantp (exp)
2820 (or (and (not (symbolp exp)) (not (consp exp)))
2821 (memq exp '(t nil))
2822 (keywordp exp)
2823 (hack-one-local-variable-quotep exp)))
2824
2825 (defun hack-one-local-variable-eval-safep (exp)
2826 "Return t if it is safe to eval EXP when it is found in a file."
2827 (or (not (consp exp))
2828 ;; Detect certain `put' expressions.
2829 (and (eq (car exp) 'put)
2830 (hack-one-local-variable-quotep (nth 1 exp))
2831 (hack-one-local-variable-quotep (nth 2 exp))
2832 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2833 (cond ((eq prop 'lisp-indent-hook)
2834 ;; Only allow safe values of lisp-indent-hook;
2835 ;; not functions.
2836 (or (numberp val) (equal val ''defun)))
2837 ((eq prop 'edebug-form-spec)
2838 ;; Only allow indirect form specs.
2839 ;; During bootstrapping, edebug-basic-spec might not be
2840 ;; defined yet.
2841 (and (fboundp 'edebug-basic-spec)
2842 (hack-one-local-variable-quotep val)
2843 (edebug-basic-spec (nth 1 val)))))))
2844 ;; Allow expressions that the user requested.
2845 (member exp safe-local-eval-forms)
2846 ;; Certain functions can be allowed with safe arguments
2847 ;; or can specify verification functions to try.
2848 (and (symbolp (car exp))
2849 (let ((prop (get (car exp) 'safe-local-eval-function)))
2850 (cond ((eq prop t)
2851 (let ((ok t))
2852 (dolist (arg (cdr exp))
2853 (unless (hack-one-local-variable-constantp arg)
2854 (setq ok nil)))
2855 ok))
2856 ((functionp prop)
2857 (funcall prop exp))
2858 ((listp prop)
2859 (let ((ok nil))
2860 (dolist (function prop)
2861 (if (funcall function exp)
2862 (setq ok t)))
2863 ok)))))))
2864
2865 (defun hack-one-local-variable (var val)
2866 "Set local variable VAR with value VAL.
2867 If VAR is `mode', call `VAL-mode' as a function unless it's
2868 already the major mode."
2869 (cond ((eq var 'mode)
2870 (let ((mode (intern (concat (downcase (symbol-name val))
2871 "-mode"))))
2872 (unless (eq (indirect-function mode)
2873 (indirect-function major-mode))
2874 (funcall mode))))
2875 ((eq var 'eval)
2876 (save-excursion (eval val)))
2877 (t
2878 ;; Make sure the string has no text properties.
2879 ;; Some text properties can get evaluated in various ways,
2880 ;; so it is risky to put them on with a local variable list.
2881 (if (stringp val)
2882 (set-text-properties 0 (length val) nil val))
2883 (set (make-local-variable var) val))))
2884
2885 \f
2886 (defcustom change-major-mode-with-file-name t
2887 "Non-nil means \\[write-file] should set the major mode from the file name.
2888 However, the mode will not be changed if
2889 \(1) a local variables list or the `-*-' line specifies a major mode, or
2890 \(2) the current major mode is a \"special\" mode,
2891 \ not suitable for ordinary files, or
2892 \(3) the new file name does not particularly specify any mode."
2893 :type 'boolean
2894 :group 'editing-basics)
2895
2896 (defun set-visited-file-name (filename &optional no-query along-with-file)
2897 "Change name of file visited in current buffer to FILENAME.
2898 This also renames the buffer to correspond to the new file.
2899 The next time the buffer is saved it will go in the newly specified file.
2900 FILENAME nil or an empty string means mark buffer as not visiting any file.
2901 Remember to delete the initial contents of the minibuffer
2902 if you wish to pass an empty string as the argument.
2903
2904 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2905 confirmation in the case where another buffer is already visiting FILENAME.
2906
2907 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2908 the old visited file has been renamed to the new name FILENAME."
2909 (interactive "FSet visited file name: ")
2910 (if (buffer-base-buffer)
2911 (error "An indirect buffer cannot visit a file"))
2912 (let (truename)
2913 (if filename
2914 (setq filename
2915 (if (string-equal filename "")
2916 nil
2917 (expand-file-name filename))))
2918 (if filename
2919 (progn
2920 (setq truename (file-truename filename))
2921 (if find-file-visit-truename
2922 (setq filename truename))))
2923 (if filename
2924 (let ((new-name (file-name-nondirectory filename)))
2925 (if (string= new-name "")
2926 (error "Empty file name"))))
2927 (let ((buffer (and filename (find-buffer-visiting filename))))
2928 (and buffer (not (eq buffer (current-buffer)))
2929 (not no-query)
2930 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
2931 filename)))
2932 (error "Aborted")))
2933 (or (equal filename buffer-file-name)
2934 (progn
2935 (and filename (lock-buffer filename))
2936 (unlock-buffer)))
2937 (setq buffer-file-name filename)
2938 (if filename ; make buffer name reflect filename.
2939 (let ((new-name (file-name-nondirectory buffer-file-name)))
2940 (if (eq system-type 'vax-vms)
2941 (setq new-name (downcase new-name)))
2942 (setq default-directory (file-name-directory buffer-file-name))
2943 ;; If new-name == old-name, renaming would add a spurious <2>
2944 ;; and it's considered as a feature in rename-buffer.
2945 (or (string= new-name (buffer-name))
2946 (rename-buffer new-name t))))
2947 (setq buffer-backed-up nil)
2948 (or along-with-file
2949 (clear-visited-file-modtime))
2950 ;; Abbreviate the file names of the buffer.
2951 (if truename
2952 (progn
2953 (setq buffer-file-truename (abbreviate-file-name truename))
2954 (if find-file-visit-truename
2955 (setq buffer-file-name truename))))
2956 (setq buffer-file-number
2957 (if filename
2958 (nthcdr 10 (file-attributes buffer-file-name))
2959 nil)))
2960 ;; write-file-functions is normally used for things like ftp-find-file
2961 ;; that visit things that are not local files as if they were files.
2962 ;; Changing to visit an ordinary local file instead should flush the hook.
2963 (kill-local-variable 'write-file-functions)
2964 (kill-local-variable 'local-write-file-hooks)
2965 (kill-local-variable 'revert-buffer-function)
2966 (kill-local-variable 'backup-inhibited)
2967 ;; If buffer was read-only because of version control,
2968 ;; that reason is gone now, so make it writable.
2969 (if vc-mode
2970 (setq buffer-read-only nil))
2971 (kill-local-variable 'vc-mode)
2972 ;; Turn off backup files for certain file names.
2973 ;; Since this is a permanent local, the major mode won't eliminate it.
2974 (and buffer-file-name
2975 backup-enable-predicate
2976 (not (funcall backup-enable-predicate buffer-file-name))
2977 (progn
2978 (make-local-variable 'backup-inhibited)
2979 (setq backup-inhibited t)))
2980 (let ((oauto buffer-auto-save-file-name))
2981 ;; If auto-save was not already on, turn it on if appropriate.
2982 (if (not buffer-auto-save-file-name)
2983 (and buffer-file-name auto-save-default
2984 (auto-save-mode t))
2985 ;; If auto save is on, start using a new name.
2986 ;; We deliberately don't rename or delete the old auto save
2987 ;; for the old visited file name. This is because perhaps
2988 ;; the user wants to save the new state and then compare with the
2989 ;; previous state from the auto save file.
2990 (setq buffer-auto-save-file-name
2991 (make-auto-save-file-name)))
2992 ;; Rename the old auto save file if any.
2993 (and oauto buffer-auto-save-file-name
2994 (file-exists-p oauto)
2995 (rename-file oauto buffer-auto-save-file-name t)))
2996 (and buffer-file-name
2997 (not along-with-file)
2998 (set-buffer-modified-p t))
2999 ;; Update the major mode, if the file name determines it.
3000 (condition-case nil
3001 ;; Don't change the mode if it is special.
3002 (or (not change-major-mode-with-file-name)
3003 (get major-mode 'mode-class)
3004 ;; Don't change the mode if the local variable list specifies it.
3005 (hack-local-variables t)
3006 (set-auto-mode t))
3007 (error nil)))
3008
3009 (defun write-file (filename &optional confirm)
3010 "Write current buffer into file FILENAME.
3011 This makes the buffer visit that file, and marks it as not modified.
3012
3013 If you specify just a directory name as FILENAME, that means to use
3014 the default file name but in that directory. You can also yank
3015 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3016
3017 If the buffer is not already visiting a file, the default file name
3018 for the output file is the buffer name.
3019
3020 If optional second arg CONFIRM is non-nil, this function
3021 asks for confirmation before overwriting an existing file.
3022 Interactively, confirmation is required unless you supply a prefix argument."
3023 ;; (interactive "FWrite file: ")
3024 (interactive
3025 (list (if buffer-file-name
3026 (read-file-name "Write file: "
3027 nil nil nil nil)
3028 (read-file-name "Write file: " default-directory
3029 (expand-file-name
3030 (file-name-nondirectory (buffer-name))
3031 default-directory)
3032 nil nil))
3033 (not current-prefix-arg)))
3034 (or (null filename) (string-equal filename "")
3035 (progn
3036 ;; If arg is just a directory,
3037 ;; use the default file name, but in that directory.
3038 (if (file-directory-p filename)
3039 (setq filename (concat (file-name-as-directory filename)
3040 (file-name-nondirectory
3041 (or buffer-file-name (buffer-name))))))
3042 (and confirm
3043 (file-exists-p filename)
3044 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3045 (error "Canceled")))
3046 (set-visited-file-name filename (not confirm))))
3047 (set-buffer-modified-p t)
3048 ;; Make buffer writable if file is writable.
3049 (and buffer-file-name
3050 (file-writable-p buffer-file-name)
3051 (setq buffer-read-only nil))
3052 (save-buffer)
3053 ;; It's likely that the VC status at the new location is different from
3054 ;; the one at the old location.
3055 (vc-find-file-hook))
3056 \f
3057 (defun backup-buffer ()
3058 "Make a backup of the disk file visited by the current buffer, if appropriate.
3059 This is normally done before saving the buffer the first time.
3060
3061 A backup may be done by renaming or by copying; see documentation of
3062 variable `make-backup-files'. If it's done by renaming, then the file is
3063 no longer accessible under its old name.
3064
3065 The value is non-nil after a backup was made by renaming.
3066 It has the form (MODES . BACKUPNAME).
3067 MODES is the result of `file-modes' on the original
3068 file; this means that the caller, after saving the buffer, should change
3069 the modes of the new file to agree with the old modes.
3070 BACKUPNAME is the backup file name, which is the old file renamed."
3071 (if (and make-backup-files (not backup-inhibited)
3072 (not buffer-backed-up)
3073 (file-exists-p buffer-file-name)
3074 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3075 '(?- ?l)))
3076 (let ((real-file-name buffer-file-name)
3077 backup-info backupname targets setmodes)
3078 ;; If specified name is a symbolic link, chase it to the target.
3079 ;; Thus we make the backups in the directory where the real file is.
3080 (setq real-file-name (file-chase-links real-file-name))
3081 (setq backup-info (find-backup-file-name real-file-name)
3082 backupname (car backup-info)
3083 targets (cdr backup-info))
3084 ;; (if (file-directory-p buffer-file-name)
3085 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3086 (if backup-info
3087 (condition-case ()
3088 (let ((delete-old-versions
3089 ;; If have old versions to maybe delete,
3090 ;; ask the user to confirm now, before doing anything.
3091 ;; But don't actually delete til later.
3092 (and targets
3093 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3094 (or delete-old-versions
3095 (y-or-n-p (format "Delete excess backup versions of %s? "
3096 real-file-name)))))
3097 (modes (file-modes buffer-file-name)))
3098 ;; Actually write the back up file.
3099 (condition-case ()
3100 (if (or file-precious-flag
3101 ; (file-symlink-p buffer-file-name)
3102 backup-by-copying
3103 ;; Don't rename a suid or sgid file.
3104 (and modes (< 0 (logand modes #o6000)))
3105 (not (file-writable-p (file-name-directory real-file-name)))
3106 (and backup-by-copying-when-linked
3107 (> (file-nlinks real-file-name) 1))
3108 (and (or backup-by-copying-when-mismatch
3109 (integerp backup-by-copying-when-privileged-mismatch))
3110 (let ((attr (file-attributes real-file-name)))
3111 (and (or backup-by-copying-when-mismatch
3112 (and (integerp (nth 2 attr))
3113 (integerp backup-by-copying-when-privileged-mismatch)
3114 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3115 (or (nth 9 attr)
3116 (not (file-ownership-preserved-p real-file-name)))))))
3117 (backup-buffer-copy real-file-name backupname modes)
3118 ;; rename-file should delete old backup.
3119 (rename-file real-file-name backupname t)
3120 (setq setmodes (cons modes backupname)))
3121 (file-error
3122 ;; If trouble writing the backup, write it in ~.
3123 (setq backupname (expand-file-name
3124 (convert-standard-filename
3125 "~/%backup%~")))
3126 (message "Cannot write backup file; backing up in %s"
3127 backupname)
3128 (sleep-for 1)
3129 (backup-buffer-copy real-file-name backupname modes)))
3130 (setq buffer-backed-up t)
3131 ;; Now delete the old versions, if desired.
3132 (if delete-old-versions
3133 (while targets
3134 (condition-case ()
3135 (delete-file (car targets))
3136 (file-error nil))
3137 (setq targets (cdr targets))))
3138 setmodes)
3139 (file-error nil))))))
3140
3141 (defun backup-buffer-copy (from-name to-name modes)
3142 (let ((umask (default-file-modes)))
3143 (unwind-protect
3144 (progn
3145 ;; Create temp files with strict access rights. It's easy to
3146 ;; loosen them later, whereas it's impossible to close the
3147 ;; time-window of loose permissions otherwise.
3148 (set-default-file-modes ?\700)
3149 (while (condition-case ()
3150 (progn
3151 (condition-case nil
3152 (delete-file to-name)
3153 (file-error nil))
3154 (copy-file from-name to-name nil t)
3155 nil)
3156 (file-already-exists t))
3157 ;; The file was somehow created by someone else between
3158 ;; `delete-file' and `copy-file', so let's try again.
3159 nil))
3160 ;; Reset the umask.
3161 (set-default-file-modes umask)))
3162 (and modes
3163 (set-file-modes to-name (logand modes #o1777))))
3164
3165 (defun file-name-sans-versions (name &optional keep-backup-version)
3166 "Return file NAME sans backup versions or strings.
3167 This is a separate procedure so your site-init or startup file can
3168 redefine it.
3169 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3170 we do not remove backup version numbers, only true file version numbers."
3171 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3172 (if handler
3173 (funcall handler 'file-name-sans-versions name keep-backup-version)
3174 (substring name 0
3175 (if (eq system-type 'vax-vms)
3176 ;; VMS version number is (a) semicolon, optional
3177 ;; sign, zero or more digits or (b) period, option
3178 ;; sign, zero or more digits, provided this is the
3179 ;; second period encountered outside of the
3180 ;; device/directory part of the file name.
3181 (or (string-match ";[-+]?[0-9]*\\'" name)
3182 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
3183 name)
3184 (match-beginning 1))
3185 (length name))
3186 (if keep-backup-version
3187 (length name)
3188 (or (string-match "\\.~[0-9.]+~\\'" name)
3189 (string-match "~\\'" name)
3190 (length name))))))))
3191
3192 (defun file-ownership-preserved-p (file)
3193 "Return t if deleting FILE and rewriting it would preserve the owner."
3194 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3195 (if handler
3196 (funcall handler 'file-ownership-preserved-p file)
3197 (let ((attributes (file-attributes file)))
3198 ;; Return t if the file doesn't exist, since it's true that no
3199 ;; information would be lost by an (attempted) delete and create.
3200 (or (null attributes)
3201 (= (nth 2 attributes) (user-uid)))))))
3202
3203 (defun file-name-sans-extension (filename)
3204 "Return FILENAME sans final \"extension\".
3205 The extension, in a file name, is the part that follows the last `.',
3206 except that a leading `.', if any, doesn't count."
3207 (save-match-data
3208 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3209 directory)
3210 (if (and (string-match "\\.[^.]*\\'" file)
3211 (not (eq 0 (match-beginning 0))))
3212 (if (setq directory (file-name-directory filename))
3213 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3214 ;; we don't want to expand it.
3215 (concat directory (substring file 0 (match-beginning 0)))
3216 (substring file 0 (match-beginning 0)))
3217 filename))))
3218
3219 (defun file-name-extension (filename &optional period)
3220 "Return FILENAME's final \"extension\".
3221 The extension, in a file name, is the part that follows the last `.',
3222 excluding version numbers and backup suffixes,
3223 except that a leading `.', if any, doesn't count.
3224 Return nil for extensionless file names such as `foo'.
3225 Return the empty string for file names such as `foo.'.
3226
3227 If PERIOD is non-nil, then the returned value includes the period
3228 that delimits the extension, and if FILENAME has no extension,
3229 the value is \"\"."
3230 (save-match-data
3231 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3232 (if (and (string-match "\\.[^.]*\\'" file)
3233 (not (eq 0 (match-beginning 0))))
3234 (substring file (+ (match-beginning 0) (if period 0 1)))
3235 (if period
3236 "")))))
3237
3238 (defcustom make-backup-file-name-function nil
3239 "A function to use instead of the default `make-backup-file-name'.
3240 A value of nil gives the default `make-backup-file-name' behavior.
3241
3242 This could be buffer-local to do something special for specific
3243 files. If you define it, you may need to change `backup-file-name-p'
3244 and `file-name-sans-versions' too.
3245
3246 See also `backup-directory-alist'."
3247 :group 'backup
3248 :type '(choice (const :tag "Default" nil)
3249 (function :tag "Your function")))
3250
3251 (defcustom backup-directory-alist nil
3252 "Alist of filename patterns and backup directory names.
3253 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3254 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3255 relative or absolute. If it is absolute, so that all matching files
3256 are backed up into the same directory, the file names in this
3257 directory will be the full name of the file backed up with all
3258 directory separators changed to `!' to prevent clashes. This will not
3259 work correctly if your filesystem truncates the resulting name.
3260
3261 For the common case of all backups going into one directory, the alist
3262 should contain a single element pairing \".\" with the appropriate
3263 directory name.
3264
3265 If this variable is nil, or it fails to match a filename, the backup
3266 is made in the original file's directory.
3267
3268 On MS-DOS filesystems without long names this variable is always
3269 ignored."
3270 :group 'backup
3271 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3272 (directory :tag "Backup directory name"))))
3273
3274 (defun normal-backup-enable-predicate (name)
3275 "Default `backup-enable-predicate' function.
3276 Checks for files in `temporary-file-directory',
3277 `small-temporary-file-directory', and /tmp."
3278 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3279 name 0 nil)))
3280 ;; Directory is under temporary-file-directory.
3281 (and (not (eq comp t))
3282 (< comp (- (length temporary-file-directory)))))
3283 (let ((comp (compare-strings "/tmp" 0 nil
3284 name 0 nil)))
3285 ;; Directory is under /tmp.
3286 (and (not (eq comp t))
3287 (< comp (- (length "/tmp")))))
3288 (if small-temporary-file-directory
3289 (let ((comp (compare-strings small-temporary-file-directory
3290 0 nil
3291 name 0 nil)))
3292 ;; Directory is under small-temporary-file-directory.
3293 (and (not (eq comp t))
3294 (< comp (- (length small-temporary-file-directory)))))))))
3295
3296 (defun make-backup-file-name (file)
3297 "Create the non-numeric backup file name for FILE.
3298 Normally this will just be the file's name with `~' appended.
3299 Customization hooks are provided as follows.
3300
3301 If the variable `make-backup-file-name-function' is non-nil, its value
3302 should be a function which will be called with FILE as its argument;
3303 the resulting name is used.
3304
3305 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3306 the documentation of that variable. If the directory for the backup
3307 doesn't exist, it is created."
3308 (if make-backup-file-name-function
3309 (funcall make-backup-file-name-function file)
3310 (if (and (eq system-type 'ms-dos)
3311 (not (msdos-long-file-names)))
3312 (let ((fn (file-name-nondirectory file)))
3313 (concat (file-name-directory file)
3314 (or (and (string-match "\\`[^.]+\\'" fn)
3315 (concat (match-string 0 fn) ".~"))
3316 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3317 (concat (match-string 0 fn) "~")))))
3318 (concat (make-backup-file-name-1 file) "~"))))
3319
3320 (defun make-backup-file-name-1 (file)
3321 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3322 (let ((alist backup-directory-alist)
3323 elt backup-directory abs-backup-directory)
3324 (while alist
3325 (setq elt (pop alist))
3326 (if (string-match (car elt) file)
3327 (setq backup-directory (cdr elt)
3328 alist nil)))
3329 ;; If backup-directory is relative, it should be relative to the
3330 ;; file's directory. By expanding explicitly here, we avoid
3331 ;; depending on default-directory.
3332 (if backup-directory
3333 (setq abs-backup-directory
3334 (expand-file-name backup-directory
3335 (file-name-directory file))))
3336 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3337 (condition-case nil
3338 (make-directory abs-backup-directory 'parents)
3339 (file-error (setq backup-directory nil
3340 abs-backup-directory nil))))
3341 (if (null backup-directory)
3342 file
3343 (if (file-name-absolute-p backup-directory)
3344 (progn
3345 (when (memq system-type '(windows-nt ms-dos cygwin))
3346 ;; Normalize DOSish file names: downcase the drive
3347 ;; letter, if any, and replace the leading "x:" with
3348 ;; "/drive_x".
3349 (or (file-name-absolute-p file)
3350 (setq file (expand-file-name file))) ; make defaults explicit
3351 ;; Replace any invalid file-name characters (for the
3352 ;; case of backing up remote files).
3353 (setq file (expand-file-name (convert-standard-filename file)))
3354 (if (eq (aref file 1) ?:)
3355 (setq file (concat "/"
3356 "drive_"
3357 (char-to-string (downcase (aref file 0)))
3358 (if (eq (aref file 2) ?/)
3359 ""
3360 "/")
3361 (substring file 2)))))
3362 ;; Make the name unique by substituting directory
3363 ;; separators. It may not really be worth bothering about
3364 ;; doubling `!'s in the original name...
3365 (expand-file-name
3366 (subst-char-in-string
3367 ?/ ?!
3368 (replace-regexp-in-string "!" "!!" file))
3369 backup-directory))
3370 (expand-file-name (file-name-nondirectory file)
3371 (file-name-as-directory abs-backup-directory))))))
3372
3373 (defun backup-file-name-p (file)
3374 "Return non-nil if FILE is a backup file name (numeric or not).
3375 This is a separate function so you can redefine it for customization.
3376 You may need to redefine `file-name-sans-versions' as well."
3377 (string-match "~\\'" file))
3378
3379 (defvar backup-extract-version-start)
3380
3381 ;; This is used in various files.
3382 ;; The usage of backup-extract-version-start is not very clean,
3383 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3384 (defun backup-extract-version (fn)
3385 "Given the name of a numeric backup file, FN, return the backup number.
3386 Uses the free variable `backup-extract-version-start', whose value should be
3387 the index in the name where the version number begins."
3388 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3389 (= (match-beginning 0) backup-extract-version-start))
3390 (string-to-number (substring fn backup-extract-version-start -1))
3391 0))
3392
3393 ;; I believe there is no need to alter this behavior for VMS;
3394 ;; since backup files are not made on VMS, it should not get called.
3395 (defun find-backup-file-name (fn)
3396 "Find a file name for a backup file FN, and suggestions for deletions.
3397 Value is a list whose car is the name for the backup file
3398 and whose cdr is a list of old versions to consider deleting now.
3399 If the value is nil, don't make a backup.
3400 Uses `backup-directory-alist' in the same way as does
3401 `make-backup-file-name'."
3402 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3403 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3404 (if handler
3405 (funcall handler 'find-backup-file-name fn)
3406 (if (or (eq version-control 'never)
3407 ;; We don't support numbered backups on plain MS-DOS
3408 ;; when long file names are unavailable.
3409 (and (eq system-type 'ms-dos)
3410 (not (msdos-long-file-names))))
3411 (list (make-backup-file-name fn))
3412 (let* ((basic-name (make-backup-file-name-1 fn))
3413 (base-versions (concat (file-name-nondirectory basic-name)
3414 ".~"))
3415 (backup-extract-version-start (length base-versions))
3416 (high-water-mark 0)
3417 (number-to-delete 0)
3418 possibilities deserve-versions-p versions)
3419 (condition-case ()
3420 (setq possibilities (file-name-all-completions
3421 base-versions
3422 (file-name-directory basic-name))
3423 versions (sort (mapcar #'backup-extract-version
3424 possibilities)
3425 #'<)
3426 high-water-mark (apply 'max 0 versions)
3427 deserve-versions-p (or version-control
3428 (> high-water-mark 0))
3429 number-to-delete (- (length versions)
3430 kept-old-versions
3431 kept-new-versions
3432 -1))
3433 (file-error (setq possibilities nil)))
3434 (if (not deserve-versions-p)
3435 (list (make-backup-file-name fn))
3436 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3437 (if (and (> number-to-delete 0)
3438 ;; Delete nothing if there is overflow
3439 ;; in the number of versions to keep.
3440 (>= (+ kept-new-versions kept-old-versions -1) 0))
3441 (mapcar (lambda (n)
3442 (format "%s.~%d~" basic-name n))
3443 (let ((v (nthcdr kept-old-versions versions)))
3444 (rplacd (nthcdr (1- number-to-delete) v) ())
3445 v))))))))))
3446
3447 (defun file-nlinks (filename)
3448 "Return number of names file FILENAME has."
3449 (car (cdr (file-attributes filename))))
3450
3451 ;; (defun file-relative-name (filename &optional directory)
3452 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3453 ;; This function returns a relative file name which is equivalent to FILENAME
3454 ;; when used with that default directory as the default.
3455 ;; If this is impossible (which can happen on MSDOS and Windows
3456 ;; when the file name and directory use different drive names)
3457 ;; then it returns FILENAME."
3458 ;; (save-match-data
3459 ;; (let ((fname (expand-file-name filename)))
3460 ;; (setq directory (file-name-as-directory
3461 ;; (expand-file-name (or directory default-directory))))
3462 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3463 ;; ;; drive names, they can't be relative, so return the absolute name.
3464 ;; (if (and (or (eq system-type 'ms-dos)
3465 ;; (eq system-type 'cygwin)
3466 ;; (eq system-type 'windows-nt))
3467 ;; (not (string-equal (substring fname 0 2)
3468 ;; (substring directory 0 2))))
3469 ;; filename
3470 ;; (let ((ancestor ".")
3471 ;; (fname-dir (file-name-as-directory fname)))
3472 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3473 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3474 ;; (setq directory (file-name-directory (substring directory 0 -1))
3475 ;; ancestor (if (equal ancestor ".")
3476 ;; ".."
3477 ;; (concat "../" ancestor))))
3478 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3479 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3480 ;; ;; We matched within FNAME's directory part.
3481 ;; ;; Add the rest of FNAME onto ANCESTOR.
3482 ;; (let ((rest (substring fname (match-end 0))))
3483 ;; (if (and (equal ancestor ".")
3484 ;; (not (equal rest "")))
3485 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3486 ;; rest
3487 ;; (concat (file-name-as-directory ancestor) rest)))
3488 ;; ;; We matched FNAME's directory equivalent.
3489 ;; ancestor))))))
3490
3491 (defun file-relative-name (filename &optional directory)
3492 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3493 This function returns a relative file name which is equivalent to FILENAME
3494 when used with that default directory as the default.
3495 If FILENAME and DIRECTORY lie on different machines or on different drives
3496 on a DOS/Windows machine, it returns FILENAME in expanded form."
3497 (save-match-data
3498 (setq directory
3499 (file-name-as-directory (expand-file-name (or directory
3500 default-directory))))
3501 (setq filename (expand-file-name filename))
3502 (let ((fremote (file-remote-p filename))
3503 (dremote (file-remote-p directory)))
3504 (if ;; Conditions for separate trees
3505 (or
3506 ;; Test for different drives on DOS/Windows
3507 (and
3508 ;; Should `cygwin' really be included here? --stef
3509 (memq system-type '(ms-dos cygwin windows-nt))
3510 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3511 ;; Test for different remote file system identification
3512 (not (equal fremote dremote)))
3513 filename
3514 (let ((ancestor ".")
3515 (filename-dir (file-name-as-directory filename)))
3516 (while (not
3517 (or
3518 (eq t (compare-strings filename-dir nil (length directory)
3519 directory nil nil case-fold-search))
3520 (eq t (compare-strings filename nil (length directory)
3521 directory nil nil case-fold-search))))
3522 (setq directory (file-name-directory (substring directory 0 -1))
3523 ancestor (if (equal ancestor ".")
3524 ".."
3525 (concat "../" ancestor))))
3526 ;; Now ancestor is empty, or .., or ../.., etc.
3527 (if (eq t (compare-strings filename nil (length directory)
3528 directory nil nil case-fold-search))
3529 ;; We matched within FILENAME's directory part.
3530 ;; Add the rest of FILENAME onto ANCESTOR.
3531 (let ((rest (substring filename (length directory))))
3532 (if (and (equal ancestor ".") (not (equal rest "")))
3533 ;; But don't bother with ANCESTOR if it would give us `./'.
3534 rest
3535 (concat (file-name-as-directory ancestor) rest)))
3536 ;; We matched FILENAME's directory equivalent.
3537 ancestor))))))
3538 \f
3539 (defun save-buffer (&optional args)
3540 "Save current buffer in visited file if modified.
3541 Variations are described below.
3542
3543 By default, makes the previous version into a backup file
3544 if previously requested or if this is the first save.
3545 Prefixed with one \\[universal-argument], marks this version
3546 to become a backup when the next save is done.
3547 Prefixed with two \\[universal-argument]'s,
3548 unconditionally makes the previous version into a backup file.
3549 Prefixed with three \\[universal-argument]'s, marks this version
3550 to become a backup when the next save is done,
3551 and unconditionally makes the previous version into a backup file.
3552
3553 With a numeric argument of 0, never make the previous version
3554 into a backup file.
3555
3556 If a file's name is FOO, the names of its numbered backup versions are
3557 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3558 Numeric backups (rather than FOO~) will be made if value of
3559 `version-control' is not the atom `never' and either there are already
3560 numeric versions of the file being backed up, or `version-control' is
3561 non-nil.
3562 We don't want excessive versions piling up, so there are variables
3563 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3564 and `kept-new-versions', which tells how many newest versions to keep.
3565 Defaults are 2 old versions and 2 new.
3566 `dired-kept-versions' controls dired's clean-directory (.) command.
3567 If `delete-old-versions' is nil, system will query user
3568 before trimming versions. Otherwise it does it silently.
3569
3570 If `vc-make-backup-files' is nil, which is the default,
3571 no backup files are made for files managed by version control.
3572 (This is because the version control system itself records previous versions.)
3573
3574 See the subroutine `basic-save-buffer' for more information."
3575 (interactive "p")
3576 (let ((modp (buffer-modified-p))
3577 (large (> (buffer-size) 50000))
3578 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3579 (memq args '(16 64)))))
3580 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3581 (if (and modp large (buffer-file-name))
3582 (message "Saving file %s..." (buffer-file-name)))
3583 (basic-save-buffer)
3584 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3585
3586 (defun delete-auto-save-file-if-necessary (&optional force)
3587 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3588 Normally delete only if the file was written by this Emacs since
3589 the last real save, but optional arg FORCE non-nil means delete anyway."
3590 (and buffer-auto-save-file-name delete-auto-save-files
3591 (not (string= buffer-file-name buffer-auto-save-file-name))
3592 (or force (recent-auto-save-p))
3593 (progn
3594 (condition-case ()
3595 (delete-file buffer-auto-save-file-name)
3596 (file-error nil))
3597 (set-buffer-auto-saved))))
3598
3599 (defvar auto-save-hook nil
3600 "Normal hook run just before auto-saving.")
3601
3602 (defcustom before-save-hook nil
3603 "Normal hook that is run before a buffer is saved to its file."
3604 :options '(copyright-update time-stamp)
3605 :type 'hook
3606 :group 'files)
3607
3608 (defcustom after-save-hook nil
3609 "Normal hook that is run after a buffer is saved to its file."
3610 :options '(executable-make-buffer-file-executable-if-script-p)
3611 :type 'hook
3612 :group 'files)
3613
3614 (defvar save-buffer-coding-system nil
3615 "If non-nil, use this coding system for saving the buffer.
3616 More precisely, use this coding system in place of the
3617 value of `buffer-file-coding-system', when saving the buffer.
3618 Calling `write-region' for any purpose other than saving the buffer
3619 will still use `buffer-file-coding-system'; this variable has no effect
3620 in such cases.")
3621
3622 (make-variable-buffer-local 'save-buffer-coding-system)
3623 (put 'save-buffer-coding-system 'permanent-local t)
3624
3625 (defun basic-save-buffer ()
3626 "Save the current buffer in its visited file, if it has been modified.
3627 The hooks `write-contents-functions' and `write-file-functions' get a chance
3628 to do the job of saving; if they do not, then the buffer is saved in
3629 the visited file in the usual way.
3630 Before and after saving the buffer, this function runs
3631 `before-save-hook' and `after-save-hook', respectively."
3632 (interactive)
3633 (save-current-buffer
3634 ;; In an indirect buffer, save its base buffer instead.
3635 (if (buffer-base-buffer)
3636 (set-buffer (buffer-base-buffer)))
3637 (if (buffer-modified-p)
3638 (let ((recent-save (recent-auto-save-p))
3639 setmodes)
3640 ;; On VMS, rename file and buffer to get rid of version number.
3641 (if (and (eq system-type 'vax-vms)
3642 (not (string= buffer-file-name
3643 (file-name-sans-versions buffer-file-name))))
3644 (let (buffer-new-name)
3645 ;; Strip VMS version number before save.
3646 (setq buffer-file-name
3647 (file-name-sans-versions buffer-file-name))
3648 ;; Construct a (unique) buffer name to correspond.
3649 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3650 (setq buffer-new-name (buffer-name buf))
3651 (kill-buffer buf))
3652 (rename-buffer buffer-new-name)))
3653 ;; If buffer has no file name, ask user for one.
3654 (or buffer-file-name
3655 (let ((filename
3656 (expand-file-name
3657 (read-file-name "File to save in: ") nil)))
3658 (if (file-exists-p filename)
3659 (if (file-directory-p filename)
3660 ;; Signal an error if the user specified the name of an
3661 ;; existing directory.
3662 (error "%s is a directory" filename)
3663 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3664 filename))
3665 (error "Canceled")))
3666 ;; Signal an error if the specified name refers to a
3667 ;; non-existing directory.
3668 (let ((dir (file-name-directory filename)))
3669 (unless (file-directory-p dir)
3670 (if (file-exists-p dir)
3671 (error "%s is not a directory" dir)
3672 (error "%s: no such directory" dir)))))
3673 (set-visited-file-name filename)))
3674 (or (verify-visited-file-modtime (current-buffer))
3675 (not (file-exists-p buffer-file-name))
3676 (yes-or-no-p
3677 (format "%s has changed since visited or saved. Save anyway? "
3678 (file-name-nondirectory buffer-file-name)))
3679 (error "Save not confirmed"))
3680 (save-restriction
3681 (widen)
3682 (save-excursion
3683 (and (> (point-max) (point-min))
3684 (not find-file-literally)
3685 (/= (char-after (1- (point-max))) ?\n)
3686 (not (and (eq selective-display t)
3687 (= (char-after (1- (point-max))) ?\r)))
3688 (or (eq require-final-newline t)
3689 (eq require-final-newline 'visit-save)
3690 (and require-final-newline
3691 (y-or-n-p
3692 (format "Buffer %s does not end in newline. Add one? "
3693 (buffer-name)))))
3694 (save-excursion
3695 (goto-char (point-max))
3696 (insert ?\n))))
3697 ;; Support VC version backups.
3698 (vc-before-save)
3699 (run-hooks 'before-save-hook)
3700 (or (run-hook-with-args-until-success 'write-contents-functions)
3701 (run-hook-with-args-until-success 'local-write-file-hooks)
3702 (run-hook-with-args-until-success 'write-file-functions)
3703 ;; If a hook returned t, file is already "written".
3704 ;; Otherwise, write it the usual way now.
3705 (setq setmodes (basic-save-buffer-1)))
3706 ;; Now we have saved the current buffer. Let's make sure
3707 ;; that buffer-file-coding-system is fixed to what
3708 ;; actually used for saving by binding it locally.
3709 (if save-buffer-coding-system
3710 (setq save-buffer-coding-system last-coding-system-used)
3711 (setq buffer-file-coding-system last-coding-system-used))
3712 (setq buffer-file-number
3713 (nthcdr 10 (file-attributes buffer-file-name)))
3714 (if setmodes
3715 (condition-case ()
3716 (set-file-modes buffer-file-name (car setmodes))
3717 (error nil))))
3718 ;; If the auto-save file was recent before this command,
3719 ;; delete it now.
3720 (delete-auto-save-file-if-necessary recent-save)
3721 ;; Support VC `implicit' locking.
3722 (vc-after-save)
3723 (run-hooks 'after-save-hook))
3724 (message "(No changes need to be saved)"))))
3725
3726 ;; This does the "real job" of writing a buffer into its visited file
3727 ;; and making a backup file. This is what is normally done
3728 ;; but inhibited if one of write-file-functions returns non-nil.
3729 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3730 (defun basic-save-buffer-1 ()
3731 (prog1
3732 (if save-buffer-coding-system
3733 (let ((coding-system-for-write save-buffer-coding-system))
3734 (basic-save-buffer-2))
3735 (basic-save-buffer-2))
3736 (setq buffer-file-coding-system-explicit last-coding-system-used)))
3737
3738 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3739 (defun basic-save-buffer-2 ()
3740 (let (tempsetmodes setmodes)
3741 (if (not (file-writable-p buffer-file-name))
3742 (let ((dir (file-name-directory buffer-file-name)))
3743 (if (not (file-directory-p dir))
3744 (if (file-exists-p dir)
3745 (error "%s is not a directory" dir)
3746 (error "%s: no such directory" dir))
3747 (if (not (file-exists-p buffer-file-name))
3748 (error "Directory %s write-protected" dir)
3749 (if (yes-or-no-p
3750 (format "File %s is write-protected; try to save anyway? "
3751 (file-name-nondirectory
3752 buffer-file-name)))
3753 (setq tempsetmodes t)
3754 (error "Attempt to save to a file which you aren't allowed to write"))))))
3755 (or buffer-backed-up
3756 (setq setmodes (backup-buffer)))
3757 (let ((dir (file-name-directory buffer-file-name)))
3758 (if (and file-precious-flag
3759 (file-writable-p dir))
3760 ;; If file is precious, write temp name, then rename it.
3761 ;; This requires write access to the containing dir,
3762 ;; which is why we don't try it if we don't have that access.
3763 (let ((realname buffer-file-name)
3764 tempname succeed
3765 (umask (default-file-modes))
3766 (old-modtime (visited-file-modtime)))
3767 ;; Create temp files with strict access rights. It's easy to
3768 ;; loosen them later, whereas it's impossible to close the
3769 ;; time-window of loose permissions otherwise.
3770 (unwind-protect
3771 (progn
3772 (clear-visited-file-modtime)
3773 (set-default-file-modes ?\700)
3774 ;; Try various temporary names.
3775 ;; This code follows the example of make-temp-file,
3776 ;; but it calls write-region in the appropriate way
3777 ;; for saving the buffer.
3778 (while (condition-case ()
3779 (progn
3780 (setq tempname
3781 (make-temp-name
3782 (expand-file-name "tmp" dir)))
3783 (write-region (point-min) (point-max)
3784 tempname nil realname
3785 buffer-file-truename 'excl)
3786 nil)
3787 (file-already-exists t))
3788 ;; The file was somehow created by someone else between
3789 ;; `make-temp-name' and `write-region', let's try again.
3790 nil)
3791 (setq succeed t))
3792 ;; Reset the umask.
3793 (set-default-file-modes umask)
3794 ;; If we failed, restore the buffer's modtime.
3795 (unless succeed
3796 (set-visited-file-modtime old-modtime)))
3797 ;; Since we have created an entirely new file,
3798 ;; make sure it gets the right permission bits set.
3799 (setq setmodes (or setmodes
3800 (cons (or (file-modes buffer-file-name)
3801 (logand ?\666 umask))
3802 buffer-file-name)))
3803 ;; We succeeded in writing the temp file,
3804 ;; so rename it.
3805 (rename-file tempname buffer-file-name t))
3806 ;; If file not writable, see if we can make it writable
3807 ;; temporarily while we write it.
3808 ;; But no need to do so if we have just backed it up
3809 ;; (setmodes is set) because that says we're superseding.
3810 (cond ((and tempsetmodes (not setmodes))
3811 ;; Change the mode back, after writing.
3812 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3813 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3814 (let (success)
3815 (unwind-protect
3816 (progn
3817 (write-region (point-min) (point-max)
3818 buffer-file-name nil t buffer-file-truename)
3819 (setq success t))
3820 ;; If we get an error writing the new file, and we made
3821 ;; the backup by renaming, undo the backing-up.
3822 (and setmodes (not success)
3823 (progn
3824 (rename-file (cdr setmodes) buffer-file-name t)
3825 (setq buffer-backed-up nil)))))))
3826 setmodes))
3827
3828 (defun diff-buffer-with-file (&optional buffer)
3829 "View the differences between BUFFER and its associated file.
3830 This requires the external program `diff' to be in your `exec-path'."
3831 (interactive "bBuffer: ")
3832 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3833 (if (and buffer-file-name
3834 (file-exists-p buffer-file-name))
3835 (let ((tempfile (make-temp-file "buffer-content-")))
3836 (unwind-protect
3837 (save-restriction
3838 (widen)
3839 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3840 (diff buffer-file-name tempfile nil t)
3841 (sit-for 0))
3842 (when (file-exists-p tempfile)
3843 (delete-file tempfile))))
3844 (message "Buffer %s has no associated file on disc" (buffer-name))
3845 ;; Display that message for 1 second so that user can read it
3846 ;; in the minibuffer.
3847 (sit-for 1)))
3848 ;; return always nil, so that save-buffers-kill-emacs will not move
3849 ;; over to the next unsaved buffer when calling `d'.
3850 nil)
3851
3852 (defvar save-some-buffers-action-alist
3853 '((?\C-r
3854 (lambda (buf)
3855 (view-buffer buf
3856 (lambda (ignore)
3857 (exit-recursive-edit)))
3858 (recursive-edit)
3859 ;; Return nil to ask about BUF again.
3860 nil)
3861 "view this buffer")
3862 (?d (lambda (buf)
3863 (save-window-excursion
3864 (diff-buffer-with-file buf))
3865 (view-buffer (get-buffer-create "*Diff*")
3866 (lambda (ignore) (exit-recursive-edit)))
3867 (recursive-edit)
3868 nil)
3869 "view changes in this buffer"))
3870 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3871
3872 (defvar buffer-save-without-query nil
3873 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3874 (make-variable-buffer-local 'buffer-save-without-query)
3875
3876 (defun save-some-buffers (&optional arg pred)
3877 "Save some modified file-visiting buffers. Asks user about each one.
3878 You can answer `y' to save, `n' not to save, `C-r' to look at the
3879 buffer in question with `view-buffer' before deciding or `d' to
3880 view the differences using `diff-buffer-with-file'.
3881
3882 Optional argument (the prefix) non-nil means save all with no questions.
3883 Optional second argument PRED determines which buffers are considered:
3884 If PRED is nil, all the file-visiting buffers are considered.
3885 If PRED is t, then certain non-file buffers will also be considered.
3886 If PRED is a zero-argument function, it indicates for each buffer whether
3887 to consider it or not when called with that buffer current.
3888
3889 See `save-some-buffers-action-alist' if you want to
3890 change the additional actions you can take on files."
3891 (interactive "P")
3892 (save-window-excursion
3893 (let* (queried some-automatic
3894 files-done abbrevs-done)
3895 (dolist (buffer (buffer-list))
3896 ;; First save any buffers that we're supposed to save unconditionally.
3897 ;; That way the following code won't ask about them.
3898 (with-current-buffer buffer
3899 (when (and buffer-save-without-query (buffer-modified-p))
3900 (setq some-automatic t)
3901 (save-buffer))))
3902 ;; Ask about those buffers that merit it,
3903 ;; and record the number thus saved.
3904 (setq files-done
3905 (map-y-or-n-p
3906 (function
3907 (lambda (buffer)
3908 (and (buffer-modified-p buffer)
3909 (not (buffer-base-buffer buffer))
3910 (or
3911 (buffer-file-name buffer)
3912 (and pred
3913 (progn
3914 (set-buffer buffer)
3915 (and buffer-offer-save (> (buffer-size) 0)))))
3916 (or (not (functionp pred))
3917 (with-current-buffer buffer (funcall pred)))
3918 (if arg
3919 t
3920 (setq queried t)
3921 (if (buffer-file-name buffer)
3922 (format "Save file %s? "
3923 (buffer-file-name buffer))
3924 (format "Save buffer %s? "
3925 (buffer-name buffer)))))))
3926 (function
3927 (lambda (buffer)
3928 (set-buffer buffer)
3929 (save-buffer)))
3930 (buffer-list)
3931 '("buffer" "buffers" "save")
3932 save-some-buffers-action-alist))
3933 ;; Maybe to save abbrevs, and record whether
3934 ;; we either saved them or asked to.
3935 (and save-abbrevs abbrevs-changed
3936 (progn
3937 (if (or arg
3938 (eq save-abbrevs 'silently)
3939 (y-or-n-p (format "Save abbrevs in %s? "
3940 abbrev-file-name)))
3941 (write-abbrev-file nil))
3942 ;; Don't keep bothering user if he says no.
3943 (setq abbrevs-changed nil)
3944 (setq abbrevs-done t)))
3945 (or queried (> files-done 0) abbrevs-done
3946 (message (if some-automatic
3947 "(Some special files were saved without asking)"
3948 "(No files need saving)"))))))
3949 \f
3950 (defun not-modified (&optional arg)
3951 "Mark current buffer as unmodified, not needing to be saved.
3952 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3953
3954 It is not a good idea to use this function in Lisp programs, because it
3955 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3956 (interactive "P")
3957 (message (if arg "Modification-flag set"
3958 "Modification-flag cleared"))
3959 (set-buffer-modified-p arg))
3960
3961 (defun toggle-read-only (&optional arg)
3962 "Change whether this buffer is visiting its file read-only.
3963 With arg, set read-only iff arg is positive.
3964 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3965 (interactive "P")
3966 (if (and arg
3967 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3968 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3969 nil ; do nothing.
3970 ;; Toggle.
3971 (cond
3972 ((and buffer-read-only view-mode)
3973 (View-exit-and-edit)
3974 (make-local-variable 'view-read-only)
3975 (setq view-read-only t)) ; Must leave view mode.
3976 ((and (not buffer-read-only) view-read-only
3977 ;; If view-mode is already active, `view-mode-enter' is a nop.
3978 (not view-mode)
3979 (not (eq (get major-mode 'mode-class) 'special)))
3980 (view-mode-enter))
3981 (t (setq buffer-read-only (not buffer-read-only))
3982 (force-mode-line-update)))
3983 (if (vc-backend buffer-file-name)
3984 (message "%s" (substitute-command-keys
3985 (concat "File is under version-control; "
3986 "use \\[vc-next-action] to check in/out"))))))
3987
3988 (defun insert-file (filename)
3989 "Insert contents of file FILENAME into buffer after point.
3990 Set mark after the inserted text.
3991
3992 This function is meant for the user to run interactively.
3993 Don't call it from programs! Use `insert-file-contents' instead.
3994 \(Its calling sequence is different; see its documentation)."
3995 (interactive "*fInsert file: ")
3996 (insert-file-1 filename #'insert-file-contents))
3997
3998 (defun append-to-file (start end filename)
3999 "Append the contents of the region to the end of file FILENAME.
4000 When called from a function, expects three arguments,
4001 START, END and FILENAME. START and END are buffer positions
4002 saying what text to write."
4003 (interactive "r\nFAppend to file: ")
4004 (write-region start end filename t))
4005
4006 (defun file-newest-backup (filename)
4007 "Return most recent backup file for FILENAME or nil if no backups exist."
4008 ;; `make-backup-file-name' will get us the right directory for
4009 ;; ordinary or numeric backups. It might create a directory for
4010 ;; backups as a side-effect, according to `backup-directory-alist'.
4011 (let* ((filename (file-name-sans-versions
4012 (make-backup-file-name (expand-file-name filename))))
4013 (file (file-name-nondirectory filename))
4014 (dir (file-name-directory filename))
4015 (comp (file-name-all-completions file dir))
4016 (newest nil)
4017 tem)
4018 (while comp
4019 (setq tem (pop comp))
4020 (cond ((and (backup-file-name-p tem)
4021 (string= (file-name-sans-versions tem) file))
4022 (setq tem (concat dir tem))
4023 (if (or (null newest)
4024 (file-newer-than-file-p tem newest))
4025 (setq newest tem)))))
4026 newest))
4027
4028 (defun rename-uniquely ()
4029 "Rename current buffer to a similar name not already taken.
4030 This function is useful for creating multiple shell process buffers
4031 or multiple mail buffers, etc."
4032 (interactive)
4033 (save-match-data
4034 (let ((base-name (buffer-name)))
4035 (and (string-match "<[0-9]+>\\'" base-name)
4036 (not (and buffer-file-name
4037 (string= base-name
4038 (file-name-nondirectory buffer-file-name))))
4039 ;; If the existing buffer name has a <NNN>,
4040 ;; which isn't part of the file name (if any),
4041 ;; then get rid of that.
4042 (setq base-name (substring base-name 0 (match-beginning 0))))
4043 (rename-buffer (generate-new-buffer-name base-name))
4044 (force-mode-line-update))))
4045
4046 (defun make-directory (dir &optional parents)
4047 "Create the directory DIR and any nonexistent parent dirs.
4048 If DIR already exists as a directory, do nothing.
4049
4050 Interactively, the default choice of directory to create
4051 is the current default directory for file names.
4052 That is useful when you have visited a file in a nonexistent directory.
4053
4054 Noninteractively, the second (optional) argument PARENTS says whether
4055 to create parent directories if they don't exist. Interactively,
4056 this happens by default."
4057 (interactive
4058 (list (read-file-name "Make directory: " default-directory default-directory
4059 nil nil)
4060 t))
4061 ;; If default-directory is a remote directory,
4062 ;; make sure we find its make-directory handler.
4063 (setq dir (expand-file-name dir))
4064 (let ((handler (find-file-name-handler dir 'make-directory)))
4065 (if handler
4066 (funcall handler 'make-directory dir parents)
4067 (if (not parents)
4068 (make-directory-internal dir)
4069 (let ((dir (directory-file-name (expand-file-name dir)))
4070 create-list)
4071 (while (not (file-exists-p dir))
4072 (setq create-list (cons dir create-list)
4073 dir (directory-file-name (file-name-directory dir))))
4074 (while create-list
4075 (make-directory-internal (car create-list))
4076 (setq create-list (cdr create-list))))))))
4077 \f
4078 (put 'revert-buffer-function 'permanent-local t)
4079 (defvar revert-buffer-function nil
4080 "Function to use to revert this buffer, or nil to do the default.
4081 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4082 which are the arguments that `revert-buffer' received.")
4083
4084 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4085 (defvar revert-buffer-insert-file-contents-function nil
4086 "Function to use to insert contents when reverting this buffer.
4087 Gets two args, first the nominal file name to use,
4088 and second, t if reading the auto-save file.
4089
4090 The function you specify is responsible for updating (or preserving) point.")
4091
4092 (defvar buffer-stale-function nil
4093 "Function to check whether a non-file buffer needs reverting.
4094 This should be a function with one optional argument NOCONFIRM.
4095 Auto Revert Mode passes t for NOCONFIRM. The function should return
4096 non-nil if the buffer should be reverted. A return value of
4097 `fast' means that the need for reverting was not checked, but
4098 that reverting the buffer is fast. The buffer is current when
4099 this function is called.
4100
4101 The idea behind the NOCONFIRM argument is that it should be
4102 non-nil if the buffer is going to be reverted without asking the
4103 user. In such situations, one has to be careful with potentially
4104 time consuming operations.
4105
4106 For more information on how this variable is used by Auto Revert mode,
4107 see Info node `(emacs)Supporting additional buffers'.")
4108
4109 (defvar before-revert-hook nil
4110 "Normal hook for `revert-buffer' to run before reverting.
4111 If `revert-buffer-function' is used to override the normal revert
4112 mechanism, this hook is not used.")
4113
4114 (defvar after-revert-hook nil
4115 "Normal hook for `revert-buffer' to run after reverting.
4116 Note that the hook value that it runs is the value that was in effect
4117 before reverting; that makes a difference if you have buffer-local
4118 hook functions.
4119
4120 If `revert-buffer-function' is used to override the normal revert
4121 mechanism, this hook is not used.")
4122
4123 (defvar revert-buffer-internal-hook)
4124
4125 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4126 "Replace current buffer text with the text of the visited file on disk.
4127 This undoes all changes since the file was visited or saved.
4128 With a prefix argument, offer to revert from latest auto-save file, if
4129 that is more recent than the visited file.
4130
4131 This command also works for special buffers that contain text which
4132 doesn't come from a file, but reflects some other data base instead:
4133 for example, Dired buffers and `buffer-list' buffers. In these cases,
4134 it reconstructs the buffer contents from the appropriate data base.
4135
4136 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4137 to revert from the auto-save file when this is nil. Note that the
4138 sense of this argument is the reverse of the prefix argument, for the
4139 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4140 to nil.
4141
4142 Optional second argument NOCONFIRM means don't ask for confirmation at
4143 all. \(The variable `revert-without-query' offers another way to
4144 revert buffers without querying for confirmation.)
4145
4146 Optional third argument PRESERVE-MODES non-nil means don't alter
4147 the files modes. Normally we reinitialize them using `normal-mode'.
4148
4149 If the value of `revert-buffer-function' is non-nil, it is called to
4150 do all the work for this command. Otherwise, the hooks
4151 `before-revert-hook' and `after-revert-hook' are run at the beginning
4152 and the end, and if `revert-buffer-insert-file-contents-function' is
4153 non-nil, it is called instead of rereading visited file contents."
4154
4155 ;; I admit it's odd to reverse the sense of the prefix argument, but
4156 ;; there is a lot of code out there which assumes that the first
4157 ;; argument should be t to avoid consulting the auto-save file, and
4158 ;; there's no straightforward way to encourage authors to notice a
4159 ;; reversal of the argument sense. So I'm just changing the user
4160 ;; interface, but leaving the programmatic interface the same.
4161 (interactive (list (not current-prefix-arg)))
4162 (if revert-buffer-function
4163 (funcall revert-buffer-function ignore-auto noconfirm)
4164 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4165 (current-buffer))
4166 (let* ((auto-save-p (and (not ignore-auto)
4167 (recent-auto-save-p)
4168 buffer-auto-save-file-name
4169 (file-readable-p buffer-auto-save-file-name)
4170 (y-or-n-p
4171 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4172 (file-name (if auto-save-p
4173 buffer-auto-save-file-name
4174 buffer-file-name)))
4175 (cond ((null file-name)
4176 (error "Buffer does not seem to be associated with any file"))
4177 ((or noconfirm
4178 (and (not (buffer-modified-p))
4179 (catch 'found
4180 (dolist (regexp revert-without-query)
4181 (when (string-match regexp file-name)
4182 (throw 'found t)))))
4183 (yes-or-no-p (format "Revert buffer from file %s? "
4184 file-name)))
4185 (run-hooks 'before-revert-hook)
4186 ;; If file was backed up but has changed since,
4187 ;; we shd make another backup.
4188 (and (not auto-save-p)
4189 (not (verify-visited-file-modtime (current-buffer)))
4190 (setq buffer-backed-up nil))
4191 ;; Effectively copy the after-revert-hook status,
4192 ;; since after-find-file will clobber it.
4193 (let ((global-hook (default-value 'after-revert-hook))
4194 (local-hook (when (local-variable-p 'after-revert-hook)
4195 after-revert-hook))
4196 (inhibit-read-only t))
4197 (cond
4198 (revert-buffer-insert-file-contents-function
4199 (unless (eq buffer-undo-list t)
4200 ;; Get rid of all undo records for this buffer.
4201 (setq buffer-undo-list nil))
4202 ;; Don't make undo records for the reversion.
4203 (let ((buffer-undo-list t))
4204 (funcall revert-buffer-insert-file-contents-function
4205 file-name auto-save-p)))
4206 ((not (file-exists-p file-name))
4207 (error (if buffer-file-number
4208 "File %s no longer exists!"
4209 "Cannot revert nonexistent file %s")
4210 file-name))
4211 ((not (file-readable-p file-name))
4212 (error (if buffer-file-number
4213 "File %s no longer readable!"
4214 "Cannot revert unreadable file %s")
4215 file-name))
4216 (t
4217 ;; Bind buffer-file-name to nil
4218 ;; so that we don't try to lock the file.
4219 (let ((buffer-file-name nil))
4220 (or auto-save-p
4221 (unlock-buffer)))
4222 (widen)
4223 (let ((coding-system-for-read
4224 ;; Auto-saved file should be read by Emacs'
4225 ;; internal coding.
4226 (if auto-save-p 'auto-save-coding
4227 (or coding-system-for-read
4228 buffer-file-coding-system-explicit))))
4229 (if (and (not enable-multibyte-characters)
4230 coding-system-for-read
4231 (not (memq (coding-system-base
4232 coding-system-for-read)
4233 '(no-conversion raw-text))))
4234 ;; As a coding system suitable for multibyte
4235 ;; buffer is specified, make the current
4236 ;; buffer multibyte.
4237 (set-buffer-multibyte t))
4238
4239 ;; This force after-insert-file-set-coding
4240 ;; (called from insert-file-contents) to set
4241 ;; buffer-file-coding-system to a proper value.
4242 (kill-local-variable 'buffer-file-coding-system)
4243
4244 ;; Note that this preserves point in an intelligent way.
4245 (if preserve-modes
4246 (let ((buffer-file-format buffer-file-format))
4247 (insert-file-contents file-name (not auto-save-p)
4248 nil nil t))
4249 (insert-file-contents file-name (not auto-save-p)
4250 nil nil t)))))
4251 ;; Recompute the truename in case changes in symlinks
4252 ;; have changed the truename.
4253 (setq buffer-file-truename
4254 (abbreviate-file-name (file-truename buffer-file-name)))
4255 (after-find-file nil nil t t preserve-modes)
4256 ;; Run after-revert-hook as it was before we reverted.
4257 (setq-default revert-buffer-internal-hook global-hook)
4258 (if local-hook
4259 (set (make-local-variable 'revert-buffer-internal-hook)
4260 local-hook)
4261 (kill-local-variable 'revert-buffer-internal-hook))
4262 (run-hooks 'revert-buffer-internal-hook))
4263 t))))))
4264
4265 (defun recover-this-file ()
4266 "Recover the visited file--get contents from its last auto-save file."
4267 (interactive)
4268 (recover-file buffer-file-name))
4269
4270 (defun recover-file (file)
4271 "Visit file FILE, but get contents from its last auto-save file."
4272 ;; Actually putting the file name in the minibuffer should be used
4273 ;; only rarely.
4274 ;; Not just because users often use the default.
4275 (interactive "FRecover file: ")
4276 (setq file (expand-file-name file))
4277 (if (auto-save-file-name-p (file-name-nondirectory file))
4278 (error "%s is an auto-save file" (abbreviate-file-name file)))
4279 (let ((file-name (let ((buffer-file-name file))
4280 (make-auto-save-file-name))))
4281 (cond ((if (file-exists-p file)
4282 (not (file-newer-than-file-p file-name file))
4283 (not (file-exists-p file-name)))
4284 (error "Auto-save file %s not current"
4285 (abbreviate-file-name file-name)))
4286 ((save-window-excursion
4287 (with-output-to-temp-buffer "*Directory*"
4288 (buffer-disable-undo standard-output)
4289 (save-excursion
4290 (let ((switches dired-listing-switches))
4291 (if (file-symlink-p file)
4292 (setq switches (concat switches "L")))
4293 (set-buffer standard-output)
4294 ;; Use insert-directory-safely, not insert-directory,
4295 ;; because these files might not exist. In particular,
4296 ;; FILE might not exist if the auto-save file was for
4297 ;; a buffer that didn't visit a file, such as "*mail*".
4298 ;; The code in v20.x called `ls' directly, so we need
4299 ;; to emulate what `ls' did in that case.
4300 (insert-directory-safely file switches)
4301 (insert-directory-safely file-name switches))))
4302 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4303 (switch-to-buffer (find-file-noselect file t))
4304 (let ((inhibit-read-only t)
4305 ;; Keep the current buffer-file-coding-system.
4306 (coding-system buffer-file-coding-system)
4307 ;; Auto-saved file should be read with special coding.
4308 (coding-system-for-read 'auto-save-coding))
4309 (erase-buffer)
4310 (insert-file-contents file-name nil)
4311 (set-buffer-file-coding-system coding-system))
4312 (after-find-file nil nil t))
4313 (t (error "Recover-file cancelled")))))
4314
4315 (defun recover-session ()
4316 "Recover auto save files from a previous Emacs session.
4317 This command first displays a Dired buffer showing you the
4318 previous sessions that you could recover from.
4319 To choose one, move point to the proper line and then type C-c C-c.
4320 Then you'll be asked about a number of files to recover."
4321 (interactive)
4322 (if (null auto-save-list-file-prefix)
4323 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4324 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4325 (unless (file-directory-p dir)
4326 (make-directory dir t))
4327 (unless (directory-files dir nil
4328 (concat "\\`" (regexp-quote
4329 (file-name-nondirectory
4330 auto-save-list-file-prefix)))
4331 t)
4332 (error "No previous sessions to recover")))
4333 (let ((ls-lisp-support-shell-wildcards t))
4334 (dired (concat auto-save-list-file-prefix "*")
4335 (concat dired-listing-switches "t")))
4336 (save-excursion
4337 (goto-char (point-min))
4338 (or (looking-at " Move to the session you want to recover,")
4339 (let ((inhibit-read-only t))
4340 ;; Each line starts with a space
4341 ;; so that Font Lock mode won't highlight the first character.
4342 (insert " Move to the session you want to recover,\n"
4343 " then type C-c C-c to select it.\n\n"
4344 " You can also delete some of these files;\n"
4345 " type d on a line to mark that file for deletion.\n\n"))))
4346 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4347 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4348
4349 (defun recover-session-finish ()
4350 "Choose one saved session to recover auto-save files from.
4351 This command is used in the special Dired buffer created by
4352 \\[recover-session]."
4353 (interactive)
4354 ;; Get the name of the session file to recover from.
4355 (let ((file (dired-get-filename))
4356 files
4357 (buffer (get-buffer-create " *recover*")))
4358 (dired-unmark 1)
4359 (dired-do-flagged-delete t)
4360 (unwind-protect
4361 (save-excursion
4362 ;; Read in the auto-save-list file.
4363 (set-buffer buffer)
4364 (erase-buffer)
4365 (insert-file-contents file)
4366 ;; Loop thru the text of that file
4367 ;; and get out the names of the files to recover.
4368 (while (not (eobp))
4369 (let (thisfile autofile)
4370 (if (eolp)
4371 ;; This is a pair of lines for a non-file-visiting buffer.
4372 ;; Get the auto-save file name and manufacture
4373 ;; a "visited file name" from that.
4374 (progn
4375 (forward-line 1)
4376 ;; If there is no auto-save file name, the
4377 ;; auto-save-list file is probably corrupted.
4378 (unless (eolp)
4379 (setq autofile
4380 (buffer-substring-no-properties
4381 (point)
4382 (line-end-position)))
4383 (setq thisfile
4384 (expand-file-name
4385 (substring
4386 (file-name-nondirectory autofile)
4387 1 -1)
4388 (file-name-directory autofile))))
4389 (forward-line 1))
4390 ;; This pair of lines is a file-visiting
4391 ;; buffer. Use the visited file name.
4392 (progn
4393 (setq thisfile
4394 (buffer-substring-no-properties
4395 (point) (progn (end-of-line) (point))))
4396 (forward-line 1)
4397 (setq autofile
4398 (buffer-substring-no-properties
4399 (point) (progn (end-of-line) (point))))
4400 (forward-line 1)))
4401 ;; Ignore a file if its auto-save file does not exist now.
4402 (if (and autofile (file-exists-p autofile))
4403 (setq files (cons thisfile files)))))
4404 (setq files (nreverse files))
4405 ;; The file contains a pair of line for each auto-saved buffer.
4406 ;; The first line of the pair contains the visited file name
4407 ;; or is empty if the buffer was not visiting a file.
4408 ;; The second line is the auto-save file name.
4409 (if files
4410 (map-y-or-n-p "Recover %s? "
4411 (lambda (file)
4412 (condition-case nil
4413 (save-excursion (recover-file file))
4414 (error
4415 "Failed to recover `%s'" file)))
4416 files
4417 '("file" "files" "recover"))
4418 (message "No files can be recovered from this session now")))
4419 (kill-buffer buffer))))
4420
4421 (defun kill-buffer-ask (buffer)
4422 "Kill buffer if confirmed."
4423 (when (yes-or-no-p
4424 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4425 (if (buffer-modified-p buffer)
4426 "HAS BEEN EDITED" "is unmodified")))
4427 (kill-buffer buffer)))
4428
4429 (defun kill-some-buffers (&optional list)
4430 "Kill some buffers. Asks the user whether to kill each one of them.
4431 Non-interactively, if optional argument LIST is non-nil, it
4432 specifies the list of buffers to kill, asking for approval for each one."
4433 (interactive)
4434 (if (null list)
4435 (setq list (buffer-list)))
4436 (while list
4437 (let* ((buffer (car list))
4438 (name (buffer-name buffer)))
4439 (and name ; Can be nil for an indirect buffer
4440 ; if we killed the base buffer.
4441 (not (string-equal name ""))
4442 (/= (aref name 0) ?\s)
4443 (kill-buffer-ask buffer)))
4444 (setq list (cdr list))))
4445
4446 (defun kill-matching-buffers (regexp &optional internal-too)
4447 "Kill buffers whose name matches the specified regexp.
4448 The optional second argument indicates whether to kill internal buffers too."
4449 (interactive "sKill buffers matching this regular expression: \nP")
4450 (dolist (buffer (buffer-list))
4451 (let ((name (buffer-name buffer)))
4452 (when (and name (not (string-equal name ""))
4453 (or internal-too (/= (aref name 0) ?\s))
4454 (string-match regexp name))
4455 (kill-buffer-ask buffer)))))
4456
4457 \f
4458 (defun auto-save-mode (arg)
4459 "Toggle auto-saving of contents of current buffer.
4460 With prefix argument ARG, turn auto-saving on if positive, else off."
4461 (interactive "P")
4462 (setq buffer-auto-save-file-name
4463 (and (if (null arg)
4464 (or (not buffer-auto-save-file-name)
4465 ;; If auto-save is off because buffer has shrunk,
4466 ;; then toggling should turn it on.
4467 (< buffer-saved-size 0))
4468 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4469 (if (and buffer-file-name auto-save-visited-file-name
4470 (not buffer-read-only))
4471 buffer-file-name
4472 (make-auto-save-file-name))))
4473 ;; If -1 was stored here, to temporarily turn off saving,
4474 ;; turn it back on.
4475 (and (< buffer-saved-size 0)
4476 (setq buffer-saved-size 0))
4477 (if (interactive-p)
4478 (message "Auto-save %s (in this buffer)"
4479 (if buffer-auto-save-file-name "on" "off")))
4480 buffer-auto-save-file-name)
4481
4482 (defun rename-auto-save-file ()
4483 "Adjust current buffer's auto save file name for current conditions.
4484 Also rename any existing auto save file, if it was made in this session."
4485 (let ((osave buffer-auto-save-file-name))
4486 (setq buffer-auto-save-file-name
4487 (make-auto-save-file-name))
4488 (if (and osave buffer-auto-save-file-name
4489 (not (string= buffer-auto-save-file-name buffer-file-name))
4490 (not (string= buffer-auto-save-file-name osave))
4491 (file-exists-p osave)
4492 (recent-auto-save-p))
4493 (rename-file osave buffer-auto-save-file-name t))))
4494
4495 (defun make-auto-save-file-name ()
4496 "Return file name to use for auto-saves of current buffer.
4497 Does not consider `auto-save-visited-file-name' as that variable is checked
4498 before calling this function. You can redefine this for customization.
4499 See also `auto-save-file-name-p'."
4500 (if buffer-file-name
4501 (let ((handler (find-file-name-handler buffer-file-name
4502 'make-auto-save-file-name)))
4503 (if handler
4504 (funcall handler 'make-auto-save-file-name)
4505 (let ((list auto-save-file-name-transforms)
4506 (filename buffer-file-name)
4507 result uniq)
4508 ;; Apply user-specified translations
4509 ;; to the file name.
4510 (while (and list (not result))
4511 (if (string-match (car (car list)) filename)
4512 (setq result (replace-match (cadr (car list)) t nil
4513 filename)
4514 uniq (car (cddr (car list)))))
4515 (setq list (cdr list)))
4516 (if result
4517 (if uniq
4518 (setq filename (concat
4519 (file-name-directory result)
4520 (subst-char-in-string
4521 ?/ ?!
4522 (replace-regexp-in-string "!" "!!"
4523 filename))))
4524 (setq filename result)))
4525 (setq result
4526 (if (and (eq system-type 'ms-dos)
4527 (not (msdos-long-file-names)))
4528 ;; We truncate the file name to DOS 8+3 limits
4529 ;; before doing anything else, because the regexp
4530 ;; passed to string-match below cannot handle
4531 ;; extensions longer than 3 characters, multiple
4532 ;; dots, and other atrocities.
4533 (let ((fn (dos-8+3-filename
4534 (file-name-nondirectory buffer-file-name))))
4535 (string-match
4536 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4537 fn)
4538 (concat (file-name-directory buffer-file-name)
4539 "#" (match-string 1 fn)
4540 "." (match-string 3 fn) "#"))
4541 (concat (file-name-directory filename)
4542 "#"
4543 (file-name-nondirectory filename)
4544 "#")))
4545 ;; Make sure auto-save file names don't contain characters
4546 ;; invalid for the underlying filesystem.
4547 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4548 ;; Don't modify remote (ange-ftp) filenames
4549 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4550 (convert-standard-filename result)
4551 result))))
4552
4553 ;; Deal with buffers that don't have any associated files. (Mail
4554 ;; mode tends to create a good number of these.)
4555
4556 (let ((buffer-name (buffer-name))
4557 (limit 0)
4558 file-name)
4559 ;; Eliminate all slashes and backslashes by
4560 ;; replacing them with sequences that start with %.
4561 ;; Quote % also, to keep distinct names distinct.
4562 (while (string-match "[/\\%]" buffer-name limit)
4563 (let* ((character (aref buffer-name (match-beginning 0)))
4564 (replacement
4565 (cond ((eq character ?%) "%%")
4566 ((eq character ?/) "%+")
4567 ((eq character ?\\) "%-"))))
4568 (setq buffer-name (replace-match replacement t t buffer-name))
4569 (setq limit (1+ (match-end 0)))))
4570 ;; Generate the file name.
4571 (setq file-name
4572 (make-temp-file
4573 (let ((fname
4574 (expand-file-name
4575 (format "#%s#" buffer-name)
4576 ;; Try a few alternative directories, to get one we can
4577 ;; write it.
4578 (cond
4579 ((file-writable-p default-directory) default-directory)
4580 ((file-writable-p "/var/tmp/") "/var/tmp/")
4581 ("~/")))))
4582 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4583 ;; Don't modify remote (ange-ftp) filenames
4584 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4585 ;; The call to convert-standard-filename is in case
4586 ;; buffer-name includes characters not allowed by the
4587 ;; DOS/Windows filesystems. make-temp-file writes to the
4588 ;; file it creates, so we must fix the file name _before_
4589 ;; make-temp-file is called.
4590 (convert-standard-filename fname)
4591 fname))
4592 nil "#"))
4593 ;; make-temp-file creates the file,
4594 ;; but we don't want it to exist until we do an auto-save.
4595 (condition-case ()
4596 (delete-file file-name)
4597 (file-error nil))
4598 file-name)))
4599
4600 (defun auto-save-file-name-p (filename)
4601 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4602 FILENAME should lack slashes. You can redefine this for customization."
4603 (string-match "^#.*#$" filename))
4604 \f
4605 (defun wildcard-to-regexp (wildcard)
4606 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4607 The generated regexp will match a filename iff the filename
4608 matches that wildcard according to shell rules. Only wildcards known
4609 by `sh' are supported."
4610 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4611 ;; Copy the initial run of non-special characters.
4612 (result (substring wildcard 0 i))
4613 (len (length wildcard)))
4614 ;; If no special characters, we're almost done.
4615 (if i
4616 (while (< i len)
4617 (let ((ch (aref wildcard i))
4618 j)
4619 (setq
4620 result
4621 (concat result
4622 (cond
4623 ((and (eq ch ?\[)
4624 (< (1+ i) len)
4625 (eq (aref wildcard (1+ i)) ?\]))
4626 "\\[")
4627 ((eq ch ?\[) ; [...] maps to regexp char class
4628 (progn
4629 (setq i (1+ i))
4630 (concat
4631 (cond
4632 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4633 (progn
4634 (setq i (1+ i))
4635 (if (eq (aref wildcard i) ?\])
4636 (progn
4637 (setq i (1+ i))
4638 "[^]")
4639 "[^")))
4640 ((eq (aref wildcard i) ?^)
4641 ;; Found "[^". Insert a `\0' character
4642 ;; (which cannot happen in a filename)
4643 ;; into the character class, so that `^'
4644 ;; is not the first character after `[',
4645 ;; and thus non-special in a regexp.
4646 (progn
4647 (setq i (1+ i))
4648 "[\000^"))
4649 ((eq (aref wildcard i) ?\])
4650 ;; I don't think `]' can appear in a
4651 ;; character class in a wildcard, but
4652 ;; let's be general here.
4653 (progn
4654 (setq i (1+ i))
4655 "[]"))
4656 (t "["))
4657 (prog1 ; copy everything upto next `]'.
4658 (substring wildcard
4659 i
4660 (setq j (string-match
4661 "]" wildcard i)))
4662 (setq i (if j (1- j) (1- len)))))))
4663 ((eq ch ?.) "\\.")
4664 ((eq ch ?*) "[^\000]*")
4665 ((eq ch ?+) "\\+")
4666 ((eq ch ?^) "\\^")
4667 ((eq ch ?$) "\\$")
4668 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4669 ((eq ch ??) "[^\000]")
4670 (t (char-to-string ch)))))
4671 (setq i (1+ i)))))
4672 ;; Shell wildcards should match the entire filename,
4673 ;; not its part. Make the regexp say so.
4674 (concat "\\`" result "\\'")))
4675 \f
4676 (defcustom list-directory-brief-switches
4677 (if (eq system-type 'vax-vms) "" "-CF")
4678 "Switches for `list-directory' to pass to `ls' for brief listing."
4679 :type 'string
4680 :group 'dired)
4681
4682 (defcustom list-directory-verbose-switches
4683 (if (eq system-type 'vax-vms)
4684 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4685 "-l")
4686 "Switches for `list-directory' to pass to `ls' for verbose listing."
4687 :type 'string
4688 :group 'dired)
4689
4690 (defun file-expand-wildcards (pattern &optional full)
4691 "Expand wildcard pattern PATTERN.
4692 This returns a list of file names which match the pattern.
4693
4694 If PATTERN is written as an absolute file name,
4695 the values are absolute also.
4696
4697 If PATTERN is written as a relative file name, it is interpreted
4698 relative to the current default directory, `default-directory'.
4699 The file names returned are normally also relative to the current
4700 default directory. However, if FULL is non-nil, they are absolute."
4701 (save-match-data
4702 (let* ((nondir (file-name-nondirectory pattern))
4703 (dirpart (file-name-directory pattern))
4704 ;; A list of all dirs that DIRPART specifies.
4705 ;; This can be more than one dir
4706 ;; if DIRPART contains wildcards.
4707 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4708 (mapcar 'file-name-as-directory
4709 (file-expand-wildcards (directory-file-name dirpart)))
4710 (list dirpart)))
4711 contents)
4712 (while dirs
4713 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4714 (file-directory-p (directory-file-name (car dirs))))
4715 (let ((this-dir-contents
4716 ;; Filter out "." and ".."
4717 (delq nil
4718 (mapcar #'(lambda (name)
4719 (unless (string-match "\\`\\.\\.?\\'"
4720 (file-name-nondirectory name))
4721 name))
4722 (directory-files (or (car dirs) ".") full
4723 (wildcard-to-regexp nondir))))))
4724 (setq contents
4725 (nconc
4726 (if (and (car dirs) (not full))
4727 (mapcar (function (lambda (name) (concat (car dirs) name)))
4728 this-dir-contents)
4729 this-dir-contents)
4730 contents))))
4731 (setq dirs (cdr dirs)))
4732 contents)))
4733
4734 (defun list-directory (dirname &optional verbose)
4735 "Display a list of files in or matching DIRNAME, a la `ls'.
4736 DIRNAME is globbed by the shell if necessary.
4737 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4738 Actions controlled by variables `list-directory-brief-switches'
4739 and `list-directory-verbose-switches'."
4740 (interactive (let ((pfx current-prefix-arg))
4741 (list (read-file-name (if pfx "List directory (verbose): "
4742 "List directory (brief): ")
4743 nil default-directory nil)
4744 pfx)))
4745 (let ((switches (if verbose list-directory-verbose-switches
4746 list-directory-brief-switches))
4747 buffer)
4748 (or dirname (setq dirname default-directory))
4749 (setq dirname (expand-file-name dirname))
4750 (with-output-to-temp-buffer "*Directory*"
4751 (setq buffer standard-output)
4752 (buffer-disable-undo standard-output)
4753 (princ "Directory ")
4754 (princ dirname)
4755 (terpri)
4756 (save-excursion
4757 (set-buffer "*Directory*")
4758 (let ((wildcard (not (file-directory-p dirname))))
4759 (insert-directory dirname switches wildcard (not wildcard)))))
4760 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4761 (with-current-buffer buffer
4762 (setq default-directory
4763 (if (file-directory-p dirname)
4764 (file-name-as-directory dirname)
4765 (file-name-directory dirname))))))
4766
4767 (defun shell-quote-wildcard-pattern (pattern)
4768 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4769
4770 PATTERN is assumed to represent a file-name wildcard suitable for the
4771 underlying filesystem. For Unix and GNU/Linux, the characters from the
4772 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4773 the parts of the pattern which don't include wildcard characters are
4774 quoted with double quotes.
4775 Existing quote characters in PATTERN are left alone, so you can pass
4776 PATTERN that already quotes some of the special characters."
4777 (save-match-data
4778 (cond
4779 ((memq system-type '(ms-dos windows-nt cygwin))
4780 ;; DOS/Windows don't allow `"' in file names. So if the
4781 ;; argument has quotes, we can safely assume it is already
4782 ;; quoted by the caller.
4783 (if (or (string-match "[\"]" pattern)
4784 ;; We quote [&()#$'] in case their shell is a port of a
4785 ;; Unixy shell. We quote [,=+] because stock DOS and
4786 ;; Windows shells require that in some cases, such as
4787 ;; passing arguments to batch files that use positional
4788 ;; arguments like %1.
4789 (not (string-match "[ \t;&()#$',=+]" pattern)))
4790 pattern
4791 (let ((result "\"")
4792 (beg 0)
4793 end)
4794 (while (string-match "[*?]+" pattern beg)
4795 (setq end (match-beginning 0)
4796 result (concat result (substring pattern beg end)
4797 "\""
4798 (substring pattern end (match-end 0))
4799 "\"")
4800 beg (match-end 0)))
4801 (concat result (substring pattern beg) "\""))))
4802 (t
4803 (let ((beg 0))
4804 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4805 (setq pattern
4806 (concat (substring pattern 0 (match-beginning 0))
4807 "\\"
4808 (substring pattern (match-beginning 0)))
4809 beg (1+ (match-end 0)))))
4810 pattern))))
4811
4812
4813 (defvar insert-directory-program "ls"
4814 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4815
4816 (defcustom directory-free-space-program "df"
4817 "Program to get the amount of free space on a file system.
4818 We assume the output has the format of `df'.
4819 The value of this variable must be just a command name or file name;
4820 if you want to specify options, use `directory-free-space-args'.
4821
4822 A value of nil disables this feature.
4823
4824 If the function `file-system-info' is defined, it is always used in
4825 preference to the program given by this variable."
4826 :type '(choice (string :tag "Program") (const :tag "None" nil))
4827 :group 'dired)
4828
4829 (defcustom directory-free-space-args
4830 (if (eq system-type 'darwin) "-k" "-Pk")
4831 "Options to use when running `directory-free-space-program'."
4832 :type 'string
4833 :group 'dired)
4834
4835 (defun get-free-disk-space (dir)
4836 "Return the amount of free space on directory DIR's file system.
4837 The result is a string that gives the number of free 1KB blocks,
4838 or nil if the system call or the program which retrieve the information
4839 fail. It returns also nil when DIR is a remote directory.
4840
4841 This function calls `file-system-info' if it is available, or invokes the
4842 program specified by `directory-free-space-program' if that is non-nil."
4843 (when (not (file-remote-p dir))
4844 ;; Try to find the number of free blocks. Non-Posix systems don't
4845 ;; always have df, but might have an equivalent system call.
4846 (if (fboundp 'file-system-info)
4847 (let ((fsinfo (file-system-info dir)))
4848 (if fsinfo
4849 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4850 (save-match-data
4851 (with-temp-buffer
4852 (when (and directory-free-space-program
4853 (eq 0 (call-process directory-free-space-program
4854 nil t nil
4855 directory-free-space-args
4856 dir)))
4857 ;; Usual format is a header line followed by a line of
4858 ;; numbers.
4859 (goto-char (point-min))
4860 (forward-line 1)
4861 (if (not (eobp))
4862 (progn
4863 ;; Move to the end of the "available blocks" number.
4864 (skip-chars-forward "^ \t")
4865 (forward-word 3)
4866 ;; Copy it into AVAILABLE.
4867 (let ((end (point)))
4868 (forward-word -1)
4869 (buffer-substring (point) end))))))))))
4870
4871 ;; The following expression replaces `dired-move-to-filename-regexp'.
4872 (defvar directory-listing-before-filename-regexp
4873 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
4874 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
4875 ;; In some locales, month abbreviations are as short as 2 letters,
4876 ;; and they can be followed by ".".
4877 ;; In Breton, a month name can include a quote character.
4878 (month (concat l-or-quote l-or-quote "+\\.?"))
4879 (s " ")
4880 (yyyy "[0-9][0-9][0-9][0-9]")
4881 (dd "[ 0-3][0-9]")
4882 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
4883 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
4884 (zone "[-+][0-2][0-9][0-5][0-9]")
4885 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
4886 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
4887 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
4888 "\\|" yyyy "-" iso-mm-dd "\\)"))
4889 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
4890 s "+"
4891 "\\(" HH:MM "\\|" yyyy "\\)"))
4892 (western-comma (concat month s "+" dd "," s "+" yyyy))
4893 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4894 ;; omits the Kanji characters after month and day-of-month.
4895 ;; On Mac OS X 10.3, the date format in East Asian locales is
4896 ;; day-of-month digits followed by month digits.
4897 (mm "[ 0-1]?[0-9]")
4898 (east-asian
4899 (concat "\\(" mm l "?" s dd l "?" s "+"
4900 "\\|" dd s mm s "+" "\\)"
4901 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
4902 ;; The "[0-9]" below requires the previous column to end in a digit.
4903 ;; This avoids recognizing `1 may 1997' as a date in the line:
4904 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4905
4906 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4907 ;; The ".*" below finds the last match if there are multiple matches.
4908 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4909 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4910
4911 ;; vc dired listings provide the state or blanks between file
4912 ;; permissions and date. The state is always surrounded by
4913 ;; parantheses:
4914 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4915 ;; This is not supported yet.
4916 (concat ".*[0-9][BkKMGTPEZY]?" s
4917 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
4918 s "+"))
4919 "Regular expression to match up to the file name in a directory listing.
4920 The default value is designed to recognize dates and times
4921 regardless of the language.")
4922
4923 (defvar insert-directory-ls-version 'unknown)
4924
4925 ;; insert-directory
4926 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4927 ;; FULL-DIRECTORY-P is nil.
4928 ;; The single line of output must display FILE's name as it was
4929 ;; given, namely, an absolute path name.
4930 ;; - must insert exactly one line for each file if WILDCARD or
4931 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4932 ;; before the file lines, plus optional text after the file lines.
4933 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4934 ;; allowed.
4935 ;; File lines should display the basename.
4936 ;; - must be consistent with
4937 ;; - functions dired-move-to-filename, (these two define what a file line is)
4938 ;; dired-move-to-end-of-filename,
4939 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4940 ;; dired-insert-headerline
4941 ;; dired-after-subdir-garbage (defines what a "total" line is)
4942 ;; - variable dired-subdir-regexp
4943 ;; - may be passed "--dired" as the first argument in SWITCHES.
4944 ;; Filename handlers might have to remove this switch if their
4945 ;; "ls" command does not support it.
4946 (defun insert-directory (file switches &optional wildcard full-directory-p)
4947 "Insert directory listing for FILE, formatted according to SWITCHES.
4948 Leaves point after the inserted text.
4949 SWITCHES may be a string of options, or a list of strings
4950 representing individual options.
4951 Optional third arg WILDCARD means treat FILE as shell wildcard.
4952 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4953 switches do not contain `d', so that a full listing is expected.
4954
4955 This works by running a directory listing program
4956 whose name is in the variable `insert-directory-program'.
4957 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4958
4959 When SWITCHES contains the long `--dired' option, this function
4960 treats it specially, for the sake of dired. However, the
4961 normally equivalent short `-D' option is just passed on to
4962 `insert-directory-program', as any other option."
4963 ;; We need the directory in order to find the right handler.
4964 (let ((handler (find-file-name-handler (expand-file-name file)
4965 'insert-directory)))
4966 (if handler
4967 (funcall handler 'insert-directory file switches
4968 wildcard full-directory-p)
4969 (if (eq system-type 'vax-vms)
4970 (vms-read-directory file switches (current-buffer))
4971 (let (result (beg (point)))
4972
4973 ;; Read the actual directory using `insert-directory-program'.
4974 ;; RESULT gets the status code.
4975 (let* (;; We at first read by no-conversion, then after
4976 ;; putting text property `dired-filename, decode one
4977 ;; bunch by one to preserve that property.
4978 (coding-system-for-read 'no-conversion)
4979 ;; This is to control encoding the arguments in call-process.
4980 (coding-system-for-write
4981 (and enable-multibyte-characters
4982 (or file-name-coding-system
4983 default-file-name-coding-system))))
4984 (setq result
4985 (if wildcard
4986 ;; Run ls in the directory part of the file pattern
4987 ;; using the last component as argument.
4988 (let ((default-directory
4989 (if (file-name-absolute-p file)
4990 (file-name-directory file)
4991 (file-name-directory (expand-file-name file))))
4992 (pattern (file-name-nondirectory file)))
4993 (call-process
4994 shell-file-name nil t nil
4995 "-c"
4996 (concat (if (memq system-type '(ms-dos windows-nt))
4997 ""
4998 "\\") ; Disregard Unix shell aliases!
4999 insert-directory-program
5000 " -d "
5001 (if (stringp switches)
5002 switches
5003 (mapconcat 'identity switches " "))
5004 " -- "
5005 ;; Quote some characters that have
5006 ;; special meanings in shells; but
5007 ;; don't quote the wildcards--we want
5008 ;; them to be special. We also
5009 ;; currently don't quote the quoting
5010 ;; characters in case people want to
5011 ;; use them explicitly to quote
5012 ;; wildcard characters.
5013 (shell-quote-wildcard-pattern pattern))))
5014 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5015 ;; directory if FILE is a symbolic link.
5016 (apply 'call-process
5017 insert-directory-program nil t nil
5018 (append
5019 (if (listp switches) switches
5020 (unless (equal switches "")
5021 ;; Split the switches at any spaces so we can
5022 ;; pass separate options as separate args.
5023 (split-string switches)))
5024 ;; Avoid lossage if FILE starts with `-'.
5025 '("--")
5026 (progn
5027 (if (string-match "\\`~" file)
5028 (setq file (expand-file-name file)))
5029 (list
5030 (if full-directory-p
5031 (concat (file-name-as-directory file) ".")
5032 file))))))))
5033
5034 ;; If we got "//DIRED//" in the output, it means we got a real
5035 ;; directory listing, even if `ls' returned nonzero.
5036 ;; So ignore any errors.
5037 (when (if (stringp switches)
5038 (string-match "--dired\\>" switches)
5039 (member "--dired" switches))
5040 (save-excursion
5041 (forward-line -2)
5042 (when (looking-at "//SUBDIRED//")
5043 (forward-line -1))
5044 (if (looking-at "//DIRED//")
5045 (setq result 0))))
5046
5047 (when (and (not (eq 0 result))
5048 (eq insert-directory-ls-version 'unknown))
5049 ;; The first time ls returns an error,
5050 ;; find the version numbers of ls,
5051 ;; and set insert-directory-ls-version
5052 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5053 ;; is equal or if the info cannot be obtained.
5054 ;; (That can mean it isn't GNU ls.)
5055 (let ((version-out
5056 (with-temp-buffer
5057 (call-process "ls" nil t nil "--version")
5058 (buffer-string))))
5059 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5060 (let* ((version (match-string 1 version-out))
5061 (split (split-string version "[.]"))
5062 (numbers (mapcar 'string-to-number split))
5063 (min '(5 2 1))
5064 comparison)
5065 (while (and (not comparison) (or numbers min))
5066 (cond ((null min)
5067 (setq comparison '>))
5068 ((null numbers)
5069 (setq comparison '<))
5070 ((> (car numbers) (car min))
5071 (setq comparison '>))
5072 ((< (car numbers) (car min))
5073 (setq comparison '<))
5074 (t
5075 (setq numbers (cdr numbers)
5076 min (cdr min)))))
5077 (setq insert-directory-ls-version (or comparison '=)))
5078 (setq insert-directory-ls-version nil))))
5079
5080 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5081 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5082 (setq result 0))
5083
5084 ;; If `insert-directory-program' failed, signal an error.
5085 (unless (eq 0 result)
5086 ;; Delete the error message it may have output.
5087 (delete-region beg (point))
5088 ;; On non-Posix systems, we cannot open a directory, so
5089 ;; don't even try, because that will always result in
5090 ;; the ubiquitous "Access denied". Instead, show the
5091 ;; command line so the user can try to guess what went wrong.
5092 (if (and (file-directory-p file)
5093 (memq system-type '(ms-dos windows-nt)))
5094 (error
5095 "Reading directory: \"%s %s -- %s\" exited with status %s"
5096 insert-directory-program
5097 (if (listp switches) (concat switches) switches)
5098 file result)
5099 ;; Unix. Access the file to get a suitable error.
5100 (access-file file "Reading directory")
5101 (error "Listing directory failed but `access-file' worked")))
5102
5103 (when (if (stringp switches)
5104 (string-match "--dired\\>" switches)
5105 (member "--dired" switches))
5106 ;; The following overshoots by one line for an empty
5107 ;; directory listed with "--dired", but without "-a"
5108 ;; switch, where the ls output contains a
5109 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5110 ;; We take care of that case later.
5111 (forward-line -2)
5112 (when (looking-at "//SUBDIRED//")
5113 (delete-region (point) (progn (forward-line 1) (point)))
5114 (forward-line -1))
5115 (if (looking-at "//DIRED//")
5116 (let ((end (line-end-position))
5117 (linebeg (point))
5118 error-lines)
5119 ;; Find all the lines that are error messages,
5120 ;; and record the bounds of each one.
5121 (goto-char beg)
5122 (while (< (point) linebeg)
5123 (or (eql (following-char) ?\s)
5124 (push (list (point) (line-end-position)) error-lines))
5125 (forward-line 1))
5126 (setq error-lines (nreverse error-lines))
5127 ;; Now read the numeric positions of file names.
5128 (goto-char linebeg)
5129 (forward-word 1)
5130 (forward-char 3)
5131 (while (< (point) end)
5132 (let ((start (insert-directory-adj-pos
5133 (+ beg (read (current-buffer)))
5134 error-lines))
5135 (end (insert-directory-adj-pos
5136 (+ beg (read (current-buffer)))
5137 error-lines)))
5138 (if (memq (char-after end) '(?\n ?\s))
5139 ;; End is followed by \n or by " -> ".
5140 (put-text-property start end 'dired-filename t)
5141 ;; It seems that we can't trust ls's output as to
5142 ;; byte positions of filenames.
5143 (put-text-property beg (point) 'dired-filename nil)
5144 (end-of-line))))
5145 (goto-char end)
5146 (beginning-of-line)
5147 (delete-region (point) (progn (forward-line 1) (point))))
5148 ;; Take care of the case where the ls output contains a
5149 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5150 ;; and we went one line too far back (see above).
5151 (forward-line 1))
5152 (if (looking-at "//DIRED-OPTIONS//")
5153 (delete-region (point) (progn (forward-line 1) (point)))))
5154
5155 ;; Now decode what read if necessary.
5156 (let ((coding (or coding-system-for-read
5157 file-name-coding-system
5158 default-file-name-coding-system
5159 'undecided))
5160 coding-no-eol
5161 val pos)
5162 (when (and enable-multibyte-characters
5163 (not (memq (coding-system-base coding)
5164 '(raw-text no-conversion))))
5165 ;; If no coding system is specified or detection is
5166 ;; requested, detect the coding.
5167 (if (eq (coding-system-base coding) 'undecided)
5168 (setq coding (detect-coding-region beg (point) t)))
5169 (if (not (eq (coding-system-base coding) 'undecided))
5170 (save-restriction
5171 (setq coding-no-eol
5172 (coding-system-change-eol-conversion coding 'unix))
5173 (narrow-to-region beg (point))
5174 (goto-char (point-min))
5175 (while (not (eobp))
5176 (setq pos (point)
5177 val (get-text-property (point) 'dired-filename))
5178 (goto-char (next-single-property-change
5179 (point) 'dired-filename nil (point-max)))
5180 ;; Force no eol conversion on a file name, so
5181 ;; that CR is preserved.
5182 (decode-coding-region pos (point)
5183 (if val coding-no-eol coding))
5184 (if val
5185 (put-text-property pos (point)
5186 'dired-filename t)))))))
5187
5188 (if full-directory-p
5189 ;; Try to insert the amount of free space.
5190 (save-excursion
5191 (goto-char beg)
5192 ;; First find the line to put it on.
5193 (when (re-search-forward "^ *\\(total\\)" nil t)
5194 (let ((available (get-free-disk-space ".")))
5195 (when available
5196 ;; Replace "total" with "used", to avoid confusion.
5197 (replace-match "total used in directory" nil nil nil 1)
5198 (end-of-line)
5199 (insert " available " available)))))))))))
5200
5201 (defun insert-directory-adj-pos (pos error-lines)
5202 "Convert `ls --dired' file name position value POS to a buffer position.
5203 File name position values returned in ls --dired output
5204 count only stdout; they don't count the error messages sent to stderr.
5205 So this function converts to them to real buffer positions.
5206 ERROR-LINES is a list of buffer positions of error message lines,
5207 of the form (START END)."
5208 (while (and error-lines (< (caar error-lines) pos))
5209 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5210 (pop error-lines))
5211 pos)
5212
5213 (defun insert-directory-safely (file switches
5214 &optional wildcard full-directory-p)
5215 "Insert directory listing for FILE, formatted according to SWITCHES.
5216
5217 Like `insert-directory', but if FILE does not exist, it inserts a
5218 message to that effect instead of signaling an error."
5219 (if (file-exists-p file)
5220 (insert-directory file switches wildcard full-directory-p)
5221 ;; Simulate the message printed by `ls'.
5222 (insert (format "%s: No such file or directory\n" file))))
5223
5224 (defvar kill-emacs-query-functions nil
5225 "Functions to call with no arguments to query about killing Emacs.
5226 If any of these functions returns nil, killing Emacs is cancelled.
5227 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
5228 but `kill-emacs', the low level primitive, does not.
5229 See also `kill-emacs-hook'.")
5230
5231 (defcustom confirm-kill-emacs nil
5232 "How to ask for confirmation when leaving Emacs.
5233 If nil, the default, don't ask at all. If the value is non-nil, it should
5234 be a predicate function such as `yes-or-no-p'."
5235 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5236 (const :tag "Ask with y-or-n-p" y-or-n-p)
5237 (const :tag "Don't confirm" nil))
5238 :group 'convenience
5239 :version "21.1")
5240
5241 (defun save-buffers-kill-emacs (&optional arg)
5242 "Offer to save each buffer, then kill this Emacs process.
5243 With prefix arg, silently save all file-visiting buffers, then kill."
5244 (interactive "P")
5245 (save-some-buffers arg t)
5246 (and (or (not (memq t (mapcar (function
5247 (lambda (buf) (and (buffer-file-name buf)
5248 (buffer-modified-p buf))))
5249 (buffer-list))))
5250 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5251 (or (not (fboundp 'process-list))
5252 ;; process-list is not defined on VMS.
5253 (let ((processes (process-list))
5254 active)
5255 (while processes
5256 (and (memq (process-status (car processes)) '(run stop open listen))
5257 (process-query-on-exit-flag (car processes))
5258 (setq active t))
5259 (setq processes (cdr processes)))
5260 (or (not active)
5261 (list-processes t)
5262 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5263 ;; Query the user for other things, perhaps.
5264 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5265 (or (null confirm-kill-emacs)
5266 (funcall confirm-kill-emacs "Really exit Emacs? "))
5267 (kill-emacs)))
5268 \f
5269 ;; We use /: as a prefix to "quote" a file name
5270 ;; so that magic file name handlers will not apply to it.
5271
5272 (setq file-name-handler-alist
5273 (cons '("\\`/:" . file-name-non-special)
5274 file-name-handler-alist))
5275
5276 ;; We depend on being the last handler on the list,
5277 ;; so that anything else which does need handling
5278 ;; has been handled already.
5279 ;; So it is safe for us to inhibit *all* magic file name handlers.
5280
5281 (defun file-name-non-special (operation &rest arguments)
5282 (let ((file-name-handler-alist nil)
5283 (default-directory
5284 (if (eq operation 'insert-directory)
5285 (directory-file-name
5286 (expand-file-name
5287 (unhandled-file-name-directory default-directory)))
5288 default-directory))
5289 ;; Get a list of the indices of the args which are file names.
5290 (file-arg-indices
5291 (cdr (or (assq operation
5292 ;; The first six are special because they
5293 ;; return a file name. We want to include the /:
5294 ;; in the return value.
5295 ;; So just avoid stripping it in the first place.
5296 '((expand-file-name . nil)
5297 (file-name-directory . nil)
5298 (file-name-as-directory . nil)
5299 (directory-file-name . nil)
5300 (file-name-sans-versions . nil)
5301 (find-backup-file-name . nil)
5302 ;; `identity' means just return the first arg
5303 ;; not stripped of its quoting.
5304 (substitute-in-file-name identity)
5305 ;; `add' means add "/:" to the result.
5306 (file-truename add 0)
5307 ;; `quote' means add "/:" to buffer-file-name.
5308 (insert-file-contents quote 0)
5309 ;; `unquote-then-quote' means set buffer-file-name
5310 ;; temporarily to unquoted filename.
5311 (verify-visited-file-modtime unquote-then-quote)
5312 ;; List the arguments which are filenames.
5313 (file-name-completion 1)
5314 (file-name-all-completions 1)
5315 (write-region 2 5)
5316 (rename-file 0 1)
5317 (copy-file 0 1)
5318 (make-symbolic-link 0 1)
5319 (add-name-to-file 0 1)))
5320 ;; For all other operations, treat the first argument only
5321 ;; as the file name.
5322 '(nil 0))))
5323 method
5324 ;; Copy ARGUMENTS so we can replace elements in it.
5325 (arguments (copy-sequence arguments)))
5326 (if (symbolp (car file-arg-indices))
5327 (setq method (pop file-arg-indices)))
5328 ;; Strip off the /: from the file names that have it.
5329 (save-match-data
5330 (while (consp file-arg-indices)
5331 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5332 (and (car pair)
5333 (string-match "\\`/:" (car pair))
5334 (setcar pair
5335 (if (= (length (car pair)) 2)
5336 "/"
5337 (substring (car pair) 2)))))
5338 (setq file-arg-indices (cdr file-arg-indices))))
5339 (cond ((eq method 'identity)
5340 (car arguments))
5341 ((eq method 'add)
5342 (concat "/:" (apply operation arguments)))
5343 ((eq method 'quote)
5344 (unwind-protect
5345 (apply operation arguments)
5346 (setq buffer-file-name (concat "/:" buffer-file-name))))
5347 ((eq method 'unquote-then-quote)
5348 (let (res)
5349 (setq buffer-file-name (substring buffer-file-name 2))
5350 (setq res (apply operation arguments))
5351 (setq buffer-file-name (concat "/:" buffer-file-name))
5352 res))
5353 (t
5354 (apply operation arguments)))))
5355 \f
5356 (define-key ctl-x-map "\C-f" 'find-file)
5357 (define-key ctl-x-map "\C-r" 'find-file-read-only)
5358 (define-key ctl-x-map "\C-v" 'find-alternate-file)
5359 (define-key ctl-x-map "\C-s" 'save-buffer)
5360 (define-key ctl-x-map "s" 'save-some-buffers)
5361 (define-key ctl-x-map "\C-w" 'write-file)
5362 (define-key ctl-x-map "i" 'insert-file)
5363 (define-key esc-map "~" 'not-modified)
5364 (define-key ctl-x-map "\C-d" 'list-directory)
5365 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
5366 (define-key ctl-x-map "\C-q" 'toggle-read-only)
5367
5368 (define-key ctl-x-4-map "f" 'find-file-other-window)
5369 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5370 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5371 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
5372 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5373
5374 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5375 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5376 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5377 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5378 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
5379
5380 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5381 ;;; files.el ends here