(revert-buffer): Different error message for reverting a nonexistent file.
[bpt/emacs.git] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4 ;;; Free Software Foundation, Inc.
5
6 ;; Maintainer: FSF
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
30
31 ;;; Code:
32
33 (defgroup backup nil
34 "Backups of edited data files."
35 :group 'files)
36
37 (defgroup find-file nil
38 "Finding files."
39 :group 'files)
40
41
42 (defcustom delete-auto-save-files t
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
44
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
47 :type 'boolean
48 :group 'auto-save)
49
50 (defcustom directory-abbrev-alist
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
57
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
60
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
64 :type '(repeat (cons :format "%v"
65 :value ("" . "")
66 (regexp :tag "From")
67 (regexp :tag "To")))
68 :group 'abbrev
69 :group 'find-file)
70
71 ;; Turn off backup files on VMS since it has version numbers.
72 (defcustom make-backup-files (not (eq system-type 'vax-vms))
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
75
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
80
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
85
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
90 :type 'boolean
91 :group 'backup)
92
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
95 (defvar backup-inhibited nil
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
98 But it is local only if you make it local.")
99 (put 'backup-inhibited 'permanent-local t)
100
101 (defcustom backup-by-copying nil
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
104 :type 'boolean
105 :group 'backup)
106
107 (defcustom backup-by-copying-when-linked nil
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
111 :type 'boolean
112 :group 'backup)
113
114 (defcustom backup-by-copying-when-mismatch nil
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
121 :type 'boolean
122 :group 'backup)
123
124 (defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
134 :group 'backup)
135
136 (defvar backup-enable-predicate 'normal-backup-enable-predicate
137 "Predicate that looks at a file name and decides whether to make backups.
138 Called with an absolute file name as argument, it returns t to enable backup.")
139
140 (defcustom buffer-offer-save nil
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
144 :type 'boolean
145 :group 'backup)
146 (make-variable-buffer-local 'buffer-offer-save)
147
148 (defcustom find-file-existing-other-name t
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
152 :type 'boolean
153 :group 'find-file)
154
155 (defcustom find-file-visit-truename nil
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
159 :type 'boolean
160 :group 'find-file)
161
162 (defcustom revert-without-query
163 nil
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
169 :type '(repeat regexp)
170 :group 'find-file)
171
172 (defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
176 If the buffer is visiting a new file, the value is nil.")
177 (make-variable-buffer-local 'buffer-file-number)
178 (put 'buffer-file-number 'permanent-local t)
179
180 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
182
183 (defvar buffer-file-read-only nil
184 "Non-nil if visited file was read-only when visited.")
185 (make-variable-buffer-local 'buffer-file-read-only)
186
187 (defcustom temporary-file-directory
188 (file-name-as-directory
189 (cond ((memq system-type '(ms-dos windows-nt))
190 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
191 ((memq system-type '(vax-vms axp-vms))
192 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
193 (t
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 "The directory for writing temporary files."
196 :group 'files
197 :type 'directory)
198
199 (defcustom small-temporary-file-directory
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
205 :group 'files
206 :type '(choice (const nil) directory))
207
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
209 (defvar null-device "/dev/null" "The system null device.")
210
211 (defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
215 "[\000-\031]\\|" ; control characters
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
218 ((memq system-type '(ms-dos windows-nt cygwin))
219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
220 "[|<>\"?*\000-\031]")) ; invalid characters
221 (t "[\000]"))
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
223
224 (defcustom file-precious-flag nil
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
227
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
232
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
236 :type 'boolean
237 :group 'backup)
238
239 (defcustom version-control nil
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
244 :type '(choice (const :tag "Never" never)
245 (const :tag "If existing" nil)
246 (other :tag "Always" t))
247 :group 'backup
248 :group 'vc)
249
250 (defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
252 :type 'integer
253 :group 'backup
254 :group 'dired)
255
256 (defcustom delete-old-versions nil
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
259 :type '(choice (const :tag "Delete" t)
260 (const :tag "Ask" nil)
261 (other :tag "Leave" other))
262 :group 'backup)
263
264 (defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
266 :type 'integer
267 :group 'backup)
268
269 (defcustom kept-new-versions 2
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
272 :type 'integer
273 :group 'backup)
274
275 (defcustom require-final-newline nil
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
279 :type '(choice (const :tag "Off" nil)
280 (const :tag "Add" t)
281 (other :tag "Ask" ask))
282 :group 'editing-basics)
283
284 (defcustom auto-save-default t
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
286 :type 'boolean
287 :group 'auto-save)
288
289 (defcustom auto-save-visited-file-name nil
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
292 :type 'boolean
293 :group 'auto-save)
294
295 (defcustom auto-save-file-name-transforms
296 `(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)"
297 ;; Don't put "\\2" inside expand-file-name, since it will be
298 ;; transformed to "/2" on DOS/Windows.
299 ,(concat temporary-file-directory "\\2") t))
300 "*Transforms to apply to buffer file name before making auto-save file name.
301 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
302 REGEXP is a regular expression to match against the file name.
303 If it matches, `replace-match' is used to replace the
304 matching part with REPLACEMENT.
305 If the optional element UNIQUIFY is non-nil, the auto-save file name is
306 constructed by taking the directory part of the replaced file-name,
307 concatenated with the buffer file name with all directory separators
308 changed to `!' to prevent clashes. This will not work
309 correctly if your filesystem truncates the resulting name.
310
311 All the transforms in the list are tried, in the order they are listed.
312 When one transform applies, its result is final;
313 no further transforms are tried.
314
315 The default value is set up to put the auto-save file into the
316 temporary directory (see the variable `temporary-file-directory') for
317 editing a remote file.
318
319 On MS-DOS filesystems without long names this variable is always
320 ignored."
321 :group 'auto-save
322 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
323 (boolean :tag "Uniquify")))
324 :version "21.1")
325
326 (defcustom save-abbrevs t
327 "*Non-nil means save word abbrevs too when files are saved.
328 If `silently', don't ask the user before saving."
329 :type '(choice (const t) (const nil) (const silently))
330 :group 'abbrev)
331
332 (defcustom find-file-run-dired t
333 "*Non-nil means allow `find-file' to visit directories.
334 To visit the directory, `find-file' runs `find-directory-functions'."
335 :type 'boolean
336 :group 'find-file)
337
338 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
339 "*List of functions to try in sequence to visit a directory.
340 Each function is called with the directory name as the sole argument
341 and should return either a buffer or nil."
342 :type '(hook :options (cvs-dired-noselect dired-noselect))
343 :group 'find-file)
344
345 ;;;It is not useful to make this a local variable.
346 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
347 (defvar find-file-not-found-functions nil
348 "List of functions to be called for `find-file' on nonexistent file.
349 These functions are called as soon as the error is detected.
350 Variable `buffer-file-name' is already set up.
351 The functions are called in the order given until one of them returns non-nil.")
352 (defvaralias 'find-file-not-found-hooks 'find-file-not-found-functions)
353 (make-obsolete-variable
354 'find-file-not-found-hooks 'find-file-not-found-functions "21.4")
355
356 ;;;It is not useful to make this a local variable.
357 ;;;(put 'find-file-hooks 'permanent-local t)
358 (defvar find-file-hook nil
359 "List of functions to be called after a buffer is loaded from a file.
360 The buffer's local variables (if any) will have been processed before the
361 functions are called.")
362 (defvaralias 'find-file-hooks 'find-file-hook)
363 (make-obsolete-variable 'find-file-hooks 'find-file-hook "21.4")
364
365 (defvar write-file-functions nil
366 "List of functions to be called before writing out a buffer to a file.
367 If one of them returns non-nil, the file is considered already written
368 and the rest are not called.
369 These hooks are considered to pertain to the visited file.
370 So any buffer-local binding of this variable is discarded if you change
371 the visited file name with \\[set-visited-file-name], but not when you
372 change the major mode.
373
374 See also `write-contents-functions'.")
375 (put 'write-file-functions 'permanent-local t)
376 (defvaralias 'write-file-hooks 'write-file-functions)
377 (make-obsolete-variable 'write-file-hooks 'write-file-functions "21.4")
378
379 (defvar local-write-file-hooks nil)
380 (make-variable-buffer-local 'local-write-file-hooks)
381 (put 'local-write-file-hooks 'permanent-local t)
382 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "21.4")
383
384 (defvar write-contents-functions nil
385 "List of functions to be called before writing out a buffer to a file.
386 If one of them returns non-nil, the file is considered already written
387 and the rest are not called.
388
389 This variable is meant to be used for hooks that pertain to the
390 buffer's contents, not to the particular visited file; thus,
391 `set-visited-file-name' does not clear this variable; but changing the
392 major mode does clear it.
393
394 See also `write-file-functions'.")
395 (make-variable-buffer-local 'write-contents-functions)
396 (defvaralias 'write-contents-hooks 'write-contents-functions)
397 (make-obsolete-variable 'write-contents-hooks 'write-contents-functions "21.4")
398
399 (defcustom enable-local-variables t
400 "*Control use of local variables in files you visit.
401 The value can be t, nil or something else.
402 A value of t means file local variables specifications are obeyed;
403 nil means they are ignored; anything else means query.
404 This variable also controls use of major modes specified in
405 a -*- line.
406
407 The command \\[normal-mode], when used interactively,
408 always obeys file local variable specifications and the -*- line,
409 and ignores this variable."
410 :type '(choice (const :tag "Obey" t)
411 (const :tag "Ignore" nil)
412 (other :tag "Query" other))
413 :group 'find-file)
414
415 (defvar local-enable-local-variables t
416 "Like `enable-local-variables' but meant for buffer-local bindings.
417 The meaningful values are nil and non-nil. The default is non-nil.
418 If a major mode sets this to nil, buffer-locally, then any local
419 variables list in the file will be ignored.
420
421 This variable does not affect the use of major modes
422 specified in a -*- line.")
423
424 (defcustom enable-local-eval 'maybe
425 "*Control processing of the \"variable\" `eval' in a file's local variables.
426 The value can be t, nil or something else.
427 A value of t means obey `eval' variables;
428 nil means ignore them; anything else means query.
429
430 The command \\[normal-mode] always obeys local-variables lists
431 and ignores this variable."
432 :type '(choice (const :tag "Obey" t)
433 (const :tag "Ignore" nil)
434 (other :tag "Query" other))
435 :group 'find-file)
436
437 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
438 (or (fboundp 'lock-buffer)
439 (defalias 'lock-buffer 'ignore))
440 (or (fboundp 'unlock-buffer)
441 (defalias 'unlock-buffer 'ignore))
442 (or (fboundp 'file-locked-p)
443 (defalias 'file-locked-p 'ignore))
444
445 (defvar view-read-only nil
446 "*Non-nil means buffers visiting files read-only, do it in view mode.")
447
448 (put 'ange-ftp-completion-hook-function 'safe-magic t)
449 (defun ange-ftp-completion-hook-function (op &rest args)
450 "Provides support for ange-ftp host name completion.
451 Runs the usual ange-ftp hook, but only for completion operations."
452 ;; Having this here avoids the need to load ange-ftp when it's not
453 ;; really in use.
454 (if (memq op '(file-name-completion file-name-all-completions))
455 (apply 'ange-ftp-hook-function op args)
456 (let ((inhibit-file-name-handlers
457 (cons 'ange-ftp-completion-hook-function
458 (and (eq inhibit-file-name-operation op)
459 inhibit-file-name-handlers)))
460 (inhibit-file-name-operation op))
461 (apply op args))))
462
463 (defun convert-standard-filename (filename)
464 "Convert a standard file's name to something suitable for the current OS.
465 This function's standard definition is trivial; it just returns the argument.
466 However, on some systems, the function is redefined with a definition
467 that really does change some file names to canonicalize certain
468 patterns and to guarantee valid names."
469 filename)
470
471 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
472 "Read directory name, prompting with PROMPT and completing in directory DIR.
473 Value is not expanded---you must call `expand-file-name' yourself.
474 Default name to DEFAULT-DIRNAME if user enters a null string.
475 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
476 except that if INITIAL is specified, that combined with DIR is used.)
477 Fourth arg MUSTMATCH non-nil means require existing directory's name.
478 Non-nil and non-t means also require confirmation after completion.
479 Fifth arg INITIAL specifies text to start with.
480 DIR defaults to current buffer's directory default."
481 (unless dir
482 (setq dir default-directory))
483 (unless default-dirname
484 (setq default-dirname
485 (if initial (concat dir initial) default-directory)))
486 (read-file-name prompt dir default-dirname mustmatch initial
487 'file-directory-p))
488
489 \f
490 (defun pwd ()
491 "Show the current default directory."
492 (interactive nil)
493 (message "Directory %s" default-directory))
494
495 (defvar cd-path nil
496 "Value of the CDPATH environment variable, as a list.
497 Not actually set up until the first time you use it.")
498
499 (defun parse-colon-path (cd-path)
500 "Explode a colon-separated search path into a list of directory names.
501 \(For values of `colon' equal to `path-separator'.)"
502 ;; We could use split-string here.
503 (and cd-path
504 (let (cd-prefix cd-list (cd-start 0) cd-colon)
505 (setq cd-path (concat cd-path path-separator))
506 (while (setq cd-colon (string-match path-separator cd-path cd-start))
507 (setq cd-list
508 (nconc cd-list
509 (list (if (= cd-start cd-colon)
510 nil
511 (substitute-in-file-name
512 (file-name-as-directory
513 (substring cd-path cd-start cd-colon)))))))
514 (setq cd-start (+ cd-colon 1)))
515 cd-list)))
516
517 (defun cd-absolute (dir)
518 "Change current directory to given absolute file name DIR."
519 ;; Put the name into directory syntax now,
520 ;; because otherwise expand-file-name may give some bad results.
521 (if (not (eq system-type 'vax-vms))
522 (setq dir (file-name-as-directory dir)))
523 (setq dir (abbreviate-file-name (expand-file-name dir)))
524 (if (not (file-directory-p dir))
525 (if (file-exists-p dir)
526 (error "%s is not a directory" dir)
527 (error "%s: no such directory" dir))
528 (if (file-executable-p dir)
529 (setq default-directory dir)
530 (error "Cannot cd to %s: Permission denied" dir))))
531
532 (defun cd (dir)
533 "Make DIR become the current buffer's default directory.
534 If your environment includes a `CDPATH' variable, try each one of that
535 colon-separated list of directories when resolving a relative directory name."
536 (interactive
537 (list (read-directory-name "Change default directory: "
538 default-directory default-directory
539 (and (member cd-path '(nil ("./")))
540 (null (getenv "CDPATH"))))))
541 (if (file-name-absolute-p dir)
542 (cd-absolute (expand-file-name dir))
543 (if (null cd-path)
544 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
545 (setq cd-path (or trypath (list "./")))))
546 (if (not (catch 'found
547 (mapcar
548 (function (lambda (x)
549 (let ((f (expand-file-name (concat x dir))))
550 (if (file-directory-p f)
551 (progn
552 (cd-absolute f)
553 (throw 'found t))))))
554 cd-path)
555 nil))
556 (error "No such directory found via CDPATH environment variable"))))
557
558 (defun load-file (file)
559 "Load the Lisp file named FILE."
560 ;; This is a case where .elc makes a lot of sense.
561 (interactive (list (let ((completion-ignored-extensions
562 (remove ".elc" completion-ignored-extensions)))
563 (read-file-name "Load file: "))))
564 (load (expand-file-name file) nil nil t))
565
566 (defun locate-file (filename path &optional suffixes predicate)
567 "Search for FILENAME through PATH.
568 If SUFFIXES is non-nil, it should be a list of suffixes to append to
569 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
570 If non-nil, PREDICATE is used instead of `file-readable-p'.
571 PREDICATE can also be an integer to pass to the `access' system call,
572 in which case file-name handlers are ignored. This usage is deprecated.
573
574 For compatibility, PREDICATE can also be one of the symbols
575 `executable', `readable', `writable', or `exists', or a list of
576 one or more of those symbols."
577 (if (and predicate (symbolp predicate) (not (functionp predicate)))
578 (setq predicate (list predicate)))
579 (when (and (consp predicate) (not (functionp predicate)))
580 (setq predicate
581 (logior (if (memq 'executable predicate) 1 0)
582 (if (memq 'writable predicate) 2 0)
583 (if (memq 'readable predicate) 4 0))))
584 (locate-file-internal filename path suffixes predicate))
585
586 (defun locate-file-completion (string path-and-suffixes action)
587 "Do completion for file names passed to `locate-file'.
588 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
589 (if (file-name-absolute-p string)
590 (read-file-name-internal string nil action)
591 (let ((names nil)
592 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
593 (string-dir (file-name-directory string)))
594 (dolist (dir (car path-and-suffixes))
595 (if string-dir (setq dir (expand-file-name string-dir dir)))
596 (when (file-directory-p dir)
597 (dolist (file (file-name-all-completions
598 (file-name-nondirectory string) dir))
599 (push (if string-dir (concat string-dir file) file) names)
600 (when (string-match suffix file)
601 (setq file (substring file 0 (match-beginning 0)))
602 (push (if string-dir (concat string-dir file) file) names)))))
603 (cond
604 ((eq action t) (all-completions string names))
605 ((null action) (try-completion string names))
606 (t (test-completion string names))))))
607
608 (defun load-library (library)
609 "Load the library named LIBRARY.
610 This is an interface to the function `load'."
611 (interactive
612 (list (completing-read "Load library: "
613 'locate-file-completion
614 (cons load-path load-suffixes))))
615 (load library))
616
617 (defun file-remote-p (file)
618 "Test whether FILE specifies a location on a remote system."
619 (let ((handler (find-file-name-handler file 'file-local-copy)))
620 (if handler
621 (get handler 'file-remote-p))))
622
623 (defun file-local-copy (file)
624 "Copy the file FILE into a temporary file on this machine.
625 Returns the name of the local copy, or nil, if FILE is directly
626 accessible."
627 ;; This formerly had an optional BUFFER argument that wasn't used by
628 ;; anything.
629 (let ((handler (find-file-name-handler file 'file-local-copy)))
630 (if handler
631 (funcall handler 'file-local-copy file)
632 nil)))
633
634 (defun file-truename (filename &optional counter prev-dirs)
635 "Return the truename of FILENAME, which should be absolute.
636 The truename of a file name is found by chasing symbolic links
637 both at the level of the file and at the level of the directories
638 containing it, until no links are left at any level.
639
640 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
641 Do not specify them in other calls."
642 ;; COUNTER can be a cons cell whose car is the count of how many more links
643 ;; to chase before getting an error.
644 ;; PREV-DIRS can be a cons cell whose car is an alist
645 ;; of truenames we've just recently computed.
646
647 ;; The last test looks dubious, maybe `+' is meant here? --simon.
648 (if (or (string= filename "") (string= filename "~")
649 (and (string= (substring filename 0 1) "~")
650 (string-match "~[^/]*" filename)))
651 (progn
652 (setq filename (expand-file-name filename))
653 (if (string= filename "")
654 (setq filename "/"))))
655 (or counter (setq counter (list 100)))
656 (let (done
657 ;; For speed, remove the ange-ftp completion handler from the list.
658 ;; We know it's not needed here.
659 ;; For even more speed, do this only on the outermost call.
660 (file-name-handler-alist
661 (if prev-dirs file-name-handler-alist
662 (let ((tem (copy-sequence file-name-handler-alist)))
663 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
664 (or prev-dirs (setq prev-dirs (list nil)))
665
666 ;; andrewi@harlequin.co.uk - none of the following code (except for
667 ;; invoking the file-name handler) currently applies on Windows
668 ;; (ie. there are no native symlinks), but there is an issue with
669 ;; case differences being ignored by the OS, and short "8.3 DOS"
670 ;; name aliases existing for all files. (The short names are not
671 ;; reported by directory-files, but can be used to refer to files.)
672 ;; It seems appropriate for file-truename to resolve these issues in
673 ;; the most natural way, which on Windows is to call the function
674 ;; `w32-long-file-name' - this returns the exact name of a file as
675 ;; it is stored on disk (expanding short name aliases with the full
676 ;; name in the process).
677 (if (eq system-type 'windows-nt)
678 (let ((handler (find-file-name-handler filename 'file-truename)))
679 ;; For file name that has a special handler, call handler.
680 ;; This is so that ange-ftp can save time by doing a no-op.
681 (if handler
682 (setq filename (funcall handler 'file-truename filename))
683 ;; If filename contains a wildcard, newname will be the old name.
684 (unless (string-match "[[*?]" filename)
685 ;; If filename exists, use the long name
686 (setq filename (or (w32-long-file-name filename) filename))))
687 (setq done t)))
688
689 ;; If this file directly leads to a link, process that iteratively
690 ;; so that we don't use lots of stack.
691 (while (not done)
692 (setcar counter (1- (car counter)))
693 (if (< (car counter) 0)
694 (error "Apparent cycle of symbolic links for %s" filename))
695 (let ((handler (find-file-name-handler filename 'file-truename)))
696 ;; For file name that has a special handler, call handler.
697 ;; This is so that ange-ftp can save time by doing a no-op.
698 (if handler
699 (setq filename (funcall handler 'file-truename filename)
700 done t)
701 (let ((dir (or (file-name-directory filename) default-directory))
702 target dirfile)
703 ;; Get the truename of the directory.
704 (setq dirfile (directory-file-name dir))
705 ;; If these are equal, we have the (or a) root directory.
706 (or (string= dir dirfile)
707 ;; If this is the same dir we last got the truename for,
708 ;; save time--don't recalculate.
709 (if (assoc dir (car prev-dirs))
710 (setq dir (cdr (assoc dir (car prev-dirs))))
711 (let ((old dir)
712 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
713 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
714 (setq dir new))))
715 (if (equal ".." (file-name-nondirectory filename))
716 (setq filename
717 (directory-file-name (file-name-directory (directory-file-name dir)))
718 done t)
719 (if (equal "." (file-name-nondirectory filename))
720 (setq filename (directory-file-name dir)
721 done t)
722 ;; Put it back on the file name.
723 (setq filename (concat dir (file-name-nondirectory filename)))
724 ;; Is the file name the name of a link?
725 (setq target (file-symlink-p filename))
726 (if target
727 ;; Yes => chase that link, then start all over
728 ;; since the link may point to a directory name that uses links.
729 ;; We can't safely use expand-file-name here
730 ;; since target might look like foo/../bar where foo
731 ;; is itself a link. Instead, we handle . and .. above.
732 (setq filename
733 (if (file-name-absolute-p target)
734 target
735 (concat dir target))
736 done nil)
737 ;; No, we are done!
738 (setq done t))))))))
739 filename))
740
741 (defun file-chase-links (filename)
742 "Chase links in FILENAME until a name that is not a link.
743 Does not examine containing directories for links,
744 unlike `file-truename'."
745 (let (tem (count 100) (newname filename))
746 (while (setq tem (file-symlink-p newname))
747 (save-match-data
748 (if (= count 0)
749 (error "Apparent cycle of symbolic links for %s" filename))
750 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
751 (while (string-match "//+" tem)
752 (setq tem (replace-match "/" nil nil tem)))
753 ;; Handle `..' by hand, since it needs to work in the
754 ;; target of any directory symlink.
755 ;; This code is not quite complete; it does not handle
756 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
757 (while (string-match "\\`\\.\\./" tem)
758 (setq tem (substring tem 3))
759 (setq newname (expand-file-name newname))
760 ;; Chase links in the default dir of the symlink.
761 (setq newname
762 (file-chase-links
763 (directory-file-name (file-name-directory newname))))
764 ;; Now find the parent of that dir.
765 (setq newname (file-name-directory newname)))
766 (setq newname (expand-file-name tem (file-name-directory newname)))
767 (setq count (1- count))))
768 newname))
769 \f
770 (defun switch-to-buffer-other-window (buffer &optional norecord)
771 "Select buffer BUFFER in another window.
772 Optional second arg NORECORD non-nil means
773 do not put this buffer at the front of the list of recently selected ones.
774
775 This uses the function `display-buffer' as a subroutine; see its
776 documentation for additional customization information."
777 (interactive "BSwitch to buffer in other window: ")
778 (let ((pop-up-windows t))
779 (pop-to-buffer buffer t norecord)))
780
781 (defun switch-to-buffer-other-frame (buffer &optional norecord)
782 "Switch to buffer BUFFER in another frame.
783 Optional second arg NORECORD non-nil means
784 do not put this buffer at the front of the list of recently selected ones.
785
786 This uses the function `display-buffer' as a subroutine; see its
787 documentation for additional customization information."
788 (interactive "BSwitch to buffer in other frame: ")
789 (let ((pop-up-frames t))
790 (pop-to-buffer buffer t norecord)
791 (raise-frame (window-frame (selected-window)))))
792
793 (defvar find-file-default nil
794 "Used within `find-file-read-args'.")
795
796 (defun find-file-read-args (prompt mustmatch)
797 (list (let ((find-file-default
798 (and buffer-file-name
799 (abbreviate-file-name buffer-file-name)))
800 (munge-default-fun
801 (lambda ()
802 (setq minibuffer-default find-file-default)
803 ;; Clear out this hook so it does not interfere
804 ;; with any recursive minibuffer usage.
805 (pop minibuffer-setup-hook)))
806 (minibuffer-setup-hook
807 minibuffer-setup-hook))
808 (add-hook 'minibuffer-setup-hook munge-default-fun)
809 (read-file-name prompt nil default-directory mustmatch))
810 t))
811
812 (defun find-file (filename &optional wildcards)
813 "Edit file FILENAME.
814 Switch to a buffer visiting file FILENAME,
815 creating one if none already exists.
816 Interactively, the default if you just type RET is the current directory,
817 but the visited file name is available through the minibuffer history:
818 type M-n to pull it into the minibuffer.
819
820 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
821 expand wildcards (if any) and visit multiple files. Wildcard expansion
822 can be suppressed by setting `find-file-wildcards'."
823 (interactive
824 (find-file-read-args "Find file: " nil))
825 (let ((value (find-file-noselect filename nil nil wildcards)))
826 (if (listp value)
827 (mapcar 'switch-to-buffer (nreverse value))
828 (switch-to-buffer value))))
829
830 (defun find-file-other-window (filename &optional wildcards)
831 "Edit file FILENAME, in another window.
832 May create a new window, or reuse an existing one.
833 See the function `display-buffer'.
834
835 Interactively, the default if you just type RET is the current directory,
836 but the visited file name is available through the minibuffer history:
837 type M-n to pull it into the minibuffer.
838
839 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
840 expand wildcards (if any) and visit multiple files."
841 (interactive (find-file-read-args "Find file in other window: " nil))
842 (let ((value (find-file-noselect filename nil nil wildcards)))
843 (if (listp value)
844 (progn
845 (setq value (nreverse value))
846 (switch-to-buffer-other-window (car value))
847 (mapcar 'switch-to-buffer (cdr value)))
848 (switch-to-buffer-other-window value))))
849
850 (defun find-file-other-frame (filename &optional wildcards)
851 "Edit file FILENAME, in another frame.
852 May create a new frame, or reuse an existing one.
853 See the function `display-buffer'.
854
855 Interactively, the default if you just type RET is the current directory,
856 but the visited file name is available through the minibuffer history:
857 type M-n to pull it into the minibuffer.
858
859 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
860 expand wildcards (if any) and visit multiple files."
861 (interactive (find-file-read-args "Find file in other frame: " nil))
862 (let ((value (find-file-noselect filename nil nil wildcards)))
863 (if (listp value)
864 (progn
865 (setq value (nreverse value))
866 (switch-to-buffer-other-frame (car value))
867 (mapcar 'switch-to-buffer (cdr value)))
868 (switch-to-buffer-other-frame value))))
869
870 (defun find-file-read-only (filename &optional wildcards)
871 "Edit file FILENAME but don't allow changes.
872 Like \\[find-file] but marks buffer as read-only.
873 Use \\[toggle-read-only] to permit editing."
874 (interactive (find-file-read-args "Find file read-only: " t))
875 (find-file filename wildcards)
876 (toggle-read-only 1)
877 (current-buffer))
878
879 (defun find-file-read-only-other-window (filename &optional wildcards)
880 "Edit file FILENAME in another window but don't allow changes.
881 Like \\[find-file-other-window] but marks buffer as read-only.
882 Use \\[toggle-read-only] to permit editing."
883 (interactive (find-file-read-args "Find file read-only other window: " t))
884 (find-file-other-window filename wildcards)
885 (toggle-read-only 1)
886 (current-buffer))
887
888 (defun find-file-read-only-other-frame (filename &optional wildcards)
889 "Edit file FILENAME in another frame but don't allow changes.
890 Like \\[find-file-other-frame] but marks buffer as read-only.
891 Use \\[toggle-read-only] to permit editing."
892 (interactive (find-file-read-args "Find file read-only other frame: " t))
893 (find-file-other-frame filename wildcards)
894 (toggle-read-only 1)
895 (current-buffer))
896
897 (defun find-alternate-file-other-window (filename)
898 "Find file FILENAME as a replacement for the file in the next window.
899 This command does not select that window."
900 (interactive
901 (save-selected-window
902 (other-window 1)
903 (let ((file buffer-file-name)
904 (file-name nil)
905 (file-dir nil))
906 (and file
907 (setq file-name (file-name-nondirectory file)
908 file-dir (file-name-directory file)))
909 (list (read-file-name
910 "Find alternate file: " file-dir nil nil file-name)))))
911 (if (one-window-p)
912 (find-file-other-window filename)
913 (save-selected-window
914 (other-window 1)
915 (find-alternate-file filename))))
916
917 (defun find-alternate-file (filename)
918 "Find file FILENAME, select its buffer, kill previous buffer.
919 If the current buffer now contains an empty file that you just visited
920 \(presumably by mistake), use this command to visit the file you really want."
921 (interactive
922 (let ((file buffer-file-name)
923 (file-name nil)
924 (file-dir nil))
925 (and file
926 (setq file-name (file-name-nondirectory file)
927 file-dir (file-name-directory file)))
928 (list (read-file-name
929 "Find alternate file: " file-dir nil nil file-name))))
930 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
931 (error "Aborted"))
932 (when (and (buffer-modified-p) (buffer-file-name))
933 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
934 (buffer-name)))
935 (save-buffer)
936 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
937 (error "Aborted"))))
938 (let ((obuf (current-buffer))
939 (ofile buffer-file-name)
940 (onum buffer-file-number)
941 (odir dired-directory)
942 (otrue buffer-file-truename)
943 (oname (buffer-name)))
944 (if (get-buffer " **lose**")
945 (kill-buffer " **lose**"))
946 (rename-buffer " **lose**")
947 (unwind-protect
948 (progn
949 (unlock-buffer)
950 ;; This prevents us from finding the same buffer
951 ;; if we specified the same file again.
952 (setq buffer-file-name nil)
953 (setq buffer-file-number nil)
954 (setq buffer-file-truename nil)
955 ;; Likewise for dired buffers.
956 (setq dired-directory nil)
957 (find-file filename))
958 (when (eq obuf (current-buffer))
959 ;; This executes if find-file gets an error
960 ;; and does not really find anything.
961 ;; We put things back as they were.
962 ;; If find-file actually finds something, we kill obuf below.
963 (setq buffer-file-name ofile)
964 (setq buffer-file-number onum)
965 (setq buffer-file-truename otrue)
966 (setq dired-directory odir)
967 (lock-buffer)
968 (rename-buffer oname)))
969 (unless (eq (current-buffer) obuf)
970 (with-current-buffer obuf
971 ;; We already asked; don't ask again.
972 (let ((kill-buffer-query-functions))
973 (kill-buffer obuf))))))
974 \f
975 (defun create-file-buffer (filename)
976 "Create a suitably named buffer for visiting FILENAME, and return it.
977 FILENAME (sans directory) is used unchanged if that name is free;
978 otherwise a string <2> or <3> or ... is appended to get an unused name."
979 (let ((lastname (file-name-nondirectory filename)))
980 (if (string= lastname "")
981 (setq lastname filename))
982 (generate-new-buffer lastname)))
983
984 (defun generate-new-buffer (name)
985 "Create and return a buffer with a name based on NAME.
986 Choose the buffer's name using `generate-new-buffer-name'."
987 (get-buffer-create (generate-new-buffer-name name)))
988
989 (defcustom automount-dir-prefix "^/tmp_mnt/"
990 "Regexp to match the automounter prefix in a directory name."
991 :group 'files
992 :type 'regexp)
993
994 (defvar abbreviated-home-dir nil
995 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
996
997 (defun abbreviate-file-name (filename)
998 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
999 This also substitutes \"~\" for the user's home directory and
1000 removes automounter prefixes (see the variable `automount-dir-prefix')."
1001 ;; Get rid of the prefixes added by the automounter.
1002 (if (and automount-dir-prefix
1003 (string-match automount-dir-prefix filename)
1004 (file-exists-p (file-name-directory
1005 (substring filename (1- (match-end 0))))))
1006 (setq filename (substring filename (1- (match-end 0)))))
1007 (let ((tail directory-abbrev-alist))
1008 ;; If any elt of directory-abbrev-alist matches this name,
1009 ;; abbreviate accordingly.
1010 (while tail
1011 (if (string-match (car (car tail)) filename)
1012 (setq filename
1013 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1014 (setq tail (cdr tail)))
1015 ;; Compute and save the abbreviated homedir name.
1016 ;; We defer computing this until the first time it's needed, to
1017 ;; give time for directory-abbrev-alist to be set properly.
1018 ;; We include a slash at the end, to avoid spurious matches
1019 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1020 (or abbreviated-home-dir
1021 (setq abbreviated-home-dir
1022 (let ((abbreviated-home-dir "$foo"))
1023 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1024 "\\(/\\|$\\)"))))
1025
1026 ;; If FILENAME starts with the abbreviated homedir,
1027 ;; make it start with `~' instead.
1028 (if (and (string-match abbreviated-home-dir filename)
1029 ;; If the home dir is just /, don't change it.
1030 (not (and (= (match-end 0) 1)
1031 (= (aref filename 0) ?/)))
1032 ;; MS-DOS root directories can come with a drive letter;
1033 ;; Novell Netware allows drive letters beyond `Z:'.
1034 (not (and (or (eq system-type 'ms-dos)
1035 (eq system-type 'cygwin)
1036 (eq system-type 'windows-nt))
1037 (save-match-data
1038 (string-match "^[a-zA-`]:/$" filename)))))
1039 (setq filename
1040 (concat "~"
1041 (substring filename (match-beginning 1) (match-end 1))
1042 (substring filename (match-end 0)))))
1043 filename))
1044
1045 (defcustom find-file-not-true-dirname-list nil
1046 "*List of logical names for which visiting shouldn't save the true dirname.
1047 On VMS, when you visit a file using a logical name that searches a path,
1048 you may or may not want the visited file name to record the specific
1049 directory where the file was found. If you *do not* want that, add the logical
1050 name to this list as a string."
1051 :type '(repeat (string :tag "Name"))
1052 :group 'find-file)
1053
1054 (defun find-buffer-visiting (filename &optional predicate)
1055 "Return the buffer visiting file FILENAME (a string).
1056 This is like `get-file-buffer', except that it checks for any buffer
1057 visiting the same file, possibly under a different name.
1058 If PREDICATE is non-nil, only a buffer satisfying it can be returned.
1059 If there is no such live buffer, return nil."
1060 (let ((predicate (or predicate #'identity))
1061 (truename (abbreviate-file-name (file-truename filename))))
1062 (or (let ((buf (get-file-buffer filename)))
1063 (when (and buf (funcall predicate buf)) buf))
1064 (let ((list (buffer-list)) found)
1065 (while (and (not found) list)
1066 (save-excursion
1067 (set-buffer (car list))
1068 (if (and buffer-file-name
1069 (string= buffer-file-truename truename)
1070 (funcall predicate (current-buffer)))
1071 (setq found (car list))))
1072 (setq list (cdr list)))
1073 found)
1074 (let* ((attributes (file-attributes truename))
1075 (number (nthcdr 10 attributes))
1076 (list (buffer-list)) found)
1077 (and buffer-file-numbers-unique
1078 number
1079 (while (and (not found) list)
1080 (with-current-buffer (car list)
1081 (if (and buffer-file-name
1082 (equal buffer-file-number number)
1083 ;; Verify this buffer's file number
1084 ;; still belongs to its file.
1085 (file-exists-p buffer-file-name)
1086 (equal (file-attributes buffer-file-truename)
1087 attributes)
1088 (funcall predicate (current-buffer)))
1089 (setq found (car list))))
1090 (setq list (cdr list))))
1091 found))))
1092 \f
1093 (defcustom find-file-wildcards t
1094 "*Non-nil means file-visiting commands should handle wildcards.
1095 For example, if you specify `*.c', that would visit all the files
1096 whose names match the pattern."
1097 :group 'files
1098 :version "20.4"
1099 :type 'boolean)
1100
1101 (defcustom find-file-suppress-same-file-warnings nil
1102 "*Non-nil means suppress warning messages for symlinked files.
1103 When nil, Emacs prints a warning when visiting a file that is already
1104 visited, but with a different name. Setting this option to t
1105 suppresses this warning."
1106 :group 'files
1107 :version "21.1"
1108 :type 'boolean)
1109
1110 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1111 "Read file FILENAME into a buffer and return the buffer.
1112 If a buffer exists visiting FILENAME, return that one, but
1113 verify that the file has not changed since visited or saved.
1114 The buffer is not selected, just returned to the caller.
1115 Optional first arg NOWARN non-nil means suppress any warning messages.
1116 Optional second arg RAWFILE non-nil means the file is read literally.
1117 Optional third arg WILDCARDS non-nil means do wildcard processing
1118 and visit all the matching files. When wildcards are actually
1119 used and expanded, the value is a list of buffers
1120 that are visiting the various files."
1121 (setq filename
1122 (abbreviate-file-name
1123 (expand-file-name filename)))
1124 (if (file-directory-p filename)
1125 (or (and find-file-run-dired
1126 (run-hook-with-args-until-success
1127 'find-directory-functions
1128 (if find-file-visit-truename
1129 (abbreviate-file-name (file-truename filename))
1130 filename)))
1131 (error "%s is a directory" filename))
1132 (if (and wildcards
1133 find-file-wildcards
1134 (not (string-match "\\`/:" filename))
1135 (string-match "[[*?]" filename))
1136 (let ((files (condition-case nil
1137 (file-expand-wildcards filename t)
1138 (error (list filename))))
1139 (find-file-wildcards nil))
1140 (if (null files)
1141 (find-file-noselect filename)
1142 (mapcar #'find-file-noselect files)))
1143 (let* ((buf (get-file-buffer filename))
1144 (truename (abbreviate-file-name (file-truename filename)))
1145 (number (nthcdr 10 (file-attributes truename)))
1146 ;; Find any buffer for a file which has same truename.
1147 (other (and (not buf) (find-buffer-visiting filename))))
1148 ;; Let user know if there is a buffer with the same truename.
1149 (if other
1150 (progn
1151 (or nowarn
1152 find-file-suppress-same-file-warnings
1153 (string-equal filename (buffer-file-name other))
1154 (message "%s and %s are the same file"
1155 filename (buffer-file-name other)))
1156 ;; Optionally also find that buffer.
1157 (if (or find-file-existing-other-name find-file-visit-truename)
1158 (setq buf other))))
1159 (if buf
1160 ;; We are using an existing buffer.
1161 (progn
1162 (or nowarn
1163 (verify-visited-file-modtime buf)
1164 (cond ((not (file-exists-p filename))
1165 (error "File %s no longer exists!" filename))
1166 ;; Certain files should be reverted automatically
1167 ;; if they have changed on disk and not in the buffer.
1168 ((and (not (buffer-modified-p buf))
1169 (let ((tail revert-without-query)
1170 (found nil))
1171 (while tail
1172 (if (string-match (car tail) filename)
1173 (setq found t))
1174 (setq tail (cdr tail)))
1175 found))
1176 (with-current-buffer buf
1177 (message "Reverting file %s..." filename)
1178 (revert-buffer t t)
1179 (message "Reverting file %s...done" filename)))
1180 ((yes-or-no-p
1181 (if (string= (file-name-nondirectory filename)
1182 (buffer-name buf))
1183 (format
1184 (if (buffer-modified-p buf)
1185 "File %s changed on disk. Discard your edits? "
1186 "File %s changed on disk. Reread from disk? ")
1187 (file-name-nondirectory filename))
1188 (format
1189 (if (buffer-modified-p buf)
1190 "File %s changed on disk. Discard your edits in %s? "
1191 "File %s changed on disk. Reread from disk into %s? ")
1192 (file-name-nondirectory filename)
1193 (buffer-name buf))))
1194 (with-current-buffer buf
1195 (revert-buffer t t)))))
1196 (with-current-buffer buf
1197
1198 ;; Check if a formerly read-only file has become
1199 ;; writable and vice versa, but if the buffer agrees
1200 ;; with the new state of the file, that is ok too.
1201 (let ((read-only (not (file-writable-p buffer-file-name))))
1202 (unless (or (eq read-only buffer-file-read-only)
1203 (eq read-only buffer-read-only))
1204 (when (or nowarn
1205 (let ((question
1206 (format "File %s is %s on disk. Change buffer mode? "
1207 buffer-file-name
1208 (if read-only "read-only" "writable"))))
1209 (y-or-n-p question)))
1210 (setq buffer-read-only read-only)))
1211 (setq buffer-file-read-only read-only))
1212
1213 (when (and (not (eq (not (null rawfile))
1214 (not (null find-file-literally))))
1215 ;; It is confusing to ask whether to visit
1216 ;; non-literally if they have the file in
1217 ;; hexl-mode.
1218 (not (eq major-mode 'hexl-mode)))
1219 (if (buffer-modified-p)
1220 (if (y-or-n-p (if rawfile
1221 "Save file and revisit literally? "
1222 "Save file and revisit non-literally? "))
1223 (progn
1224 (save-buffer)
1225 (find-file-noselect-1 buf filename nowarn
1226 rawfile truename number))
1227 (if (y-or-n-p (if rawfile
1228 "Discard your edits and revisit file literally? "
1229 "Discard your edits and revisit file non-literally? "))
1230 (find-file-noselect-1 buf filename nowarn
1231 rawfile truename number)
1232 (error (if rawfile "File already visited non-literally"
1233 "File already visited literally"))))
1234 (if (y-or-n-p (if rawfile
1235 "Revisit file literally? "
1236 "Revisit file non-literally? "))
1237 (find-file-noselect-1 buf filename nowarn
1238 rawfile truename number)
1239 (error (if rawfile "File already visited non-literally"
1240 "File already visited literally"))))))
1241 ;; Return the buffer we are using.
1242 buf)
1243 ;; Create a new buffer.
1244 (setq buf (create-file-buffer filename))
1245 (set-buffer-major-mode buf)
1246 ;; find-file-noselect-1 may use a different buffer.
1247 (find-file-noselect-1 buf filename nowarn
1248 rawfile truename number))))))
1249
1250 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1251 (let ((inhibit-read-only t)
1252 error)
1253 (with-current-buffer buf
1254 (kill-local-variable 'find-file-literally)
1255 ;; Needed in case we are re-visiting the file with a different
1256 ;; text representation.
1257 (kill-local-variable 'buffer-file-coding-system)
1258 (kill-local-variable 'cursor-type)
1259 (erase-buffer)
1260 (and (default-value 'enable-multibyte-characters)
1261 (not rawfile)
1262 (set-buffer-multibyte t))
1263 (if rawfile
1264 (condition-case ()
1265 (insert-file-contents-literally filename t)
1266 (file-error
1267 (when (and (file-exists-p filename)
1268 (not (file-readable-p filename)))
1269 (kill-buffer buf)
1270 (signal 'file-error (list "File is not readable"
1271 filename)))
1272 ;; Unconditionally set error
1273 (setq error t)))
1274 (condition-case ()
1275 (insert-file-contents filename t)
1276 (file-error
1277 (when (and (file-exists-p filename)
1278 (not (file-readable-p filename)))
1279 (kill-buffer buf)
1280 (signal 'file-error (list "File is not readable"
1281 filename)))
1282 ;; Run find-file-not-found-hooks until one returns non-nil.
1283 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1284 ;; If they fail too, set error.
1285 (setq error t)))))
1286 ;; Record the file's truename, and maybe use that as visited name.
1287 (if (equal filename buffer-file-name)
1288 (setq buffer-file-truename truename)
1289 (setq buffer-file-truename
1290 (abbreviate-file-name (file-truename buffer-file-name))))
1291 (setq buffer-file-number number)
1292 ;; On VMS, we may want to remember which directory in a search list
1293 ;; the file was found in.
1294 (and (eq system-type 'vax-vms)
1295 (let (logical)
1296 (if (string-match ":" (file-name-directory filename))
1297 (setq logical (substring (file-name-directory filename)
1298 0 (match-beginning 0))))
1299 (not (member logical find-file-not-true-dirname-list)))
1300 (setq buffer-file-name buffer-file-truename))
1301 (if find-file-visit-truename
1302 (setq buffer-file-name
1303 (setq filename
1304 (expand-file-name buffer-file-truename))))
1305 ;; Set buffer's default directory to that of the file.
1306 (setq default-directory (file-name-directory buffer-file-name))
1307 ;; Turn off backup files for certain file names. Since
1308 ;; this is a permanent local, the major mode won't eliminate it.
1309 (and (not (funcall backup-enable-predicate buffer-file-name))
1310 (progn
1311 (make-local-variable 'backup-inhibited)
1312 (setq backup-inhibited t)))
1313 (if rawfile
1314 (progn
1315 (set-buffer-multibyte nil)
1316 (setq buffer-file-coding-system 'no-conversion)
1317 (make-local-variable 'find-file-literally)
1318 (setq find-file-literally t))
1319 (after-find-file error (not nowarn)))
1320 (current-buffer))))
1321 \f
1322 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1323 "Like `insert-file-contents', but only reads in the file literally.
1324 A buffer may be modified in several ways after reading into the buffer,
1325 to Emacs features such as format decoding, character code
1326 conversion, `find-file-hook', automatic uncompression, etc.
1327
1328 This function ensures that none of these modifications will take place."
1329 (let ((format-alist nil)
1330 (after-insert-file-functions nil)
1331 (coding-system-for-read 'no-conversion)
1332 (coding-system-for-write 'no-conversion)
1333 (find-buffer-file-type-function
1334 (if (fboundp 'find-buffer-file-type)
1335 (symbol-function 'find-buffer-file-type)
1336 nil))
1337 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1338 (inhibit-file-name-operation 'insert-file-contents))
1339 (unwind-protect
1340 (progn
1341 (fset 'find-buffer-file-type (lambda (filename) t))
1342 (insert-file-contents filename visit beg end replace))
1343 (if find-buffer-file-type-function
1344 (fset 'find-buffer-file-type find-buffer-file-type-function)
1345 (fmakunbound 'find-buffer-file-type)))))
1346
1347 (defun insert-file-1 (filename insert-func)
1348 (if (file-directory-p filename)
1349 (signal 'file-error (list "Opening input file" "file is a directory"
1350 filename)))
1351 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1352 #'buffer-modified-p))
1353 (tem (funcall insert-func filename)))
1354 (push-mark (+ (point) (car (cdr tem))))
1355 (when buffer
1356 (message "File %s already visited and modified in buffer %s"
1357 filename (buffer-name buffer)))))
1358
1359 (defun insert-file-literally (filename)
1360 "Insert contents of file FILENAME into buffer after point with no conversion.
1361
1362 This function is meant for the user to run interactively.
1363 Don't call it from programs! Use `insert-file-contents-literally' instead.
1364 \(Its calling sequence is different; see its documentation)."
1365 (interactive "*fInsert file literally: ")
1366 (insert-file-1 filename #'insert-file-contents-literally))
1367
1368 (defvar find-file-literally nil
1369 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1370 This is a permanent local.")
1371 (put 'find-file-literally 'permanent-local t)
1372
1373 (defun find-file-literally (filename)
1374 "Visit file FILENAME with no conversion of any kind.
1375 Format conversion and character code conversion are both disabled,
1376 and multibyte characters are disabled in the resulting buffer.
1377 The major mode used is Fundamental mode regardless of the file name,
1378 and local variable specifications in the file are ignored.
1379 Automatic uncompression and adding a newline at the end of the
1380 file due to `require-final-newline' is also disabled.
1381
1382 You cannot absolutely rely on this function to result in
1383 visiting the file literally. If Emacs already has a buffer
1384 which is visiting the file, you get the existing buffer,
1385 regardless of whether it was created literally or not.
1386
1387 In a Lisp program, if you want to be sure of accessing a file's
1388 contents literally, you should create a temporary buffer and then read
1389 the file contents into it using `insert-file-contents-literally'."
1390 (interactive "FFind file literally: ")
1391 (switch-to-buffer (find-file-noselect filename nil t)))
1392 \f
1393 (defvar after-find-file-from-revert-buffer nil)
1394
1395 (defun after-find-file (&optional error warn noauto
1396 after-find-file-from-revert-buffer
1397 nomodes)
1398 "Called after finding a file and by the default revert function.
1399 Sets buffer mode, parses local variables.
1400 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1401 error in reading the file. WARN non-nil means warn if there
1402 exists an auto-save file more recent than the visited file.
1403 NOAUTO means don't mess with auto-save mode.
1404 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1405 means this call was from `revert-buffer'.
1406 Fifth arg NOMODES non-nil means don't alter the file's modes.
1407 Finishes by calling the functions in `find-file-hook'
1408 unless NOMODES is non-nil."
1409 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1410 (if noninteractive
1411 nil
1412 (let* (not-serious
1413 (msg
1414 (cond
1415 ((not warn) nil)
1416 ((and error (file-attributes buffer-file-name))
1417 (setq buffer-read-only t)
1418 "File exists, but cannot be read")
1419 ((not buffer-read-only)
1420 (if (and warn
1421 ;; No need to warn if buffer is auto-saved
1422 ;; under the name of the visited file.
1423 (not (and buffer-file-name
1424 auto-save-visited-file-name))
1425 (file-newer-than-file-p (or buffer-auto-save-file-name
1426 (make-auto-save-file-name))
1427 buffer-file-name))
1428 (format "%s has auto save data; consider M-x recover-this-file"
1429 (file-name-nondirectory buffer-file-name))
1430 (setq not-serious t)
1431 (if error "(New file)" nil)))
1432 ((not error)
1433 (setq not-serious t)
1434 "Note: file is write protected")
1435 ((file-attributes (directory-file-name default-directory))
1436 "File not found and directory write-protected")
1437 ((file-exists-p (file-name-directory buffer-file-name))
1438 (setq buffer-read-only nil))
1439 (t
1440 (setq buffer-read-only nil)
1441 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1442 "Use M-x make-directory RET RET to create the directory"
1443 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1444 (when msg
1445 (message "%s" msg)
1446 (or not-serious (sit-for 1 nil t))))
1447 (when (and auto-save-default (not noauto))
1448 (auto-save-mode t)))
1449 ;; Make people do a little extra work (C-x C-q)
1450 ;; before altering a backup file.
1451 (when (backup-file-name-p buffer-file-name)
1452 (setq buffer-read-only t))
1453 ;; When a file is marked read-only,
1454 ;; make the buffer read-only even if root is looking at it.
1455 (when (and (file-modes (buffer-file-name))
1456 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1457 (setq buffer-read-only t))
1458 (unless nomodes
1459 (when (and view-read-only view-mode)
1460 (view-mode-disable))
1461 (normal-mode t)
1462 (when (and buffer-read-only
1463 view-read-only
1464 (not (eq (get major-mode 'mode-class) 'special)))
1465 (view-mode-enter))
1466 (run-hooks 'find-file-hook)))
1467
1468 (defun normal-mode (&optional find-file)
1469 "Choose the major mode for this buffer automatically.
1470 Also sets up any specified local variables of the file.
1471 Uses the visited file name, the -*- line, and the local variables spec.
1472
1473 This function is called automatically from `find-file'. In that case,
1474 we may set up the file-specified mode and local variables,
1475 depending on the value of `enable-local-variables': if it is t, we do;
1476 if it is nil, we don't; otherwise, we query.
1477 In addition, if `local-enable-local-variables' is nil, we do
1478 not set local variables (though we do notice a mode specified with -*-.)
1479
1480 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1481 or from Lisp without specifying the optional argument FIND-FILE;
1482 in that case, this function acts as if `enable-local-variables' were t."
1483 (interactive)
1484 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1485 (condition-case err
1486 (set-auto-mode)
1487 (error (message "File mode specification error: %s"
1488 (prin1-to-string err))))
1489 (condition-case err
1490 (let ((enable-local-variables (or (not find-file)
1491 enable-local-variables)))
1492 (hack-local-variables))
1493 (error (message "File local-variables error: %s"
1494 (prin1-to-string err))))
1495 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1496 (ucs-set-table-for-input)))
1497
1498 (defvar auto-mode-alist
1499 (mapc
1500 (lambda (elt)
1501 (cons (purecopy (car elt)) (cdr elt)))
1502 '(("\\.te?xt\\'" . text-mode)
1503 ("\\.c\\'" . c-mode)
1504 ("\\.h\\'" . c-mode)
1505 ("\\.tex\\'" . tex-mode)
1506 ("\\.ltx\\'" . latex-mode)
1507 ("\\.el\\'" . emacs-lisp-mode)
1508 ("\\.scm\\'" . scheme-mode)
1509 ("\\.l\\'" . lisp-mode)
1510 ("\\.lisp\\'" . lisp-mode)
1511 ("\\.f\\'" . fortran-mode)
1512 ("\\.F\\'" . fortran-mode)
1513 ("\\.for\\'" . fortran-mode)
1514 ("\\.p\\'" . pascal-mode)
1515 ("\\.pas\\'" . pascal-mode)
1516 ("\\.ad[abs]\\'" . ada-mode)
1517 ("\\.ad[bs].dg\\'" . ada-mode)
1518 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
1519 ("\\.s?html?\\'" . html-mode)
1520 ("\\.cc\\'" . c++-mode)
1521 ("\\.hh\\'" . c++-mode)
1522 ("\\.hpp\\'" . c++-mode)
1523 ("\\.C\\'" . c++-mode)
1524 ("\\.H\\'" . c++-mode)
1525 ("\\.cpp\\'" . c++-mode)
1526 ("\\.cxx\\'" . c++-mode)
1527 ("\\.hxx\\'" . c++-mode)
1528 ("\\.c\\+\\+\\'" . c++-mode)
1529 ("\\.h\\+\\+\\'" . c++-mode)
1530 ("\\.m\\'" . objc-mode)
1531 ("\\.java\\'" . java-mode)
1532 ("\\.mk\\'" . makefile-mode)
1533 ("\\(M\\|m\\|GNUm\\)akefile\\'" . makefile-mode)
1534 ("\\.am\\'" . makefile-mode) ;For Automake.
1535 ;; Less common extensions come here
1536 ;; so more common ones above are found faster.
1537 ("\\.texinfo\\'" . texinfo-mode)
1538 ("\\.te?xi\\'" . texinfo-mode)
1539 ("\\.s\\'" . asm-mode)
1540 ("\\.S\\'" . asm-mode)
1541 ("\\.asm\\'" . asm-mode)
1542 ("ChangeLog\\'" . change-log-mode)
1543 ("change\\.log\\'" . change-log-mode)
1544 ("changelo\\'" . change-log-mode)
1545 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1546 ;; for MSDOS and MS-Windows (which are case-insensitive)
1547 ("changelog\\'" . change-log-mode)
1548 ("changelog\\.[0-9]+\\'" . change-log-mode)
1549 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1550 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1551 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1552 ("\\.bash\\'" . sh-mode)
1553 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1554 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1555 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1556 ("\\.m?spec\\'" . sh-mode)
1557 ("\\.mm\\'" . nroff-mode)
1558 ("\\.me\\'" . nroff-mode)
1559 ("\\.ms\\'" . nroff-mode)
1560 ("\\.man\\'" . nroff-mode)
1561 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
1562 ("\\.TeX\\'" . tex-mode)
1563 ("\\.sty\\'" . latex-mode)
1564 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1565 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1566 ("\\.bbl\\'" . latex-mode)
1567 ("\\.bib\\'" . bibtex-mode)
1568 ("\\.sql\\'" . sql-mode)
1569 ("\\.m4\\'" . m4-mode)
1570 ("\\.mc\\'" . m4-mode)
1571 ("\\.mf\\'" . metafont-mode)
1572 ("\\.mp\\'" . metapost-mode)
1573 ("\\.vhdl?\\'" . vhdl-mode)
1574 ("\\.article\\'" . text-mode)
1575 ("\\.letter\\'" . text-mode)
1576 ("\\.tcl\\'" . tcl-mode)
1577 ("\\.exp\\'" . tcl-mode)
1578 ("\\.itcl\\'" . tcl-mode)
1579 ("\\.itk\\'" . tcl-mode)
1580 ("\\.icn\\'" . icon-mode)
1581 ("\\.sim\\'" . simula-mode)
1582 ("\\.mss\\'" . scribe-mode)
1583 ("\\.f90\\'" . f90-mode)
1584 ("\\.f95\\'" . f90-mode)
1585 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1586 ("\\.pro\\'" . idlwave-mode)
1587 ("\\.lsp\\'" . lisp-mode)
1588 ("\\.awk\\'" . awk-mode)
1589 ("\\.prolog\\'" . prolog-mode)
1590 ("\\.tar\\'" . tar-mode)
1591 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|ear\\|jar\\|war\\)\\'" . archive-mode)
1592 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|EAR\\|JAR\\|WAR\\)\\'" . archive-mode)
1593 ("\\.sx[dmicw]\\'" . archive-mode) ; OpenOffice.org
1594 ;; Mailer puts message to be edited in
1595 ;; /tmp/Re.... or Message
1596 ("\\`/tmp/Re" . text-mode)
1597 ("/Message[0-9]*\\'" . text-mode)
1598 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1599 ("\\.zone\\'" . zone-mode)
1600 ;; some news reader is reported to use this
1601 ("\\`/tmp/fol/" . text-mode)
1602 ("\\.y\\'" . c-mode)
1603 ("\\.lex\\'" . c-mode)
1604 ("\\.oak\\'" . scheme-mode)
1605 ("\\.sgml?\\'" . sgml-mode)
1606 ("\\.xml\\'" . sgml-mode)
1607 ("\\.dtd\\'" . sgml-mode)
1608 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1609 ("\\.idl\\'" . idl-mode)
1610 ;; .emacs or .gnus or .viper following a directory delimiter in
1611 ;; Unix, MSDOG or VMS syntax.
1612 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
1613 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1614 ;; _emacs following a directory delimiter
1615 ;; in MsDos syntax
1616 ("[:/]_emacs\\'" . emacs-lisp-mode)
1617 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1618 ("\\.ml\\'" . lisp-mode)
1619 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1620 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1621 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1622 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1623 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1624 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1625 ("BROWSE\\'" . ebrowse-tree-mode)
1626 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1627 ("#\\*mail\\*" . mail-mode)
1628 ;; Get rid of any trailing .n.m and try again.
1629 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1630 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1631 ;; Using mode nil rather than `ignore' would let the search continue
1632 ;; through this list (with the shortened name) rather than start over.
1633 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1634 ;; The following should come after the ChangeLog pattern
1635 ;; for the sake of ChangeLog.1, etc.
1636 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1637 ("\\.[1-9]\\'" . nroff-mode)
1638 ("\\.g\\'" . antlr-mode)
1639 ("\\.ses\\'" . ses-mode)
1640 ("\\.in\\'" nil t)))
1641 "Alist of filename patterns vs corresponding major mode functions.
1642 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1643 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1644 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1645 mode function to use. FUNCTION will be called, unless it is nil.
1646
1647 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1648 calling FUNCTION (if it's not nil), we delete the suffix that matched
1649 REGEXP and search the list again for another match.")
1650
1651
1652 (defvar interpreter-mode-alist
1653 (mapc
1654 (lambda (l)
1655 (cons (purecopy (car l)) (cdr l)))
1656 '(("perl" . perl-mode)
1657 ("perl5" . perl-mode)
1658 ("miniperl" . perl-mode)
1659 ("wish" . tcl-mode)
1660 ("wishx" . tcl-mode)
1661 ("tcl" . tcl-mode)
1662 ("tclsh" . tcl-mode)
1663 ("awk" . awk-mode)
1664 ("mawk" . awk-mode)
1665 ("nawk" . awk-mode)
1666 ("gawk" . awk-mode)
1667 ("scm" . scheme-mode)
1668 ("ash" . sh-mode)
1669 ("bash" . sh-mode)
1670 ("bash2" . sh-mode)
1671 ("csh" . sh-mode)
1672 ("dtksh" . sh-mode)
1673 ("es" . sh-mode)
1674 ("itcsh" . sh-mode)
1675 ("jsh" . sh-mode)
1676 ("ksh" . sh-mode)
1677 ("oash" . sh-mode)
1678 ("pdksh" . sh-mode)
1679 ("rc" . sh-mode)
1680 ("rpm" . sh-mode)
1681 ("sh" . sh-mode)
1682 ("sh5" . sh-mode)
1683 ("tcsh" . sh-mode)
1684 ("wksh" . sh-mode)
1685 ("wsh" . sh-mode)
1686 ("zsh" . sh-mode)
1687 ("tail" . text-mode)
1688 ("more" . text-mode)
1689 ("less" . text-mode)
1690 ("pg" . text-mode)
1691 ("make" . makefile-mode) ; Debian uses this
1692 ("guile" . scheme-mode)
1693 ("clisp" . lisp-mode)))
1694 "Alist mapping interpreter names to major modes.
1695 This alist applies to files whose first line starts with `#!'.
1696 Each element looks like (INTERPRETER . MODE).
1697 The car of each element is compared with
1698 the name of the interpreter specified in the first line.
1699 If it matches, mode MODE is selected.")
1700
1701 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1702 "List of regexps; if one matches a file name, don't look for `-*-'.")
1703
1704 (defvar inhibit-first-line-modes-suffixes nil
1705 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1706 When checking `inhibit-first-line-modes-regexps', we first discard
1707 from the end of the file name anything that matches one of these regexps.")
1708
1709 (defvar auto-mode-interpreter-regexp
1710 "#![ \t]?\\([^ \t\n]*\
1711 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1712 "Regular expression matching interpreters, for file mode determination.
1713 This regular expression is matched against the first line of a file
1714 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1715 a mode from the file's name. If it matches, the file is assumed to
1716 be interpreted by the interpreter matched by the second group of the
1717 regular expression. The mode is then determined as the mode associated
1718 with that interpreter in `interpreter-mode-alist'.")
1719
1720 (defun set-auto-mode (&optional just-from-file-name)
1721 "Select major mode appropriate for current buffer.
1722 This checks for a -*- mode tag in the buffer's text,
1723 compares the filename against the entries in `auto-mode-alist',
1724 or checks the interpreter that runs this file against
1725 `interpreter-mode-alist'.
1726
1727 It does not check for the `mode:' local variable in the
1728 Local Variables section of the file; for that, use `hack-local-variables'.
1729
1730 If `enable-local-variables' is nil, this function does not check for a
1731 -*- mode tag.
1732
1733 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1734 then we do not set anything but the major mode,
1735 and we don't even do that unless it would come from the file name."
1736 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1737 (let (end done modes)
1738 (save-excursion
1739 (goto-char (point-min))
1740 (skip-chars-forward " \t\n")
1741 (and enable-local-variables
1742 (setq end (set-auto-mode-1))
1743 (if (save-excursion (search-forward ":" end t))
1744 ;; Find all specifications for the `mode:' variable
1745 ;; and execute them left to right.
1746 (while (let ((case-fold-search t))
1747 (or (and (looking-at "mode:")
1748 (goto-char (match-end 0)))
1749 (re-search-forward "[ \t;]mode:" end t)))
1750 (skip-chars-forward " \t")
1751 (let ((beg (point)))
1752 (if (search-forward ";" end t)
1753 (forward-char -1)
1754 (goto-char end))
1755 (skip-chars-backward " \t")
1756 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1757 modes)))
1758 ;; Simple -*-MODE-*- case.
1759 (push (intern (concat (downcase (buffer-substring (point) end))
1760 "-mode"))
1761 modes))))
1762 ;; If we found modes to use, invoke them now,
1763 ;; outside the save-excursion.
1764 (unless just-from-file-name
1765 (dolist (mode (nreverse modes))
1766 (if (not (functionp mode))
1767 (message "Ignoring unknown mode `%s'" mode)
1768 (setq done t)
1769 (funcall mode))))
1770 ;; If we didn't find a mode from a -*- line, try using the file name.
1771 (if (and (not done) buffer-file-name)
1772 (let ((name buffer-file-name)
1773 (keep-going t))
1774 ;; Remove backup-suffixes from file name.
1775 (setq name (file-name-sans-versions name))
1776 (while keep-going
1777 (setq keep-going nil)
1778 (let ((alist auto-mode-alist)
1779 (mode nil))
1780 ;; Find first matching alist entry.
1781 (let ((case-fold-search
1782 (memq system-type '(vax-vms windows-nt cygwin))))
1783 (while (and (not mode) alist)
1784 (if (string-match (car (car alist)) name)
1785 (if (and (consp (cdr (car alist)))
1786 (nth 2 (car alist)))
1787 (setq mode (car (cdr (car alist)))
1788 name (substring name 0 (match-beginning 0))
1789 keep-going t)
1790 (setq mode (cdr (car alist))
1791 keep-going nil)))
1792 (setq alist (cdr alist))))
1793 (if mode
1794 ;; When JUST-FROM-FILE-NAME is set,
1795 ;; we are working on behalf of set-visited-file-name.
1796 ;; In that case, if the major mode specified is the
1797 ;; same one we already have, don't actually reset it.
1798 ;; We don't want to lose minor modes such as Font Lock.
1799 (unless (and just-from-file-name (eq mode major-mode))
1800 (funcall mode))
1801 ;; If we can't deduce a mode from the file name,
1802 ;; look for an interpreter specified in the first line.
1803 ;; As a special case, allow for things like "#!/bin/env perl",
1804 ;; which finds the interpreter anywhere in $PATH.
1805 (let ((interpreter
1806 (save-excursion
1807 (goto-char (point-min))
1808 (if (looking-at auto-mode-interpreter-regexp)
1809 (match-string 2)
1810 "")))
1811 elt)
1812 ;; Map interpreter name to a mode.
1813 (setq elt (assoc (file-name-nondirectory interpreter)
1814 interpreter-mode-alist))
1815 (unless just-from-file-name
1816 (if elt
1817 (funcall (cdr elt))))))))))))
1818
1819
1820 (defun set-auto-mode-1 ()
1821 "Find the -*- spec in the buffer.
1822 Call with point at the place to start searching from.
1823 If one is found, set point to the beginning
1824 and return the position of the end.
1825 Otherwise, return nil; point may be changed."
1826 (let (beg end)
1827 (and
1828 ;; Don't look for -*- if this file name matches any
1829 ;; of the regexps in inhibit-first-line-modes-regexps.
1830 (let ((temp inhibit-first-line-modes-regexps)
1831 (name (if buffer-file-name
1832 (file-name-sans-versions buffer-file-name)
1833 (buffer-name))))
1834 (while (let ((sufs inhibit-first-line-modes-suffixes))
1835 (while (and sufs (not (string-match (car sufs) name)))
1836 (setq sufs (cdr sufs)))
1837 sufs)
1838 (setq name (substring name 0 (match-beginning 0))))
1839 (while (and temp
1840 (not (string-match (car temp) name)))
1841 (setq temp (cdr temp)))
1842 (not temp))
1843
1844 (search-forward "-*-" (save-excursion
1845 ;; If the file begins with "#!"
1846 ;; (exec interpreter magic), look
1847 ;; for mode frobs in the first two
1848 ;; lines. You cannot necessarily
1849 ;; put them in the first line of
1850 ;; such a file without screwing up
1851 ;; the interpreter invocation.
1852 (end-of-line (and (looking-at "^#!") 2))
1853 (point)) t)
1854 (progn
1855 (skip-chars-forward " \t")
1856 (setq beg (point))
1857 (search-forward "-*-"
1858 (save-excursion (end-of-line) (point))
1859 t))
1860 (progn
1861 (forward-char -3)
1862 (skip-chars-backward " \t")
1863 (setq end (point))
1864 (goto-char beg)
1865 end))))
1866
1867 (defun hack-local-variables-prop-line ()
1868 "Set local variables specified in the -*- line.
1869 Ignore any specification for `mode:' and `coding:';
1870 `set-auto-mode' should already have handled `mode:',
1871 `set-auto-coding' should already have handled `coding:'."
1872 (save-excursion
1873 (goto-char (point-min))
1874 (let ((result nil)
1875 (end (set-auto-mode-1))
1876 (enable-local-variables
1877 (and local-enable-local-variables enable-local-variables)))
1878 ;; Parse the -*- line into the `result' alist.
1879 (cond ((not end)
1880 nil)
1881 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1882 ;; Simple form: "-*- MODENAME -*-". Already handled.
1883 nil)
1884 (t
1885 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1886 ;; (last ";" is optional).
1887 (while (< (point) end)
1888 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1889 (error "Malformed -*- line"))
1890 (goto-char (match-end 0))
1891 ;; There used to be a downcase here,
1892 ;; but the manual didn't say so,
1893 ;; and people want to set var names that aren't all lc.
1894 (let ((key (intern (buffer-substring
1895 (match-beginning 1)
1896 (match-end 1))))
1897 (val (save-restriction
1898 (narrow-to-region (point) end)
1899 (read (current-buffer)))))
1900 ;; It is traditional to ignore
1901 ;; case when checking for `mode' in set-auto-mode,
1902 ;; so we must do that here as well.
1903 ;; That is inconsistent, but we're stuck with it.
1904 ;; The same can be said for `coding' in set-auto-coding.
1905 (or (equal (downcase (symbol-name key)) "mode")
1906 (equal (downcase (symbol-name key)) "coding")
1907 (setq result (cons (cons key val) result)))
1908 (skip-chars-forward " \t;")))
1909 (setq result (nreverse result))))
1910
1911 (if (and result
1912 (or (eq enable-local-variables t)
1913 (and enable-local-variables
1914 (save-window-excursion
1915 (condition-case nil
1916 (switch-to-buffer (current-buffer))
1917 (error
1918 ;; If we fail to switch in the selected window,
1919 ;; it is probably a minibuffer.
1920 ;; So try another window.
1921 (condition-case nil
1922 (switch-to-buffer-other-window (current-buffer))
1923 (error
1924 (switch-to-buffer-other-frame (current-buffer))))))
1925 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1926 (file-name-nondirectory buffer-file-name)))))))
1927 (let ((enable-local-eval enable-local-eval))
1928 (while result
1929 (hack-one-local-variable (car (car result)) (cdr (car result)))
1930 (setq result (cdr result))))))))
1931
1932 (defvar hack-local-variables-hook nil
1933 "Normal hook run after processing a file's local variables specs.
1934 Major modes can use this to examine user-specified local variables
1935 in order to initialize other data structure based on them.")
1936
1937 (defun hack-local-variables (&optional mode-only)
1938 "Parse and put into effect this buffer's local variables spec.
1939 If MODE-ONLY is non-nil, all we do is check whether the major mode
1940 is specified, returning t if it is specified."
1941 (unless mode-only
1942 (hack-local-variables-prop-line))
1943 ;; Look for "Local variables:" line in last page.
1944 (let (mode-specified
1945 (enable-local-variables
1946 (and local-enable-local-variables enable-local-variables)))
1947 (save-excursion
1948 (goto-char (point-max))
1949 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1950 (if (let ((case-fold-search t))
1951 (and (search-forward "Local Variables:" nil t)
1952 (or (eq enable-local-variables t)
1953 mode-only
1954 (and enable-local-variables
1955 (save-window-excursion
1956 (switch-to-buffer (current-buffer))
1957 (save-excursion
1958 (beginning-of-line)
1959 (set-window-start (selected-window) (point)))
1960 (y-or-n-p (format "Set local variables as specified at end of %s? "
1961 (if buffer-file-name
1962 (file-name-nondirectory
1963 buffer-file-name)
1964 (concat "buffer "
1965 (buffer-name))))))))))
1966 (let ((continue t)
1967 prefix prefixlen suffix beg
1968 mode-specified
1969 (enable-local-eval enable-local-eval))
1970 ;; The prefix is what comes before "local variables:" in its line.
1971 ;; The suffix is what comes after "local variables:" in its line.
1972 (skip-chars-forward " \t")
1973 (or (eolp)
1974 (setq suffix (buffer-substring (point)
1975 (progn (end-of-line) (point)))))
1976 (goto-char (match-beginning 0))
1977 (or (bolp)
1978 (setq prefix
1979 (buffer-substring (point)
1980 (progn (beginning-of-line) (point)))))
1981
1982 (if prefix (setq prefixlen (length prefix)
1983 prefix (regexp-quote prefix)))
1984 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1985 (while continue
1986 ;; Look at next local variable spec.
1987 (if selective-display (re-search-forward "[\n\C-m]")
1988 (forward-line 1))
1989 ;; Skip the prefix, if any.
1990 (if prefix
1991 (if (looking-at prefix)
1992 (forward-char prefixlen)
1993 (error "Local variables entry is missing the prefix")))
1994 ;; Find the variable name; strip whitespace.
1995 (skip-chars-forward " \t")
1996 (setq beg (point))
1997 (skip-chars-forward "^:\n")
1998 (if (eolp) (error "Missing colon in local variables entry"))
1999 (skip-chars-backward " \t")
2000 (let* ((str (buffer-substring beg (point)))
2001 (var (read str))
2002 val)
2003 ;; Setting variable named "end" means end of list.
2004 (if (string-equal (downcase str) "end")
2005 (setq continue nil)
2006 ;; Otherwise read the variable value.
2007 (skip-chars-forward "^:")
2008 (forward-char 1)
2009 (setq val (read (current-buffer)))
2010 (skip-chars-backward "\n")
2011 (skip-chars-forward " \t")
2012 (or (if suffix (looking-at suffix) (eolp))
2013 (error "Local variables entry is terminated incorrectly"))
2014 (if mode-only
2015 (if (eq var 'mode)
2016 (setq mode-specified t))
2017 ;; Set the variable. "Variables" mode and eval are funny.
2018 (hack-one-local-variable var val))))))))
2019 (unless mode-only
2020 (run-hooks 'hack-local-variables-hook))
2021 mode-specified))
2022
2023 (defvar ignored-local-variables
2024 '(enable-local-eval)
2025 "Variables to be ignored in a file's local variable spec.")
2026
2027 ;; Get confirmation before setting these variables as locals in a file.
2028 (put 'debugger 'risky-local-variable t)
2029 (put 'enable-local-eval 'risky-local-variable t)
2030 (put 'ignored-local-variables 'risky-local-variable t)
2031 (put 'eval 'risky-local-variable t)
2032 (put 'file-name-handler-alist 'risky-local-variable t)
2033 (put 'inhibit-quit 'risky-local-variable t)
2034 (put 'minor-mode-alist 'risky-local-variable t)
2035 (put 'minor-mode-map-alist 'risky-local-variable t)
2036 (put 'minor-mode-overriding-map-alist 'risky-local-variable t)
2037 (put 'overriding-local-map 'risky-local-variable t)
2038 (put 'overriding-terminal-local-map 'risky-local-variable t)
2039 (put 'auto-mode-alist 'risky-local-variable t)
2040 (put 'after-load-alist 'risky-local-variable t)
2041 (put 'buffer-file-name 'risky-local-variable t)
2042 (put 'buffer-undo-list 'risky-local-variable t)
2043 (put 'buffer-auto-save-file-name 'risky-local-variable t)
2044 (put 'buffer-file-truename 'risky-local-variable t)
2045 (put 'default-text-properties 'risky-local-variable t)
2046 (put 'exec-path 'risky-local-variable t)
2047 (put 'load-path 'risky-local-variable t)
2048 (put 'exec-directory 'risky-local-variable t)
2049 (put 'process-environment 'risky-local-variable t)
2050 (put 'dabbrev-case-fold-search 'risky-local-variable t)
2051 (put 'dabbrev-case-replace 'risky-local-variable t)
2052 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2053 (put 'outline-level 'risky-local-variable t)
2054 (put 'rmail-output-file-alist 'risky-local-variable t)
2055 (put 'font-lock-defaults 'risky-local-variable t)
2056 (put 'special-display-buffer-names 'risky-local-variable t)
2057 (put 'frame-title-format 'risky-local-variable t)
2058 (put 'global-mode-string 'risky-local-variable t)
2059 (put 'header-line-format 'risky-local-variable t)
2060 (put 'icon-title-format 'risky-local-variable t)
2061 (put 'input-method-alist 'risky-local-variable t)
2062 (put 'format-alist 'risky-local-variable t)
2063 (put 'vc-mode 'risky-local-variable t)
2064 (put 'imenu-generic-expression 'risky-local-variable t)
2065 (put 'imenu-index-alist 'risky-local-variable t)
2066 (put 'standard-input 'risky-local-variable t)
2067 (put 'standard-output 'risky-local-variable t)
2068 (put 'unread-command-events 'risky-local-variable t)
2069 (put 'max-lisp-eval-depth 'risky-local-variable t)
2070 (put 'max-specpdl-size 'risky-local-variable t)
2071 (put 'mode-line-format 'risky-local-variable t)
2072 (put 'mode-line-modified 'risky-local-variable t)
2073 (put 'mode-line-mule-info 'risky-local-variable t)
2074 (put 'mode-line-buffer-identification 'risky-local-variable t)
2075 (put 'mode-line-modes 'risky-local-variable t)
2076 (put 'mode-line-position 'risky-local-variable t)
2077 (put 'mode-line-process 'risky-local-variable t)
2078 (put 'mode-name 'risky-local-variable t)
2079 (put 'display-time-string 'risky-local-variable t)
2080 (put 'parse-time-rules 'risky-local-variable t)
2081
2082 ;; This case is safe because the user gets to check it before it is used.
2083 (put 'compile-command 'safe-local-variable 'stringp)
2084
2085 (defun risky-local-variable-p (sym val)
2086 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2087 If VAL is nil, the question is whether any value might be dangerous."
2088 (let ((safep (get sym 'safe-local-variable)))
2089 (or (memq sym ignored-local-variables)
2090 (get sym 'risky-local-variable)
2091 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2092 (symbol-name sym))
2093 (not safep))
2094 ;; If the safe-local-variable property isn't t or nil,
2095 ;; then it must return non-nil on the proposed value to be safe.
2096 (and (not (memq safep '(t nil)))
2097 (or (null val)
2098 (not (funcall safep val)))))))
2099
2100 (defcustom safe-local-eval-forms nil
2101 "*Expressions that are considered \"safe\" in an `eval:' local variable.
2102 Add expressions to this list if you want Emacs to evaluate them, when
2103 they appear in an `eval' local variable specification, without first
2104 asking you for confirmation."
2105 :group 'find-file
2106 :version "21.4"
2107 :type '(repeat sexp))
2108
2109 (put 'c-set-style 'safe-local-eval-function t)
2110
2111 (defun hack-one-local-variable-quotep (exp)
2112 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2113
2114 (defun hack-one-local-variable-constantp (exp)
2115 (or (and (not (symbolp exp)) (not (consp exp)))
2116 (memq exp '(t nil))
2117 (keywordp exp)
2118 (hack-one-local-variable-quotep exp)))
2119
2120 (defun hack-one-local-variable-eval-safep (exp)
2121 "Return t if it is safe to eval EXP when it is found in a file."
2122 (or (not (consp exp))
2123 ;; Detect certain `put' expressions.
2124 (and (eq (car exp) 'put)
2125 (hack-one-local-variable-quotep (nth 1 exp))
2126 (hack-one-local-variable-quotep (nth 2 exp))
2127 (memq (nth 1 (nth 2 exp))
2128 '(lisp-indent-hook))
2129 ;; Only allow safe values of lisp-indent-hook;
2130 ;; not functions.
2131 (or (numberp (nth 3 exp))
2132 (equal (nth 3 exp) ''defun)))
2133 ;; Allow expressions that the user requested.
2134 (member exp safe-local-eval-forms)
2135 ;; Certain functions can be allowed with safe arguments
2136 ;; or can specify verification functions to try.
2137 (and (symbolp (car exp))
2138 (let ((prop (get (car exp) 'safe-local-eval-function)))
2139 (cond ((eq prop t)
2140 (let ((ok t))
2141 (dolist (arg (cdr exp))
2142 (unless (hack-one-local-variable-constantp arg)
2143 (setq ok nil)))
2144 ok))
2145 ((functionp prop)
2146 (funcall prop exp))
2147 ((listp prop)
2148 (let ((ok nil))
2149 (dolist (function prop)
2150 (if (funcall function exp)
2151 (setq ok t)))
2152 ok)))))))
2153
2154 (defun hack-one-local-variable (var val)
2155 "\"Set\" one variable in a local variables spec.
2156 A few patterns are specified so that any name which matches one
2157 is considered risky."
2158 (cond ((eq var 'mode)
2159 (funcall (intern (concat (downcase (symbol-name val))
2160 "-mode"))))
2161 ((eq var 'coding)
2162 ;; We have already handled coding: tag in set-auto-coding.
2163 nil)
2164 ;; "Setting" eval means either eval it or do nothing.
2165 ;; Likewise for setting hook variables.
2166 ((risky-local-variable-p var val)
2167 ;; Permit evalling a put of a harmless property.
2168 ;; if the args do nothing tricky.
2169 (if (or (and (eq var 'eval)
2170 (hack-one-local-variable-eval-safep val))
2171 ;; Permit eval if not root and user says ok.
2172 (and (not (zerop (user-uid)))
2173 (or (eq enable-local-eval t)
2174 (and enable-local-eval
2175 (save-window-excursion
2176 (switch-to-buffer (current-buffer))
2177 (save-excursion
2178 (beginning-of-line)
2179 (set-window-start (selected-window) (point)))
2180 (setq enable-local-eval
2181 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
2182 (if buffer-file-name
2183 (concat "file " (file-name-nondirectory buffer-file-name))
2184 (concat "buffer " (buffer-name)))))))))))
2185 (if (eq var 'eval)
2186 (save-excursion (eval val))
2187 (make-local-variable var)
2188 (set var val))
2189 (message "Ignoring risky spec in the local variables list")))
2190 ;; Ordinary variable, really set it.
2191 (t (make-local-variable var)
2192 ;; Make sure the string has no text properties.
2193 ;; Some text properties can get evaluated in various ways,
2194 ;; so it is risky to put them on with a local variable list.
2195 (if (stringp val)
2196 (set-text-properties 0 (length val) nil val))
2197 (set var val))))
2198
2199 \f
2200 (defcustom change-major-mode-with-file-name t
2201 "*Non-nil means \\[write-file] should set the major mode from the file name.
2202 However, the mode will not be changed if
2203 \(1) a local variables list or the `-*-' line specifies a major mode, or
2204 \(2) the current major mode is a \"special\" mode,
2205 \ not suitable for ordinary files, or
2206 \(3) the new file name does not particularly specify any mode."
2207 :type 'boolean
2208 :group 'editing-basics)
2209
2210 (defun set-visited-file-name (filename &optional no-query along-with-file)
2211 "Change name of file visited in current buffer to FILENAME.
2212 The next time the buffer is saved it will go in the newly specified file.
2213 nil or empty string as argument means make buffer not be visiting any file.
2214 Remember to delete the initial contents of the minibuffer
2215 if you wish to pass an empty string as the argument.
2216
2217 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2218 confirmation in the case where another buffer is already visiting FILENAME.
2219
2220 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2221 the old visited file has been renamed to the new name FILENAME."
2222 (interactive "FSet visited file name: ")
2223 (if (buffer-base-buffer)
2224 (error "An indirect buffer cannot visit a file"))
2225 (let (truename)
2226 (if filename
2227 (setq filename
2228 (if (string-equal filename "")
2229 nil
2230 (expand-file-name filename))))
2231 (if filename
2232 (progn
2233 (setq truename (file-truename filename))
2234 (if find-file-visit-truename
2235 (setq filename truename))))
2236 (let ((buffer (and filename (find-buffer-visiting filename))))
2237 (and buffer (not (eq buffer (current-buffer)))
2238 (not no-query)
2239 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2240 filename)))
2241 (error "Aborted")))
2242 (or (equal filename buffer-file-name)
2243 (progn
2244 (and filename (lock-buffer filename))
2245 (unlock-buffer)))
2246 (setq buffer-file-name filename)
2247 (if filename ; make buffer name reflect filename.
2248 (let ((new-name (file-name-nondirectory buffer-file-name)))
2249 (if (string= new-name "")
2250 (error "Empty file name"))
2251 (if (eq system-type 'vax-vms)
2252 (setq new-name (downcase new-name)))
2253 (setq default-directory (file-name-directory buffer-file-name))
2254 (or (string= new-name (buffer-name))
2255 (rename-buffer new-name t))))
2256 (setq buffer-backed-up nil)
2257 (or along-with-file
2258 (clear-visited-file-modtime))
2259 ;; Abbreviate the file names of the buffer.
2260 (if truename
2261 (progn
2262 (setq buffer-file-truename (abbreviate-file-name truename))
2263 (if find-file-visit-truename
2264 (setq buffer-file-name buffer-file-truename))))
2265 (setq buffer-file-number
2266 (if filename
2267 (nthcdr 10 (file-attributes buffer-file-name))
2268 nil)))
2269 ;; write-file-functions is normally used for things like ftp-find-file
2270 ;; that visit things that are not local files as if they were files.
2271 ;; Changing to visit an ordinary local file instead should flush the hook.
2272 (kill-local-variable 'write-file-functions)
2273 (kill-local-variable 'local-write-file-hooks)
2274 (kill-local-variable 'revert-buffer-function)
2275 (kill-local-variable 'backup-inhibited)
2276 ;; If buffer was read-only because of version control,
2277 ;; that reason is gone now, so make it writable.
2278 (if vc-mode
2279 (setq buffer-read-only nil))
2280 (kill-local-variable 'vc-mode)
2281 ;; Turn off backup files for certain file names.
2282 ;; Since this is a permanent local, the major mode won't eliminate it.
2283 (and buffer-file-name
2284 (not (funcall backup-enable-predicate buffer-file-name))
2285 (progn
2286 (make-local-variable 'backup-inhibited)
2287 (setq backup-inhibited t)))
2288 (let ((oauto buffer-auto-save-file-name))
2289 ;; If auto-save was not already on, turn it on if appropriate.
2290 (if (not buffer-auto-save-file-name)
2291 (and buffer-file-name auto-save-default
2292 (auto-save-mode t))
2293 ;; If auto save is on, start using a new name.
2294 ;; We deliberately don't rename or delete the old auto save
2295 ;; for the old visited file name. This is because perhaps
2296 ;; the user wants to save the new state and then compare with the
2297 ;; previous state from the auto save file.
2298 (setq buffer-auto-save-file-name
2299 (make-auto-save-file-name)))
2300 ;; Rename the old auto save file if any.
2301 (and oauto buffer-auto-save-file-name
2302 (file-exists-p oauto)
2303 (rename-file oauto buffer-auto-save-file-name t)))
2304 (and buffer-file-name
2305 (not along-with-file)
2306 (set-buffer-modified-p t))
2307 ;; Update the major mode, if the file name determines it.
2308 (condition-case nil
2309 ;; Don't change the mode if it is special.
2310 (or (not change-major-mode-with-file-name)
2311 (get major-mode 'mode-class)
2312 ;; Don't change the mode if the local variable list specifies it.
2313 (hack-local-variables t)
2314 (set-auto-mode t))
2315 (error nil)))
2316
2317 (defun write-file (filename &optional confirm)
2318 "Write current buffer into file FILENAME.
2319 This makes the buffer visit that file, and marks it as not modified.
2320
2321 If you specify just a directory name as FILENAME, that means to use
2322 the default file name but in that directory. You can also yank
2323 the default file name into the minibuffer to edit it, using M-n.
2324
2325 If the buffer is not already visiting a file, the default file name
2326 for the output file is the buffer name.
2327
2328 If optional second arg CONFIRM is non-nil, this function
2329 asks for confirmation before overwriting an existing file.
2330 Interactively, confirmation is required unless you supply a prefix argument."
2331 ;; (interactive "FWrite file: ")
2332 (interactive
2333 (list (if buffer-file-name
2334 (read-file-name "Write file: "
2335 nil nil nil nil)
2336 (read-file-name "Write file: " default-directory
2337 (expand-file-name
2338 (file-name-nondirectory (buffer-name))
2339 default-directory)
2340 nil nil))
2341 (not current-prefix-arg)))
2342 (or (null filename) (string-equal filename "")
2343 (progn
2344 ;; If arg is just a directory,
2345 ;; use the default file name, but in that directory.
2346 (if (file-directory-p filename)
2347 (setq filename (concat (file-name-as-directory filename)
2348 (file-name-nondirectory
2349 (or buffer-file-name (buffer-name))))))
2350 (and confirm
2351 (file-exists-p filename)
2352 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2353 (error "Canceled")))
2354 (set-visited-file-name filename (not confirm))))
2355 (set-buffer-modified-p t)
2356 ;; Make buffer writable if file is writable.
2357 (and buffer-file-name
2358 (file-writable-p buffer-file-name)
2359 (setq buffer-read-only nil))
2360 (save-buffer))
2361 \f
2362 (defun backup-buffer ()
2363 "Make a backup of the disk file visited by the current buffer, if appropriate.
2364 This is normally done before saving the buffer the first time.
2365
2366 A backup may be done by renaming or by copying; see documentation of
2367 variable `make-backup-files'. If it's done by renaming, then the file is
2368 no longer accessible under its old name.
2369
2370 The value is non-nil after a backup was made by renaming.
2371 It has the form (MODES . BACKUPNAME).
2372 MODES is the result of `file-modes' on the original
2373 file; this means that the caller, after saving the buffer, should change
2374 the modes of the new file to agree with the old modes.
2375 BACKUPNAME is the backup file name, which is the old file renamed."
2376 (if (and make-backup-files (not backup-inhibited)
2377 (not buffer-backed-up)
2378 (file-exists-p buffer-file-name)
2379 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2380 '(?- ?l)))
2381 (let ((real-file-name buffer-file-name)
2382 backup-info backupname targets setmodes)
2383 ;; If specified name is a symbolic link, chase it to the target.
2384 ;; Thus we make the backups in the directory where the real file is.
2385 (setq real-file-name (file-chase-links real-file-name))
2386 (setq backup-info (find-backup-file-name real-file-name)
2387 backupname (car backup-info)
2388 targets (cdr backup-info))
2389 ;; (if (file-directory-p buffer-file-name)
2390 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2391 (if backup-info
2392 (condition-case ()
2393 (let ((delete-old-versions
2394 ;; If have old versions to maybe delete,
2395 ;; ask the user to confirm now, before doing anything.
2396 ;; But don't actually delete til later.
2397 (and targets
2398 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2399 (or delete-old-versions
2400 (y-or-n-p (format "Delete excess backup versions of %s? "
2401 real-file-name)))))
2402 (modes (file-modes buffer-file-name)))
2403 ;; Actually write the back up file.
2404 (condition-case ()
2405 (if (or file-precious-flag
2406 ; (file-symlink-p buffer-file-name)
2407 backup-by-copying
2408 ;; Don't rename a suid or sgid file.
2409 (and modes (< 0 (logand modes #o6000)))
2410 (and backup-by-copying-when-linked
2411 (> (file-nlinks real-file-name) 1))
2412 (and (or backup-by-copying-when-mismatch
2413 (integerp backup-by-copying-when-privileged-mismatch))
2414 (let ((attr (file-attributes real-file-name)))
2415 (and (or backup-by-copying-when-mismatch
2416 (and (integerp (nth 2 attr))
2417 (integerp backup-by-copying-when-privileged-mismatch)
2418 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2419 (or (nth 9 attr)
2420 (not (file-ownership-preserved-p real-file-name)))))))
2421 (backup-buffer-copy real-file-name backupname modes)
2422 ;; rename-file should delete old backup.
2423 (rename-file real-file-name backupname t)
2424 (setq setmodes (cons modes backupname)))
2425 (file-error
2426 ;; If trouble writing the backup, write it in ~.
2427 (setq backupname (expand-file-name
2428 (convert-standard-filename
2429 "~/%backup%~")))
2430 (message "Cannot write backup file; backing up in %s"
2431 (file-name-nondirectory backupname))
2432 (sleep-for 1)
2433 (backup-buffer-copy real-file-name backupname modes)))
2434 (setq buffer-backed-up t)
2435 ;; Now delete the old versions, if desired.
2436 (if delete-old-versions
2437 (while targets
2438 (condition-case ()
2439 (delete-file (car targets))
2440 (file-error nil))
2441 (setq targets (cdr targets))))
2442 setmodes)
2443 (file-error nil))))))
2444
2445 (defun backup-buffer-copy (from-name to-name modes)
2446 (condition-case ()
2447 (copy-file from-name to-name t t)
2448 (file-error
2449 ;; If copying fails because file TO-NAME
2450 ;; is not writable, delete that file and try again.
2451 (if (and (file-exists-p to-name)
2452 (not (file-writable-p to-name)))
2453 (delete-file to-name))
2454 (copy-file from-name to-name t t)))
2455 (set-file-modes to-name (logand modes #o1777)))
2456
2457 (defun file-name-sans-versions (name &optional keep-backup-version)
2458 "Return file NAME sans backup versions or strings.
2459 This is a separate procedure so your site-init or startup file can
2460 redefine it.
2461 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2462 we do not remove backup version numbers, only true file version numbers."
2463 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2464 (if handler
2465 (funcall handler 'file-name-sans-versions name keep-backup-version)
2466 (substring name 0
2467 (if (eq system-type 'vax-vms)
2468 ;; VMS version number is (a) semicolon, optional
2469 ;; sign, zero or more digits or (b) period, option
2470 ;; sign, zero or more digits, provided this is the
2471 ;; second period encountered outside of the
2472 ;; device/directory part of the file name.
2473 (or (string-match ";[-+]?[0-9]*\\'" name)
2474 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2475 name)
2476 (match-beginning 1))
2477 (length name))
2478 (if keep-backup-version
2479 (length name)
2480 (or (string-match "\\.~[0-9.]+~\\'" name)
2481 (string-match "~\\'" name)
2482 (length name))))))))
2483
2484 (defun file-ownership-preserved-p (file)
2485 "Return t if deleting FILE and rewriting it would preserve the owner."
2486 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2487 (if handler
2488 (funcall handler 'file-ownership-preserved-p file)
2489 (let ((attributes (file-attributes file)))
2490 ;; Return t if the file doesn't exist, since it's true that no
2491 ;; information would be lost by an (attempted) delete and create.
2492 (or (null attributes)
2493 (= (nth 2 attributes) (user-uid)))))))
2494
2495 (defun file-name-sans-extension (filename)
2496 "Return FILENAME sans final \"extension\".
2497 The extension, in a file name, is the part that follows the last `.',
2498 except that a leading `.', if any, doesn't count."
2499 (save-match-data
2500 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2501 directory)
2502 (if (and (string-match "\\.[^.]*\\'" file)
2503 (not (eq 0 (match-beginning 0))))
2504 (if (setq directory (file-name-directory filename))
2505 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2506 ;; we don't want to expand it.
2507 (concat directory (substring file 0 (match-beginning 0)))
2508 (substring file 0 (match-beginning 0)))
2509 filename))))
2510
2511 (defun file-name-extension (filename &optional period)
2512 "Return FILENAME's final \"extension\".
2513 The extension, in a file name, is the part that follows the last `.',
2514 except that a leading `.', if any, doesn't count.
2515 Return nil for extensionless file names such as `foo'.
2516 Return the empty string for file names such as `foo.'.
2517
2518 If PERIOD is non-nil, then the returned value includes the period
2519 that delimits the extension, and if FILENAME has no extension,
2520 the value is \"\"."
2521 (save-match-data
2522 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2523 (if (and (string-match "\\.[^.]*\\'" file)
2524 (not (eq 0 (match-beginning 0))))
2525 (substring file (+ (match-beginning 0) (if period 0 1)))
2526 (if period
2527 "")))))
2528
2529 (defcustom make-backup-file-name-function nil
2530 "A function to use instead of the default `make-backup-file-name'.
2531 A value of nil gives the default `make-backup-file-name' behaviour.
2532
2533 This could be buffer-local to do something special for specific
2534 files. If you define it, you may need to change `backup-file-name-p'
2535 and `file-name-sans-versions' too.
2536
2537 See also `backup-directory-alist'."
2538 :group 'backup
2539 :type '(choice (const :tag "Default" nil)
2540 (function :tag "Your function")))
2541
2542 (defcustom backup-directory-alist nil
2543 "Alist of filename patterns and backup directory names.
2544 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2545 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2546 relative or absolute. If it is absolute, so that all matching files
2547 are backed up into the same directory, the file names in this
2548 directory will be the full name of the file backed up with all
2549 directory separators changed to `!' to prevent clashes. This will not
2550 work correctly if your filesystem truncates the resulting name.
2551
2552 For the common case of all backups going into one directory, the alist
2553 should contain a single element pairing \".\" with the appropriate
2554 directory name.
2555
2556 If this variable is nil, or it fails to match a filename, the backup
2557 is made in the original file's directory.
2558
2559 On MS-DOS filesystems without long names this variable is always
2560 ignored."
2561 :group 'backup
2562 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2563 (directory :tag "Backup directory name"))))
2564
2565 (defun normal-backup-enable-predicate (name)
2566 "Default `backup-enable-predicate' function.
2567 Checks for files in `temporary-file-directory' or
2568 `small-temporary-file-directory'."
2569 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2570 name 0 nil)))
2571 ;; Directory is under temporary-file-directory.
2572 (and (not (eq comp t))
2573 (< comp (- (length temporary-file-directory)))))
2574 (if small-temporary-file-directory
2575 (let ((comp (compare-strings small-temporary-file-directory
2576 0 nil
2577 name 0 nil)))
2578 ;; Directory is under small-temporary-file-directory.
2579 (and (not (eq comp t))
2580 (< comp (- (length small-temporary-file-directory)))))))))
2581
2582 (defun make-backup-file-name (file)
2583 "Create the non-numeric backup file name for FILE.
2584 Normally this will just be the file's name with `~' appended.
2585 Customization hooks are provided as follows.
2586
2587 If the variable `make-backup-file-name-function' is non-nil, its value
2588 should be a function which will be called with FILE as its argument;
2589 the resulting name is used.
2590
2591 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2592 the documentation of that variable. If the directory for the backup
2593 doesn't exist, it is created."
2594 (if make-backup-file-name-function
2595 (funcall make-backup-file-name-function file)
2596 (if (and (eq system-type 'ms-dos)
2597 (not (msdos-long-file-names)))
2598 (let ((fn (file-name-nondirectory file)))
2599 (concat (file-name-directory file)
2600 (or (and (string-match "\\`[^.]+\\'" fn)
2601 (concat (match-string 0 fn) ".~"))
2602 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2603 (concat (match-string 0 fn) "~")))))
2604 (concat (make-backup-file-name-1 file) "~"))))
2605
2606 (defun make-backup-file-name-1 (file)
2607 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2608 (let ((alist backup-directory-alist)
2609 elt backup-directory failed)
2610 (while alist
2611 (setq elt (pop alist))
2612 (if (string-match (car elt) file)
2613 (setq backup-directory (cdr elt)
2614 alist nil)))
2615 (if (and backup-directory (not (file-exists-p backup-directory)))
2616 (condition-case nil
2617 (make-directory backup-directory 'parents)
2618 (file-error (setq backup-directory nil))))
2619 (if (null backup-directory)
2620 file
2621 (if (file-name-absolute-p backup-directory)
2622 (progn
2623 (when (memq system-type '(windows-nt ms-dos cygwin))
2624 ;; Normalize DOSish file names: downcase the drive
2625 ;; letter, if any, and replace the leading "x:" with
2626 ;; "/drive_x".
2627 (or (file-name-absolute-p file)
2628 (setq file (expand-file-name file))) ; make defaults explicit
2629 ;; Replace any invalid file-name characters (for the
2630 ;; case of backing up remote files).
2631 (setq file (expand-file-name (convert-standard-filename file)))
2632 (if (eq (aref file 1) ?:)
2633 (setq file (concat "/"
2634 "drive_"
2635 (char-to-string (downcase (aref file 0)))
2636 (if (eq (aref file 2) ?/)
2637 ""
2638 "/")
2639 (substring file 2)))))
2640 ;; Make the name unique by substituting directory
2641 ;; separators. It may not really be worth bothering about
2642 ;; doubling `!'s in the original name...
2643 (expand-file-name
2644 (subst-char-in-string
2645 ?/ ?!
2646 (replace-regexp-in-string "!" "!!" file))
2647 backup-directory))
2648 (expand-file-name (file-name-nondirectory file)
2649 (file-name-as-directory
2650 (expand-file-name backup-directory
2651 (file-name-directory file))))))))
2652
2653 (defun backup-file-name-p (file)
2654 "Return non-nil if FILE is a backup file name (numeric or not).
2655 This is a separate function so you can redefine it for customization.
2656 You may need to redefine `file-name-sans-versions' as well."
2657 (string-match "~\\'" file))
2658
2659 (defvar backup-extract-version-start)
2660
2661 ;; This is used in various files.
2662 ;; The usage of backup-extract-version-start is not very clean,
2663 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2664 (defun backup-extract-version (fn)
2665 "Given the name of a numeric backup file, FN, return the backup number.
2666 Uses the free variable `backup-extract-version-start', whose value should be
2667 the index in the name where the version number begins."
2668 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2669 (= (match-beginning 0) backup-extract-version-start))
2670 (string-to-int (substring fn backup-extract-version-start -1))
2671 0))
2672
2673 ;; I believe there is no need to alter this behavior for VMS;
2674 ;; since backup files are not made on VMS, it should not get called.
2675 (defun find-backup-file-name (fn)
2676 "Find a file name for a backup file FN, and suggestions for deletions.
2677 Value is a list whose car is the name for the backup file
2678 and whose cdr is a list of old versions to consider deleting now.
2679 If the value is nil, don't make a backup.
2680 Uses `backup-directory-alist' in the same way as does
2681 `make-backup-file-name'."
2682 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2683 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2684 (if handler
2685 (funcall handler 'find-backup-file-name fn)
2686 (if (or (eq version-control 'never)
2687 ;; We don't support numbered backups on plain MS-DOS
2688 ;; when long file names are unavailable.
2689 (and (eq system-type 'ms-dos)
2690 (not (msdos-long-file-names))))
2691 (list (make-backup-file-name fn))
2692 (let* ((basic-name (make-backup-file-name-1 fn))
2693 (base-versions (concat (file-name-nondirectory basic-name)
2694 ".~"))
2695 (backup-extract-version-start (length base-versions))
2696 (high-water-mark 0)
2697 (number-to-delete 0)
2698 possibilities deserve-versions-p versions)
2699 (condition-case ()
2700 (setq possibilities (file-name-all-completions
2701 base-versions
2702 (file-name-directory basic-name))
2703 versions (sort (mapcar #'backup-extract-version
2704 possibilities)
2705 #'<)
2706 high-water-mark (apply 'max 0 versions)
2707 deserve-versions-p (or version-control
2708 (> high-water-mark 0))
2709 number-to-delete (- (length versions)
2710 kept-old-versions
2711 kept-new-versions
2712 -1))
2713 (file-error (setq possibilities nil)))
2714 (if (not deserve-versions-p)
2715 (list (make-backup-file-name fn))
2716 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
2717 (if (and (> number-to-delete 0)
2718 ;; Delete nothing if there is overflow
2719 ;; in the number of versions to keep.
2720 (>= (+ kept-new-versions kept-old-versions -1) 0))
2721 (mapcar (lambda (n)
2722 (format "%s.~%d~" basic-name n))
2723 (let ((v (nthcdr kept-old-versions versions)))
2724 (rplacd (nthcdr (1- number-to-delete) v) ())
2725 v))))))))))
2726
2727 (defun file-nlinks (filename)
2728 "Return number of names file FILENAME has."
2729 (car (cdr (file-attributes filename))))
2730
2731 (defun file-relative-name (filename &optional directory)
2732 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2733 This function returns a relative file name which is equivalent to FILENAME
2734 when used with that default directory as the default.
2735 If this is impossible (which can happen on MSDOS and Windows
2736 when the file name and directory use different drive names)
2737 then it returns FILENAME."
2738 (save-match-data
2739 (let ((fname (expand-file-name filename)))
2740 (setq directory (file-name-as-directory
2741 (expand-file-name (or directory default-directory))))
2742 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2743 ;; drive names, they can't be relative, so return the absolute name.
2744 (if (and (or (eq system-type 'ms-dos)
2745 (eq system-type 'cygwin)
2746 (eq system-type 'windows-nt))
2747 (not (string-equal (substring fname 0 2)
2748 (substring directory 0 2))))
2749 filename
2750 (let ((ancestor ".")
2751 (fname-dir (file-name-as-directory fname)))
2752 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2753 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2754 (setq directory (file-name-directory (substring directory 0 -1))
2755 ancestor (if (equal ancestor ".")
2756 ".."
2757 (concat "../" ancestor))))
2758 ;; Now ancestor is empty, or .., or ../.., etc.
2759 (if (string-match (concat "^" (regexp-quote directory)) fname)
2760 ;; We matched within FNAME's directory part.
2761 ;; Add the rest of FNAME onto ANCESTOR.
2762 (let ((rest (substring fname (match-end 0))))
2763 (if (and (equal ancestor ".")
2764 (not (equal rest "")))
2765 ;; But don't bother with ANCESTOR if it would give us `./'.
2766 rest
2767 (concat (file-name-as-directory ancestor) rest)))
2768 ;; We matched FNAME's directory equivalent.
2769 ancestor))))))
2770 \f
2771 (defun save-buffer (&optional args)
2772 "Save current buffer in visited file if modified. Versions described below.
2773 By default, makes the previous version into a backup file
2774 if previously requested or if this is the first save.
2775 With 1 \\[universal-argument], marks this version
2776 to become a backup when the next save is done.
2777 With 2 \\[universal-argument]'s,
2778 unconditionally makes the previous version into a backup file.
2779 With 3 \\[universal-argument]'s, marks this version
2780 to become a backup when the next save is done,
2781 and unconditionally makes the previous version into a backup file.
2782
2783 With argument of 0, never make the previous version into a backup file.
2784
2785 If a file's name is FOO, the names of its numbered backup versions are
2786 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2787 Numeric backups (rather than FOO~) will be made if value of
2788 `version-control' is not the atom `never' and either there are already
2789 numeric versions of the file being backed up, or `version-control' is
2790 non-nil.
2791 We don't want excessive versions piling up, so there are variables
2792 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2793 and `kept-new-versions', which tells how many newest versions to keep.
2794 Defaults are 2 old versions and 2 new.
2795 `dired-kept-versions' controls dired's clean-directory (.) command.
2796 If `delete-old-versions' is nil, system will query user
2797 before trimming versions. Otherwise it does it silently.
2798
2799 If `vc-make-backup-files' is nil, which is the default,
2800 no backup files are made for files managed by version control.
2801 (This is because the version control system itself records previous versions.)
2802
2803 See the subroutine `basic-save-buffer' for more information."
2804 (interactive "p")
2805 (let ((modp (buffer-modified-p))
2806 (large (> (buffer-size) 50000))
2807 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2808 (memq args '(16 64)))))
2809 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2810 (if (and modp large (buffer-file-name))
2811 (message "Saving file %s..." (buffer-file-name)))
2812 (basic-save-buffer)
2813 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2814
2815 (defun delete-auto-save-file-if-necessary (&optional force)
2816 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2817 Normally delete only if the file was written by this Emacs since
2818 the last real save, but optional arg FORCE non-nil means delete anyway."
2819 (and buffer-auto-save-file-name delete-auto-save-files
2820 (not (string= buffer-file-name buffer-auto-save-file-name))
2821 (or force (recent-auto-save-p))
2822 (progn
2823 (condition-case ()
2824 (delete-file buffer-auto-save-file-name)
2825 (file-error nil))
2826 (set-buffer-auto-saved))))
2827
2828 (defvar auto-save-hook nil
2829 "Normal hook run just before auto-saving.")
2830
2831 (defcustom after-save-hook nil
2832 "Normal hook that is run after a buffer is saved to its file."
2833 :options '(executable-make-buffer-file-executable-if-script-p)
2834 :type 'hook
2835 :group 'files)
2836
2837 (defvar save-buffer-coding-system nil
2838 "If non-nil, use this coding system for saving the buffer.
2839 More precisely, use this coding system in place of the
2840 value of `buffer-file-coding-system', when saving the buffer.
2841 Calling `write-region' for any purpose other than saving the buffer
2842 will still use `buffer-file-coding-system'; this variable has no effect
2843 in such cases.")
2844
2845 (make-variable-buffer-local 'save-buffer-coding-system)
2846 (put 'save-buffer-coding-system 'permanent-local t)
2847
2848 (defun basic-save-buffer ()
2849 "Save the current buffer in its visited file, if it has been modified.
2850 The hooks `write-contents-functions' and `write-file-functions' get a chance
2851 to do the job of saving; if they do not, then the buffer is saved in
2852 the visited file file in the usual way.
2853 After saving the buffer, this function runs `after-save-hook'."
2854 (interactive)
2855 (save-current-buffer
2856 ;; In an indirect buffer, save its base buffer instead.
2857 (if (buffer-base-buffer)
2858 (set-buffer (buffer-base-buffer)))
2859 (if (buffer-modified-p)
2860 (let ((recent-save (recent-auto-save-p))
2861 setmodes tempsetmodes)
2862 ;; On VMS, rename file and buffer to get rid of version number.
2863 (if (and (eq system-type 'vax-vms)
2864 (not (string= buffer-file-name
2865 (file-name-sans-versions buffer-file-name))))
2866 (let (buffer-new-name)
2867 ;; Strip VMS version number before save.
2868 (setq buffer-file-name
2869 (file-name-sans-versions buffer-file-name))
2870 ;; Construct a (unique) buffer name to correspond.
2871 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2872 (setq buffer-new-name (buffer-name buf))
2873 (kill-buffer buf))
2874 (rename-buffer buffer-new-name)))
2875 ;; If buffer has no file name, ask user for one.
2876 (or buffer-file-name
2877 (let ((filename
2878 (expand-file-name
2879 (read-file-name "File to save in: ") nil)))
2880 (and (file-exists-p filename)
2881 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2882 filename))
2883 (error "Canceled")))
2884 (set-visited-file-name filename)))
2885 (or (verify-visited-file-modtime (current-buffer))
2886 (not (file-exists-p buffer-file-name))
2887 (yes-or-no-p
2888 (format "%s has changed since visited or saved. Save anyway? "
2889 (file-name-nondirectory buffer-file-name)))
2890 (error "Save not confirmed"))
2891 (save-restriction
2892 (widen)
2893 (save-excursion
2894 (and (> (point-max) (point-min))
2895 (not find-file-literally)
2896 (/= (char-after (1- (point-max))) ?\n)
2897 (not (and (eq selective-display t)
2898 (= (char-after (1- (point-max))) ?\r)))
2899 (or (eq require-final-newline t)
2900 (and require-final-newline
2901 (y-or-n-p
2902 (format "Buffer %s does not end in newline. Add one? "
2903 (buffer-name)))))
2904 (save-excursion
2905 (goto-char (point-max))
2906 (insert ?\n))))
2907 ;; Support VC version backups.
2908 (vc-before-save)
2909 (or (run-hook-with-args-until-success 'write-contents-functions)
2910 (run-hook-with-args-until-success 'local-write-file-hooks)
2911 (run-hook-with-args-until-success 'write-file-functions)
2912 ;; If a hook returned t, file is already "written".
2913 ;; Otherwise, write it the usual way now.
2914 (setq setmodes (basic-save-buffer-1)))
2915 ;; Now we have saved the current buffer. Let's make sure
2916 ;; that buffer-file-coding-system is fixed to what
2917 ;; actually used for saving by binding it locally.
2918 (if save-buffer-coding-system
2919 (setq save-buffer-coding-system last-coding-system-used)
2920 (setq buffer-file-coding-system last-coding-system-used))
2921 (setq buffer-file-number
2922 (nthcdr 10 (file-attributes buffer-file-name)))
2923 (if setmodes
2924 (condition-case ()
2925 (set-file-modes buffer-file-name (car setmodes))
2926 (error nil))))
2927 ;; If the auto-save file was recent before this command,
2928 ;; delete it now.
2929 (delete-auto-save-file-if-necessary recent-save)
2930 ;; Support VC `implicit' locking.
2931 (vc-after-save)
2932 (run-hooks 'after-save-hook))
2933 (message "(No changes need to be saved)"))))
2934
2935 ;; This does the "real job" of writing a buffer into its visited file
2936 ;; and making a backup file. This is what is normally done
2937 ;; but inhibited if one of write-file-functions returns non-nil.
2938 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
2939 (defun basic-save-buffer-1 ()
2940 (if save-buffer-coding-system
2941 (let ((coding-system-for-write save-buffer-coding-system))
2942 (basic-save-buffer-2))
2943 (basic-save-buffer-2)))
2944
2945 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
2946 (defun basic-save-buffer-2 ()
2947 (let (tempsetmodes setmodes)
2948 (if (not (file-writable-p buffer-file-name))
2949 (let ((dir (file-name-directory buffer-file-name)))
2950 (if (not (file-directory-p dir))
2951 (if (file-exists-p dir)
2952 (error "%s is not a directory" dir)
2953 (error "%s: no such directory" buffer-file-name))
2954 (if (not (file-exists-p buffer-file-name))
2955 (error "Directory %s write-protected" dir)
2956 (if (yes-or-no-p
2957 (format "File %s is write-protected; try to save anyway? "
2958 (file-name-nondirectory
2959 buffer-file-name)))
2960 (setq tempsetmodes t)
2961 (error "Attempt to save to a file which you aren't allowed to write"))))))
2962 (or buffer-backed-up
2963 (setq setmodes (backup-buffer)))
2964 (let ((dir (file-name-directory buffer-file-name)))
2965 (if (and file-precious-flag
2966 (file-writable-p dir))
2967 ;; If file is precious, write temp name, then rename it.
2968 ;; This requires write access to the containing dir,
2969 ;; which is why we don't try it if we don't have that access.
2970 (let ((realname buffer-file-name)
2971 tempname temp nogood i succeed
2972 (old-modtime (visited-file-modtime)))
2973 (setq i 0)
2974 (setq nogood t)
2975 ;; Find the temporary name to write under.
2976 (while nogood
2977 (setq tempname (format
2978 (if (and (eq system-type 'ms-dos)
2979 (not (msdos-long-file-names)))
2980 "%s#%d.tm#" ; MSDOS limits files to 8+3
2981 (if (memq system-type '(vax-vms axp-vms))
2982 "%s$tmp$%d"
2983 "%s#tmp#%d"))
2984 dir i))
2985 (setq nogood (file-exists-p tempname))
2986 (setq i (1+ i)))
2987 (unwind-protect
2988 (progn (clear-visited-file-modtime)
2989 (write-region (point-min) (point-max)
2990 tempname nil realname
2991 buffer-file-truename)
2992 (setq succeed t))
2993 ;; If writing the temp file fails,
2994 ;; delete the temp file.
2995 (or succeed
2996 (progn
2997 (condition-case nil
2998 (delete-file tempname)
2999 (file-error nil))
3000 (set-visited-file-modtime old-modtime))))
3001 ;; Since we have created an entirely new file
3002 ;; and renamed it, make sure it gets the
3003 ;; right permission bits set.
3004 (setq setmodes (or setmodes (cons (file-modes buffer-file-name)
3005 buffer-file-name)))
3006 ;; We succeeded in writing the temp file,
3007 ;; so rename it.
3008 (rename-file tempname buffer-file-name t))
3009 ;; If file not writable, see if we can make it writable
3010 ;; temporarily while we write it.
3011 ;; But no need to do so if we have just backed it up
3012 ;; (setmodes is set) because that says we're superseding.
3013 (cond ((and tempsetmodes (not setmodes))
3014 ;; Change the mode back, after writing.
3015 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3016 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3017 (let (success)
3018 (unwind-protect
3019 (progn
3020 (write-region (point-min) (point-max)
3021 buffer-file-name nil t buffer-file-truename)
3022 (setq success t))
3023 ;; If we get an error writing the new file, and we made
3024 ;; the backup by renaming, undo the backing-up.
3025 (and setmodes (not success)
3026 (rename-file (cdr setmodes) buffer-file-name))))))
3027 setmodes))
3028
3029 (defun diff-buffer-with-file (&optional buffer)
3030 "View the differences between BUFFER and its associated file.
3031 This requires the external program `diff' to be in your `exec-path'."
3032 (interactive "bBuffer: ")
3033 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3034 (if (and buffer-file-name
3035 (file-exists-p buffer-file-name))
3036 (let ((tempfile (make-temp-file "buffer-content-")))
3037 (unwind-protect
3038 (save-restriction
3039 (widen)
3040 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3041 (diff buffer-file-name tempfile nil t)
3042 (sit-for 0))
3043 (when (file-exists-p tempfile)
3044 (delete-file tempfile))))
3045 (message "Buffer %s has no associated file on disc" (buffer-name))
3046 ;; Display that message for 1 second so that user can read it
3047 ;; in the minibuffer.
3048 (sit-for 1)))
3049 ;; return always nil, so that save-buffers-kill-emacs will not move
3050 ;; over to the next unsaved buffer when calling `d'.
3051 nil)
3052
3053 (defvar save-some-buffers-action-alist
3054 '((?\C-r
3055 (lambda (buf)
3056 (view-buffer buf
3057 (lambda (ignore)
3058 (exit-recursive-edit)))
3059 (recursive-edit)
3060 ;; Return nil to ask about BUF again.
3061 nil)
3062 "display the current buffer")
3063 (?d diff-buffer-with-file
3064 "show difference to last saved version"))
3065 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3066 (put 'save-some-buffers-action-alist 'risky-local-variable t)
3067
3068 (defun save-some-buffers (&optional arg pred)
3069 "Save some modified file-visiting buffers. Asks user about each one.
3070 You can answer `y' to save, `n' not to save, `C-r' to look at the
3071 buffer in question with `view-buffer' before deciding or `d' to
3072 view the differences using `diff-buffer-to-file'.
3073
3074 Optional argument (the prefix) non-nil means save all with no questions.
3075 Optional second argument PRED determines which buffers are considered:
3076 If PRED is nil, all the file-visiting buffers are considered.
3077 If PRED is t, then certain non-file buffers will also be considered.
3078 If PRED is a zero-argument function, it indicates for each buffer whether
3079 to consider it or not when called with that buffer current.
3080
3081 See `save-some-buffers-action-alist' if you want to
3082 change the additional actions you can take on files."
3083 (interactive "P")
3084 (save-window-excursion
3085 (let* ((queried nil)
3086 (files-done
3087 (map-y-or-n-p
3088 (function
3089 (lambda (buffer)
3090 (and (buffer-modified-p buffer)
3091 (not (buffer-base-buffer buffer))
3092 (or
3093 (buffer-file-name buffer)
3094 (and pred
3095 (progn
3096 (set-buffer buffer)
3097 (and buffer-offer-save (> (buffer-size) 0)))))
3098 (or (not (functionp pred))
3099 (with-current-buffer buffer (funcall pred)))
3100 (if arg
3101 t
3102 (setq queried t)
3103 (if (buffer-file-name buffer)
3104 (format "Save file %s? "
3105 (buffer-file-name buffer))
3106 (format "Save buffer %s? "
3107 (buffer-name buffer)))))))
3108 (function
3109 (lambda (buffer)
3110 (set-buffer buffer)
3111 (save-buffer)))
3112 (buffer-list)
3113 '("buffer" "buffers" "save")
3114 save-some-buffers-action-alist))
3115 (abbrevs-done
3116 (and save-abbrevs abbrevs-changed
3117 (progn
3118 (if (or arg
3119 (eq save-abbrevs 'silently)
3120 (y-or-n-p (format "Save abbrevs in %s? "
3121 abbrev-file-name)))
3122 (write-abbrev-file nil))
3123 ;; Don't keep bothering user if he says no.
3124 (setq abbrevs-changed nil)
3125 t))))
3126 (or queried (> files-done 0) abbrevs-done
3127 (message "(No files need saving)")))))
3128 \f
3129 (defun not-modified (&optional arg)
3130 "Mark current buffer as unmodified, not needing to be saved.
3131 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3132
3133 It is not a good idea to use this function in Lisp programs, because it
3134 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3135 (interactive "P")
3136 (message (if arg "Modification-flag set"
3137 "Modification-flag cleared"))
3138 (set-buffer-modified-p arg))
3139
3140 (defun toggle-read-only (&optional arg)
3141 "Change whether this buffer is visiting its file read-only.
3142 With arg, set read-only iff arg is positive.
3143 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3144 (interactive "P")
3145 (if (and arg
3146 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3147 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3148 nil ; do nothing.
3149 ;; Toggle.
3150 (cond
3151 ((and buffer-read-only view-mode)
3152 (View-exit-and-edit)
3153 (make-local-variable 'view-read-only)
3154 (setq view-read-only t)) ; Must leave view mode.
3155 ((and (not buffer-read-only) view-read-only
3156 (not (eq (get major-mode 'mode-class) 'special)))
3157 (view-mode-enter))
3158 (t (setq buffer-read-only (not buffer-read-only))
3159 (force-mode-line-update)))
3160 (if (vc-backend buffer-file-name)
3161 (message (substitute-command-keys
3162 (concat "File is under version-control; "
3163 "use \\[vc-next-action] to check in/out"))))))
3164
3165 (defun insert-file (filename)
3166 "Insert contents of file FILENAME into buffer after point.
3167 Set mark after the inserted text.
3168
3169 This function is meant for the user to run interactively.
3170 Don't call it from programs! Use `insert-file-contents' instead.
3171 \(Its calling sequence is different; see its documentation)."
3172 (interactive "*fInsert file: ")
3173 (insert-file-1 filename #'insert-file-contents))
3174
3175 (defun append-to-file (start end filename)
3176 "Append the contents of the region to the end of file FILENAME.
3177 When called from a function, expects three arguments,
3178 START, END and FILENAME. START and END are buffer positions
3179 saying what text to write."
3180 (interactive "r\nFAppend to file: ")
3181 (write-region start end filename t))
3182
3183 (defun file-newest-backup (filename)
3184 "Return most recent backup file for FILENAME or nil if no backups exist."
3185 ;; `make-backup-file-name' will get us the right directory for
3186 ;; ordinary or numeric backups. It might create a directory for
3187 ;; backups as a side-effect, according to `backup-directory-alist'.
3188 (let* ((filename (file-name-sans-versions
3189 (make-backup-file-name filename)))
3190 (file (file-name-nondirectory filename))
3191 (dir (file-name-directory filename))
3192 (comp (file-name-all-completions file dir))
3193 (newest nil)
3194 tem)
3195 (while comp
3196 (setq tem (pop comp))
3197 (cond ((and (backup-file-name-p tem)
3198 (string= (file-name-sans-versions tem) file))
3199 (setq tem (concat dir tem))
3200 (if (or (null newest)
3201 (file-newer-than-file-p tem newest))
3202 (setq newest tem)))))
3203 newest))
3204
3205 (defun rename-uniquely ()
3206 "Rename current buffer to a similar name not already taken.
3207 This function is useful for creating multiple shell process buffers
3208 or multiple mail buffers, etc."
3209 (interactive)
3210 (save-match-data
3211 (let ((base-name (buffer-name)))
3212 (and (string-match "<[0-9]+>\\'" base-name)
3213 (not (and buffer-file-name
3214 (string= base-name
3215 (file-name-nondirectory buffer-file-name))))
3216 ;; If the existing buffer name has a <NNN>,
3217 ;; which isn't part of the file name (if any),
3218 ;; then get rid of that.
3219 (setq base-name (substring base-name 0 (match-beginning 0))))
3220 (rename-buffer (generate-new-buffer-name base-name))
3221 (force-mode-line-update))))
3222
3223 (defun make-directory (dir &optional parents)
3224 "Create the directory DIR and any nonexistent parent dirs.
3225 Interactively, the default choice of directory to create
3226 is the current default directory for file names.
3227 That is useful when you have visited a file in a nonexistent directory.
3228
3229 Noninteractively, the second (optional) argument PARENTS says whether
3230 to create parent directories if they don't exist."
3231 (interactive
3232 (list (read-file-name "Make directory: " default-directory default-directory
3233 nil nil)
3234 t))
3235 ;; If default-directory is a remote directory,
3236 ;; make sure we find its make-directory handler.
3237 (setq dir (expand-file-name dir))
3238 (let ((handler (find-file-name-handler dir 'make-directory)))
3239 (if handler
3240 (funcall handler 'make-directory dir parents)
3241 (if (not parents)
3242 (make-directory-internal dir)
3243 (let ((dir (directory-file-name (expand-file-name dir)))
3244 create-list)
3245 (while (not (file-exists-p dir))
3246 (setq create-list (cons dir create-list)
3247 dir (directory-file-name (file-name-directory dir))))
3248 (while create-list
3249 (make-directory-internal (car create-list))
3250 (setq create-list (cdr create-list))))))))
3251 \f
3252 (put 'revert-buffer-function 'permanent-local t)
3253 (defvar revert-buffer-function nil
3254 "Function to use to revert this buffer, or nil to do the default.
3255 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3256 which are the arguments that `revert-buffer' received.")
3257
3258 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3259 (defvar revert-buffer-insert-file-contents-function nil
3260 "Function to use to insert contents when reverting this buffer.
3261 Gets two args, first the nominal file name to use,
3262 and second, t if reading the auto-save file.
3263
3264 The function you specify is responsible for updating (or preserving) point.")
3265
3266 (defvar before-revert-hook nil
3267 "Normal hook for `revert-buffer' to run before reverting.
3268 If `revert-buffer-function' is used to override the normal revert
3269 mechanism, this hook is not used.")
3270
3271 (defvar after-revert-hook nil
3272 "Normal hook for `revert-buffer' to run after reverting.
3273 Note that the hook value that it runs is the value that was in effect
3274 before reverting; that makes a difference if you have buffer-local
3275 hook functions.
3276
3277 If `revert-buffer-function' is used to override the normal revert
3278 mechanism, this hook is not used.")
3279
3280 (defvar revert-buffer-internal-hook)
3281
3282 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
3283 "Replace current buffer text with the text of the visited file on disk.
3284 This undoes all changes since the file was visited or saved.
3285 With a prefix argument, offer to revert from latest auto-save file, if
3286 that is more recent than the visited file.
3287
3288 This command also works for special buffers that contain text which
3289 doesn't come from a file, but reflects some other data base instead:
3290 for example, Dired buffers and buffer-list buffers. In these cases,
3291 it reconstructs the buffer contents from the appropriate data base.
3292
3293 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3294 to revert from the auto-save file when this is nil. Note that the
3295 sense of this argument is the reverse of the prefix argument, for the
3296 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3297 to nil.
3298
3299 Optional second argument NOCONFIRM means don't ask for confirmation at
3300 all. (The local variable `revert-without-query', if non-nil, prevents
3301 confirmation.)
3302
3303 Optional third argument PRESERVE-MODES non-nil means don't alter
3304 the files modes. Normally we reinitialize them using `normal-mode'.
3305
3306 If the value of `revert-buffer-function' is non-nil, it is called to
3307 do all the work for this command. Otherwise, the hooks
3308 `before-revert-hook' and `after-revert-hook' are run at the beginning
3309 and the end, and if `revert-buffer-insert-file-contents-function' is
3310 non-nil, it is called instead of rereading visited file contents."
3311
3312 ;; I admit it's odd to reverse the sense of the prefix argument, but
3313 ;; there is a lot of code out there which assumes that the first
3314 ;; argument should be t to avoid consulting the auto-save file, and
3315 ;; there's no straightforward way to encourage authors to notice a
3316 ;; reversal of the argument sense. So I'm just changing the user
3317 ;; interface, but leaving the programmatic interface the same.
3318 (interactive (list (not current-prefix-arg)))
3319 (if revert-buffer-function
3320 (funcall revert-buffer-function ignore-auto noconfirm)
3321 (let* ((auto-save-p (and (not ignore-auto)
3322 (recent-auto-save-p)
3323 buffer-auto-save-file-name
3324 (file-readable-p buffer-auto-save-file-name)
3325 (y-or-n-p
3326 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3327 (file-name (if auto-save-p
3328 buffer-auto-save-file-name
3329 buffer-file-name)))
3330 (cond ((null file-name)
3331 (error "Buffer does not seem to be associated with any file"))
3332 ((or noconfirm
3333 (and (not (buffer-modified-p))
3334 (let ((tail revert-without-query)
3335 (found nil))
3336 (while tail
3337 (if (string-match (car tail) file-name)
3338 (setq found t))
3339 (setq tail (cdr tail)))
3340 found))
3341 (yes-or-no-p (format "Revert buffer from file %s? "
3342 file-name)))
3343 (run-hooks 'before-revert-hook)
3344 ;; If file was backed up but has changed since,
3345 ;; we shd make another backup.
3346 (and (not auto-save-p)
3347 (not (verify-visited-file-modtime (current-buffer)))
3348 (setq buffer-backed-up nil))
3349 ;; Get rid of all undo records for this buffer.
3350 (or (eq buffer-undo-list t)
3351 (setq buffer-undo-list nil))
3352 ;; Effectively copy the after-revert-hook status,
3353 ;; since after-find-file will clobber it.
3354 (let ((global-hook (default-value 'after-revert-hook))
3355 (local-hook-p (local-variable-p 'after-revert-hook))
3356 (local-hook (and (local-variable-p 'after-revert-hook)
3357 after-revert-hook)))
3358 (let (buffer-read-only
3359 ;; Don't make undo records for the reversion.
3360 (buffer-undo-list t))
3361 (if revert-buffer-insert-file-contents-function
3362 (funcall revert-buffer-insert-file-contents-function
3363 file-name auto-save-p)
3364 (if (not (file-exists-p file-name))
3365 (error (if buffer-file-number
3366 "File %s no longer exists!"
3367 "Cannot revert nonexistent file %s")
3368 file-name))
3369 ;; Bind buffer-file-name to nil
3370 ;; so that we don't try to lock the file.
3371 (let ((buffer-file-name nil))
3372 (or auto-save-p
3373 (unlock-buffer)))
3374 (widen)
3375 (let ((coding-system-for-read
3376 ;; Auto-saved file shoule be read without
3377 ;; any code conversion.
3378 (if auto-save-p 'emacs-mule-unix
3379 (or coding-system-for-read
3380 buffer-file-coding-system))))
3381 ;; This force
3382 ;; after-insert-file-set-buffer-file-coding-system
3383 ;; (called from insert-file-contents) to set
3384 ;; buffer-file-coding-system to a proper value.
3385 (kill-local-variable 'buffer-file-coding-system)
3386
3387 ;; Note that this preserves point in an intelligent way.
3388 (if preserve-modes
3389 (let ((buffer-file-format buffer-file-format))
3390 (insert-file-contents file-name (not auto-save-p)
3391 nil nil t))
3392 (insert-file-contents file-name (not auto-save-p)
3393 nil nil t)))))
3394 ;; Recompute the truename in case changes in symlinks
3395 ;; have changed the truename.
3396 (setq buffer-file-truename
3397 (abbreviate-file-name (file-truename buffer-file-name)))
3398 (after-find-file nil nil t t preserve-modes)
3399 ;; Run after-revert-hook as it was before we reverted.
3400 (setq-default revert-buffer-internal-hook global-hook)
3401 (if local-hook-p
3402 (progn
3403 (make-local-variable 'revert-buffer-internal-hook)
3404 (setq revert-buffer-internal-hook local-hook))
3405 (kill-local-variable 'revert-buffer-internal-hook))
3406 (run-hooks 'revert-buffer-internal-hook))
3407 t)))))
3408
3409 (defun recover-this-file ()
3410 "Recover the visited file--get contents from its last auto-save file."
3411 (interactive)
3412 (recover-file buffer-file-name))
3413
3414 (defun recover-file (file)
3415 "Visit file FILE, but get contents from its last auto-save file."
3416 ;; Actually putting the file name in the minibuffer should be used
3417 ;; only rarely.
3418 ;; Not just because users often use the default.
3419 (interactive "FRecover file: ")
3420 (setq file (expand-file-name file))
3421 (if (auto-save-file-name-p (file-name-nondirectory file))
3422 (error "%s is an auto-save file" file))
3423 (let ((file-name (let ((buffer-file-name file))
3424 (make-auto-save-file-name))))
3425 (cond ((if (file-exists-p file)
3426 (not (file-newer-than-file-p file-name file))
3427 (not (file-exists-p file-name)))
3428 (error "Auto-save file %s not current" file-name))
3429 ((save-window-excursion
3430 (with-output-to-temp-buffer "*Directory*"
3431 (buffer-disable-undo standard-output)
3432 (save-excursion
3433 (let ((switches dired-listing-switches))
3434 (if (file-symlink-p file)
3435 (setq switches (concat switches "L")))
3436 (set-buffer standard-output)
3437 ;; Use insert-directory-safely, not insert-directory,
3438 ;; because these files might not exist. In particular,
3439 ;; FILE might not exist if the auto-save file was for
3440 ;; a buffer that didn't visit a file, such as "*mail*".
3441 ;; The code in v20.x called `ls' directly, so we need
3442 ;; to emulate what `ls' did in that case.
3443 (insert-directory-safely file switches)
3444 (insert-directory-safely file-name switches))))
3445 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3446 (switch-to-buffer (find-file-noselect file t))
3447 (let ((buffer-read-only nil)
3448 ;; Keep the current buffer-file-coding-system.
3449 (coding-system buffer-file-coding-system)
3450 ;; Auto-saved file shoule be read without any code conversion.
3451 (coding-system-for-read 'emacs-mule-unix))
3452 (erase-buffer)
3453 (insert-file-contents file-name nil)
3454 (set-buffer-file-coding-system coding-system))
3455 (after-find-file nil nil t))
3456 (t (error "Recover-file cancelled")))))
3457
3458 (defun recover-session ()
3459 "Recover auto save files from a previous Emacs session.
3460 This command first displays a Dired buffer showing you the
3461 previous sessions that you could recover from.
3462 To choose one, move point to the proper line and then type C-c C-c.
3463 Then you'll be asked about a number of files to recover."
3464 (interactive)
3465 (if (null auto-save-list-file-prefix)
3466 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3467 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3468 (unless (file-directory-p dir)
3469 (make-directory dir t)))
3470 (let ((ls-lisp-support-shell-wildcards t))
3471 (dired (concat auto-save-list-file-prefix "*")
3472 (concat dired-listing-switches "t")))
3473 (save-excursion
3474 (goto-char (point-min))
3475 (or (looking-at " Move to the session you want to recover,")
3476 (let ((inhibit-read-only t))
3477 ;; Each line starts with a space
3478 ;; so that Font Lock mode won't highlight the first character.
3479 (insert " Move to the session you want to recover,\n"
3480 " then type C-c C-c to select it.\n\n"
3481 " You can also delete some of these files;\n"
3482 " type d on a line to mark that file for deletion.\n\n"))))
3483 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3484 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3485
3486 (defun recover-session-finish ()
3487 "Choose one saved session to recover auto-save files from.
3488 This command is used in the special Dired buffer created by
3489 \\[recover-session]."
3490 (interactive)
3491 ;; Get the name of the session file to recover from.
3492 (let ((file (dired-get-filename))
3493 files
3494 (buffer (get-buffer-create " *recover*")))
3495 (dired-unmark 1)
3496 (dired-do-flagged-delete t)
3497 (unwind-protect
3498 (save-excursion
3499 ;; Read in the auto-save-list file.
3500 (set-buffer buffer)
3501 (erase-buffer)
3502 (insert-file-contents file)
3503 ;; Loop thru the text of that file
3504 ;; and get out the names of the files to recover.
3505 (while (not (eobp))
3506 (let (thisfile autofile)
3507 (if (eolp)
3508 ;; This is a pair of lines for a non-file-visiting buffer.
3509 ;; Get the auto-save file name and manufacture
3510 ;; a "visited file name" from that.
3511 (progn
3512 (forward-line 1)
3513 (setq autofile
3514 (buffer-substring-no-properties
3515 (point)
3516 (save-excursion
3517 (end-of-line)
3518 (point))))
3519 (setq thisfile
3520 (expand-file-name
3521 (substring
3522 (file-name-nondirectory autofile)
3523 1 -1)
3524 (file-name-directory autofile)))
3525 (forward-line 1))
3526 ;; This pair of lines is a file-visiting
3527 ;; buffer. Use the visited file name.
3528 (progn
3529 (setq thisfile
3530 (buffer-substring-no-properties
3531 (point) (progn (end-of-line) (point))))
3532 (forward-line 1)
3533 (setq autofile
3534 (buffer-substring-no-properties
3535 (point) (progn (end-of-line) (point))))
3536 (forward-line 1)))
3537 ;; Ignore a file if its auto-save file does not exist now.
3538 (if (file-exists-p autofile)
3539 (setq files (cons thisfile files)))))
3540 (setq files (nreverse files))
3541 ;; The file contains a pair of line for each auto-saved buffer.
3542 ;; The first line of the pair contains the visited file name
3543 ;; or is empty if the buffer was not visiting a file.
3544 ;; The second line is the auto-save file name.
3545 (if files
3546 (map-y-or-n-p "Recover %s? "
3547 (lambda (file)
3548 (condition-case nil
3549 (save-excursion (recover-file file))
3550 (error
3551 "Failed to recover `%s'" file)))
3552 files
3553 '("file" "files" "recover"))
3554 (message "No files can be recovered from this session now")))
3555 (kill-buffer buffer))))
3556
3557 (defun kill-some-buffers (&optional list)
3558 "For each buffer in LIST, ask whether to kill it.
3559 LIST defaults to all existing live buffers."
3560 (interactive)
3561 (if (null list)
3562 (setq list (buffer-list)))
3563 (while list
3564 (let* ((buffer (car list))
3565 (name (buffer-name buffer)))
3566 (and (not (string-equal name ""))
3567 (/= (aref name 0) ? )
3568 (yes-or-no-p
3569 (format "Buffer %s %s. Kill? "
3570 name
3571 (if (buffer-modified-p buffer)
3572 "HAS BEEN EDITED" "is unmodified")))
3573 (kill-buffer buffer)))
3574 (setq list (cdr list))))
3575 \f
3576 (defun auto-save-mode (arg)
3577 "Toggle auto-saving of contents of current buffer.
3578 With prefix argument ARG, turn auto-saving on if positive, else off."
3579 (interactive "P")
3580 (setq buffer-auto-save-file-name
3581 (and (if (null arg)
3582 (or (not buffer-auto-save-file-name)
3583 ;; If auto-save is off because buffer has shrunk,
3584 ;; then toggling should turn it on.
3585 (< buffer-saved-size 0))
3586 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3587 (if (and buffer-file-name auto-save-visited-file-name
3588 (not buffer-read-only))
3589 buffer-file-name
3590 (make-auto-save-file-name))))
3591 ;; If -1 was stored here, to temporarily turn off saving,
3592 ;; turn it back on.
3593 (and (< buffer-saved-size 0)
3594 (setq buffer-saved-size 0))
3595 (if (interactive-p)
3596 (message "Auto-save %s (in this buffer)"
3597 (if buffer-auto-save-file-name "on" "off")))
3598 buffer-auto-save-file-name)
3599
3600 (defun rename-auto-save-file ()
3601 "Adjust current buffer's auto save file name for current conditions.
3602 Also rename any existing auto save file, if it was made in this session."
3603 (let ((osave buffer-auto-save-file-name))
3604 (setq buffer-auto-save-file-name
3605 (make-auto-save-file-name))
3606 (if (and osave buffer-auto-save-file-name
3607 (not (string= buffer-auto-save-file-name buffer-file-name))
3608 (not (string= buffer-auto-save-file-name osave))
3609 (file-exists-p osave)
3610 (recent-auto-save-p))
3611 (rename-file osave buffer-auto-save-file-name t))))
3612
3613 (defun make-auto-save-file-name ()
3614 "Return file name to use for auto-saves of current buffer.
3615 Does not consider `auto-save-visited-file-name' as that variable is checked
3616 before calling this function. You can redefine this for customization.
3617 See also `auto-save-file-name-p'."
3618 (if buffer-file-name
3619 (let ((list auto-save-file-name-transforms)
3620 (filename buffer-file-name)
3621 result uniq)
3622 ;; Apply user-specified translations
3623 ;; to the file name.
3624 (while (and list (not result))
3625 (if (string-match (car (car list)) filename)
3626 (setq result (replace-match (cadr (car list)) t nil
3627 filename)
3628 uniq (car (cddr (car list)))))
3629 (setq list (cdr list)))
3630 (if result
3631 (if uniq
3632 (setq filename (concat
3633 (file-name-directory result)
3634 (subst-char-in-string
3635 ?/ ?!
3636 (replace-regexp-in-string "!" "!!"
3637 filename))))
3638 (setq filename result)))
3639 (setq result
3640 (if (and (eq system-type 'ms-dos)
3641 (not (msdos-long-file-names)))
3642 ;; We truncate the file name to DOS 8+3 limits
3643 ;; before doing anything else, because the regexp
3644 ;; passed to string-match below cannot handle
3645 ;; extensions longer than 3 characters, multiple
3646 ;; dots, and other atrocities.
3647 (let ((fn (dos-8+3-filename
3648 (file-name-nondirectory buffer-file-name))))
3649 (string-match
3650 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
3651 fn)
3652 (concat (file-name-directory buffer-file-name)
3653 "#" (match-string 1 fn)
3654 "." (match-string 3 fn) "#"))
3655 (concat (file-name-directory filename)
3656 "#"
3657 (file-name-nondirectory filename)
3658 "#")))
3659 ;; Make sure auto-save file names don't contain characters
3660 ;; invalid for the underlying filesystem.
3661 (if (and (memq system-type '(ms-dos windows-nt))
3662 ;; Don't modify remote (ange-ftp) filenames
3663 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
3664 (convert-standard-filename result)
3665 result))
3666
3667 ;; Deal with buffers that don't have any associated files. (Mail
3668 ;; mode tends to create a good number of these.)
3669
3670 (let ((buffer-name (buffer-name))
3671 (limit 0)
3672 file-name)
3673 ;; Eliminate all slashes and backslashes by
3674 ;; replacing them with sequences that start with %.
3675 ;; Quote % also, to keep distinct names distinct.
3676 (while (string-match "[/\\%]" buffer-name limit)
3677 (let* ((character (aref buffer-name (match-beginning 0)))
3678 (replacement
3679 (cond ((eq character ?%) "%%")
3680 ((eq character ?/) "%+")
3681 ((eq character ?\\) "%-"))))
3682 (setq buffer-name (replace-match replacement t t buffer-name))
3683 (setq limit (1+ (match-end 0)))))
3684 ;; Generate the file name.
3685 (setq file-name
3686 (make-temp-file
3687 (let ((fname
3688 (expand-file-name
3689 (format "#%s#" buffer-name)
3690 ;; Try a few alternative directories, to get one we can
3691 ;; write it.
3692 (cond
3693 ((file-writable-p default-directory) default-directory)
3694 ((file-writable-p "/var/tmp/") "/var/tmp/")
3695 ("~/")))))
3696 (if (and (memq system-type '(ms-dos windows-nt))
3697 ;; Don't modify remote (ange-ftp) filenames
3698 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
3699 ;; The call to convert-standard-filename is in case
3700 ;; buffer-name includes characters not allowed by the
3701 ;; DOS/Windows filesystems. make-temp-file writes to the
3702 ;; file it creates, so we must fix the file name _before_
3703 ;; make-temp-file is called.
3704 (convert-standard-filename fname)
3705 fname))
3706 nil "#"))
3707 ;; make-temp-file creates the file,
3708 ;; but we don't want it to exist until we do an auto-save.
3709 (condition-case ()
3710 (delete-file file-name)
3711 (file-error nil))
3712 file-name)))
3713
3714 (defun auto-save-file-name-p (filename)
3715 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3716 FILENAME should lack slashes. You can redefine this for customization."
3717 (string-match "^#.*#$" filename))
3718 \f
3719 (defun wildcard-to-regexp (wildcard)
3720 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3721 The generated regexp will match a filename iff the filename
3722 matches that wildcard according to shell rules. Only wildcards known
3723 by `sh' are supported."
3724 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3725 ;; Copy the initial run of non-special characters.
3726 (result (substring wildcard 0 i))
3727 (len (length wildcard)))
3728 ;; If no special characters, we're almost done.
3729 (if i
3730 (while (< i len)
3731 (let ((ch (aref wildcard i))
3732 j)
3733 (setq
3734 result
3735 (concat result
3736 (cond
3737 ((and (eq ch ?\[)
3738 (< (1+ i) len)
3739 (eq (aref wildcard (1+ i)) ?\]))
3740 "\\[")
3741 ((eq ch ?\[) ; [...] maps to regexp char class
3742 (progn
3743 (setq i (1+ i))
3744 (concat
3745 (cond
3746 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3747 (progn
3748 (setq i (1+ i))
3749 (if (eq (aref wildcard i) ?\])
3750 (progn
3751 (setq i (1+ i))
3752 "[^]")
3753 "[^")))
3754 ((eq (aref wildcard i) ?^)
3755 ;; Found "[^". Insert a `\0' character
3756 ;; (which cannot happen in a filename)
3757 ;; into the character class, so that `^'
3758 ;; is not the first character after `[',
3759 ;; and thus non-special in a regexp.
3760 (progn
3761 (setq i (1+ i))
3762 "[\000^"))
3763 ((eq (aref wildcard i) ?\])
3764 ;; I don't think `]' can appear in a
3765 ;; character class in a wildcard, but
3766 ;; let's be general here.
3767 (progn
3768 (setq i (1+ i))
3769 "[]"))
3770 (t "["))
3771 (prog1 ; copy everything upto next `]'.
3772 (substring wildcard
3773 i
3774 (setq j (string-match
3775 "]" wildcard i)))
3776 (setq i (if j (1- j) (1- len)))))))
3777 ((eq ch ?.) "\\.")
3778 ((eq ch ?*) "[^\000]*")
3779 ((eq ch ?+) "\\+")
3780 ((eq ch ?^) "\\^")
3781 ((eq ch ?$) "\\$")
3782 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3783 ((eq ch ??) "[^\000]")
3784 (t (char-to-string ch)))))
3785 (setq i (1+ i)))))
3786 ;; Shell wildcards should match the entire filename,
3787 ;; not its part. Make the regexp say so.
3788 (concat "\\`" result "\\'")))
3789 \f
3790 (defcustom list-directory-brief-switches
3791 (if (eq system-type 'vax-vms) "" "-CF")
3792 "*Switches for `list-directory' to pass to `ls' for brief listing."
3793 :type 'string
3794 :group 'dired)
3795
3796 (defcustom list-directory-verbose-switches
3797 (if (eq system-type 'vax-vms)
3798 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3799 "-l")
3800 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3801 :type 'string
3802 :group 'dired)
3803
3804 (defun file-expand-wildcards (pattern &optional full)
3805 "Expand wildcard pattern PATTERN.
3806 This returns a list of file names which match the pattern.
3807
3808 If PATTERN is written as an absolute relative file name,
3809 the values are absolute also.
3810
3811 If PATTERN is written as a relative file name, it is interpreted
3812 relative to the current default directory, `default-directory'.
3813 The file names returned are normally also relative to the current
3814 default directory. However, if FULL is non-nil, they are absolute."
3815 (save-match-data
3816 (let* ((nondir (file-name-nondirectory pattern))
3817 (dirpart (file-name-directory pattern))
3818 ;; A list of all dirs that DIRPART specifies.
3819 ;; This can be more than one dir
3820 ;; if DIRPART contains wildcards.
3821 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
3822 (mapcar 'file-name-as-directory
3823 (file-expand-wildcards (directory-file-name dirpart)))
3824 (list dirpart)))
3825 contents)
3826 (while dirs
3827 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3828 (file-directory-p (directory-file-name (car dirs))))
3829 (let ((this-dir-contents
3830 ;; Filter out "." and ".."
3831 (delq nil
3832 (mapcar #'(lambda (name)
3833 (unless (string-match "\\`\\.\\.?\\'"
3834 (file-name-nondirectory name))
3835 name))
3836 (directory-files (or (car dirs) ".") full
3837 (wildcard-to-regexp nondir))))))
3838 (setq contents
3839 (nconc
3840 (if (and (car dirs) (not full))
3841 (mapcar (function (lambda (name) (concat (car dirs) name)))
3842 this-dir-contents)
3843 this-dir-contents)
3844 contents))))
3845 (setq dirs (cdr dirs)))
3846 contents)))
3847
3848 (defun list-directory (dirname &optional verbose)
3849 "Display a list of files in or matching DIRNAME, a la `ls'.
3850 DIRNAME is globbed by the shell if necessary.
3851 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3852 Actions controlled by variables `list-directory-brief-switches'
3853 and `list-directory-verbose-switches'."
3854 (interactive (let ((pfx current-prefix-arg))
3855 (list (read-file-name (if pfx "List directory (verbose): "
3856 "List directory (brief): ")
3857 nil default-directory nil)
3858 pfx)))
3859 (let ((switches (if verbose list-directory-verbose-switches
3860 list-directory-brief-switches))
3861 buffer)
3862 (or dirname (setq dirname default-directory))
3863 (setq dirname (expand-file-name dirname))
3864 (with-output-to-temp-buffer "*Directory*"
3865 (setq buffer standard-output)
3866 (buffer-disable-undo standard-output)
3867 (princ "Directory ")
3868 (princ dirname)
3869 (terpri)
3870 (save-excursion
3871 (set-buffer "*Directory*")
3872 (let ((wildcard (not (file-directory-p dirname))))
3873 (insert-directory dirname switches wildcard (not wildcard)))))
3874 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3875 (with-current-buffer buffer
3876 (setq default-directory
3877 (if (file-directory-p dirname)
3878 (file-name-as-directory dirname)
3879 (file-name-directory dirname))))))
3880
3881 (defun shell-quote-wildcard-pattern (pattern)
3882 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3883
3884 PATTERN is assumed to represent a file-name wildcard suitable for the
3885 underlying filesystem. For Unix and GNU/Linux, the characters from the
3886 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
3887 the parts of the pattern which don't include wildcard characters are
3888 quoted with double quotes.
3889 Existing quote characters in PATTERN are left alone, so you can pass
3890 PATTERN that already quotes some of the special characters."
3891 (save-match-data
3892 (cond
3893 ((memq system-type '(ms-dos windows-nt cygwin))
3894 ;; DOS/Windows don't allow `"' in file names. So if the
3895 ;; argument has quotes, we can safely assume it is already
3896 ;; quoted by the caller.
3897 (if (or (string-match "[\"]" pattern)
3898 ;; We quote [&()#$'] in case their shell is a port of a
3899 ;; Unixy shell. We quote [,=+] because stock DOS and
3900 ;; Windows shells require that in some cases, such as
3901 ;; passing arguments to batch files that use positional
3902 ;; arguments like %1.
3903 (not (string-match "[ \t;&()#$',=+]" pattern)))
3904 pattern
3905 (let ((result "\"")
3906 (beg 0)
3907 end)
3908 (while (string-match "[*?]+" pattern beg)
3909 (setq end (match-beginning 0)
3910 result (concat result (substring pattern beg end)
3911 "\""
3912 (substring pattern end (match-end 0))
3913 "\"")
3914 beg (match-end 0)))
3915 (concat result (substring pattern beg) "\""))))
3916 (t
3917 (let ((beg 0))
3918 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3919 (setq pattern
3920 (concat (substring pattern 0 (match-beginning 0))
3921 "\\"
3922 (substring pattern (match-beginning 0)))
3923 beg (1+ (match-end 0)))))
3924 pattern))))
3925
3926
3927 (defvar insert-directory-program "ls"
3928 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3929
3930 (defcustom directory-free-space-program "df"
3931 "*Program to get the amount of free space on a file system.
3932 We assume the output has the format of `df'.
3933 The value of this variable must be just a command name or file name;
3934 if you want to specify options, use `directory-free-space-args'.
3935
3936 A value of nil disables this feature.
3937
3938 If the function `file-system-info' is defined, it is always used in
3939 preference to the program given by this variable."
3940 :type '(choice (string :tag "Program") (const :tag "None" nil))
3941 :group 'dired)
3942
3943 (defcustom directory-free-space-args
3944 (if (eq system-type 'darwin) "-k" "-Pk")
3945 "*Options to use when running `directory-free-space-program'."
3946 :type 'string
3947 :group 'dired)
3948
3949 (defun get-free-disk-space (dir)
3950 "Return the mount of free space on directory DIR's file system.
3951 The result is a string that gives the number of free 1KB blocks,
3952 or nil if the system call or the program which retrieve the infornmation
3953 fail.
3954
3955 This function calls `file-system-info' if it is available, or invokes the
3956 program specified by `directory-free-space-program' if that is non-nil."
3957 ;; Try to find the number of free blocks. Non-Posix systems don't
3958 ;; always have df, but might have an equivalent system call.
3959 (if (fboundp 'file-system-info)
3960 (let ((fsinfo (file-system-info dir)))
3961 (if fsinfo
3962 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
3963 (save-match-data
3964 (with-temp-buffer
3965 (when (and directory-free-space-program
3966 (zerop (call-process directory-free-space-program
3967 nil t nil
3968 directory-free-space-args
3969 dir)))
3970 ;; Usual format is a header line followed by a line of
3971 ;; numbers.
3972 (goto-char (point-min))
3973 (forward-line 1)
3974 (if (not (eobp))
3975 (progn
3976 ;; Move to the end of the "available blocks" number.
3977 (skip-chars-forward "^ \t")
3978 (forward-word 3)
3979 ;; Copy it into AVAILABLE.
3980 (let ((end (point)))
3981 (forward-word -1)
3982 (buffer-substring (point) end)))))))))
3983
3984
3985 ;; insert-directory
3986 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3987 ;; FULL-DIRECTORY-P is nil.
3988 ;; The single line of output must display FILE's name as it was
3989 ;; given, namely, an absolute path name.
3990 ;; - must insert exactly one line for each file if WILDCARD or
3991 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3992 ;; before the file lines, plus optional text after the file lines.
3993 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3994 ;; allowed.
3995 ;; File lines should display the basename.
3996 ;; - must be consistent with
3997 ;; - functions dired-move-to-filename, (these two define what a file line is)
3998 ;; dired-move-to-end-of-filename,
3999 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4000 ;; dired-insert-headerline
4001 ;; dired-after-subdir-garbage (defines what a "total" line is)
4002 ;; - variable dired-subdir-regexp
4003 ;; - may be passed "--dired" as the first argument in SWITCHES.
4004 ;; Filename handlers might have to remove this switch if their
4005 ;; "ls" command does not support it.
4006 (defun insert-directory (file switches &optional wildcard full-directory-p)
4007 "Insert directory listing for FILE, formatted according to SWITCHES.
4008 Leaves point after the inserted text.
4009 SWITCHES may be a string of options, or a list of strings.
4010 Optional third arg WILDCARD means treat FILE as shell wildcard.
4011 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4012 switches do not contain `d', so that a full listing is expected.
4013
4014 This works by running a directory listing program
4015 whose name is in the variable `insert-directory-program'.
4016 If WILDCARD, it also runs the shell specified by `shell-file-name'."
4017 ;; We need the directory in order to find the right handler.
4018 (let ((handler (find-file-name-handler (expand-file-name file)
4019 'insert-directory)))
4020 (if handler
4021 (funcall handler 'insert-directory file switches
4022 wildcard full-directory-p)
4023 (if (eq system-type 'vax-vms)
4024 (vms-read-directory file switches (current-buffer))
4025 (let (result available (beg (point)))
4026
4027 ;; Read the actual directory using `insert-directory-program'.
4028 ;; RESULT gets the status code.
4029 (let* (;; We at first read by no-conversion, then after
4030 ;; putting text property `dired-filename, decode one
4031 ;; bunch by one to preserve that property.
4032 (coding-system-for-read 'no-conversion)
4033 ;; This is to control encoding the arguments in call-process.
4034 (coding-system-for-write
4035 (and enable-multibyte-characters
4036 (or file-name-coding-system
4037 default-file-name-coding-system))))
4038 (setq result
4039 (if wildcard
4040 ;; Run ls in the directory part of the file pattern
4041 ;; using the last component as argument.
4042 (let ((default-directory
4043 (if (file-name-absolute-p file)
4044 (file-name-directory file)
4045 (file-name-directory (expand-file-name file))))
4046 (pattern (file-name-nondirectory file)))
4047 (call-process
4048 shell-file-name nil t nil
4049 "-c"
4050 (concat (if (memq system-type '(ms-dos windows-nt))
4051 ""
4052 "\\") ; Disregard Unix shell aliases!
4053 insert-directory-program
4054 " -d "
4055 (if (stringp switches)
4056 switches
4057 (mapconcat 'identity switches " "))
4058 " -- "
4059 ;; Quote some characters that have
4060 ;; special meanings in shells; but
4061 ;; don't quote the wildcards--we want
4062 ;; them to be special. We also
4063 ;; currently don't quote the quoting
4064 ;; characters in case people want to
4065 ;; use them explicitly to quote
4066 ;; wildcard characters.
4067 (shell-quote-wildcard-pattern pattern))))
4068 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4069 ;; directory if FILE is a symbolic link.
4070 (apply 'call-process
4071 insert-directory-program nil t nil
4072 (append
4073 (if (listp switches) switches
4074 (unless (equal switches "")
4075 ;; Split the switches at any spaces so we can
4076 ;; pass separate options as separate args.
4077 (split-string switches)))
4078 ;; Avoid lossage if FILE starts with `-'.
4079 '("--")
4080 (progn
4081 (if (string-match "\\`~" file)
4082 (setq file (expand-file-name file)))
4083 (list
4084 (if full-directory-p
4085 (concat (file-name-as-directory file) ".")
4086 file))))))))
4087
4088 ;; If `insert-directory-program' failed, signal an error.
4089 (if (/= result 0)
4090 ;; On non-Posix systems, we cannot open a directory, so
4091 ;; don't even try, because that will always result in
4092 ;; the ubiquitous "Access denied". Instead, show the
4093 ;; command line so the user can try to guess what went wrong.
4094 (if (and (file-directory-p file)
4095 (memq system-type '(ms-dos windows-nt)))
4096 (error
4097 "Reading directory: \"%s %s -- %s\" exited with status %s"
4098 insert-directory-program
4099 (if (listp switches) (concat switches) switches)
4100 file result)
4101 ;; Unix. Access the file to get a suitable error.
4102 (access-file file "Reading directory")
4103 (error "Listing directory failed but `access-file' worked")))
4104
4105 (when (string-match "--dired\\>" switches)
4106 (forward-line -2)
4107 (when (looking-at "//SUBDIRED//")
4108 (delete-region (point) (progn (forward-line 1) (point)))
4109 (forward-line -1))
4110 (let ((end (line-end-position)))
4111 (forward-word 1)
4112 (forward-char 3)
4113 (while (< (point) end)
4114 (let ((start (+ beg (read (current-buffer))))
4115 (end (+ beg (read (current-buffer)))))
4116 (if (= (char-after end) ?\n)
4117 (put-text-property start end 'dired-filename t)
4118 ;; It seems that we can't trust ls's output as to
4119 ;; byte positions of filenames.
4120 (put-text-property beg (point) 'dired-filename nil)
4121 (end-of-line))))
4122 (goto-char end)
4123 (beginning-of-line)
4124 (delete-region (point) (progn (forward-line 2) (point)))))
4125
4126 ;; Now decode what read if necessary.
4127 (let ((coding (or coding-system-for-write
4128 (detect-coding-region beg (point) t)))
4129 val pos)
4130 (if (not (eq (coding-system-base coding) 'undecided))
4131 (save-restriction
4132 (narrow-to-region beg (point))
4133 (goto-char (point-min))
4134 (while (not (eobp))
4135 (setq pos (point)
4136 val (get-text-property (point) 'dired-filename))
4137 (goto-char (next-single-property-change
4138 (point) 'dired-filename nil (point-max)))
4139 (decode-coding-region pos (point) coding)
4140 (if val
4141 (put-text-property pos (point) 'dired-filename t))))))
4142
4143 (if full-directory-p
4144 ;; Try to insert the amount of free space.
4145 (save-excursion
4146 (goto-char beg)
4147 ;; First find the line to put it on.
4148 (when (re-search-forward "^ *\\(total\\)" nil t)
4149 (let ((available (get-free-disk-space ".")))
4150 (when available
4151 ;; Replace "total" with "used", to avoid confusion.
4152 (replace-match "total used in directory" nil nil nil 1)
4153 (end-of-line)
4154 (insert " available " available)))))))))))
4155
4156 (defun insert-directory-safely (file switches
4157 &optional wildcard full-directory-p)
4158 "Insert directory listing for FILE, formatted according to SWITCHES.
4159
4160 Like `insert-directory', but if FILE does not exist, it inserts a
4161 message to that effect instead of signaling an error."
4162 (if (file-exists-p file)
4163 (insert-directory file switches wildcard full-directory-p)
4164 ;; Simulate the message printed by `ls'.
4165 (insert (format "%s: No such file or directory\n" file))))
4166
4167 (defvar kill-emacs-query-functions nil
4168 "Functions to call with no arguments to query about killing Emacs.
4169 If any of these functions returns nil, killing Emacs is cancelled.
4170 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
4171 but `kill-emacs', the low level primitive, does not.
4172 See also `kill-emacs-hook'.")
4173
4174 (defcustom confirm-kill-emacs nil
4175 "How to ask for confirmation when leaving Emacs.
4176 If nil, the default, don't ask at all. If the value is non-nil, it should
4177 be a predicate function such as `yes-or-no-p'."
4178 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
4179 (const :tag "Ask with y-or-n-p" y-or-n-p)
4180 (const :tag "Don't confirm" nil))
4181 :group 'emacs
4182 :version "21.1")
4183
4184 (defun save-buffers-kill-emacs (&optional arg)
4185 "Offer to save each buffer, then kill this Emacs process.
4186 With prefix arg, silently save all file-visiting buffers, then kill."
4187 (interactive "P")
4188 (save-some-buffers arg t)
4189 (and (or (not (memq t (mapcar (function
4190 (lambda (buf) (and (buffer-file-name buf)
4191 (buffer-modified-p buf))))
4192 (buffer-list))))
4193 (yes-or-no-p "Modified buffers exist; exit anyway? "))
4194 (or (not (fboundp 'process-list))
4195 ;; process-list is not defined on VMS.
4196 (let ((processes (process-list))
4197 active)
4198 (while processes
4199 (and (memq (process-status (car processes)) '(run stop open listen))
4200 (process-query-on-exit-flag (car processes))
4201 (setq active t))
4202 (setq processes (cdr processes)))
4203 (or (not active)
4204 (list-processes t)
4205 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
4206 ;; Query the user for other things, perhaps.
4207 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
4208 (or (null confirm-kill-emacs)
4209 (funcall confirm-kill-emacs "Really exit Emacs? "))
4210 (kill-emacs)))
4211 \f
4212 ;; We use /: as a prefix to "quote" a file name
4213 ;; so that magic file name handlers will not apply to it.
4214
4215 (setq file-name-handler-alist
4216 (cons '("\\`/:" . file-name-non-special)
4217 file-name-handler-alist))
4218
4219 ;; We depend on being the last handler on the list,
4220 ;; so that anything else which does need handling
4221 ;; has been handled already.
4222 ;; So it is safe for us to inhibit *all* magic file name handlers.
4223
4224 (defun file-name-non-special (operation &rest arguments)
4225 (let ((file-name-handler-alist nil)
4226 (default-directory
4227 (if (eq operation 'insert-directory)
4228 (directory-file-name
4229 (expand-file-name
4230 (unhandled-file-name-directory default-directory)))
4231 default-directory))
4232 ;; Get a list of the indices of the args which are file names.
4233 (file-arg-indices
4234 (cdr (or (assq operation
4235 ;; The first five are special because they
4236 ;; return a file name. We want to include the /:
4237 ;; in the return value.
4238 ;; So just avoid stripping it in the first place.
4239 '((expand-file-name . nil)
4240 (file-name-directory . nil)
4241 (file-name-as-directory . nil)
4242 (directory-file-name . nil)
4243 (file-name-sans-versions . nil)
4244 ;; `identity' means just return the first arg
4245 ;; as stripped of its quoting.
4246 (substitute-in-file-name . identity)
4247 (file-name-completion 1)
4248 (file-name-all-completions 1)
4249 (rename-file 0 1)
4250 (copy-file 0 1)
4251 (make-symbolic-link 0 1)
4252 (add-name-to-file 0 1)))
4253 ;; For all other operations, treat the first argument only
4254 ;; as the file name.
4255 '(nil 0))))
4256 ;; Copy ARGUMENTS so we can replace elements in it.
4257 (arguments (copy-sequence arguments)))
4258 ;; Strip off the /: from the file names that have this handler.
4259 (save-match-data
4260 (while (consp file-arg-indices)
4261 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4262 (and (car pair)
4263 (string-match "\\`/:" (car pair))
4264 (setcar pair
4265 (if (= (length (car pair)) 2)
4266 "/"
4267 (substring (car pair) 2)))))
4268 (setq file-arg-indices (cdr file-arg-indices))))
4269 (if (eq file-arg-indices 'identity)
4270 (car arguments)
4271 (apply operation arguments))))
4272 \f
4273 (define-key ctl-x-map "\C-f" 'find-file)
4274 (define-key ctl-x-map "\C-r" 'find-file-read-only)
4275 (define-key ctl-x-map "\C-v" 'find-alternate-file)
4276 (define-key ctl-x-map "\C-s" 'save-buffer)
4277 (define-key ctl-x-map "s" 'save-some-buffers)
4278 (define-key ctl-x-map "\C-w" 'write-file)
4279 (define-key ctl-x-map "i" 'insert-file)
4280 (define-key esc-map "~" 'not-modified)
4281 (define-key ctl-x-map "\C-d" 'list-directory)
4282 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
4283 (define-key ctl-x-map "\C-q" 'toggle-read-only)
4284
4285 (define-key ctl-x-4-map "f" 'find-file-other-window)
4286 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4287 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4288 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
4289 (define-key ctl-x-4-map "\C-o" 'display-buffer)
4290
4291 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
4292 (define-key ctl-x-5-map "f" 'find-file-other-frame)
4293 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
4294 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
4295
4296 ;;; files.el ends here