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