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