(generate-file-autoloads): Bind float-output-format.
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
a292c99f 3;; Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
b4da00e9 4
3a801d0c
ER
5;; Maintainer: FSF
6
b4da00e9
RM
7;; This file is part of GNU Emacs.
8
9;; GNU Emacs is free software; you can redistribute it and/or modify
10;; it under the terms of the GNU General Public License as published by
e5167999 11;; the Free Software Foundation; either version 2, or (at your option)
b4da00e9
RM
12;; any later version.
13
14;; GNU Emacs is distributed in the hope that it will be useful,
15;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17;; GNU General Public License for more details.
18
19;; You should have received a copy of the GNU General Public License
20;; along with GNU Emacs; see the file COPYING. If not, write to
21;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22
e41b2db1
ER
23;;; Commentary:
24
25;; Defines most of Emacs's file- and directory-handling functions,
26;; including basic file visiting, backup generation, link handling,
27;; ITS-id version control, load- and write-hook handling, and the like.
28
e5167999
ER
29;;; Code:
30
b4da00e9
RM
31(defconst delete-auto-save-files t
32 "*Non-nil means delete a buffer's auto-save file when the buffer is saved.")
33
34(defconst directory-abbrev-alist
35 nil
36 "*Alist of abbreviations for file directories.
37A list of elements of the form (FROM . TO), each meaning to replace
38FROM with TO when it appears in a directory name. This replacement is
39done when setting up the default directory of a newly visited file.
40*Every* FROM string should start with `^'.
41
42Use this feature when you have directories which you normally refer to
43via absolute symbolic links. Make TO the name of the link, and FROM
44the name it is linked to.")
45
46;;; Turn off backup files on VMS since it has version numbers.
47(defconst make-backup-files (not (eq system-type 'vax-vms))
4ea836c1 48 "*Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
49This can be done by renaming the file or by copying.
50
51Renaming means that Emacs renames the existing file so that it is a
52backup file, then writes the buffer into a new file. Any other names
53that the old file had will now refer to the backup file. The new file
54is owned by you and its group is defaulted.
55
56Copying means that Emacs copies the existing file into the backup
57file, then writes the buffer on top of the existing file. Any other
58names that the old file had will now refer to the new (edited) file.
59The file's owner and group are unchanged.
60
61The choice of renaming or copying is controlled by the variables
62`backup-by-copying', `backup-by-copying-when-linked' and
63`backup-by-copying-when-mismatch'.")
64
65;; Do this so that local variables based on the file name
66;; are not overridden by the major mode.
67(defvar backup-inhibited nil
68 "Non-nil means don't make a backup file for this buffer.")
69(put 'backup-inhibited 'permanent-local t)
70
71(defconst backup-by-copying nil
72 "*Non-nil means always use copying to create backup files.
73See documentation of variable `make-backup-files'.")
74
75(defconst backup-by-copying-when-linked nil
76 "*Non-nil means use copying to create backups for files with multiple names.
77This causes the alternate names to refer to the latest version as edited.
78This variable is relevant only if `backup-by-copying' is nil.")
79
80(defconst backup-by-copying-when-mismatch nil
81 "*Non-nil means create backups by copying if this preserves owner or group.
82Renaming may still be used (subject to control of other variables)
83when it would not result in changing the owner or group of the file;
84that is, for files which are owned by you and whose group matches
85the default for a new file created there by you.
86This variable is relevant only if `backup-by-copying' is nil.")
87
88(defvar backup-enable-predicate
89 '(lambda (name)
90 (or (< (length name) 5)
91 (not (string-equal "/tmp/" (substring name 0 5)))))
92 "Predicate that looks at a file name and decides whether to make backups.
93Called with an absolute file name as argument, it returns t to enable backup.")
94
95(defconst buffer-offer-save nil
96 "*Non-nil in a buffer means offer to save the buffer on exit
97even if the buffer is not visiting a file.
98Automatically local in all buffers.")
99(make-variable-buffer-local 'buffer-offer-save)
100
f3e23606
RS
101(defconst find-file-existing-other-name nil
102 "*Non-nil means find a file under alternative names, in existing buffers.
103This means if any existing buffer is visiting the file you want
104under another name, you get the existing buffer instead of a new buffer.")
105
106(defconst find-file-visit-truename nil
107 "*Non-nil means visit a file under its truename.
108The truename of a file is found by chasing all links
109both at the file level and at the levels of the containing directories.")
110
111(defvar buffer-file-truename nil
112 "The truename of the file visited in the current buffer.
113This variable is automatically local in all buffers, when non-nil.")
114(make-variable-buffer-local 'buffer-file-truename)
115(put 'buffer-file-truename 'permanent-local t)
116
117(defvar buffer-file-number nil
118 "The device number and file number of the file visited in the current buffer.
119The value is a list of the form (FILENUM DEVNUM).
120This pair of numbers uniquely identifies the file.
121If the buffer is visiting a new file, the value is nil.")
122(make-variable-buffer-local 'buffer-file-number)
123(put 'buffer-file-number 'permanent-local t)
124
b4da00e9
RM
125(defconst file-precious-flag nil
126 "*Non-nil means protect against I/O errors while saving files.
127Some modes set this non-nil in particular buffers.")
128
129(defvar version-control nil
130 "*Control use of version numbers for backup files.
131t means make numeric backup versions unconditionally.
132nil means make them for files that have some already.
133never means do not make them.")
134
135(defvar dired-kept-versions 2
136 "*When cleaning directory, number of versions to keep.")
137
138(defvar trim-versions-without-asking nil
6d74b528
ER
139 "*If t, deletes excess backup versions silently.
140If nil, asks confirmation. Any other value prevents any trimming.")
b4da00e9
RM
141
142(defvar kept-old-versions 2
143 "*Number of oldest versions to keep when a new numbered backup is made.")
144
145(defvar kept-new-versions 2
146 "*Number of newest versions to keep when a new numbered backup is made.
147Includes the new backup. Must be > 0")
148
149(defconst require-final-newline nil
150 "*Value of t says silently ensure a file ends in a newline when it is saved.
151Non-nil but not t says ask user whether to add a newline when there isn't one.
152nil means don't add newlines.")
153
154(defconst auto-save-default t
155 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
156
157(defconst auto-save-visited-file-name nil
158 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
159Normally auto-save files are written under other names.")
160
161(defconst save-abbrevs nil
162 "*Non-nil means save word abbrevs too when files are saved.
163Loading an abbrev file sets this to t.")
164
165(defconst find-file-run-dired t
320b4233 166 "*Non-nil says run dired if `find-file' is given the name of a directory.")
b4da00e9 167
92966e6f
RS
168;;;It is not useful to make this a local variable.
169;;;(put 'find-file-not-found-hooks 'permanent-local t)
b4da00e9
RM
170(defvar find-file-not-found-hooks nil
171 "List of functions to be called for `find-file' on nonexistent file.
172These functions are called as soon as the error is detected.
173`buffer-file-name' is already set up.
174The functions are called in the order given until one of them returns non-nil.")
175
92966e6f
RS
176;;;It is not useful to make this a local variable.
177;;;(put 'find-file-hooks 'permanent-local t)
b4da00e9
RM
178(defvar find-file-hooks nil
179 "List of functions to be called after a buffer is loaded from a file.
180The buffer's local variables (if any) will have been processed before the
181functions are called.")
182
c9dca4e0 183;;; In case someone does make it local.
b4da00e9
RM
184(put 'write-file-hooks 'permanent-local t)
185(defvar write-file-hooks nil
186 "List of functions to be called before writing out a buffer to a file.
187If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
188and the rest are not called.
189These hooks are considered to pertain to the visited file.
190So this list is cleared if you change the visited file name.
c9dca4e0
RS
191See also `write-contents-hooks'.
192Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
193
194(put 'local-write-file-hooks 'permanent-local t)
195(defvar local-write-file-hooks nil
196 "Just like `write-file-hooks', except intended for per-buffer use.
197The functions in this list are called before the ones in
198`write-file-hooks'.")
8c0e7b73
JB
199
200(defvar write-contents-hooks nil
201 "List of functions to be called before writing out a buffer to a file.
202If one of them returns non-nil, the file is considered already written
203and the rest are not called.
204These hooks are considered to pertain to the buffer's contents,
205not to the particular visited file; thus, `set-visited-file-name' does
206not clear this variable, but changing the major mode does clear it.
207See also `write-file-hooks'.")
b4da00e9
RM
208
209(defconst enable-local-variables t
210 "*Control use of local-variables lists in files you visit.
211The value can be t, nil or something else.
212A value of t means local-variables lists are obeyed;
213nil means they are ignored; anything else means query.
214
215The command \\[normal-mode] always obeys local-variables lists
216and ignores this variable.")
217
2bba782c 218(defconst enable-local-eval 'maybe
d207b766
RS
219 "*Control processing of the \"variable\" `eval' in a file's local variables.
220The value can be t, nil or something else.
221A value of t means obey `eval' variables;
222nil means ignore them; anything else means query.
223
224The command \\[normal-mode] always obeys local-variables lists
225and ignores this variable.")
b4da00e9
RM
226
227;; Avoid losing in versions where CLASH_DETECTION is disabled.
228(or (fboundp 'lock-buffer)
231c4e10 229 (defalias 'lock-buffer 'ignore))
b4da00e9 230(or (fboundp 'unlock-buffer)
231c4e10 231 (defalias 'unlock-buffer 'ignore))
93fe0a35
RS
232
233;; This hook function provides support for ange-ftp host name
234;; completion. It runs the usual ange-ftp hook, but only for
235;; completion operations. Having this here avoids the need
236;; to load ange-ftp when it's not really in use.
237(defun ange-ftp-completion-hook-function (op &rest args)
238 (if (memq op '(file-name-completion file-name-all-completions))
239 (apply 'ange-ftp-hook-function op args)
240 (let (file-name-handler-alist)
241 (apply op args))))
b4da00e9
RM
242\f
243(defun pwd ()
244 "Show the current default directory."
245 (interactive nil)
246 (message "Directory %s" default-directory))
247
231c4e10
ER
248(defvar cd-path nil
249 "Value of the CDPATH environment variable, as a list.
250Not actually set up until the first time you you use it.")
251
252(defun parse-colon-path (cd-path)
253 "Explode a colon-separated list of paths into a string list."
254 (and cd-path
255 (let (cd-prefix cd-list (cd-start 0) cd-colon)
256 (setq cd-path (concat cd-path ":"))
257 (while (setq cd-colon (string-match ":" cd-path cd-start))
258 (setq cd-list
9daefb36
RS
259 (nconc cd-list
260 (list (substitute-in-file-name
e33e80e4
RS
261 (if (= cd-start cd-colon)
262 "."
263 (file-name-as-directory
264 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
265 (setq cd-start (+ cd-colon 1)))
266 cd-list)))
267
268(defun cd-absolute (dir)
30c5ce9c 269 "Change current directory to given absolute file name DIR."
b3c4423b 270 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9
RM
271 (if (not (eq system-type 'vax-vms))
272 (setq dir (file-name-as-directory dir)))
273 (if (not (file-directory-p dir))
274 (error "%s is not a directory" dir)
275 (if (file-executable-p dir)
276 (setq default-directory dir)
9daefb36 277 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 278
231c4e10
ER
279(defun cd (dir)
280 "Make DIR become the current buffer's default directory.
30c5ce9c
RS
281If your environment includes a `CDPATH' variable, try each one of that
282colon-separated list of directories when resolving a relative directory name."
231c4e10 283 (interactive "FChange default directory: ")
30c5ce9c
RS
284 (if (file-name-absolute-p dir)
285 (cd-absolute (expand-file-name dir))
286 (if (null cd-path)
287 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
288 (setq cd-path (or trypath (list "./")))))
289 (if (not (catch 'found
290 (mapcar
291 (function (lambda (x)
292 (let ((f (expand-file-name (concat x dir))))
293 (if (file-directory-p f)
294 (progn
295 (cd-absolute f)
296 (throw 'found t))))))
297 cd-path)
298 nil))
299 (error "No such directory found via CDPATH environment variable"))))
231c4e10 300
b4da00e9
RM
301(defun load-file (file)
302 "Load the Lisp file named FILE."
303 (interactive "fLoad file: ")
304 (load (expand-file-name file) nil nil t))
305
306(defun load-library (library)
307 "Load the library named LIBRARY.
308This is an interface to the function `load'."
309 (interactive "sLoad library: ")
310 (load library))
5d68c2c2
RS
311
312;; OTHER is the other file to be compared.
313(defun file-local-copy (file)
314 "Copy the file FILE into a temporary file on this machine.
315Returns the name of the local copy, or nil, if FILE is directly
316accessible."
5dbfdacd 317 (let ((handler (find-file-name-handler file)))
5d68c2c2
RS
318 (if handler
319 (funcall handler 'file-local-copy file)
320 nil)))
f3e23606
RS
321
322(defun file-truename (filename)
323 "Return the truename of FILENAME, which should be absolute.
324The truename of a file name is found by chasing symbolic links
325both at the level of the file and at the level of the directories
326containing it, until no links are left at any level."
6d1df4b2 327 (if (string= filename "~")
1cc2fbeb
RS
328 (progn
329 (setq filename (expand-file-name filename))
330 (if (string= filename "")
331 (setq filename "/"))))
5dbfdacd 332 (let ((handler (find-file-name-handler filename)))
6f176f94
RS
333 ;; For file name that has a special handler, call handler.
334 ;; This is so that ange-ftp can save time by doing a no-op.
335 (if handler
336 (funcall handler 'file-truename filename)
337 (let ((dir (file-name-directory filename))
338 target dirfile)
339 ;; Get the truename of the directory.
340 (setq dirfile (directory-file-name dir))
341 ;; If these are equal, we have the (or a) root directory.
342 (or (string= dir dirfile)
343 (setq dir (file-name-as-directory (file-truename dirfile))))
c3bf10c2
RS
344 (if (equal ".." (file-name-nondirectory filename))
345 (directory-file-name (file-name-directory (directory-file-name dir)))
346 (if (equal "." (file-name-nondirectory filename))
347 (directory-file-name dir)
348 ;; Put it back on the file name.
349 (setq filename (concat dir (file-name-nondirectory filename)))
350 ;; Is the file name the name of a link?
351 (setq target (file-symlink-p filename))
352 (if target
353 ;; Yes => chase that link, then start all over
354 ;; since the link may point to a directory name that uses links.
355 ;; We can't safely use expand-file-name here
356 ;; since target might look like foo/../bar where foo
357 ;; is itself a link. Instead, we handle . and .. above.
358 (if (file-name-absolute-p target)
359 (file-truename target)
360 (file-truename (concat dir target)))
361 ;; No, we are done!
362 filename)))))))
5dbfdacd 363
5dadeb29
RS
364(defun file-chase-links (filename)
365 "Chase links in FILENAME until a name that is not a link.
366Does not examine containing directories for links,
367unlike `file-truename'."
368 (let (tem (count 100) (newname filename))
369 (while (setq tem (file-symlink-p newname))
370 (if (= count 0)
371 (error "Apparent cycle of symbolic links for %s" filename))
cf65b429
RS
372 ;; Handle `..' by hand, since it needs to work in the
373 ;; target of any directory symlink.
374 ;; This code is not quite complete; it does not handle
375 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
376 (while (string-match "\\.\\./" tem)
377 (setq tem (substring tem 3))
378 (setq newname (file-name-as-directory
379 ;; Do the .. by hand.
380 (directory-file-name
381 (file-name-directory
382 ;; Chase links in the default dir of the symlink.
383 (file-chase-links
384 (directory-file-name
385 (file-name-directory newname))))))))
5dadeb29
RS
386 (setq newname (expand-file-name tem (file-name-directory newname)))
387 (setq count (1- count)))
388 newname))
b4da00e9
RM
389\f
390(defun switch-to-buffer-other-window (buffer)
391 "Select buffer BUFFER in another window."
392 (interactive "BSwitch to buffer in other window: ")
393 (let ((pop-up-windows t))
394 (pop-to-buffer buffer t)))
395
f98955ea
JB
396(defun switch-to-buffer-other-frame (buffer)
397 "Switch to buffer BUFFER in another frame."
398 (interactive "BSwitch to buffer in other frame: ")
399 (let ((pop-up-frames t))
2be5e5db 400 (pop-to-buffer buffer t)))
5bbbceb1 401
b4da00e9
RM
402(defun find-file (filename)
403 "Edit file FILENAME.
404Switch to a buffer visiting file FILENAME,
405creating one if none already exists."
406 (interactive "FFind file: ")
407 (switch-to-buffer (find-file-noselect filename)))
408
409(defun find-file-other-window (filename)
410 "Edit file FILENAME, in another window.
411May create a new window, or reuse an existing one.
412See the function `display-buffer'."
413 (interactive "FFind file in other window: ")
414 (switch-to-buffer-other-window (find-file-noselect filename)))
415
f98955ea
JB
416(defun find-file-other-frame (filename)
417 "Edit file FILENAME, in another frame.
418May create a new frame, or reuse an existing one.
5bbbceb1 419See the function `display-buffer'."
f98955ea
JB
420 (interactive "FFind file in other frame: ")
421 (switch-to-buffer-other-frame (find-file-noselect filename)))
5bbbceb1 422
b4da00e9
RM
423(defun find-file-read-only (filename)
424 "Edit file FILENAME but don't allow changes.
425Like \\[find-file] but marks buffer as read-only.
426Use \\[toggle-read-only] to permit editing."
427 (interactive "fFind file read-only: ")
428 (find-file filename)
320b4233
RS
429 (setq buffer-read-only t)
430 (current-buffer))
b4da00e9
RM
431
432(defun find-file-read-only-other-window (filename)
433 "Edit file FILENAME in another window but don't allow changes.
434Like \\[find-file-other-window] but marks buffer as read-only.
435Use \\[toggle-read-only] to permit editing."
436 (interactive "fFind file read-only other window: ")
9466a1f6 437 (find-file-other-window filename)
320b4233
RS
438 (setq buffer-read-only t)
439 (current-buffer))
b4da00e9 440
f98955ea
JB
441(defun find-file-read-only-other-frame (filename)
442 "Edit file FILENAME in another frame but don't allow changes.
443Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 444Use \\[toggle-read-only] to permit editing."
f98955ea
JB
445 (interactive "fFind file read-only other frame: ")
446 (find-file-other-frame filename)
320b4233
RS
447 (setq buffer-read-only t)
448 (current-buffer))
5bbbceb1 449
b4da00e9
RM
450(defun find-alternate-file (filename)
451 "Find file FILENAME, select its buffer, kill previous buffer.
452If the current buffer now contains an empty file that you just visited
453\(presumably by mistake), use this command to visit the file you really want."
454 (interactive
455 (let ((file buffer-file-name)
456 (file-name nil)
457 (file-dir nil))
458 (and file
459 (setq file-name (file-name-nondirectory file)
460 file-dir (file-name-directory file)))
a61f59b4
JA
461 (list (read-file-name
462 "Find alternate file: " file-dir nil nil file-name))))
b4da00e9
RM
463 (and (buffer-modified-p)
464 ;; (not buffer-read-only)
465 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
466 (buffer-name))))
467 (error "Aborted"))
468 (let ((obuf (current-buffer))
469 (ofile buffer-file-name)
8bb27285
RS
470 (onum buffer-file-number)
471 (otrue buffer-file-truename)
b4da00e9
RM
472 (oname (buffer-name)))
473 (rename-buffer " **lose**")
474 (setq buffer-file-name nil)
8bb27285
RS
475 (setq buffer-file-number nil)
476 (setq buffer-file-truename nil)
b4da00e9
RM
477 (unwind-protect
478 (progn
479 (unlock-buffer)
480 (find-file filename))
481 (cond ((eq obuf (current-buffer))
482 (setq buffer-file-name ofile)
8bb27285
RS
483 (setq buffer-file-number onum)
484 (setq buffer-file-truename otrue)
b4da00e9
RM
485 (lock-buffer)
486 (rename-buffer oname))))
487 (or (eq (current-buffer) obuf)
488 (kill-buffer obuf))))
489
490(defun create-file-buffer (filename)
491 "Create a suitably named buffer for visiting FILENAME, and return it.
492FILENAME (sans directory) is used unchanged if that name is free;
493otherwise a string <2> or <3> or ... is appended to get an unused name."
494 (let ((lastname (file-name-nondirectory filename)))
495 (if (string= lastname "")
496 (setq lastname filename))
497 (generate-new-buffer lastname)))
498
5bbbceb1
JB
499(defun generate-new-buffer (name)
500 "Create and return a buffer with a name based on NAME.
29165787 501Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
502 (get-buffer-create (generate-new-buffer-name name)))
503
e373f201
JB
504(defconst automount-dir-prefix "^/tmp_mnt/"
505 "Regexp to match the automounter prefix in a directory name.")
506
ffb3a4db
RS
507(defvar abbreviated-home-dir nil
508 "The the user's homedir abbreviated according to `directory-abbrev-list'.")
509
5bbbceb1 510(defun abbreviate-file-name (filename)
29165787 511 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
5bbbceb1 512This also substitutes \"~\" for the user's home directory.
29165787 513Type \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201
JB
514 ;; Get rid of the prefixes added by the automounter.
515 (if (and (string-match automount-dir-prefix filename)
516 (file-exists-p (file-name-directory
517 (substring filename (1- (match-end 0))))))
518 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 519 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
520 ;; If any elt of directory-abbrev-alist matches this name,
521 ;; abbreviate accordingly.
5bbbceb1
JB
522 (while tail
523 (if (string-match (car (car tail)) filename)
524 (setq filename
525 (concat (cdr (car tail)) (substring filename (match-end 0)))))
526 (setq tail (cdr tail)))
ffb3a4db
RS
527 ;; Compute and save the abbreviated homedir name.
528 ;; We defer computing this until the first time it's needed, to
529 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
530 ;; We include a slash at the end, to avoid spurious matches
531 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
532 (or abbreviated-home-dir
533 (setq abbreviated-home-dir
534 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
535 (concat "^" (abbreviate-file-name (expand-file-name "~"))
536 "\\(/\\|$\\)"))))
537
ffb3a4db
RS
538 ;; If FILENAME starts with the abbreviated homedir,
539 ;; make it start with `~' instead.
540 (if (string-match abbreviated-home-dir filename)
5bbbceb1 541 (setq filename
28dbf501
JB
542 (concat "~"
543 ;; If abbreviated-home-dir ends with a slash,
544 ;; don't remove the corresponding slash from
545 ;; filename. On MS-DOS and OS/2, you can have
546 ;; home directories like "g:/", in which it is
547 ;; important not to remove the slash. And what
548 ;; about poor root on Unix systems?
549 (if (eq ?/ (aref abbreviated-home-dir
550 (1- (length abbreviated-home-dir))))
551 "/"
552 "")
3a8a836d 553 (substring filename (match-beginning 1) (match-end 1))
28dbf501 554 (substring filename (match-end 0)))))
5bbbceb1
JB
555 filename))
556
1770543d
RS
557(defvar find-file-not-true-dirname-list nil
558 "*List of logical names for which visiting shouldn't save the true dirname.
559On VMS, when you visit a file using a logical name that searches a path,
560you may or may not want the visited file name to record the specific
561directory where the file was found. If you *do not* want that, add the logical
562name to this list as a string.")
563
b4da00e9
RM
564(defun find-file-noselect (filename &optional nowarn)
565 "Read file FILENAME into a buffer and return the buffer.
566If a buffer exists visiting FILENAME, return that one, but
567verify that the file has not changed since visited or saved.
568The buffer is not selected, just returned to the caller."
e373f201
JB
569 (setq filename
570 (abbreviate-file-name
571 (expand-file-name filename)))
b4da00e9
RM
572 (if (file-directory-p filename)
573 (if find-file-run-dired
574 (dired-noselect filename)
575 (error "%s is a directory." filename))
f3e23606
RS
576 (let* ((buf (get-file-buffer filename))
577 (truename (abbreviate-file-name (file-truename filename)))
578 (number (nthcdr 10 (file-attributes truename)))
579 ;; Find any buffer for a file which has same truename.
580 (same-truename
581 (or buf ; Shortcut
582 (let (found
583 (list (buffer-list)))
584 (while (and (not found) list)
585 (save-excursion
586 (set-buffer (car list))
4269ed64
RM
587 (if (and buffer-file-name
588 (string= buffer-file-truename truename))
f3e23606
RS
589 (setq found (car list))))
590 (setq list (cdr list)))
591 found)))
592 (same-number
593 (or buf ; Shortcut
594 (and number
595 (let (found
596 (list (buffer-list)))
597 (while (and (not found) list)
598 (save-excursion
599 (set-buffer (car list))
4e7afa86
RS
600 (if (and (equal buffer-file-number number)
601 ;; Verify this buffer's file number
602 ;; still belongs to its file.
603 (file-exists-p buffer-file-name)
604 (equal (nthcdr 10 (file-attributes buffer-file-name)) number))
f3e23606
RS
605 (setq found (car list))))
606 (setq list (cdr list)))
607 found))))
608 error)
609 ;; Let user know if there is a buffer with the same truename.
610 (if (and (not buf) same-truename (not nowarn))
611 (message "%s and %s are the same file (%s)"
612 filename (buffer-file-name same-truename)
613 truename)
614 (if (and (not buf) same-number (not nowarn))
615 (message "%s and %s are the same file"
616 filename (buffer-file-name same-number))))
617
618 ;; Optionally also find that buffer.
619 (if (or find-file-existing-other-name find-file-visit-truename)
620 (setq buf (or same-truename same-number)))
b4da00e9
RM
621 (if buf
622 (or nowarn
623 (verify-visited-file-modtime buf)
624 (cond ((not (file-exists-p filename))
625 (error "File %s no longer exists!" filename))
626 ((yes-or-no-p
627 (format
628 (if (buffer-modified-p buf)
629 "File %s changed on disk. Discard your edits? "
630 "File %s changed on disk. Read the new version? ")
631 (file-name-nondirectory filename)))
632 (save-excursion
633 (set-buffer buf)
634 (revert-buffer t t)))))
635 (save-excursion
f3e23606
RS
636;;; The truename stuff makes this obsolete.
637;;; (let* ((link-name (car (file-attributes filename)))
638;;; (linked-buf (and (stringp link-name)
639;;; (get-file-buffer link-name))))
640;;; (if (bufferp linked-buf)
641;;; (message "Symbolic link to file in buffer %s"
642;;; (buffer-name linked-buf))))
b4da00e9
RM
643 (setq buf (create-file-buffer filename))
644 (set-buffer buf)
645 (erase-buffer)
646 (condition-case ()
647 (insert-file-contents filename t)
648 (file-error
649 (setq error t)
650 ;; Run find-file-not-found-hooks until one returns non-nil.
651 (let ((hooks find-file-not-found-hooks))
652 (while (and hooks
653 (not (funcall (car hooks))))
654 (setq hooks (cdr hooks))))))
f3e23606
RS
655 ;; Find the file's truename, and maybe use that as visited name.
656 (setq buffer-file-truename (abbreviate-file-name truename))
1770543d
RS
657 (setq buffer-file-number number)
658 ;; On VMS, we may want to remember which directory in a search list
659 ;; the file was found in.
660 (and (eq system-type 'vax-vms)
661 (let (logical)
662 (if (string-match ":" (file-name-directory filename))
663 (setq logical (substring (file-name-directory filename)
664 0 (match-beginning 0))))
665 (not (member logical find-file-not-true-dirname-list)))
666 (setq buffer-file-name buffer-file-truename))
1cc2fbeb 667 (if find-file-visit-truename
27d0420c
RS
668 (setq buffer-file-name
669 (setq filename
670 (expand-file-name buffer-file-truename))))
b4da00e9
RM
671 ;; Set buffer's default directory to that of the file.
672 (setq default-directory (file-name-directory filename))
673 ;; Turn off backup files for certain file names. Since
674 ;; this is a permanent local, the major mode won't eliminate it.
675 (and (not (funcall backup-enable-predicate buffer-file-name))
676 (progn
677 (make-local-variable 'backup-inhibited)
678 (setq backup-inhibited t)))
679 (after-find-file error (not nowarn))))
680 buf)))
681\f
8cfb9d46 682(defun after-find-file (&optional error warn noauto)
b4da00e9
RM
683 "Called after finding a file and by the default revert function.
684Sets buffer mode, parses local variables.
8cfb9d46 685Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
686error in reading the file. WARN non-nil means warn if there
687exists an auto-save file more recent than the visited file.
8cfb9d46 688NOAUTO means don't mess with auto-save mode.
b4da00e9
RM
689Finishes by calling the functions in `find-file-hooks'."
690 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
691 (if noninteractive
692 nil
693 (let* (not-serious
694 (msg
695 (cond ((and error (file-attributes buffer-file-name))
696 (setq buffer-read-only t)
697 "File exists, but is read-protected.")
698 ((not buffer-read-only)
699 (if (and warn
700 (file-newer-than-file-p (make-auto-save-file-name)
701 buffer-file-name))
702 "Auto save file is newer; consider M-x recover-file"
703 (setq not-serious t)
704 (if error "(New file)" nil)))
705 ((not error)
706 (setq not-serious t)
707 "Note: file is write protected")
708 ((file-attributes (directory-file-name default-directory))
709 "File not found and directory write-protected")
4e43240a
RS
710 ((file-exists-p (file-name-directory buffer-file-name))
711 (setq buffer-read-only nil))
b4da00e9 712 (t
5bbbceb1 713 (setq buffer-read-only nil)
4e43240a
RS
714 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
715 "Use M-x make-dir RET RET to create the directory"
716 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
b4da00e9
RM
717 (if msg
718 (progn
719 (message msg)
720 (or not-serious (sit-for 1 nil t)))))
8cfb9d46 721 (if (and auto-save-default (not noauto))
b4da00e9
RM
722 (auto-save-mode t)))
723 (normal-mode t)
724 (mapcar 'funcall find-file-hooks))
725
726(defun normal-mode (&optional find-file)
727 "Choose the major mode for this buffer automatically.
728Also sets up any specified local variables of the file.
729Uses the visited file name, the -*- line, and the local variables spec.
730
731This function is called automatically from `find-file'. In that case,
732we may set up specified local variables depending on the value of
733`enable-local-variables': if it is t, we do; if it is nil, we don't;
734otherwise, we query. `enable-local-variables' is ignored if you
735run `normal-mode' explicitly."
736 (interactive)
737 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
738 (condition-case err
739 (set-auto-mode)
740 (error (message "File mode specification error: %s"
741 (prin1-to-string err))))
742 (condition-case err
7b3f3dc2
JB
743 (let ((enable-local-variables (or (not find-file)
744 enable-local-variables)))
745 (hack-local-variables))
b4da00e9
RM
746 (error (message "File local-variables error: %s"
747 (prin1-to-string err)))))
748
7b3f3dc2
JB
749(defvar auto-mode-alist (mapcar 'purecopy
750 '(("\\.text\\'" . text-mode)
751 ("\\.c\\'" . c-mode)
752 ("\\.h\\'" . c-mode)
753 ("\\.tex\\'" . TeX-mode)
754 ("\\.ltx\\'" . LaTeX-mode)
755 ("\\.el\\'" . emacs-lisp-mode)
756 ("\\.mm\\'" . nroff-mode)
757 ("\\.me\\'" . nroff-mode)
c80d2575
ER
758 ("\\.ms\\'" . nroff-mode)
759 ("\\.man\\'" . nroff-mode)
7b3f3dc2
JB
760 ("\\.scm\\'" . scheme-mode)
761 ("\\.l\\'" . lisp-mode)
762 ("\\.lisp\\'" . lisp-mode)
763 ("\\.f\\'" . fortran-mode)
764 ("\\.for\\'" . fortran-mode)
765 ("\\.mss\\'" . scribe-mode)
766 ("\\.pl\\'" . prolog-mode)
767 ("\\.cc\\'" . c++-mode)
2b845a8c 768 ("\\.hh\\'" . c++-mode)
7b3f3dc2 769 ("\\.C\\'" . c++-mode)
2b845a8c 770 ("\\.H\\'" . c++-mode)
a3666e47
RS
771;;; ("\\.mk\\'" . makefile-mode)
772;;; ("[Mm]akefile" . makefile-mode)
7b3f3dc2
JB
773;;; Less common extensions come here
774;;; so more common ones above are found faster.
775 ("\\.s\\'" . asm-mode)
776 ("ChangeLog\\'" . change-log-mode)
7adc58e5 777 ("ChangeLog.[0-9]+\\'" . change-log-mode)
7b3f3dc2 778 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
7adc58e5
RS
779;; The following should come after the ChangeLog pattern
780;; for the sake of ChangeLog.1, etc.
781 ("\\.[12345678]\\'" . nroff-mode)
7b3f3dc2
JB
782 ("\\.TeX\\'" . TeX-mode)
783 ("\\.sty\\'" . LaTeX-mode)
784 ("\\.bbl\\'" . LaTeX-mode)
785 ("\\.bib\\'" . bibtex-mode)
786 ("\\.article\\'" . text-mode)
787 ("\\.letter\\'" . text-mode)
788 ("\\.texinfo\\'" . texinfo-mode)
fd5285f3 789 ("\\.texi\\'" . texinfo-mode)
7b3f3dc2
JB
790 ("\\.lsp\\'" . lisp-mode)
791 ("\\.awk\\'" . awk-mode)
792 ("\\.prolog\\'" . prolog-mode)
c80d2575 793 ("\\.tar\\'" . tar-mode)
7b3f3dc2
JB
794 ;; Mailer puts message to be edited in
795 ;; /tmp/Re.... or Message
796 ("^/tmp/Re" . text-mode)
797 ("/Message[0-9]*\\'" . text-mode)
798 ;; some news reader is reported to use this
799 ("^/tmp/fol/" . text-mode)
800 ("\\.y\\'" . c-mode)
c80d2575 801 ("\\.lex\\'" . c-mode)
7b3f3dc2
JB
802 ("\\.oak\\'" . scheme-mode)
803 ("\\.scm.[0-9]*\\'" . scheme-mode)
278584fb
RS
804 ("\\.sgm\\'" . sgml-mode)
805 ("\\.sgml\\'" . sgml-mode)
806 ("\\.dtd\\'" . sgml-mode)
7b3f3dc2
JB
807 ;; .emacs following a directory delimiter
808 ;; in either Unix or VMS syntax.
809 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
810 ("\\.ml\\'" . lisp-mode)))
811 "\
812Alist of filename patterns vs corresponding major mode functions.
813Each element looks like (REGEXP . FUNCTION).
814Visiting a file whose name matches REGEXP causes FUNCTION to be called.")
815
a0c9f21b
RS
816(defconst inhibit-local-variables-regexps '("\\.tar$")
817 "List of regexps; if one matches a file name, don't look for local vars.")
818
b4da00e9
RM
819(defun set-auto-mode ()
820 "Select major mode appropriate for current buffer.
7b3f3dc2
JB
821This checks for a -*- mode tag in the buffer's text, or
822compares the filename against the entries in auto-mode-alist. It does
823not check for the \"mode:\" local variable in the Local Variables
824section of the file; for that, use `hack-local-variables'.
825
f3e23606 826If `enable-local-variables' is nil, this function does not check for a
7b3f3dc2 827-*- mode tag."
b4da00e9
RM
828 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
829 (let (beg end mode)
830 (save-excursion
831 (goto-char (point-min))
832 (skip-chars-forward " \t\n")
7b3f3dc2 833 (if (and enable-local-variables
a0c9f21b
RS
834 ;; Don't look for -*- if this file name matches any
835 ;; of the regexps in inhibit-local-variables-regexps.
836 (not (let ((temp inhibit-local-variables-regexps))
837 (while (and temp
838 (not (string-match (car temp)
839 buffer-file-name)))
840 (setq temp (cdr temp)))
841 (not temp)))
a292c99f
RM
842 (search-forward "-*-" (save-excursion
843 ;; If the file begins with "#!"
844 ;; (exec interpreter magic), look
845 ;; for mode frobs in the first two
846 ;; lines. You cannot necessarily
847 ;; put them in the first line of
848 ;; such a file without screwing up
849 ;; the interpreter invocation.
850 (end-of-line (and (looking-at "^#!") 2))
851 (point)) t)
b4da00e9
RM
852 (progn
853 (skip-chars-forward " \t")
854 (setq beg (point))
7b3f3dc2
JB
855 (search-forward "-*-"
856 (save-excursion (end-of-line) (point))
857 t))
b4da00e9
RM
858 (progn
859 (forward-char -3)
860 (skip-chars-backward " \t")
861 (setq end (point))
862 (goto-char beg)
863 (if (search-forward ":" end t)
864 (progn
865 (goto-char beg)
866 (if (let ((case-fold-search t))
867 (search-forward "mode:" end t))
868 (progn
869 (skip-chars-forward " \t")
870 (setq beg (point))
871 (if (search-forward ";" end t)
872 (forward-char -1)
873 (goto-char end))
874 (skip-chars-backward " \t")
875 (setq mode (buffer-substring beg (point))))))
876 (setq mode (buffer-substring beg end)))))
877 (setq mode (intern (concat (downcase mode) "-mode")))
dd573bc0
JB
878 (if buffer-file-name
879 (let ((alist auto-mode-alist)
880 (name buffer-file-name))
881 (let ((case-fold-search (eq system-type 'vax-vms)))
882 ;; Remove backup-suffixes from file name.
883 (setq name (file-name-sans-versions name))
884 ;; Find first matching alist entry.
885 (while (and (not mode) alist)
886 (if (string-match (car (car alist)) name)
887 (setq mode (cdr (car alist))))
888 (setq alist (cdr alist))))))))
b4da00e9
RM
889 (if mode (funcall mode))))
890
f3e23606
RS
891(defun hack-local-variables-prop-line ()
892 ;; Set local variables specified in the -*- line.
893 ;; Returns t if mode was set.
894 (save-excursion
895 (goto-char (point-min))
896 (skip-chars-forward " \t\n\r")
897 (let ((result '())
898 (end (save-excursion (end-of-line) (point)))
899 mode-p)
900 ;; Parse the -*- line into the `result' alist.
901 (cond ((not (search-forward "-*-" end t))
902 ;; doesn't have one.
903 nil)
904 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
905 ;; Simple form: "-*- MODENAME -*-".
906 (setq result
907 (list (cons 'mode
908 (intern (buffer-substring
909 (match-beginning 1)
910 (match-end 1)))))))
911 (t
912 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
913 ;; (last ";" is optional).
914 (save-excursion
915 (if (search-forward "-*-" end t)
916 (setq end (- (point) 3))
917 (error "-*- not terminated before end of line")))
918 (while (< (point) end)
919 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
920 (error "malformed -*- line"))
921 (goto-char (match-end 0))
922 (let ((key (intern (downcase (buffer-substring
923 (match-beginning 1)
924 (match-end 1)))))
925 (val (save-restriction
926 (narrow-to-region (point) end)
927 (read (current-buffer)))))
928 (setq result (cons (cons key val) result))
929 (skip-chars-forward " \t;")))
930 (setq result (nreverse result))))
931
932 ;; Mode is magic.
933 (let (mode)
934 (while (setq mode (assq 'mode result))
935 (setq mode-p t result (delq mode result))
936 (funcall (intern (concat (downcase (symbol-name (cdr mode)))
937 "-mode")))))
938
939 (if (and result
940 (or (eq enable-local-variables t)
941 (and enable-local-variables
942 (save-window-excursion
943 (switch-to-buffer (current-buffer))
944 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
945 (file-name-nondirectory buffer-file-name)))))))
946 (while result
947 (let ((key (car (car result)))
948 (val (cdr (car result))))
949 ;; 'mode has already been removed from this list.
950 (hack-one-local-variable key val))
951 (setq result (cdr result))))
952 mode-p)))
953
7b3f3dc2 954(defun hack-local-variables ()
5792c834 955 "Parse and put into effect this buffer's local variables spec."
f3e23606 956 (hack-local-variables-prop-line)
b4da00e9
RM
957 ;; Look for "Local variables:" line in last page.
958 (save-excursion
959 (goto-char (point-max))
960 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
961 (if (let ((case-fold-search t))
962 (and (search-forward "Local Variables:" nil t)
7b3f3dc2 963 (or (eq enable-local-variables t)
b4da00e9
RM
964 (and enable-local-variables
965 (save-window-excursion
966 (switch-to-buffer (current-buffer))
967 (save-excursion
968 (beginning-of-line)
969 (set-window-start (selected-window) (point)))
970 (y-or-n-p (format "Set local variables as specified at end of %s? "
971 (file-name-nondirectory buffer-file-name))))))))
972 (let ((continue t)
2bba782c
RS
973 prefix prefixlen suffix beg
974 (enable-local-eval enable-local-eval))
b4da00e9
RM
975 ;; The prefix is what comes before "local variables:" in its line.
976 ;; The suffix is what comes after "local variables:" in its line.
977 (skip-chars-forward " \t")
978 (or (eolp)
979 (setq suffix (buffer-substring (point)
980 (progn (end-of-line) (point)))))
981 (goto-char (match-beginning 0))
982 (or (bolp)
983 (setq prefix
984 (buffer-substring (point)
985 (progn (beginning-of-line) (point)))))
7b3f3dc2 986
b4da00e9
RM
987 (if prefix (setq prefixlen (length prefix)
988 prefix (regexp-quote prefix)))
989 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
990 (while continue
991 ;; Look at next local variable spec.
992 (if selective-display (re-search-forward "[\n\C-m]")
993 (forward-line 1))
994 ;; Skip the prefix, if any.
995 (if prefix
996 (if (looking-at prefix)
997 (forward-char prefixlen)
998 (error "Local variables entry is missing the prefix")))
999 ;; Find the variable name; strip whitespace.
1000 (skip-chars-forward " \t")
1001 (setq beg (point))
1002 (skip-chars-forward "^:\n")
1003 (if (eolp) (error "Missing colon in local variables entry"))
1004 (skip-chars-backward " \t")
1005 (let* ((str (buffer-substring beg (point)))
1006 (var (read str))
1007 val)
1008 ;; Setting variable named "end" means end of list.
1009 (if (string-equal (downcase str) "end")
1010 (setq continue nil)
1011 ;; Otherwise read the variable value.
1012 (skip-chars-forward "^:")
1013 (forward-char 1)
1014 (setq val (read (current-buffer)))
1015 (skip-chars-backward "\n")
1016 (skip-chars-forward " \t")
1017 (or (if suffix (looking-at suffix) (eolp))
1018 (error "Local variables entry is terminated incorrectly"))
1019 ;; Set the variable. "Variables" mode and eval are funny.
f3e23606
RS
1020 (hack-one-local-variable var val))))))))
1021
1022(defconst ignored-local-variables
1023 '(enable-local-eval)
1024 "Variables to be ignored in a file's local variable spec.")
1025
1026;; "Set" one variable in a local variables spec.
1027;; A few variable names are treated specially.
1028(defun hack-one-local-variable (var val)
1029 (cond ((eq var 'mode)
1030 (funcall (intern (concat (downcase (symbol-name val))
1031 "-mode"))))
1032 ((memq var ignored-local-variables)
1033 nil)
1034 ;; "Setting" eval means either eval it or do nothing.
7d3221d7
RS
1035 ;; Likewise for setting hook variables.
1036 ((or (eq var 'eval)
1037 (string-match "-hooks?$\\|-functions?$" (symbol-name var)))
f3e23606
RS
1038 (if (and (not (string= (user-login-name) "root"))
1039 (or (eq enable-local-eval t)
1040 (and enable-local-eval
1041 (save-window-excursion
1042 (switch-to-buffer (current-buffer))
1043 (save-excursion
1044 (beginning-of-line)
1045 (set-window-start (selected-window) (point)))
1046 (setq enable-local-eval
7d3221d7 1047 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
f3e23606 1048 (file-name-nondirectory buffer-file-name))))))))
7d3221d7
RS
1049 (if (eq var 'eval)
1050 (save-excursion (eval val))
1051 (make-local-variable var)
1052 (set var val))
f3e23606
RS
1053 (message "Ignoring `eval:' in file's local variables")))
1054 ;; Ordinary variable, really set it.
1055 (t (make-local-variable var)
1056 (set var val))))
1057
b4da00e9
RM
1058\f
1059(defun set-visited-file-name (filename)
1060 "Change name of file visited in current buffer to FILENAME.
1061The next time the buffer is saved it will go in the newly specified file.
1062nil or empty string as argument means make buffer not be visiting any file.
1063Remember to delete the initial contents of the minibuffer
1064if you wish to pass an empty string as the argument."
1065 (interactive "FSet visited file name: ")
1066 (if filename
1067 (setq filename
1068 (if (string-equal filename "")
1069 nil
1070 (expand-file-name filename))))
1071 (or (equal filename buffer-file-name)
1072 (null filename)
1073 (progn
1074 (lock-buffer filename)
1075 (unlock-buffer)))
1076 (setq buffer-file-name filename)
1077 (if filename ; make buffer name reflect filename.
5bbbceb1 1078 (let ((new-name (file-name-nondirectory buffer-file-name)))
b4da00e9
RM
1079 (if (string= new-name "")
1080 (error "Empty file name"))
1081 (if (eq system-type 'vax-vms)
1082 (setq new-name (downcase new-name)))
1083 (setq default-directory (file-name-directory buffer-file-name))
5bbbceb1 1084 (rename-buffer new-name t)))
b4da00e9
RM
1085 (setq buffer-backed-up nil)
1086 (clear-visited-file-modtime)
f3e23606
RS
1087 (if filename
1088 (progn
1089 (setq buffer-file-truename
1090 (abbreviate-file-name (file-truename buffer-file-name)))
1091 (if find-file-visit-truename
1092 (setq buffer-file-name buffer-file-truename))
1093 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name))))
1094 (setq buffer-file-truename nil buffer-file-number nil))
b4da00e9
RM
1095 ;; write-file-hooks is normally used for things like ftp-find-file
1096 ;; that visit things that are not local files as if they were files.
1097 ;; Changing to visit an ordinary local file instead should flush the hook.
1098 (kill-local-variable 'write-file-hooks)
c9dca4e0 1099 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
1100 (kill-local-variable 'revert-buffer-function)
1101 (kill-local-variable 'backup-inhibited)
1102 ;; Turn off backup files for certain file names.
1103 ;; Since this is a permanent local, the major mode won't eliminate it.
1104 (and (not (funcall backup-enable-predicate buffer-file-name))
1105 (progn
1106 (make-local-variable 'backup-inhibited)
1107 (setq backup-inhibited t)))
c77a81cf
RS
1108 (let ((oauto buffer-auto-save-file-name))
1109 ;; If auto-save was not already on, turn it on if appropriate.
1110 (if (not buffer-auto-save-file-name)
1111 (and buffer-file-name auto-save-default
1112 (auto-save-mode t))
1113 ;; If auto save is on, start using a new name.
1114 ;; We deliberately don't rename or delete the old auto save
1115 ;; for the old visited file name. This is because perhaps
1116 ;; the user wants to save the new state and then compare with the
1117 ;; previous state from the auto save file.
1118 (setq buffer-auto-save-file-name
1119 (make-auto-save-file-name)))
1120 ;; Rename the old auto save file if any.
1121 (and oauto buffer-auto-save-file-name
e6f0e76c 1122 (file-exists-p oauto)
c77a81cf 1123 (rename-file oauto buffer-auto-save-file-name t)))
b4da00e9
RM
1124 (if buffer-file-name
1125 (set-buffer-modified-p t)))
1126
1127(defun write-file (filename)
1128 "Write current buffer into file FILENAME.
41f48cb1
RS
1129Makes buffer visit that file, and marks it not modified.
1130If the buffer is already visiting a file, you can specify
1131a directory name as FILENAME, to write a file of the same
1132old name in that directory."
b4da00e9
RM
1133;; (interactive "FWrite file: ")
1134 (interactive
1135 (list (if buffer-file-name
1136 (read-file-name "Write file: "
1137 nil nil nil nil)
1138 (read-file-name "Write file: "
1139 (cdr (assq 'default-directory
1140 (buffer-local-variables)))
1141 nil nil (buffer-name)))))
1142 (or (null filename) (string-equal filename "")
41f48cb1
RS
1143 (progn
1144 ;; If arg is just a directory,
1145 ;; use same file name, but in that directory.
1146 (if (and (file-directory-p filename) buffer-file-name)
1147 (setq filename (concat (file-name-as-directory filename)
1148 (file-name-nondirectory buffer-file-name))))
1149 (set-visited-file-name filename)))
b4da00e9
RM
1150 (set-buffer-modified-p t)
1151 (save-buffer))
1152\f
1153(defun backup-buffer ()
1154 "Make a backup of the disk file visited by the current buffer, if appropriate.
1155This is normally done before saving the buffer the first time.
1156If the value is non-nil, it is the result of `file-modes' on the original
1157file; this means that the caller, after saving the buffer, should change
1158the modes of the new file to agree with the old modes."
1159 (if (and make-backup-files (not backup-inhibited)
1160 (not buffer-backed-up)
1161 (file-exists-p buffer-file-name)
1162 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1163 '(?- ?l)))
1164 (let ((real-file-name buffer-file-name)
1165 backup-info backupname targets setmodes)
1166 ;; If specified name is a symbolic link, chase it to the target.
1167 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 1168 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
1169 (setq backup-info (find-backup-file-name real-file-name)
1170 backupname (car backup-info)
1171 targets (cdr backup-info))
1172;;; (if (file-directory-p buffer-file-name)
1173;;; (error "Cannot save buffer in directory %s" buffer-file-name))
1174 (condition-case ()
1175 (let ((delete-old-versions
1176 ;; If have old versions to maybe delete,
1177 ;; ask the user to confirm now, before doing anything.
1178 ;; But don't actually delete til later.
1179 (and targets
6d74b528 1180 (or (eq trim-versions-without-asking t) (eq trim-versions-without-asking nil))
b4da00e9
RM
1181 (or trim-versions-without-asking
1182 (y-or-n-p (format "Delete excess backup versions of %s? "
1183 real-file-name))))))
1184 ;; Actually write the back up file.
1185 (condition-case ()
1186 (if (or file-precious-flag
1187; (file-symlink-p buffer-file-name)
1188 backup-by-copying
1189 (and backup-by-copying-when-linked
1190 (> (file-nlinks real-file-name) 1))
1191 (and backup-by-copying-when-mismatch
1192 (let ((attr (file-attributes real-file-name)))
1193 (or (nth 9 attr)
1194 (/= (nth 2 attr) (user-uid))))))
65864ae0
RS
1195 (condition-case ()
1196 (copy-file real-file-name backupname t t)
1197 (file-error
1198 ;; If copying fails because file BACKUPNAME
1199 ;; is not writable, delete that file and try again.
1200 (if (and (file-exists-p backupname)
1201 (not (file-writable-p backupname)))
1202 (delete-file backupname))
1203 (copy-file real-file-name backupname t t)))
1204 ;; rename-file should delete old backup.
b4da00e9
RM
1205 (rename-file real-file-name backupname t)
1206 (setq setmodes (file-modes backupname)))
1207 (file-error
1208 ;; If trouble writing the backup, write it in ~.
1209 (setq backupname (expand-file-name "~/%backup%~"))
1210 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1211 (sleep-for 1)
65864ae0
RS
1212 (condition-case ()
1213 (copy-file real-file-name backupname t t)
1214 (file-error
1215 ;; If copying fails because file BACKUPNAME
1216 ;; is not writable, delete that file and try again.
1217 (if (and (file-exists-p backupname)
1218 (not (file-writable-p backupname)))
1219 (delete-file backupname))
1220 (copy-file real-file-name backupname t t)))))
b4da00e9
RM
1221 (setq buffer-backed-up t)
1222 ;; Now delete the old versions, if desired.
1223 (if delete-old-versions
1224 (while targets
1225 (condition-case ()
1226 (delete-file (car targets))
1227 (file-error nil))
1228 (setq targets (cdr targets))))
1229 setmodes)
1230 (file-error nil)))))
1231
c3554e95 1232(defun file-name-sans-versions (name &optional keep-backup-version)
b4da00e9
RM
1233 "Return FILENAME sans backup versions or strings.
1234This is a separate procedure so your site-init or startup file can
c3554e95
RS
1235redefine it.
1236If the optional argument KEEP-BACKUP-VERSION is non-nil,
1237we do not remove backup version numbers, only true file version numbers."
5dbfdacd 1238 (let ((handler (find-file-name-handler name)))
c3554e95
RS
1239 (if handler
1240 (funcall handler 'file-name-sans-versions name keep-backup-version)
1241 (substring name 0
1242 (if (eq system-type 'vax-vms)
1243 ;; VMS version number is (a) semicolon, optional
1244 ;; sign, zero or more digits or (b) period, option
1245 ;; sign, zero or more digits, provided this is the
1246 ;; second period encountered outside of the
1247 ;; device/directory part of the file name.
1248 (or (string-match ";[---+]?[0-9]*\\'" name)
1249 (if (string-match "\\.[^]>:]*\\(\\.[---+]?[0-9]*\\)\\'"
1250 name)
1251 (match-beginning 1))
1252 (length name))
1253 (if keep-backup-version
1254 (length name)
1255 (or (string-match "\\.~[0-9]+~\\'" name)
1256 (string-match "~\\'" name)
1257 (length name))))))))
b4da00e9
RM
1258
1259(defun make-backup-file-name (file)
1260 "Create the non-numeric backup file name for FILE.
1261This is a separate function so you can redefine it for customization."
1262 (concat file "~"))
1263
1264(defun backup-file-name-p (file)
1265 "Return non-nil if FILE is a backup file name (numeric or not).
1266This is a separate function so you can redefine it for customization.
1267You may need to redefine `file-name-sans-versions' as well."
1268 (string-match "~$" file))
1269
2d051399
RS
1270;; This is used in various files.
1271;; The usage of bv-length is not very clean,
1272;; but I can't see a good alternative,
1273;; so as of now I am leaving it alone.
1274(defun backup-extract-version (fn)
1275 "Given the name of a numeric backup file, return the backup number.
1276Uses the free variable `bv-length', whose value should be
1277the index in the name where the version number begins."
1278 (if (and (string-match "[0-9]+~$" fn bv-length)
1279 (= (match-beginning 0) bv-length))
1280 (string-to-int (substring fn bv-length -1))
1281 0))
1282
b4da00e9
RM
1283;; I believe there is no need to alter this behavior for VMS;
1284;; since backup files are not made on VMS, it should not get called.
1285(defun find-backup-file-name (fn)
1286 "Find a file name for a backup file, and suggestions for deletions.
1287Value is a list whose car is the name for the backup file
1288 and whose cdr is a list of old versions to consider deleting now."
1289 (if (eq version-control 'never)
1290 (list (make-backup-file-name fn))
1291 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1292 (bv-length (length base-versions))
1293 (possibilities (file-name-all-completions
1294 base-versions
1295 (file-name-directory fn)))
79058860 1296 (versions (sort (mapcar
2d051399 1297 (function backup-extract-version)
79058860 1298 possibilities)
b4da00e9 1299 '<))
5bbbceb1 1300 (high-water-mark (apply 'max 0 versions))
b4da00e9
RM
1301 (deserve-versions-p
1302 (or version-control
1303 (> high-water-mark 0)))
1304 (number-to-delete (- (length versions)
1305 kept-old-versions kept-new-versions -1)))
1306 (if (not deserve-versions-p)
1307 (list (make-backup-file-name fn))
1308 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
9115e938
NF
1309 (if (and (> number-to-delete 0)
1310 ;; Delete nothing if there is overflow
1311 ;; in the number of versions to keep.
1312 (>= (+ kept-new-versions kept-old-versions -1) 0))
b4da00e9
RM
1313 (mapcar (function (lambda (n)
1314 (concat fn ".~" (int-to-string n) "~")))
1315 (let ((v (nthcdr kept-old-versions versions)))
1316 (rplacd (nthcdr (1- number-to-delete) v) ())
1317 v))))))))
1318
b4da00e9
RM
1319(defun file-nlinks (filename)
1320 "Return number of names file FILENAME has."
1321 (car (cdr (file-attributes filename))))
6c636af9 1322
46fa3073
RS
1323(defun file-relative-name-1 (directory)
1324 (cond ((string= directory "/")
1325 filename)
1326 ((string-match (concat "^" (regexp-quote directory))
1327 filename)
1328 (substring filename (match-end 0)))
1329 (t
1330 (file-relative-name-1
1331 (file-name-directory (substring directory 0 -1))))))
1332
6c636af9
RM
1333(defun file-relative-name (filename &optional directory)
1334 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1335 (setq filename (expand-file-name filename)
77fb6aed
RS
1336 directory (file-name-as-directory (expand-file-name
1337 (or directory default-directory))))
46fa3073 1338 (file-relative-name-1 directory))
b4da00e9
RM
1339\f
1340(defun save-buffer (&optional args)
1341 "Save current buffer in visited file if modified. Versions described below.
1342By default, makes the previous version into a backup file
1343 if previously requested or if this is the first save.
1344With 1 or 3 \\[universal-argument]'s, marks this version
1345 to become a backup when the next save is done.
1346With 2 or 3 \\[universal-argument]'s,
1347 unconditionally makes the previous version into a backup file.
1348With argument of 0, never makes the previous version into a backup file.
1349
1350If a file's name is FOO, the names of its numbered backup versions are
1351 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1352Numeric backups (rather than FOO~) will be made if value of
1353 `version-control' is not the atom `never' and either there are already
1354 numeric versions of the file being backed up, or `version-control' is
1355 non-nil.
1356We don't want excessive versions piling up, so there are variables
1357 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1358 and `kept-new-versions', which tells how many newest versions to keep.
1359 Defaults are 2 old versions and 2 new.
1360`dired-kept-versions' controls dired's clean-directory (.) command.
1361If `trim-versions-without-asking' is nil, system will query user
1362 before trimming versions. Otherwise it does it silently."
1363 (interactive "p")
1364 (let ((modp (buffer-modified-p))
1365 (large (> (buffer-size) 50000))
1366 (make-backup-files (and make-backup-files (not (eq args 0)))))
1367 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1368 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1369 (basic-save-buffer)
1370 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1371
1372(defun delete-auto-save-file-if-necessary (&optional force)
1373 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1374Normally delete only if the file was written by this Emacs since
1375the last real save, but optional arg FORCE non-nil means delete anyway."
1376 (and buffer-auto-save-file-name delete-auto-save-files
1377 (not (string= buffer-file-name buffer-auto-save-file-name))
1378 (or force (recent-auto-save-p))
1379 (progn
1380 (condition-case ()
1381 (delete-file buffer-auto-save-file-name)
1382 (file-error nil))
1383 (set-buffer-auto-saved))))
1384
1385(defun basic-save-buffer ()
1386 "Save the current buffer in its visited file, if it has been modified."
1387 (interactive)
1388 (if (buffer-modified-p)
1389 (let ((recent-save (recent-auto-save-p))
1390 setmodes tempsetmodes)
1391 ;; On VMS, rename file and buffer to get rid of version number.
1392 (if (and (eq system-type 'vax-vms)
1393 (not (string= buffer-file-name
1394 (file-name-sans-versions buffer-file-name))))
1395 (let (buffer-new-name)
1396 ;; Strip VMS version number before save.
1397 (setq buffer-file-name
1398 (file-name-sans-versions buffer-file-name))
1399 ;; Construct a (unique) buffer name to correspond.
1400 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1401 (setq buffer-new-name (buffer-name buf))
1402 (kill-buffer buf))
1403 (rename-buffer buffer-new-name)))
1404 ;; If buffer has no file name, ask user for one.
1405 (or buffer-file-name
1406 (progn
1407 (setq buffer-file-name
1408 (expand-file-name (read-file-name "File to save in: ") nil)
1409 default-directory (file-name-directory buffer-file-name))
fec33c0b
RS
1410 (and auto-save-default (not buffer-auto-save-file-name)
1411 (auto-save-mode t))))
b4da00e9
RM
1412 (or (verify-visited-file-modtime (current-buffer))
1413 (not (file-exists-p buffer-file-name))
1414 (yes-or-no-p
1415 (format "%s has changed since visited or saved. Save anyway? "
1416 (file-name-nondirectory buffer-file-name)))
1417 (error "Save not confirmed"))
1418 (save-restriction
1419 (widen)
1420 (and (> (point-max) 1)
1421 (/= (char-after (1- (point-max))) ?\n)
1422 (or (eq require-final-newline t)
1423 (and require-final-newline
1424 (y-or-n-p
1425 (format "Buffer %s does not end in newline. Add one? "
1426 (buffer-name)))))
1427 (save-excursion
1428 (goto-char (point-max))
1429 (insert ?\n)))
c9dca4e0
RS
1430 (let ((hooks (append write-contents-hooks local-write-file-hooks
1431 write-file-hooks))
b4da00e9
RM
1432 (done nil))
1433 (while (and hooks
1434 (not (setq done (funcall (car hooks)))))
1435 (setq hooks (cdr hooks)))
1436 ;; If a hook returned t, file is already "written".
1437 (cond ((not done)
1438 (if (not (file-writable-p buffer-file-name))
1439 (let ((dir (file-name-directory buffer-file-name)))
1440 (if (not (file-directory-p dir))
1441 (error "%s is not a directory" dir)
1442 (if (not (file-exists-p buffer-file-name))
1443 (error "Directory %s write-protected" dir)
1444 (if (yes-or-no-p
1445 (format "File %s is write-protected; try to save anyway? "
1446 (file-name-nondirectory
1447 buffer-file-name)))
1448 (setq tempsetmodes t)
1449 (error "Attempt to save to a file which you aren't allowed to write"))))))
1450 (or buffer-backed-up
1451 (setq setmodes (backup-buffer)))
1452 (if file-precious-flag
f3e23606
RS
1453 ;; If file is precious, write temp name, then rename it.
1454 (let ((dir (file-name-directory buffer-file-name))
1455 (realname buffer-file-name)
1456 tempname temp nogood i succeed)
1457 (setq i 0)
1458 (setq nogood t)
1459 ;; Find the temporary name to write under.
1460 (while nogood
1461 (setq tempname (format "%s#tmp#%d" dir i))
1462 (setq nogood (file-exists-p tempname))
1463 (setq i (1+ i)))
b4da00e9
RM
1464 (unwind-protect
1465 (progn (clear-visited-file-modtime)
1466 (write-region (point-min) (point-max)
f3e23606
RS
1467 tempname nil realname)
1468 (setq succeed t))
1469 ;; If writing the temp file fails,
1470 ;; delete the temp file.
1471 (or succeed (delete-file tempname)))
b411d947
JB
1472 ;; Since we have created an entirely new file
1473 ;; and renamed it, make sure it gets the
1474 ;; right permission bits set.
1475 (setq setmodes (file-modes buffer-file-name))
f3e23606
RS
1476 ;; We succeeded in writing the temp file,
1477 ;; so rename it.
1478 (rename-file tempname buffer-file-name t))
b4da00e9
RM
1479 ;; If file not writable, see if we can make it writable
1480 ;; temporarily while we write it.
1481 ;; But no need to do so if we have just backed it up
1482 ;; (setmodes is set) because that says we're superseding.
1483 (cond ((and tempsetmodes (not setmodes))
1484 ;; Change the mode back, after writing.
1485 (setq setmodes (file-modes buffer-file-name))
1486 (set-file-modes buffer-file-name 511)))
1487 (write-region (point-min) (point-max)
1488 buffer-file-name nil t)))))
f3e23606 1489 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
b4da00e9
RM
1490 (if setmodes
1491 (condition-case ()
f3e23606 1492 (set-file-modes buffer-file-name setmodes)
b4da00e9
RM
1493 (error nil))))
1494 ;; If the auto-save file was recent before this command,
1495 ;; delete it now.
1496 (delete-auto-save-file-if-necessary recent-save)
1bf3d475 1497 (run-hooks 'after-save-hook))
b4da00e9
RM
1498 (message "(No changes need to be saved)")))
1499
b4da00e9
RM
1500(defun save-some-buffers (&optional arg exiting)
1501 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
1502Optional argument (the prefix) non-nil means save all with no questions.
1503Optional second argument EXITING means ask about certain non-file buffers
1504 as well as about file buffers."
b4da00e9 1505 (interactive "P")
907482b9 1506 (save-window-excursion
b5e86cb3
RM
1507 (if (zerop (map-y-or-n-p
1508 (function
1509 (lambda (buffer)
1510 (and (buffer-modified-p buffer)
1511 (or
1512 (buffer-file-name buffer)
1513 (and exiting
1514 (progn
1515 (set-buffer buffer)
1516 (and buffer-offer-save (> (buffer-size) 0)))))
1517 (if arg
1518 t
1519 (if (buffer-file-name buffer)
1520 (format "Save file %s? "
1521 (buffer-file-name buffer))
1522 (format "Save buffer %s? "
1523 (buffer-name buffer)))))))
1524 (function
1525 (lambda (buffer)
e065a56e
JB
1526 (set-buffer buffer)
1527 (save-buffer)))
b5e86cb3 1528 (buffer-list)
907482b9 1529 '("buffer" "buffers" "save")
df01170b
RS
1530 (list (list ?\C-r (lambda (buf)
1531 (view-buffer buf)
1586b965
RS
1532 (setq view-exit-action
1533 '(lambda (ignore)
1534 (exit-recursive-edit)))
df01170b
RS
1535 (recursive-edit)
1536 ;; Return nil to ask about BUF again.
1537 nil)
907482b9
RM
1538 "display the current buffer"))
1539 ))
b5e86cb3 1540 (message "(No files need saving)"))))
b4da00e9
RM
1541\f
1542(defun not-modified (&optional arg)
1543 "Mark current buffer as unmodified, not needing to be saved.
1544With prefix arg, mark buffer as modified, so \\[save-buffer] will save."
1545 (interactive "P")
1546 (message (if arg "Modification-flag set"
1547 "Modification-flag cleared"))
1548 (set-buffer-modified-p arg))
1549
1550(defun toggle-read-only (&optional arg)
1551 "Change whether this buffer is visiting its file read-only.
1552With arg, set read-only iff arg is positive."
1553 (interactive "P")
1554 (setq buffer-read-only
1555 (if (null arg)
1556 (not buffer-read-only)
1557 (> (prefix-numeric-value arg) 0)))
1558 ;; Force mode-line redisplay
1559 (set-buffer-modified-p (buffer-modified-p)))
1560
1561(defun insert-file (filename)
1562 "Insert contents of file FILENAME into buffer after point.
1563Set mark after the inserted text.
1564
1565This function is meant for the user to run interactively.
1566Don't call it from programs! Use `insert-file-contents' instead.
1567\(Its calling sequence is different; see its documentation)."
1568 (interactive "fInsert file: ")
3be6243a
RS
1569 (if (file-directory-p filename)
1570 (signal 'file-error (list "Opening input file" "file is a directory"
1571 filename)))
b4da00e9
RM
1572 (let ((tem (insert-file-contents filename)))
1573 (push-mark (+ (point) (car (cdr tem))))))
1574
1575(defun append-to-file (start end filename)
1576 "Append the contents of the region to the end of file FILENAME.
1577When called from a function, expects three arguments,
1578START, END and FILENAME. START and END are buffer positions
1579saying what text to write."
1580 (interactive "r\nFAppend to file: ")
1581 (write-region start end filename t))
1582
1583(defun file-newest-backup (filename)
1584 "Return most recent backup file for FILENAME or nil if no backups exist."
1585 (let* ((filename (expand-file-name filename))
1586 (file (file-name-nondirectory filename))
1587 (dir (file-name-directory filename))
1588 (comp (file-name-all-completions file dir))
1589 newest)
1590 (while comp
1591 (setq file (concat dir (car comp))
1592 comp (cdr comp))
1593 (if (and (backup-file-name-p file)
1594 (or (null newest) (file-newer-than-file-p file newest)))
1595 (setq newest file)))
1596 newest))
1597
1598(defun rename-uniquely ()
1599 "Rename current buffer to a similar name not already taken.
1600This function is useful for creating multiple shell process buffers
1601or multiple mail buffers, etc."
1602 (interactive)
1603 (let* ((new-buf (generate-new-buffer (buffer-name)))
1604 (name (buffer-name new-buf)))
1605 (kill-buffer new-buf)
1606 (rename-buffer name)
1607 (set-buffer-modified-p (buffer-modified-p)))) ; force mode line update
5bbbceb1 1608
4e43240a 1609(defun make-directory (dir &optional parents)
5ce8bb89
RS
1610 "Create the directory DIR and any nonexistent parent dirs.
1611Interactively, the default choice of directory to create
1612is the current default directory for file names.
1613That is useful when you have visited a file in a nonexistint directory.
1614
1615Noninteractively, the second (optional) argument PARENTS says whether
1616to create parent directories if they don't exist."
1617 (interactive
1618 (list (read-file-name "Make directory: " default-directory default-directory
1619 nil nil)
1620 t))
5dbfdacd 1621 (let ((handler (find-file-name-handler dir)))
4e43240a
RS
1622 (if handler
1623 (funcall handler 'make-directory dir parents)
1624 (if (not parents)
1625 (make-directory-internal dir)
1626 (let ((dir (directory-file-name (expand-file-name dir)))
1627 create-list)
1628 (while (not (file-exists-p dir))
1629 (setq create-list (cons dir create-list)
1630 dir (directory-file-name (file-name-directory dir))))
1631 (while create-list
1632 (make-directory-internal (car create-list))
1633 (setq create-list (cdr create-list))))))))
b4da00e9
RM
1634\f
1635(put 'revert-buffer-function 'permanent-local t)
1636(defvar revert-buffer-function nil
1637 "Function to use to revert this buffer, or nil to do the default.")
1638
1639(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1640(defvar revert-buffer-insert-file-contents-function nil
1641 "Function to use to insert contents when reverting this buffer.
1642Gets two args, first the nominal file name to use,
1643and second, t if reading the auto-save file.")
1644
1ab31687 1645(defun revert-buffer (&optional ignore-auto noconfirm)
b4da00e9
RM
1646 "Replace the buffer text with the text of the visited file on disk.
1647This undoes all changes since the file was visited or saved.
8c0e7b73
JB
1648With a prefix argument, offer to revert from latest auto-save file, if
1649that is more recent than the visited file.
1ab31687
JB
1650
1651When called from lisp, the first argument is IGNORE-AUTO; only offer
1652to revert from the auto-save file when this is nil. Note that the
1653sense of this argument is the reverse of the prefix argument, for the
1654sake of backward compatibility. IGNORE-AUTO is optional, defaulting
1655to nil.
1656
1657Optional second argument NOCONFIRM means don't ask for confirmation at
1658all.
b4da00e9 1659
8c0e7b73
JB
1660If the value of `revert-buffer-function' is non-nil, it is called to
1661do the work."
1ab31687
JB
1662 ;; I admit it's odd to reverse the sense of the prefix argument, but
1663 ;; there is a lot of code out there which assumes that the first
1664 ;; argument should be t to avoid consulting the auto-save file, and
1665 ;; there's no straightforward way to encourage authors to notice a
1666 ;; reversal of the argument sense. So I'm just changing the user
1667 ;; interface, but leaving the programmatic interface the same.
1668 (interactive (list (not prefix-arg)))
b4da00e9 1669 (if revert-buffer-function
1ab31687 1670 (funcall revert-buffer-function ignore-auto noconfirm)
b4da00e9 1671 (let* ((opoint (point))
1ab31687
JB
1672 (auto-save-p (and (not ignore-auto)
1673 (recent-auto-save-p)
b4da00e9
RM
1674 buffer-auto-save-file-name
1675 (file-readable-p buffer-auto-save-file-name)
1676 (y-or-n-p
1677 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
1678 (file-name (if auto-save-p
1679 buffer-auto-save-file-name
1680 buffer-file-name)))
1681 (cond ((null file-name)
1682 (error "Buffer does not seem to be associated with any file"))
1683 ((or noconfirm
1684 (yes-or-no-p (format "Revert buffer from file %s? "
1685 file-name)))
1686 ;; If file was backed up but has changed since,
1687 ;; we shd make another backup.
1688 (and (not auto-save-p)
5bbbceb1 1689 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
1690 (setq buffer-backed-up nil))
1691 ;; Get rid of all undo records for this buffer.
1692 (or (eq buffer-undo-list t)
1693 (setq buffer-undo-list nil))
1694 (let ((buffer-read-only nil)
1695 ;; Don't make undo records for the reversion.
1696 (buffer-undo-list t))
1697 (if revert-buffer-insert-file-contents-function
1698 (funcall revert-buffer-insert-file-contents-function
1699 file-name auto-save-p)
1700 (if (not (file-exists-p file-name))
1701 (error "File %s no longer exists!" file-name))
1702 ;; Bind buffer-file-name to nil
1703 ;; so that we don't try to lock the file.
1704 (let ((buffer-file-name nil))
1705 (or auto-save-p
1706 (unlock-buffer))
1707 (erase-buffer))
1708 (insert-file-contents file-name (not auto-save-p))))
1709 (goto-char (min opoint (point-max)))
8cfb9d46 1710 (after-find-file nil nil t)
b4da00e9
RM
1711 t)))))
1712
1713(defun recover-file (file)
1714 "Visit file FILE, but get contents from its last auto-save file."
1715 (interactive
1716 (let ((prompt-file buffer-file-name)
1717 (file-name nil)
1718 (file-dir nil))
1719 (and prompt-file
1720 (setq file-name (file-name-nondirectory prompt-file)
1721 file-dir (file-name-directory prompt-file)))
1722 (list (read-file-name "Recover file: "
1723 file-dir nil nil file-name))))
1724 (setq file (expand-file-name file))
1725 (if (auto-save-file-name-p file) (error "%s is an auto-save file" file))
1726 (let ((file-name (let ((buffer-file-name file))
1727 (make-auto-save-file-name))))
1728 (cond ((not (file-newer-than-file-p file-name file))
1729 (error "Auto-save file %s not current" file-name))
1730 ((save-window-excursion
1731 (if (not (eq system-type 'vax-vms))
1732 (with-output-to-temp-buffer "*Directory*"
1733 (buffer-disable-undo standard-output)
1734 (call-process "ls" nil standard-output nil
2dc2b736
RS
1735 (if (file-symlink-p file) "-lL" "-l")
1736 file file-name)))
b4da00e9
RM
1737 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
1738 (switch-to-buffer (find-file-noselect file t))
1739 (let ((buffer-read-only nil))
1740 (erase-buffer)
1741 (insert-file-contents file-name nil))
8cfb9d46 1742 (after-find-file nil nil t))
b4da00e9
RM
1743 (t (error "Recover-file cancelled.")))))
1744
1745(defun kill-some-buffers ()
1746 "For each buffer, ask whether to kill it."
1747 (interactive)
1748 (let ((list (buffer-list)))
1749 (while list
1750 (let* ((buffer (car list))
1751 (name (buffer-name buffer)))
1752 (and (not (string-equal name ""))
1753 (/= (aref name 0) ? )
1754 (yes-or-no-p
1755 (format "Buffer %s %s. Kill? "
1756 name
1757 (if (buffer-modified-p buffer)
1758 "HAS BEEN EDITED" "is unmodified")))
1759 (kill-buffer buffer)))
1760 (setq list (cdr list)))))
1761\f
1762(defun auto-save-mode (arg)
1763 "Toggle auto-saving of contents of current buffer.
f3e23606 1764With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
1765 (interactive "P")
1766 (setq buffer-auto-save-file-name
1767 (and (if (null arg)
1768 (not buffer-auto-save-file-name)
1769 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
1770 (if (and buffer-file-name auto-save-visited-file-name
1771 (not buffer-read-only))
1772 buffer-file-name
1773 (make-auto-save-file-name))))
1774 (if (interactive-p)
1775 (message "Auto-save %s (in this buffer)"
1776 (if buffer-auto-save-file-name "on" "off")))
1777 buffer-auto-save-file-name)
1778
1779(defun rename-auto-save-file ()
1780 "Adjust current buffer's auto save file name for current conditions.
1781Also rename any existing auto save file, if it was made in this session."
1782 (let ((osave buffer-auto-save-file-name))
1783 (setq buffer-auto-save-file-name
1784 (make-auto-save-file-name))
1785 (if (and osave buffer-auto-save-file-name
1786 (not (string= buffer-auto-save-file-name buffer-file-name))
1787 (not (string= buffer-auto-save-file-name osave))
1788 (file-exists-p osave)
1789 (recent-auto-save-p))
1790 (rename-file osave buffer-auto-save-file-name t))))
1791
1792(defun make-auto-save-file-name ()
1793 "Return file name to use for auto-saves of current buffer.
1794Does not consider `auto-save-visited-file-name' as that variable is checked
1795before calling this function. You can redefine this for customization.
1796See also `auto-save-file-name-p'."
1797 (if buffer-file-name
1798 (concat (file-name-directory buffer-file-name)
1799 "#"
1800 (file-name-nondirectory buffer-file-name)
1801 "#")
1802 ;; For non-file bfr, use bfr name and Emacs pid.
1803 (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))))
1804
1805(defun auto-save-file-name-p (filename)
1806 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
1807FILENAME should lack slashes. You can redefine this for customization."
1808 (string-match "^#.*#$" filename))
1809\f
1810(defconst list-directory-brief-switches
1811 (if (eq system-type 'vax-vms) "" "-CF")
1812 "*Switches for list-directory to pass to `ls' for brief listing,")
1813
1814(defconst list-directory-verbose-switches
1815 (if (eq system-type 'vax-vms)
1816 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
1817 "-l")
1818 "*Switches for list-directory to pass to `ls' for verbose listing,")
1819
1820(defun list-directory (dirname &optional verbose)
1821 "Display a list of files in or matching DIRNAME, a la `ls'.
1822DIRNAME is globbed by the shell if necessary.
1823Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
1824Actions controlled by variables `list-directory-brief-switches'
1825and `list-directory-verbose-switches'."
1826 (interactive (let ((pfx current-prefix-arg))
1827 (list (read-file-name (if pfx "List directory (verbose): "
1828 "List directory (brief): ")
1829 nil default-directory nil)
1830 pfx)))
1831 (let ((switches (if verbose list-directory-verbose-switches
1832 list-directory-brief-switches)))
1833 (or dirname (setq dirname default-directory))
1834 (setq dirname (expand-file-name dirname))
1835 (with-output-to-temp-buffer "*Directory*"
1836 (buffer-disable-undo standard-output)
1837 (princ "Directory ")
1838 (princ dirname)
1839 (terpri)
c3554e95
RS
1840 (save-excursion
1841 (set-buffer "*Directory*")
1842 (let ((wildcard (not (file-directory-p dirname))))
1843 (insert-directory dirname switches wildcard (not wildcard)))))))
1844
1845(defvar insert-directory-program "ls"
1846 "Absolute or relative name of the `ls' program used by `insert-directory'.")
1847
1848;; insert-directory
1849;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
1850;; FULL-DIRECTORY-P is nil.
1851;; The single line of output must display FILE's name as it was
1852;; given, namely, an absolute path name.
1853;; - must insert exactly one line for each file if WILDCARD or
1854;; FULL-DIRECTORY-P is t, plus one optional "total" line
1855;; before the file lines, plus optional text after the file lines.
1856;; Lines are delimited by "\n", so filenames containing "\n" are not
1857;; allowed.
1858;; File lines should display the basename.
1859;; - must be consistent with
1860;; - functions dired-move-to-filename, (these two define what a file line is)
1861;; dired-move-to-end-of-filename,
1862;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
1863;; dired-insert-headerline
1864;; dired-after-subdir-garbage (defines what a "total" line is)
1865;; - variable dired-subdir-regexp
1866(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 1867 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95
RS
1868Leaves point after the inserted text.
1869Optional third arg WILDCARD means treat FILE as shell wildcard.
1870Optional fourth arg FULL-DIRECTORY-P means file is a directory and
1871switches do not contain `d', so that a full listing is expected.
1872
1873This works by running a directory listing program
406e12d9 1874whose name is in the variable `insert-directory-program'.
c3554e95 1875If WILDCARD, it also runs the shell specified by `shell-file-name'."
5dbfdacd 1876 (let ((handler (find-file-name-handler file)))
c3554e95
RS
1877 (if handler
1878 (funcall handler 'insert-directory file switches
1879 wildcard full-directory-p)
b4da00e9 1880 (if (eq system-type 'vax-vms)
c3554e95
RS
1881 (vms-read-directory file switches (current-buffer))
1882 (if wildcard
1883 (let ((default-directory (file-name-directory file)))
1884 (call-process shell-file-name nil t nil
1885 "-c" (concat insert-directory-program
1886 " -d " switches " "
1887 (file-name-nondirectory file))))
a18b7c81
JB
1888 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
1889 ;; directory if FILE is a symbolic link.
1890 (call-process insert-directory-program nil t nil switches
1891 (if full-directory-p
1892 (concat (file-name-as-directory file) ".")
1893 file)))))))
b4da00e9
RM
1894
1895(defun save-buffers-kill-emacs (&optional arg)
1896 "Offer to save each buffer, then kill this Emacs process.
1897With prefix arg, silently save all file-visiting buffers, then kill."
1898 (interactive "P")
1899 (save-some-buffers arg t)
1900 (and (or (not (memq t (mapcar (function
1901 (lambda (buf) (and (buffer-file-name buf)
1902 (buffer-modified-p buf))))
1903 (buffer-list))))
1904 (yes-or-no-p "Modified buffers exist; exit anyway? "))
1905 (or (not (fboundp 'process-list))
1906 ;; process-list is not defined on VMS.
1907 (let ((processes (process-list))
1908 active)
1909 (while processes
528415e7 1910 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
1911 (let ((val (process-kill-without-query (car processes))))
1912 (process-kill-without-query (car processes) val)
1913 val)
1914 (setq active t))
1915 (setq processes (cdr processes)))
1916 (or (not active)
1917 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
1918 (kill-emacs)))
1919\f
1920(define-key ctl-x-map "\C-f" 'find-file)
1921(define-key ctl-x-map "\C-q" 'toggle-read-only)
1922(define-key ctl-x-map "\C-r" 'find-file-read-only)
1923(define-key ctl-x-map "\C-v" 'find-alternate-file)
1924(define-key ctl-x-map "\C-s" 'save-buffer)
1925(define-key ctl-x-map "s" 'save-some-buffers)
1926(define-key ctl-x-map "\C-w" 'write-file)
1927(define-key ctl-x-map "i" 'insert-file)
1928(define-key esc-map "~" 'not-modified)
1929(define-key ctl-x-map "\C-d" 'list-directory)
1930(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
1931
1932(define-key ctl-x-4-map "f" 'find-file-other-window)
1933(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
1934(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
1935(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 1936(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 1937
f98955ea
JB
1938(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
1939(define-key ctl-x-5-map "f" 'find-file-other-frame)
1940(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
1941(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
1942
1943;;; files.el ends here