Fix typo in previous change.
[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
f862241d 63`backup-by-copying-when-mismatch'. See also `backup-inhibited'.")
b4da00e9
RM
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
f862241d
RS
68 "Non-nil means don't make a backup, regardless of the other parameters.
69This variable is intended for use by making it local to a buffer.
70But it is local only if you make it local.")
b4da00e9
RM
71(put 'backup-inhibited 'permanent-local t)
72
73(defconst backup-by-copying nil
74 "*Non-nil means always use copying to create backup files.
75See documentation of variable `make-backup-files'.")
76
77(defconst backup-by-copying-when-linked nil
78 "*Non-nil means use copying to create backups for files with multiple names.
79This causes the alternate names to refer to the latest version as edited.
80This variable is relevant only if `backup-by-copying' is nil.")
81
82(defconst backup-by-copying-when-mismatch nil
83 "*Non-nil means create backups by copying if this preserves owner or group.
84Renaming may still be used (subject to control of other variables)
85when it would not result in changing the owner or group of the file;
86that is, for files which are owned by you and whose group matches
87the default for a new file created there by you.
88This variable is relevant only if `backup-by-copying' is nil.")
89
90(defvar backup-enable-predicate
91 '(lambda (name)
92 (or (< (length name) 5)
93 (not (string-equal "/tmp/" (substring name 0 5)))))
94 "Predicate that looks at a file name and decides whether to make backups.
95Called with an absolute file name as argument, it returns t to enable backup.")
96
97(defconst buffer-offer-save nil
98 "*Non-nil in a buffer means offer to save the buffer on exit
99even if the buffer is not visiting a file.
100Automatically local in all buffers.")
101(make-variable-buffer-local 'buffer-offer-save)
102
f3e23606
RS
103(defconst find-file-existing-other-name nil
104 "*Non-nil means find a file under alternative names, in existing buffers.
105This means if any existing buffer is visiting the file you want
106under another name, you get the existing buffer instead of a new buffer.")
107
108(defconst find-file-visit-truename nil
109 "*Non-nil means visit a file under its truename.
110The truename of a file is found by chasing all links
111both at the file level and at the levels of the containing directories.")
112
113(defvar buffer-file-truename nil
114 "The truename of the file visited in the current buffer.
115This variable is automatically local in all buffers, when non-nil.")
116(make-variable-buffer-local 'buffer-file-truename)
117(put 'buffer-file-truename 'permanent-local t)
118
119(defvar buffer-file-number nil
120 "The device number and file number of the file visited in the current buffer.
121The value is a list of the form (FILENUM DEVNUM).
122This pair of numbers uniquely identifies the file.
123If the buffer is visiting a new file, the value is nil.")
124(make-variable-buffer-local 'buffer-file-number)
125(put 'buffer-file-number 'permanent-local t)
126
b4da00e9
RM
127(defconst file-precious-flag nil
128 "*Non-nil means protect against I/O errors while saving files.
129Some modes set this non-nil in particular buffers.")
130
131(defvar version-control nil
132 "*Control use of version numbers for backup files.
133t means make numeric backup versions unconditionally.
134nil means make them for files that have some already.
135never means do not make them.")
136
137(defvar dired-kept-versions 2
138 "*When cleaning directory, number of versions to keep.")
139
140(defvar trim-versions-without-asking nil
6d74b528
ER
141 "*If t, deletes excess backup versions silently.
142If nil, asks confirmation. Any other value prevents any trimming.")
b4da00e9
RM
143
144(defvar kept-old-versions 2
145 "*Number of oldest versions to keep when a new numbered backup is made.")
146
147(defvar kept-new-versions 2
148 "*Number of newest versions to keep when a new numbered backup is made.
149Includes the new backup. Must be > 0")
150
151(defconst require-final-newline nil
152 "*Value of t says silently ensure a file ends in a newline when it is saved.
153Non-nil but not t says ask user whether to add a newline when there isn't one.
154nil means don't add newlines.")
155
156(defconst auto-save-default t
157 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
158
159(defconst auto-save-visited-file-name nil
160 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
161Normally auto-save files are written under other names.")
162
163(defconst save-abbrevs nil
164 "*Non-nil means save word abbrevs too when files are saved.
165Loading an abbrev file sets this to t.")
166
167(defconst find-file-run-dired t
320b4233 168 "*Non-nil says run dired if `find-file' is given the name of a directory.")
b4da00e9 169
92966e6f
RS
170;;;It is not useful to make this a local variable.
171;;;(put 'find-file-not-found-hooks 'permanent-local t)
b4da00e9
RM
172(defvar find-file-not-found-hooks nil
173 "List of functions to be called for `find-file' on nonexistent file.
174These functions are called as soon as the error is detected.
175`buffer-file-name' is already set up.
176The functions are called in the order given until one of them returns non-nil.")
177
92966e6f
RS
178;;;It is not useful to make this a local variable.
179;;;(put 'find-file-hooks 'permanent-local t)
b4da00e9
RM
180(defvar find-file-hooks nil
181 "List of functions to be called after a buffer is loaded from a file.
182The buffer's local variables (if any) will have been processed before the
183functions are called.")
184
c9dca4e0 185;;; In case someone does make it local.
b4da00e9
RM
186(put 'write-file-hooks 'permanent-local t)
187(defvar write-file-hooks nil
188 "List of functions to be called before writing out a buffer to a file.
189If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
190and the rest are not called.
191These hooks are considered to pertain to the visited file.
192So this list is cleared if you change the visited file name.
c9dca4e0
RS
193See also `write-contents-hooks'.
194Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
195
196(put 'local-write-file-hooks 'permanent-local t)
197(defvar local-write-file-hooks nil
198 "Just like `write-file-hooks', except intended for per-buffer use.
199The functions in this list are called before the ones in
200`write-file-hooks'.")
8c0e7b73
JB
201
202(defvar write-contents-hooks nil
203 "List of functions to be called before writing out a buffer to a file.
204If one of them returns non-nil, the file is considered already written
205and the rest are not called.
206These hooks are considered to pertain to the buffer's contents,
207not to the particular visited file; thus, `set-visited-file-name' does
208not clear this variable, but changing the major mode does clear it.
209See also `write-file-hooks'.")
b4da00e9
RM
210
211(defconst enable-local-variables t
212 "*Control use of local-variables lists in files you visit.
213The value can be t, nil or something else.
214A value of t means local-variables lists are obeyed;
215nil means they are ignored; anything else means query.
216
217The command \\[normal-mode] always obeys local-variables lists
218and ignores this variable.")
219
2bba782c 220(defconst enable-local-eval 'maybe
d207b766
RS
221 "*Control processing of the \"variable\" `eval' in a file's local variables.
222The value can be t, nil or something else.
223A value of t means obey `eval' variables;
224nil means ignore them; anything else means query.
225
226The command \\[normal-mode] always obeys local-variables lists
227and ignores this variable.")
b4da00e9
RM
228
229;; Avoid losing in versions where CLASH_DETECTION is disabled.
230(or (fboundp 'lock-buffer)
231c4e10 231 (defalias 'lock-buffer 'ignore))
b4da00e9 232(or (fboundp 'unlock-buffer)
231c4e10 233 (defalias 'unlock-buffer 'ignore))
93fe0a35
RS
234
235;; This hook function provides support for ange-ftp host name
236;; completion. It runs the usual ange-ftp hook, but only for
237;; completion operations. Having this here avoids the need
238;; to load ange-ftp when it's not really in use.
239(defun ange-ftp-completion-hook-function (op &rest args)
240 (if (memq op '(file-name-completion file-name-all-completions))
241 (apply 'ange-ftp-hook-function op args)
242 (let (file-name-handler-alist)
243 (apply op args))))
b4da00e9
RM
244\f
245(defun pwd ()
246 "Show the current default directory."
247 (interactive nil)
248 (message "Directory %s" default-directory))
249
231c4e10
ER
250(defvar cd-path nil
251 "Value of the CDPATH environment variable, as a list.
252Not actually set up until the first time you you use it.")
253
254(defun parse-colon-path (cd-path)
255 "Explode a colon-separated list of paths into a string list."
256 (and cd-path
257 (let (cd-prefix cd-list (cd-start 0) cd-colon)
258 (setq cd-path (concat cd-path ":"))
259 (while (setq cd-colon (string-match ":" cd-path cd-start))
260 (setq cd-list
9daefb36 261 (nconc cd-list
c52e4104
RS
262 (list (if (= cd-start cd-colon)
263 nil
264 (substitute-in-file-name
e33e80e4
RS
265 (file-name-as-directory
266 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
267 (setq cd-start (+ cd-colon 1)))
268 cd-list)))
269
270(defun cd-absolute (dir)
30c5ce9c 271 "Change current directory to given absolute file name DIR."
b3c4423b 272 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9
RM
273 (if (not (eq system-type 'vax-vms))
274 (setq dir (file-name-as-directory dir)))
275 (if (not (file-directory-p dir))
276 (error "%s is not a directory" dir)
277 (if (file-executable-p dir)
278 (setq default-directory dir)
9daefb36 279 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 280
231c4e10
ER
281(defun cd (dir)
282 "Make DIR become the current buffer's default directory.
30c5ce9c
RS
283If your environment includes a `CDPATH' variable, try each one of that
284colon-separated list of directories when resolving a relative directory name."
231c4e10 285 (interactive "FChange default directory: ")
30c5ce9c
RS
286 (if (file-name-absolute-p dir)
287 (cd-absolute (expand-file-name dir))
288 (if (null cd-path)
289 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
290 (setq cd-path (or trypath (list "./")))))
291 (if (not (catch 'found
292 (mapcar
293 (function (lambda (x)
294 (let ((f (expand-file-name (concat x dir))))
295 (if (file-directory-p f)
296 (progn
297 (cd-absolute f)
298 (throw 'found t))))))
299 cd-path)
300 nil))
301 (error "No such directory found via CDPATH environment variable"))))
231c4e10 302
b4da00e9
RM
303(defun load-file (file)
304 "Load the Lisp file named FILE."
305 (interactive "fLoad file: ")
306 (load (expand-file-name file) nil nil t))
307
308(defun load-library (library)
309 "Load the library named LIBRARY.
310This is an interface to the function `load'."
311 (interactive "sLoad library: ")
312 (load library))
5d68c2c2
RS
313
314;; OTHER is the other file to be compared.
315(defun file-local-copy (file)
316 "Copy the file FILE into a temporary file on this machine.
317Returns the name of the local copy, or nil, if FILE is directly
318accessible."
5dbfdacd 319 (let ((handler (find-file-name-handler file)))
5d68c2c2
RS
320 (if handler
321 (funcall handler 'file-local-copy file)
322 nil)))
f3e23606
RS
323
324(defun file-truename (filename)
325 "Return the truename of FILENAME, which should be absolute.
326The truename of a file name is found by chasing symbolic links
327both at the level of the file and at the level of the directories
328containing it, until no links are left at any level."
6d1df4b2 329 (if (string= filename "~")
1cc2fbeb
RS
330 (progn
331 (setq filename (expand-file-name filename))
332 (if (string= filename "")
333 (setq filename "/"))))
5dbfdacd 334 (let ((handler (find-file-name-handler filename)))
6f176f94
RS
335 ;; For file name that has a special handler, call handler.
336 ;; This is so that ange-ftp can save time by doing a no-op.
337 (if handler
338 (funcall handler 'file-truename filename)
339 (let ((dir (file-name-directory filename))
340 target dirfile)
341 ;; Get the truename of the directory.
342 (setq dirfile (directory-file-name dir))
343 ;; If these are equal, we have the (or a) root directory.
344 (or (string= dir dirfile)
345 (setq dir (file-name-as-directory (file-truename dirfile))))
c3bf10c2
RS
346 (if (equal ".." (file-name-nondirectory filename))
347 (directory-file-name (file-name-directory (directory-file-name dir)))
348 (if (equal "." (file-name-nondirectory filename))
349 (directory-file-name dir)
350 ;; Put it back on the file name.
351 (setq filename (concat dir (file-name-nondirectory filename)))
352 ;; Is the file name the name of a link?
353 (setq target (file-symlink-p filename))
354 (if target
355 ;; Yes => chase that link, then start all over
356 ;; since the link may point to a directory name that uses links.
357 ;; We can't safely use expand-file-name here
358 ;; since target might look like foo/../bar where foo
359 ;; is itself a link. Instead, we handle . and .. above.
360 (if (file-name-absolute-p target)
361 (file-truename target)
362 (file-truename (concat dir target)))
363 ;; No, we are done!
364 filename)))))))
5dbfdacd 365
5dadeb29
RS
366(defun file-chase-links (filename)
367 "Chase links in FILENAME until a name that is not a link.
368Does not examine containing directories for links,
369unlike `file-truename'."
370 (let (tem (count 100) (newname filename))
371 (while (setq tem (file-symlink-p newname))
372 (if (= count 0)
373 (error "Apparent cycle of symbolic links for %s" filename))
cf65b429
RS
374 ;; Handle `..' by hand, since it needs to work in the
375 ;; target of any directory symlink.
376 ;; This code is not quite complete; it does not handle
377 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
378 (while (string-match "\\.\\./" tem)
379 (setq tem (substring tem 3))
380 (setq newname (file-name-as-directory
381 ;; Do the .. by hand.
382 (directory-file-name
383 (file-name-directory
384 ;; Chase links in the default dir of the symlink.
385 (file-chase-links
386 (directory-file-name
387 (file-name-directory newname))))))))
5dadeb29
RS
388 (setq newname (expand-file-name tem (file-name-directory newname)))
389 (setq count (1- count)))
390 newname))
b4da00e9
RM
391\f
392(defun switch-to-buffer-other-window (buffer)
393 "Select buffer BUFFER in another window."
394 (interactive "BSwitch to buffer in other window: ")
395 (let ((pop-up-windows t))
396 (pop-to-buffer buffer t)))
397
f98955ea
JB
398(defun switch-to-buffer-other-frame (buffer)
399 "Switch to buffer BUFFER in another frame."
400 (interactive "BSwitch to buffer in other frame: ")
401 (let ((pop-up-frames t))
2be5e5db 402 (pop-to-buffer buffer t)))
5bbbceb1 403
b4da00e9
RM
404(defun find-file (filename)
405 "Edit file FILENAME.
406Switch to a buffer visiting file FILENAME,
407creating one if none already exists."
408 (interactive "FFind file: ")
409 (switch-to-buffer (find-file-noselect filename)))
410
411(defun find-file-other-window (filename)
412 "Edit file FILENAME, in another window.
413May create a new window, or reuse an existing one.
414See the function `display-buffer'."
415 (interactive "FFind file in other window: ")
416 (switch-to-buffer-other-window (find-file-noselect filename)))
417
f98955ea
JB
418(defun find-file-other-frame (filename)
419 "Edit file FILENAME, in another frame.
420May create a new frame, or reuse an existing one.
5bbbceb1 421See the function `display-buffer'."
f98955ea
JB
422 (interactive "FFind file in other frame: ")
423 (switch-to-buffer-other-frame (find-file-noselect filename)))
5bbbceb1 424
b4da00e9
RM
425(defun find-file-read-only (filename)
426 "Edit file FILENAME but don't allow changes.
427Like \\[find-file] but marks buffer as read-only.
428Use \\[toggle-read-only] to permit editing."
429 (interactive "fFind file read-only: ")
430 (find-file filename)
320b4233
RS
431 (setq buffer-read-only t)
432 (current-buffer))
b4da00e9
RM
433
434(defun find-file-read-only-other-window (filename)
435 "Edit file FILENAME in another window but don't allow changes.
436Like \\[find-file-other-window] but marks buffer as read-only.
437Use \\[toggle-read-only] to permit editing."
438 (interactive "fFind file read-only other window: ")
9466a1f6 439 (find-file-other-window filename)
320b4233
RS
440 (setq buffer-read-only t)
441 (current-buffer))
b4da00e9 442
f98955ea
JB
443(defun find-file-read-only-other-frame (filename)
444 "Edit file FILENAME in another frame but don't allow changes.
445Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 446Use \\[toggle-read-only] to permit editing."
f98955ea
JB
447 (interactive "fFind file read-only other frame: ")
448 (find-file-other-frame filename)
320b4233
RS
449 (setq buffer-read-only t)
450 (current-buffer))
5bbbceb1 451
b4da00e9
RM
452(defun find-alternate-file (filename)
453 "Find file FILENAME, select its buffer, kill previous buffer.
454If the current buffer now contains an empty file that you just visited
455\(presumably by mistake), use this command to visit the file you really want."
456 (interactive
457 (let ((file buffer-file-name)
458 (file-name nil)
459 (file-dir nil))
460 (and file
461 (setq file-name (file-name-nondirectory file)
462 file-dir (file-name-directory file)))
a61f59b4
JA
463 (list (read-file-name
464 "Find alternate file: " file-dir nil nil file-name))))
b4da00e9
RM
465 (and (buffer-modified-p)
466 ;; (not buffer-read-only)
467 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
468 (buffer-name))))
469 (error "Aborted"))
470 (let ((obuf (current-buffer))
471 (ofile buffer-file-name)
8bb27285
RS
472 (onum buffer-file-number)
473 (otrue buffer-file-truename)
b4da00e9
RM
474 (oname (buffer-name)))
475 (rename-buffer " **lose**")
476 (setq buffer-file-name nil)
8bb27285
RS
477 (setq buffer-file-number nil)
478 (setq buffer-file-truename nil)
b4da00e9
RM
479 (unwind-protect
480 (progn
481 (unlock-buffer)
482 (find-file filename))
483 (cond ((eq obuf (current-buffer))
484 (setq buffer-file-name ofile)
8bb27285
RS
485 (setq buffer-file-number onum)
486 (setq buffer-file-truename otrue)
b4da00e9
RM
487 (lock-buffer)
488 (rename-buffer oname))))
489 (or (eq (current-buffer) obuf)
490 (kill-buffer obuf))))
491
492(defun create-file-buffer (filename)
493 "Create a suitably named buffer for visiting FILENAME, and return it.
494FILENAME (sans directory) is used unchanged if that name is free;
495otherwise a string <2> or <3> or ... is appended to get an unused name."
496 (let ((lastname (file-name-nondirectory filename)))
497 (if (string= lastname "")
498 (setq lastname filename))
499 (generate-new-buffer lastname)))
500
5bbbceb1
JB
501(defun generate-new-buffer (name)
502 "Create and return a buffer with a name based on NAME.
29165787 503Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
504 (get-buffer-create (generate-new-buffer-name name)))
505
e373f201
JB
506(defconst automount-dir-prefix "^/tmp_mnt/"
507 "Regexp to match the automounter prefix in a directory name.")
508
ffb3a4db
RS
509(defvar abbreviated-home-dir nil
510 "The the user's homedir abbreviated according to `directory-abbrev-list'.")
511
5bbbceb1 512(defun abbreviate-file-name (filename)
29165787 513 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
5bbbceb1 514This also substitutes \"~\" for the user's home directory.
29165787 515Type \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201
JB
516 ;; Get rid of the prefixes added by the automounter.
517 (if (and (string-match automount-dir-prefix filename)
518 (file-exists-p (file-name-directory
519 (substring filename (1- (match-end 0))))))
520 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 521 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
522 ;; If any elt of directory-abbrev-alist matches this name,
523 ;; abbreviate accordingly.
5bbbceb1
JB
524 (while tail
525 (if (string-match (car (car tail)) filename)
526 (setq filename
527 (concat (cdr (car tail)) (substring filename (match-end 0)))))
528 (setq tail (cdr tail)))
ffb3a4db
RS
529 ;; Compute and save the abbreviated homedir name.
530 ;; We defer computing this until the first time it's needed, to
531 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
532 ;; We include a slash at the end, to avoid spurious matches
533 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
534 (or abbreviated-home-dir
535 (setq abbreviated-home-dir
536 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
537 (concat "^" (abbreviate-file-name (expand-file-name "~"))
538 "\\(/\\|$\\)"))))
539
ffb3a4db
RS
540 ;; If FILENAME starts with the abbreviated homedir,
541 ;; make it start with `~' instead.
542 (if (string-match abbreviated-home-dir filename)
5bbbceb1 543 (setq filename
28dbf501
JB
544 (concat "~"
545 ;; If abbreviated-home-dir ends with a slash,
546 ;; don't remove the corresponding slash from
547 ;; filename. On MS-DOS and OS/2, you can have
548 ;; home directories like "g:/", in which it is
549 ;; important not to remove the slash. And what
550 ;; about poor root on Unix systems?
551 (if (eq ?/ (aref abbreviated-home-dir
552 (1- (length abbreviated-home-dir))))
553 "/"
554 "")
3a8a836d 555 (substring filename (match-beginning 1) (match-end 1))
28dbf501 556 (substring filename (match-end 0)))))
5bbbceb1
JB
557 filename))
558
1770543d
RS
559(defvar find-file-not-true-dirname-list nil
560 "*List of logical names for which visiting shouldn't save the true dirname.
561On VMS, when you visit a file using a logical name that searches a path,
562you may or may not want the visited file name to record the specific
563directory where the file was found. If you *do not* want that, add the logical
564name to this list as a string.")
565
b4da00e9
RM
566(defun find-file-noselect (filename &optional nowarn)
567 "Read file FILENAME into a buffer and return the buffer.
568If a buffer exists visiting FILENAME, return that one, but
569verify that the file has not changed since visited or saved.
570The buffer is not selected, just returned to the caller."
e373f201
JB
571 (setq filename
572 (abbreviate-file-name
573 (expand-file-name filename)))
b4da00e9
RM
574 (if (file-directory-p filename)
575 (if find-file-run-dired
576 (dired-noselect filename)
577 (error "%s is a directory." filename))
f3e23606
RS
578 (let* ((buf (get-file-buffer filename))
579 (truename (abbreviate-file-name (file-truename filename)))
580 (number (nthcdr 10 (file-attributes truename)))
581 ;; Find any buffer for a file which has same truename.
582 (same-truename
583 (or buf ; Shortcut
584 (let (found
585 (list (buffer-list)))
586 (while (and (not found) list)
587 (save-excursion
588 (set-buffer (car list))
4269ed64
RM
589 (if (and buffer-file-name
590 (string= buffer-file-truename truename))
f3e23606
RS
591 (setq found (car list))))
592 (setq list (cdr list)))
593 found)))
594 (same-number
595 (or buf ; Shortcut
596 (and number
597 (let (found
598 (list (buffer-list)))
599 (while (and (not found) list)
600 (save-excursion
601 (set-buffer (car list))
4e7afa86
RS
602 (if (and (equal buffer-file-number number)
603 ;; Verify this buffer's file number
604 ;; still belongs to its file.
605 (file-exists-p buffer-file-name)
606 (equal (nthcdr 10 (file-attributes buffer-file-name)) number))
f3e23606
RS
607 (setq found (car list))))
608 (setq list (cdr list)))
609 found))))
610 error)
611 ;; Let user know if there is a buffer with the same truename.
612 (if (and (not buf) same-truename (not nowarn))
613 (message "%s and %s are the same file (%s)"
614 filename (buffer-file-name same-truename)
615 truename)
616 (if (and (not buf) same-number (not nowarn))
617 (message "%s and %s are the same file"
618 filename (buffer-file-name same-number))))
619
620 ;; Optionally also find that buffer.
621 (if (or find-file-existing-other-name find-file-visit-truename)
622 (setq buf (or same-truename same-number)))
b4da00e9
RM
623 (if buf
624 (or nowarn
625 (verify-visited-file-modtime buf)
626 (cond ((not (file-exists-p filename))
627 (error "File %s no longer exists!" filename))
628 ((yes-or-no-p
629 (format
630 (if (buffer-modified-p buf)
631 "File %s changed on disk. Discard your edits? "
632 "File %s changed on disk. Read the new version? ")
633 (file-name-nondirectory filename)))
634 (save-excursion
635 (set-buffer buf)
636 (revert-buffer t t)))))
637 (save-excursion
f3e23606
RS
638;;; The truename stuff makes this obsolete.
639;;; (let* ((link-name (car (file-attributes filename)))
640;;; (linked-buf (and (stringp link-name)
641;;; (get-file-buffer link-name))))
642;;; (if (bufferp linked-buf)
643;;; (message "Symbolic link to file in buffer %s"
644;;; (buffer-name linked-buf))))
b4da00e9
RM
645 (setq buf (create-file-buffer filename))
646 (set-buffer buf)
647 (erase-buffer)
648 (condition-case ()
649 (insert-file-contents filename t)
650 (file-error
651 (setq error t)
652 ;; Run find-file-not-found-hooks until one returns non-nil.
653 (let ((hooks find-file-not-found-hooks))
654 (while (and hooks
455d9d28
RS
655 (not (and (funcall (car hooks))
656 ;; If a hook succeeded, clear error.
657 (progn (setq error nil)
658 ;; Also exit the loop.
659 t))))
b4da00e9 660 (setq hooks (cdr hooks))))))
f3e23606
RS
661 ;; Find the file's truename, and maybe use that as visited name.
662 (setq buffer-file-truename (abbreviate-file-name truename))
1770543d
RS
663 (setq buffer-file-number number)
664 ;; On VMS, we may want to remember which directory in a search list
665 ;; the file was found in.
666 (and (eq system-type 'vax-vms)
667 (let (logical)
668 (if (string-match ":" (file-name-directory filename))
669 (setq logical (substring (file-name-directory filename)
670 0 (match-beginning 0))))
671 (not (member logical find-file-not-true-dirname-list)))
672 (setq buffer-file-name buffer-file-truename))
1cc2fbeb 673 (if find-file-visit-truename
27d0420c
RS
674 (setq buffer-file-name
675 (setq filename
676 (expand-file-name buffer-file-truename))))
b4da00e9
RM
677 ;; Set buffer's default directory to that of the file.
678 (setq default-directory (file-name-directory filename))
679 ;; Turn off backup files for certain file names. Since
680 ;; this is a permanent local, the major mode won't eliminate it.
681 (and (not (funcall backup-enable-predicate buffer-file-name))
682 (progn
683 (make-local-variable 'backup-inhibited)
684 (setq backup-inhibited t)))
685 (after-find-file error (not nowarn))))
686 buf)))
687\f
8cfb9d46 688(defun after-find-file (&optional error warn noauto)
b4da00e9
RM
689 "Called after finding a file and by the default revert function.
690Sets buffer mode, parses local variables.
8cfb9d46 691Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
692error in reading the file. WARN non-nil means warn if there
693exists an auto-save file more recent than the visited file.
8cfb9d46 694NOAUTO means don't mess with auto-save mode.
b4da00e9
RM
695Finishes by calling the functions in `find-file-hooks'."
696 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
697 (if noninteractive
698 nil
699 (let* (not-serious
700 (msg
701 (cond ((and error (file-attributes buffer-file-name))
702 (setq buffer-read-only t)
ff78d520 703 "File exists, but cannot be read.")
b4da00e9
RM
704 ((not buffer-read-only)
705 (if (and warn
706 (file-newer-than-file-p (make-auto-save-file-name)
707 buffer-file-name))
708 "Auto save file is newer; consider M-x recover-file"
709 (setq not-serious t)
710 (if error "(New file)" nil)))
711 ((not error)
712 (setq not-serious t)
713 "Note: file is write protected")
714 ((file-attributes (directory-file-name default-directory))
715 "File not found and directory write-protected")
4e43240a
RS
716 ((file-exists-p (file-name-directory buffer-file-name))
717 (setq buffer-read-only nil))
b4da00e9 718 (t
5bbbceb1 719 (setq buffer-read-only nil)
4e43240a
RS
720 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
721 "Use M-x make-dir RET RET to create the directory"
722 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
b4da00e9
RM
723 (if msg
724 (progn
725 (message msg)
726 (or not-serious (sit-for 1 nil t)))))
8cfb9d46 727 (if (and auto-save-default (not noauto))
b4da00e9
RM
728 (auto-save-mode t)))
729 (normal-mode t)
730 (mapcar 'funcall find-file-hooks))
731
732(defun normal-mode (&optional find-file)
733 "Choose the major mode for this buffer automatically.
734Also sets up any specified local variables of the file.
735Uses the visited file name, the -*- line, and the local variables spec.
736
737This function is called automatically from `find-file'. In that case,
738we may set up specified local variables depending on the value of
739`enable-local-variables': if it is t, we do; if it is nil, we don't;
740otherwise, we query. `enable-local-variables' is ignored if you
741run `normal-mode' explicitly."
742 (interactive)
743 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
744 (condition-case err
745 (set-auto-mode)
746 (error (message "File mode specification error: %s"
747 (prin1-to-string err))))
748 (condition-case err
7b3f3dc2
JB
749 (let ((enable-local-variables (or (not find-file)
750 enable-local-variables)))
751 (hack-local-variables))
b4da00e9
RM
752 (error (message "File local-variables error: %s"
753 (prin1-to-string err)))))
754
7b3f3dc2
JB
755(defvar auto-mode-alist (mapcar 'purecopy
756 '(("\\.text\\'" . text-mode)
757 ("\\.c\\'" . c-mode)
758 ("\\.h\\'" . c-mode)
759 ("\\.tex\\'" . TeX-mode)
760 ("\\.ltx\\'" . LaTeX-mode)
761 ("\\.el\\'" . emacs-lisp-mode)
762 ("\\.mm\\'" . nroff-mode)
763 ("\\.me\\'" . nroff-mode)
c80d2575
ER
764 ("\\.ms\\'" . nroff-mode)
765 ("\\.man\\'" . nroff-mode)
7b3f3dc2
JB
766 ("\\.scm\\'" . scheme-mode)
767 ("\\.l\\'" . lisp-mode)
768 ("\\.lisp\\'" . lisp-mode)
769 ("\\.f\\'" . fortran-mode)
770 ("\\.for\\'" . fortran-mode)
771 ("\\.mss\\'" . scribe-mode)
772 ("\\.pl\\'" . prolog-mode)
773 ("\\.cc\\'" . c++-mode)
2b845a8c 774 ("\\.hh\\'" . c++-mode)
7b3f3dc2 775 ("\\.C\\'" . c++-mode)
2b845a8c 776 ("\\.H\\'" . c++-mode)
a3666e47
RS
777;;; ("\\.mk\\'" . makefile-mode)
778;;; ("[Mm]akefile" . makefile-mode)
7b3f3dc2
JB
779;;; Less common extensions come here
780;;; so more common ones above are found faster.
781 ("\\.s\\'" . asm-mode)
782 ("ChangeLog\\'" . change-log-mode)
7adc58e5 783 ("ChangeLog.[0-9]+\\'" . change-log-mode)
7b3f3dc2 784 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
7adc58e5
RS
785;; The following should come after the ChangeLog pattern
786;; for the sake of ChangeLog.1, etc.
787 ("\\.[12345678]\\'" . nroff-mode)
7b3f3dc2
JB
788 ("\\.TeX\\'" . TeX-mode)
789 ("\\.sty\\'" . LaTeX-mode)
790 ("\\.bbl\\'" . LaTeX-mode)
791 ("\\.bib\\'" . bibtex-mode)
792 ("\\.article\\'" . text-mode)
793 ("\\.letter\\'" . text-mode)
794 ("\\.texinfo\\'" . texinfo-mode)
fd5285f3 795 ("\\.texi\\'" . texinfo-mode)
7b3f3dc2
JB
796 ("\\.lsp\\'" . lisp-mode)
797 ("\\.awk\\'" . awk-mode)
798 ("\\.prolog\\'" . prolog-mode)
c80d2575 799 ("\\.tar\\'" . tar-mode)
7b3f3dc2
JB
800 ;; Mailer puts message to be edited in
801 ;; /tmp/Re.... or Message
802 ("^/tmp/Re" . text-mode)
803 ("/Message[0-9]*\\'" . text-mode)
804 ;; some news reader is reported to use this
805 ("^/tmp/fol/" . text-mode)
806 ("\\.y\\'" . c-mode)
c80d2575 807 ("\\.lex\\'" . c-mode)
7b3f3dc2
JB
808 ("\\.oak\\'" . scheme-mode)
809 ("\\.scm.[0-9]*\\'" . scheme-mode)
278584fb
RS
810 ("\\.sgm\\'" . sgml-mode)
811 ("\\.sgml\\'" . sgml-mode)
812 ("\\.dtd\\'" . sgml-mode)
7b3f3dc2
JB
813 ;; .emacs following a directory delimiter
814 ;; in either Unix or VMS syntax.
815 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
816 ("\\.ml\\'" . lisp-mode)))
817 "\
818Alist of filename patterns vs corresponding major mode functions.
819Each element looks like (REGEXP . FUNCTION).
820Visiting a file whose name matches REGEXP causes FUNCTION to be called.")
821
a0c9f21b
RS
822(defconst inhibit-local-variables-regexps '("\\.tar$")
823 "List of regexps; if one matches a file name, don't look for local vars.")
824
b4da00e9
RM
825(defun set-auto-mode ()
826 "Select major mode appropriate for current buffer.
7b3f3dc2
JB
827This checks for a -*- mode tag in the buffer's text, or
828compares the filename against the entries in auto-mode-alist. It does
829not check for the \"mode:\" local variable in the Local Variables
830section of the file; for that, use `hack-local-variables'.
831
f3e23606 832If `enable-local-variables' is nil, this function does not check for a
7b3f3dc2 833-*- mode tag."
b4da00e9 834 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
9fa7bfe5 835 (let (beg end done)
b4da00e9
RM
836 (save-excursion
837 (goto-char (point-min))
838 (skip-chars-forward " \t\n")
9fa7bfe5
RS
839 (and enable-local-variables
840 ;; Don't look for -*- if this file name matches any
841 ;; of the regexps in inhibit-local-variables-regexps.
842 (let ((temp inhibit-local-variables-regexps))
843 (while (and temp
844 (not (string-match (car temp)
845 buffer-file-name)))
846 (setq temp (cdr temp)))
847 (not temp))
848 (search-forward "-*-" (save-excursion
849 ;; If the file begins with "#!"
850 ;; (exec interpreter magic), look
851 ;; for mode frobs in the first two
852 ;; lines. You cannot necessarily
853 ;; put them in the first line of
854 ;; such a file without screwing up
855 ;; the interpreter invocation.
856 (end-of-line (and (looking-at "^#!") 2))
857 (point)) t)
858 (progn
859 (skip-chars-forward " \t")
860 (setq beg (point))
861 (search-forward "-*-"
862 (save-excursion (end-of-line) (point))
863 t))
864 (progn
865 (forward-char -3)
866 (skip-chars-backward " \t")
867 (setq end (point))
868 (goto-char beg)
869 (if (save-excursion (search-forward ":" end t))
870 ;; Find all specifications for the `mode:' variable
871 ;; and execute hem left to right.
872 (while (let ((case-fold-search t))
873 (search-forward "mode:" end t))
874 (skip-chars-forward " \t")
875 (setq beg (point))
876 (if (search-forward ";" end t)
877 (forward-char -1)
878 (goto-char end))
879 (skip-chars-backward " \t")
880 (funcall (intern (concat (downcase (buffer-substring beg (point))) "-mode"))))
881 ;; Simple -*-MODE-*- case.
882 (funcall (intern (concat (downcase (buffer-substring beg end)) "-mode"))))
883 (setq done t)))
884 ;; If we didn't find a mode from a -*- line, try using the file name.
885 (if (and (not done) buffer-file-name)
886 (let ((alist auto-mode-alist)
887 (name buffer-file-name)
888 mode)
889 (let ((case-fold-search (eq system-type 'vax-vms)))
890 ;; Remove backup-suffixes from file name.
891 (setq name (file-name-sans-versions name))
892 ;; Find first matching alist entry.
893 (while (and (not mode) alist)
894 (if (string-match (car (car alist)) name)
895 (setq mode (cdr (car alist))))
896 (setq alist (cdr alist))))
897 (if mode (funcall mode)))))))
b4da00e9 898
f3e23606
RS
899(defun hack-local-variables-prop-line ()
900 ;; Set local variables specified in the -*- line.
9fa7bfe5
RS
901 ;; Ignore any specification for `mode:';
902 ;; set-auto-mode should already have handled that.
f3e23606
RS
903 (save-excursion
904 (goto-char (point-min))
905 (skip-chars-forward " \t\n\r")
906 (let ((result '())
9fa7bfe5 907 (end (save-excursion (end-of-line) (point))))
f3e23606
RS
908 ;; Parse the -*- line into the `result' alist.
909 (cond ((not (search-forward "-*-" end t))
910 ;; doesn't have one.
911 nil)
912 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
913 ;; Simple form: "-*- MODENAME -*-".
914 (setq result
915 (list (cons 'mode
916 (intern (buffer-substring
917 (match-beginning 1)
918 (match-end 1)))))))
919 (t
920 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
921 ;; (last ";" is optional).
922 (save-excursion
923 (if (search-forward "-*-" end t)
924 (setq end (- (point) 3))
925 (error "-*- not terminated before end of line")))
926 (while (< (point) end)
927 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
928 (error "malformed -*- line"))
929 (goto-char (match-end 0))
930 (let ((key (intern (downcase (buffer-substring
931 (match-beginning 1)
932 (match-end 1)))))
933 (val (save-restriction
934 (narrow-to-region (point) end)
935 (read (current-buffer)))))
936 (setq result (cons (cons key val) result))
937 (skip-chars-forward " \t;")))
938 (setq result (nreverse result))))
f3e23606
RS
939
940 (if (and result
941 (or (eq enable-local-variables t)
942 (and enable-local-variables
943 (save-window-excursion
944 (switch-to-buffer (current-buffer))
945 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
946 (file-name-nondirectory buffer-file-name)))))))
947 (while result
948 (let ((key (car (car result)))
949 (val (cdr (car result))))
9fa7bfe5
RS
950 (or (eq key 'mode)
951 (hack-one-local-variable key val)))
952 (setq result (cdr result)))))))
f3e23606 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
2943f983
RS
1406 (set-visited-file-name
1407 (expand-file-name (read-file-name "File to save in: ") nil)))
b4da00e9
RM
1408 (or (verify-visited-file-modtime (current-buffer))
1409 (not (file-exists-p buffer-file-name))
1410 (yes-or-no-p
1411 (format "%s has changed since visited or saved. Save anyway? "
1412 (file-name-nondirectory buffer-file-name)))
1413 (error "Save not confirmed"))
1414 (save-restriction
1415 (widen)
1416 (and (> (point-max) 1)
1417 (/= (char-after (1- (point-max))) ?\n)
1418 (or (eq require-final-newline t)
1419 (and require-final-newline
1420 (y-or-n-p
1421 (format "Buffer %s does not end in newline. Add one? "
1422 (buffer-name)))))
1423 (save-excursion
1424 (goto-char (point-max))
1425 (insert ?\n)))
c9dca4e0
RS
1426 (let ((hooks (append write-contents-hooks local-write-file-hooks
1427 write-file-hooks))
b4da00e9
RM
1428 (done nil))
1429 (while (and hooks
1430 (not (setq done (funcall (car hooks)))))
1431 (setq hooks (cdr hooks)))
1432 ;; If a hook returned t, file is already "written".
1433 (cond ((not done)
1434 (if (not (file-writable-p buffer-file-name))
1435 (let ((dir (file-name-directory buffer-file-name)))
1436 (if (not (file-directory-p dir))
1437 (error "%s is not a directory" dir)
1438 (if (not (file-exists-p buffer-file-name))
1439 (error "Directory %s write-protected" dir)
1440 (if (yes-or-no-p
1441 (format "File %s is write-protected; try to save anyway? "
1442 (file-name-nondirectory
1443 buffer-file-name)))
1444 (setq tempsetmodes t)
1445 (error "Attempt to save to a file which you aren't allowed to write"))))))
1446 (or buffer-backed-up
1447 (setq setmodes (backup-buffer)))
1448 (if file-precious-flag
f3e23606
RS
1449 ;; If file is precious, write temp name, then rename it.
1450 (let ((dir (file-name-directory buffer-file-name))
1451 (realname buffer-file-name)
1452 tempname temp nogood i succeed)
1453 (setq i 0)
1454 (setq nogood t)
1455 ;; Find the temporary name to write under.
1456 (while nogood
1457 (setq tempname (format "%s#tmp#%d" dir i))
1458 (setq nogood (file-exists-p tempname))
1459 (setq i (1+ i)))
b4da00e9
RM
1460 (unwind-protect
1461 (progn (clear-visited-file-modtime)
1462 (write-region (point-min) (point-max)
f3e23606
RS
1463 tempname nil realname)
1464 (setq succeed t))
1465 ;; If writing the temp file fails,
1466 ;; delete the temp file.
1467 (or succeed (delete-file tempname)))
b411d947
JB
1468 ;; Since we have created an entirely new file
1469 ;; and renamed it, make sure it gets the
1470 ;; right permission bits set.
1471 (setq setmodes (file-modes buffer-file-name))
f3e23606
RS
1472 ;; We succeeded in writing the temp file,
1473 ;; so rename it.
1474 (rename-file tempname buffer-file-name t))
b4da00e9
RM
1475 ;; If file not writable, see if we can make it writable
1476 ;; temporarily while we write it.
1477 ;; But no need to do so if we have just backed it up
1478 ;; (setmodes is set) because that says we're superseding.
1479 (cond ((and tempsetmodes (not setmodes))
1480 ;; Change the mode back, after writing.
1481 (setq setmodes (file-modes buffer-file-name))
1482 (set-file-modes buffer-file-name 511)))
1483 (write-region (point-min) (point-max)
1484 buffer-file-name nil t)))))
f3e23606 1485 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
b4da00e9
RM
1486 (if setmodes
1487 (condition-case ()
f3e23606 1488 (set-file-modes buffer-file-name setmodes)
b4da00e9
RM
1489 (error nil))))
1490 ;; If the auto-save file was recent before this command,
1491 ;; delete it now.
1492 (delete-auto-save-file-if-necessary recent-save)
1bf3d475 1493 (run-hooks 'after-save-hook))
b4da00e9
RM
1494 (message "(No changes need to be saved)")))
1495
b4da00e9
RM
1496(defun save-some-buffers (&optional arg exiting)
1497 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
1498Optional argument (the prefix) non-nil means save all with no questions.
1499Optional second argument EXITING means ask about certain non-file buffers
1500 as well as about file buffers."
b4da00e9 1501 (interactive "P")
907482b9 1502 (save-window-excursion
b5e86cb3
RM
1503 (if (zerop (map-y-or-n-p
1504 (function
1505 (lambda (buffer)
1506 (and (buffer-modified-p buffer)
1507 (or
1508 (buffer-file-name buffer)
1509 (and exiting
1510 (progn
1511 (set-buffer buffer)
1512 (and buffer-offer-save (> (buffer-size) 0)))))
1513 (if arg
1514 t
1515 (if (buffer-file-name buffer)
1516 (format "Save file %s? "
1517 (buffer-file-name buffer))
1518 (format "Save buffer %s? "
1519 (buffer-name buffer)))))))
1520 (function
1521 (lambda (buffer)
e065a56e
JB
1522 (set-buffer buffer)
1523 (save-buffer)))
b5e86cb3 1524 (buffer-list)
907482b9 1525 '("buffer" "buffers" "save")
df01170b
RS
1526 (list (list ?\C-r (lambda (buf)
1527 (view-buffer buf)
1586b965
RS
1528 (setq view-exit-action
1529 '(lambda (ignore)
1530 (exit-recursive-edit)))
df01170b
RS
1531 (recursive-edit)
1532 ;; Return nil to ask about BUF again.
1533 nil)
907482b9
RM
1534 "display the current buffer"))
1535 ))
b5e86cb3 1536 (message "(No files need saving)"))))
b4da00e9
RM
1537\f
1538(defun not-modified (&optional arg)
1539 "Mark current buffer as unmodified, not needing to be saved.
1540With prefix arg, mark buffer as modified, so \\[save-buffer] will save."
1541 (interactive "P")
1542 (message (if arg "Modification-flag set"
1543 "Modification-flag cleared"))
1544 (set-buffer-modified-p arg))
1545
1546(defun toggle-read-only (&optional arg)
1547 "Change whether this buffer is visiting its file read-only.
1548With arg, set read-only iff arg is positive."
1549 (interactive "P")
1550 (setq buffer-read-only
1551 (if (null arg)
1552 (not buffer-read-only)
1553 (> (prefix-numeric-value arg) 0)))
1554 ;; Force mode-line redisplay
1555 (set-buffer-modified-p (buffer-modified-p)))
1556
1557(defun insert-file (filename)
1558 "Insert contents of file FILENAME into buffer after point.
1559Set mark after the inserted text.
1560
1561This function is meant for the user to run interactively.
1562Don't call it from programs! Use `insert-file-contents' instead.
1563\(Its calling sequence is different; see its documentation)."
1564 (interactive "fInsert file: ")
3be6243a
RS
1565 (if (file-directory-p filename)
1566 (signal 'file-error (list "Opening input file" "file is a directory"
1567 filename)))
b4da00e9
RM
1568 (let ((tem (insert-file-contents filename)))
1569 (push-mark (+ (point) (car (cdr tem))))))
1570
1571(defun append-to-file (start end filename)
1572 "Append the contents of the region to the end of file FILENAME.
1573When called from a function, expects three arguments,
1574START, END and FILENAME. START and END are buffer positions
1575saying what text to write."
1576 (interactive "r\nFAppend to file: ")
1577 (write-region start end filename t))
1578
1579(defun file-newest-backup (filename)
1580 "Return most recent backup file for FILENAME or nil if no backups exist."
1581 (let* ((filename (expand-file-name filename))
1582 (file (file-name-nondirectory filename))
1583 (dir (file-name-directory filename))
1584 (comp (file-name-all-completions file dir))
1585 newest)
1586 (while comp
1587 (setq file (concat dir (car comp))
1588 comp (cdr comp))
1589 (if (and (backup-file-name-p file)
1590 (or (null newest) (file-newer-than-file-p file newest)))
1591 (setq newest file)))
1592 newest))
1593
1594(defun rename-uniquely ()
1595 "Rename current buffer to a similar name not already taken.
1596This function is useful for creating multiple shell process buffers
1597or multiple mail buffers, etc."
1598 (interactive)
1599 (let* ((new-buf (generate-new-buffer (buffer-name)))
1600 (name (buffer-name new-buf)))
1601 (kill-buffer new-buf)
1602 (rename-buffer name)
1603 (set-buffer-modified-p (buffer-modified-p)))) ; force mode line update
5bbbceb1 1604
4e43240a 1605(defun make-directory (dir &optional parents)
5ce8bb89
RS
1606 "Create the directory DIR and any nonexistent parent dirs.
1607Interactively, the default choice of directory to create
1608is the current default directory for file names.
1609That is useful when you have visited a file in a nonexistint directory.
1610
1611Noninteractively, the second (optional) argument PARENTS says whether
1612to create parent directories if they don't exist."
1613 (interactive
1614 (list (read-file-name "Make directory: " default-directory default-directory
1615 nil nil)
1616 t))
5dbfdacd 1617 (let ((handler (find-file-name-handler dir)))
4e43240a
RS
1618 (if handler
1619 (funcall handler 'make-directory dir parents)
1620 (if (not parents)
1621 (make-directory-internal dir)
1622 (let ((dir (directory-file-name (expand-file-name dir)))
1623 create-list)
1624 (while (not (file-exists-p dir))
1625 (setq create-list (cons dir create-list)
1626 dir (directory-file-name (file-name-directory dir))))
1627 (while create-list
1628 (make-directory-internal (car create-list))
1629 (setq create-list (cdr create-list))))))))
b4da00e9
RM
1630\f
1631(put 'revert-buffer-function 'permanent-local t)
1632(defvar revert-buffer-function nil
1633 "Function to use to revert this buffer, or nil to do the default.")
1634
1635(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1636(defvar revert-buffer-insert-file-contents-function nil
1637 "Function to use to insert contents when reverting this buffer.
1638Gets two args, first the nominal file name to use,
1639and second, t if reading the auto-save file.")
1640
1ab31687 1641(defun revert-buffer (&optional ignore-auto noconfirm)
b4da00e9
RM
1642 "Replace the buffer text with the text of the visited file on disk.
1643This undoes all changes since the file was visited or saved.
8c0e7b73
JB
1644With a prefix argument, offer to revert from latest auto-save file, if
1645that is more recent than the visited file.
1ab31687
JB
1646
1647When called from lisp, the first argument is IGNORE-AUTO; only offer
1648to revert from the auto-save file when this is nil. Note that the
1649sense of this argument is the reverse of the prefix argument, for the
1650sake of backward compatibility. IGNORE-AUTO is optional, defaulting
1651to nil.
1652
1653Optional second argument NOCONFIRM means don't ask for confirmation at
1654all.
b4da00e9 1655
8c0e7b73
JB
1656If the value of `revert-buffer-function' is non-nil, it is called to
1657do the work."
1ab31687
JB
1658 ;; I admit it's odd to reverse the sense of the prefix argument, but
1659 ;; there is a lot of code out there which assumes that the first
1660 ;; argument should be t to avoid consulting the auto-save file, and
1661 ;; there's no straightforward way to encourage authors to notice a
1662 ;; reversal of the argument sense. So I'm just changing the user
1663 ;; interface, but leaving the programmatic interface the same.
1664 (interactive (list (not prefix-arg)))
b4da00e9 1665 (if revert-buffer-function
1ab31687 1666 (funcall revert-buffer-function ignore-auto noconfirm)
b4da00e9 1667 (let* ((opoint (point))
1ab31687
JB
1668 (auto-save-p (and (not ignore-auto)
1669 (recent-auto-save-p)
b4da00e9
RM
1670 buffer-auto-save-file-name
1671 (file-readable-p buffer-auto-save-file-name)
1672 (y-or-n-p
1673 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
1674 (file-name (if auto-save-p
1675 buffer-auto-save-file-name
1676 buffer-file-name)))
1677 (cond ((null file-name)
1678 (error "Buffer does not seem to be associated with any file"))
1679 ((or noconfirm
1680 (yes-or-no-p (format "Revert buffer from file %s? "
1681 file-name)))
1682 ;; If file was backed up but has changed since,
1683 ;; we shd make another backup.
1684 (and (not auto-save-p)
5bbbceb1 1685 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
1686 (setq buffer-backed-up nil))
1687 ;; Get rid of all undo records for this buffer.
1688 (or (eq buffer-undo-list t)
1689 (setq buffer-undo-list nil))
1690 (let ((buffer-read-only nil)
1691 ;; Don't make undo records for the reversion.
1692 (buffer-undo-list t))
1693 (if revert-buffer-insert-file-contents-function
1694 (funcall revert-buffer-insert-file-contents-function
1695 file-name auto-save-p)
1696 (if (not (file-exists-p file-name))
1697 (error "File %s no longer exists!" file-name))
1698 ;; Bind buffer-file-name to nil
1699 ;; so that we don't try to lock the file.
1700 (let ((buffer-file-name nil))
1701 (or auto-save-p
1702 (unlock-buffer))
1703 (erase-buffer))
1704 (insert-file-contents file-name (not auto-save-p))))
1705 (goto-char (min opoint (point-max)))
8cfb9d46 1706 (after-find-file nil nil t)
b4da00e9
RM
1707 t)))))
1708
1709(defun recover-file (file)
1710 "Visit file FILE, but get contents from its last auto-save file."
1711 (interactive
1712 (let ((prompt-file buffer-file-name)
1713 (file-name nil)
1714 (file-dir nil))
1715 (and prompt-file
1716 (setq file-name (file-name-nondirectory prompt-file)
1717 file-dir (file-name-directory prompt-file)))
1718 (list (read-file-name "Recover file: "
1719 file-dir nil nil file-name))))
1720 (setq file (expand-file-name file))
1721 (if (auto-save-file-name-p file) (error "%s is an auto-save file" file))
1722 (let ((file-name (let ((buffer-file-name file))
1723 (make-auto-save-file-name))))
1724 (cond ((not (file-newer-than-file-p file-name file))
1725 (error "Auto-save file %s not current" file-name))
1726 ((save-window-excursion
1727 (if (not (eq system-type 'vax-vms))
1728 (with-output-to-temp-buffer "*Directory*"
1729 (buffer-disable-undo standard-output)
1730 (call-process "ls" nil standard-output nil
2dc2b736
RS
1731 (if (file-symlink-p file) "-lL" "-l")
1732 file file-name)))
b4da00e9
RM
1733 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
1734 (switch-to-buffer (find-file-noselect file t))
1735 (let ((buffer-read-only nil))
1736 (erase-buffer)
1737 (insert-file-contents file-name nil))
8cfb9d46 1738 (after-find-file nil nil t))
b4da00e9
RM
1739 (t (error "Recover-file cancelled.")))))
1740
1741(defun kill-some-buffers ()
1742 "For each buffer, ask whether to kill it."
1743 (interactive)
1744 (let ((list (buffer-list)))
1745 (while list
1746 (let* ((buffer (car list))
1747 (name (buffer-name buffer)))
1748 (and (not (string-equal name ""))
1749 (/= (aref name 0) ? )
1750 (yes-or-no-p
1751 (format "Buffer %s %s. Kill? "
1752 name
1753 (if (buffer-modified-p buffer)
1754 "HAS BEEN EDITED" "is unmodified")))
1755 (kill-buffer buffer)))
1756 (setq list (cdr list)))))
1757\f
1758(defun auto-save-mode (arg)
1759 "Toggle auto-saving of contents of current buffer.
f3e23606 1760With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
1761 (interactive "P")
1762 (setq buffer-auto-save-file-name
1763 (and (if (null arg)
1764 (not buffer-auto-save-file-name)
1765 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
1766 (if (and buffer-file-name auto-save-visited-file-name
1767 (not buffer-read-only))
1768 buffer-file-name
1769 (make-auto-save-file-name))))
1770 (if (interactive-p)
1771 (message "Auto-save %s (in this buffer)"
1772 (if buffer-auto-save-file-name "on" "off")))
1773 buffer-auto-save-file-name)
1774
1775(defun rename-auto-save-file ()
1776 "Adjust current buffer's auto save file name for current conditions.
1777Also rename any existing auto save file, if it was made in this session."
1778 (let ((osave buffer-auto-save-file-name))
1779 (setq buffer-auto-save-file-name
1780 (make-auto-save-file-name))
1781 (if (and osave buffer-auto-save-file-name
1782 (not (string= buffer-auto-save-file-name buffer-file-name))
1783 (not (string= buffer-auto-save-file-name osave))
1784 (file-exists-p osave)
1785 (recent-auto-save-p))
1786 (rename-file osave buffer-auto-save-file-name t))))
1787
1788(defun make-auto-save-file-name ()
1789 "Return file name to use for auto-saves of current buffer.
1790Does not consider `auto-save-visited-file-name' as that variable is checked
1791before calling this function. You can redefine this for customization.
1792See also `auto-save-file-name-p'."
1793 (if buffer-file-name
1794 (concat (file-name-directory buffer-file-name)
1795 "#"
1796 (file-name-nondirectory buffer-file-name)
1797 "#")
1798 ;; For non-file bfr, use bfr name and Emacs pid.
1799 (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))))
1800
1801(defun auto-save-file-name-p (filename)
1802 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
1803FILENAME should lack slashes. You can redefine this for customization."
1804 (string-match "^#.*#$" filename))
1805\f
1806(defconst list-directory-brief-switches
1807 (if (eq system-type 'vax-vms) "" "-CF")
1808 "*Switches for list-directory to pass to `ls' for brief listing,")
1809
1810(defconst list-directory-verbose-switches
1811 (if (eq system-type 'vax-vms)
1812 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
1813 "-l")
1814 "*Switches for list-directory to pass to `ls' for verbose listing,")
1815
1816(defun list-directory (dirname &optional verbose)
1817 "Display a list of files in or matching DIRNAME, a la `ls'.
1818DIRNAME is globbed by the shell if necessary.
1819Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
1820Actions controlled by variables `list-directory-brief-switches'
1821and `list-directory-verbose-switches'."
1822 (interactive (let ((pfx current-prefix-arg))
1823 (list (read-file-name (if pfx "List directory (verbose): "
1824 "List directory (brief): ")
1825 nil default-directory nil)
1826 pfx)))
1827 (let ((switches (if verbose list-directory-verbose-switches
1828 list-directory-brief-switches)))
1829 (or dirname (setq dirname default-directory))
1830 (setq dirname (expand-file-name dirname))
1831 (with-output-to-temp-buffer "*Directory*"
1832 (buffer-disable-undo standard-output)
1833 (princ "Directory ")
1834 (princ dirname)
1835 (terpri)
c3554e95
RS
1836 (save-excursion
1837 (set-buffer "*Directory*")
1838 (let ((wildcard (not (file-directory-p dirname))))
1839 (insert-directory dirname switches wildcard (not wildcard)))))))
1840
1841(defvar insert-directory-program "ls"
1842 "Absolute or relative name of the `ls' program used by `insert-directory'.")
1843
1844;; insert-directory
1845;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
1846;; FULL-DIRECTORY-P is nil.
1847;; The single line of output must display FILE's name as it was
1848;; given, namely, an absolute path name.
1849;; - must insert exactly one line for each file if WILDCARD or
1850;; FULL-DIRECTORY-P is t, plus one optional "total" line
1851;; before the file lines, plus optional text after the file lines.
1852;; Lines are delimited by "\n", so filenames containing "\n" are not
1853;; allowed.
1854;; File lines should display the basename.
1855;; - must be consistent with
1856;; - functions dired-move-to-filename, (these two define what a file line is)
1857;; dired-move-to-end-of-filename,
1858;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
1859;; dired-insert-headerline
1860;; dired-after-subdir-garbage (defines what a "total" line is)
1861;; - variable dired-subdir-regexp
1862(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 1863 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95
RS
1864Leaves point after the inserted text.
1865Optional third arg WILDCARD means treat FILE as shell wildcard.
1866Optional fourth arg FULL-DIRECTORY-P means file is a directory and
1867switches do not contain `d', so that a full listing is expected.
1868
1869This works by running a directory listing program
406e12d9 1870whose name is in the variable `insert-directory-program'.
c3554e95 1871If WILDCARD, it also runs the shell specified by `shell-file-name'."
5dbfdacd 1872 (let ((handler (find-file-name-handler file)))
c3554e95
RS
1873 (if handler
1874 (funcall handler 'insert-directory file switches
1875 wildcard full-directory-p)
b4da00e9 1876 (if (eq system-type 'vax-vms)
c3554e95
RS
1877 (vms-read-directory file switches (current-buffer))
1878 (if wildcard
a9fa0bd5
RS
1879 ;; Run ls in the directory of the file pattern we asked for.
1880 (let ((default-directory
1881 (if (file-name-absolute-p file)
1882 (file-name-directory file)
1883 (file-name-directory (expand-file-name file)))))
c3554e95
RS
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