entered into RCS
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
e5167999
ER
3;; Maintainer: FSF
4;; Last-Modified: 09 Jul 92
5
8c0e7b73 6;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
b4da00e9
RM
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
e5167999 12;; the Free Software Foundation; either version 2, or (at your option)
b4da00e9
RM
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs; see the file COPYING. If not, write to
22;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23
e5167999
ER
24;;; Code:
25
b4da00e9
RM
26(defconst delete-auto-save-files t
27 "*Non-nil means delete a buffer's auto-save file when the buffer is saved.")
28
29(defconst directory-abbrev-alist
30 nil
31 "*Alist of abbreviations for file directories.
32A list of elements of the form (FROM . TO), each meaning to replace
33FROM with TO when it appears in a directory name. This replacement is
34done when setting up the default directory of a newly visited file.
35*Every* FROM string should start with `^'.
36
37Use this feature when you have directories which you normally refer to
38via absolute symbolic links. Make TO the name of the link, and FROM
39the name it is linked to.")
40
41;;; Turn off backup files on VMS since it has version numbers.
42(defconst make-backup-files (not (eq system-type 'vax-vms))
43 "*Create a backup of each file when it is saved for the first time.
44This can be done by renaming the file or by copying.
45
46Renaming means that Emacs renames the existing file so that it is a
47backup file, then writes the buffer into a new file. Any other names
48that the old file had will now refer to the backup file. The new file
49is owned by you and its group is defaulted.
50
51Copying means that Emacs copies the existing file into the backup
52file, then writes the buffer on top of the existing file. Any other
53names that the old file had will now refer to the new (edited) file.
54The file's owner and group are unchanged.
55
56The choice of renaming or copying is controlled by the variables
57`backup-by-copying', `backup-by-copying-when-linked' and
58`backup-by-copying-when-mismatch'.")
59
60;; Do this so that local variables based on the file name
61;; are not overridden by the major mode.
62(defvar backup-inhibited nil
63 "Non-nil means don't make a backup file for this buffer.")
64(put 'backup-inhibited 'permanent-local t)
65
66(defconst backup-by-copying nil
67 "*Non-nil means always use copying to create backup files.
68See documentation of variable `make-backup-files'.")
69
70(defconst backup-by-copying-when-linked nil
71 "*Non-nil means use copying to create backups for files with multiple names.
72This causes the alternate names to refer to the latest version as edited.
73This variable is relevant only if `backup-by-copying' is nil.")
74
75(defconst backup-by-copying-when-mismatch nil
76 "*Non-nil means create backups by copying if this preserves owner or group.
77Renaming may still be used (subject to control of other variables)
78when it would not result in changing the owner or group of the file;
79that is, for files which are owned by you and whose group matches
80the default for a new file created there by you.
81This variable is relevant only if `backup-by-copying' is nil.")
82
83(defvar backup-enable-predicate
84 '(lambda (name)
85 (or (< (length name) 5)
86 (not (string-equal "/tmp/" (substring name 0 5)))))
87 "Predicate that looks at a file name and decides whether to make backups.
88Called with an absolute file name as argument, it returns t to enable backup.")
89
90(defconst buffer-offer-save nil
91 "*Non-nil in a buffer means offer to save the buffer on exit
92even if the buffer is not visiting a file.
93Automatically local in all buffers.")
94(make-variable-buffer-local 'buffer-offer-save)
95
96(defconst file-precious-flag nil
97 "*Non-nil means protect against I/O errors while saving files.
98Some modes set this non-nil in particular buffers.")
99
100(defvar version-control nil
101 "*Control use of version numbers for backup files.
102t means make numeric backup versions unconditionally.
103nil means make them for files that have some already.
104never means do not make them.")
105
106(defvar dired-kept-versions 2
107 "*When cleaning directory, number of versions to keep.")
108
109(defvar trim-versions-without-asking nil
6d74b528
ER
110 "*If t, deletes excess backup versions silently.
111If nil, asks confirmation. Any other value prevents any trimming.")
b4da00e9
RM
112
113(defvar kept-old-versions 2
114 "*Number of oldest versions to keep when a new numbered backup is made.")
115
116(defvar kept-new-versions 2
117 "*Number of newest versions to keep when a new numbered backup is made.
118Includes the new backup. Must be > 0")
119
120(defconst require-final-newline nil
121 "*Value of t says silently ensure a file ends in a newline when it is saved.
122Non-nil but not t says ask user whether to add a newline when there isn't one.
123nil means don't add newlines.")
124
125(defconst auto-save-default t
126 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
127
128(defconst auto-save-visited-file-name nil
129 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
130Normally auto-save files are written under other names.")
131
132(defconst save-abbrevs nil
133 "*Non-nil means save word abbrevs too when files are saved.
134Loading an abbrev file sets this to t.")
135
136(defconst find-file-run-dired t
137 "*Non-nil says run dired if find-file is given the name of a directory.")
138
139(put 'find-file-not-found-hooks 'permanent-local t)
140(defvar find-file-not-found-hooks nil
141 "List of functions to be called for `find-file' on nonexistent file.
142These functions are called as soon as the error is detected.
143`buffer-file-name' is already set up.
144The functions are called in the order given until one of them returns non-nil.")
145
146(put 'find-file-hooks 'permanent-local t)
147(defvar find-file-hooks nil
148 "List of functions to be called after a buffer is loaded from a file.
149The buffer's local variables (if any) will have been processed before the
150functions are called.")
151
152(put 'write-file-hooks 'permanent-local t)
153(defvar write-file-hooks nil
154 "List of functions to be called before writing out a buffer to a file.
155If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
156and the rest are not called.
157These hooks are considered to pertain to the visited file.
158So this list is cleared if you change the visited file name.
159See also `write-contents-hooks'.")
160
161(defvar write-contents-hooks nil
162 "List of functions to be called before writing out a buffer to a file.
163If one of them returns non-nil, the file is considered already written
164and the rest are not called.
165These hooks are considered to pertain to the buffer's contents,
166not to the particular visited file; thus, `set-visited-file-name' does
167not clear this variable, but changing the major mode does clear it.
168See also `write-file-hooks'.")
b4da00e9
RM
169
170(defconst enable-local-variables t
171 "*Control use of local-variables lists in files you visit.
172The value can be t, nil or something else.
173A value of t means local-variables lists are obeyed;
174nil means they are ignored; anything else means query.
175
176The command \\[normal-mode] always obeys local-variables lists
177and ignores this variable.")
178
d207b766
RS
179(defconst enable-local-eval nil
180 "*Control processing of the \"variable\" `eval' in a file's local variables.
181The value can be t, nil or something else.
182A value of t means obey `eval' variables;
183nil means ignore them; anything else means query.
184
185The command \\[normal-mode] always obeys local-variables lists
186and ignores this variable.")
b4da00e9
RM
187
188;; Avoid losing in versions where CLASH_DETECTION is disabled.
189(or (fboundp 'lock-buffer)
190 (fset 'lock-buffer 'ignore))
191(or (fboundp 'unlock-buffer)
192 (fset 'unlock-buffer 'ignore))
193\f
194(defun pwd ()
195 "Show the current default directory."
196 (interactive nil)
197 (message "Directory %s" default-directory))
198
199(defun cd (dir)
200 "Make DIR become the current buffer's default directory."
201 (interactive "DChange default directory: ")
202 (setq dir (expand-file-name dir))
203 (if (not (eq system-type 'vax-vms))
204 (setq dir (file-name-as-directory dir)))
205 (if (not (file-directory-p dir))
206 (error "%s is not a directory" dir)
207 (if (file-executable-p dir)
208 (setq default-directory dir)
209 (error "Cannot cd to %s: Permission denied" dir)))
5bbbceb1
JB
210 ;; We used to call pwd at this point. That's not terribly helpful
211 ;; when we're invoking cd interactively, and the new cmushell-based
212 ;; shell has its own (better) facilities for this.
213)
b4da00e9
RM
214
215(defun load-file (file)
216 "Load the Lisp file named FILE."
217 (interactive "fLoad file: ")
218 (load (expand-file-name file) nil nil t))
219
220(defun load-library (library)
221 "Load the library named LIBRARY.
222This is an interface to the function `load'."
223 (interactive "sLoad library: ")
224 (load library))
225\f
226(defun switch-to-buffer-other-window (buffer)
227 "Select buffer BUFFER in another window."
228 (interactive "BSwitch to buffer in other window: ")
229 (let ((pop-up-windows t))
230 (pop-to-buffer buffer t)))
231
f98955ea
JB
232(defun switch-to-buffer-other-frame (buffer)
233 "Switch to buffer BUFFER in another frame."
234 (interactive "BSwitch to buffer in other frame: ")
235 (let ((pop-up-frames t))
5bbbceb1
JB
236 (pop-to-buffer buffer)))
237
b4da00e9
RM
238(defun find-file (filename)
239 "Edit file FILENAME.
240Switch to a buffer visiting file FILENAME,
241creating one if none already exists."
242 (interactive "FFind file: ")
243 (switch-to-buffer (find-file-noselect filename)))
244
245(defun find-file-other-window (filename)
246 "Edit file FILENAME, in another window.
247May create a new window, or reuse an existing one.
248See the function `display-buffer'."
249 (interactive "FFind file in other window: ")
250 (switch-to-buffer-other-window (find-file-noselect filename)))
251
f98955ea
JB
252(defun find-file-other-frame (filename)
253 "Edit file FILENAME, in another frame.
254May create a new frame, or reuse an existing one.
5bbbceb1 255See the function `display-buffer'."
f98955ea
JB
256 (interactive "FFind file in other frame: ")
257 (switch-to-buffer-other-frame (find-file-noselect filename)))
5bbbceb1 258
b4da00e9
RM
259(defun find-file-read-only (filename)
260 "Edit file FILENAME but don't allow changes.
261Like \\[find-file] but marks buffer as read-only.
262Use \\[toggle-read-only] to permit editing."
263 (interactive "fFind file read-only: ")
264 (find-file filename)
265 (setq buffer-read-only t))
266
267(defun find-file-read-only-other-window (filename)
268 "Edit file FILENAME in another window but don't allow changes.
269Like \\[find-file-other-window] but marks buffer as read-only.
270Use \\[toggle-read-only] to permit editing."
271 (interactive "fFind file read-only other window: ")
272 (find-file filename)
273 (setq buffer-read-only t))
274
f98955ea
JB
275(defun find-file-read-only-other-frame (filename)
276 "Edit file FILENAME in another frame but don't allow changes.
277Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 278Use \\[toggle-read-only] to permit editing."
f98955ea
JB
279 (interactive "fFind file read-only other frame: ")
280 (find-file-other-frame filename)
5bbbceb1
JB
281 (setq buffer-read-only t))
282
b4da00e9
RM
283(defun find-alternate-file (filename)
284 "Find file FILENAME, select its buffer, kill previous buffer.
285If the current buffer now contains an empty file that you just visited
286\(presumably by mistake), use this command to visit the file you really want."
287 (interactive
288 (let ((file buffer-file-name)
289 (file-name nil)
290 (file-dir nil))
291 (and file
292 (setq file-name (file-name-nondirectory file)
293 file-dir (file-name-directory file)))
294 (list (read-file-name "Find alternate file: " file-dir nil nil file-name))))
295 (and (buffer-modified-p)
296 ;; (not buffer-read-only)
297 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
298 (buffer-name))))
299 (error "Aborted"))
300 (let ((obuf (current-buffer))
301 (ofile buffer-file-name)
302 (oname (buffer-name)))
303 (rename-buffer " **lose**")
304 (setq buffer-file-name nil)
305 (unwind-protect
306 (progn
307 (unlock-buffer)
308 (find-file filename))
309 (cond ((eq obuf (current-buffer))
310 (setq buffer-file-name ofile)
311 (lock-buffer)
312 (rename-buffer oname))))
313 (or (eq (current-buffer) obuf)
314 (kill-buffer obuf))))
315
316(defun create-file-buffer (filename)
317 "Create a suitably named buffer for visiting FILENAME, and return it.
318FILENAME (sans directory) is used unchanged if that name is free;
319otherwise a string <2> or <3> or ... is appended to get an unused name."
320 (let ((lastname (file-name-nondirectory filename)))
321 (if (string= lastname "")
322 (setq lastname filename))
323 (generate-new-buffer lastname)))
324
5bbbceb1
JB
325(defun generate-new-buffer (name)
326 "Create and return a buffer with a name based on NAME.
327Choose the buffer's name using generate-new-buffer-name."
328 (get-buffer-create (generate-new-buffer-name name)))
329
e373f201
JB
330(defconst automount-dir-prefix "^/tmp_mnt/"
331 "Regexp to match the automounter prefix in a directory name.")
332
5bbbceb1
JB
333(defun abbreviate-file-name (filename)
334 "Return a version of FILENAME shortened using directory-abbrev-alist.
335This also substitutes \"~\" for the user's home directory.
336See \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201
JB
337 ;; Get rid of the prefixes added by the automounter.
338 (if (and (string-match automount-dir-prefix filename)
339 (file-exists-p (file-name-directory
340 (substring filename (1- (match-end 0))))))
341 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1
JB
342 (let ((tail directory-abbrev-alist))
343 (while tail
344 (if (string-match (car (car tail)) filename)
345 (setq filename
346 (concat (cdr (car tail)) (substring filename (match-end 0)))))
347 (setq tail (cdr tail)))
348 (if (string-match (concat "^" (expand-file-name "~")) filename)
349 (setq filename
350 (concat "~" (substring filename (match-end 0)))))
351 filename))
352
b4da00e9
RM
353(defun find-file-noselect (filename &optional nowarn)
354 "Read file FILENAME into a buffer and return the buffer.
355If a buffer exists visiting FILENAME, return that one, but
356verify that the file has not changed since visited or saved.
357The buffer is not selected, just returned to the caller."
e373f201
JB
358 (setq filename
359 (abbreviate-file-name
360 (expand-file-name filename)))
b4da00e9
RM
361 (if (file-directory-p filename)
362 (if find-file-run-dired
363 (dired-noselect filename)
364 (error "%s is a directory." filename))
365 (let ((buf (get-file-buffer filename))
366 error)
367 (if buf
368 (or nowarn
369 (verify-visited-file-modtime buf)
370 (cond ((not (file-exists-p filename))
371 (error "File %s no longer exists!" filename))
372 ((yes-or-no-p
373 (format
374 (if (buffer-modified-p buf)
375 "File %s changed on disk. Discard your edits? "
376 "File %s changed on disk. Read the new version? ")
377 (file-name-nondirectory filename)))
378 (save-excursion
379 (set-buffer buf)
380 (revert-buffer t t)))))
381 (save-excursion
382 (let* ((link-name (car (file-attributes filename)))
383 (linked-buf (and (stringp link-name)
384 (get-file-buffer link-name))))
385 (if (bufferp linked-buf)
386 (message "Symbolic link to file in buffer %s"
387 (buffer-name linked-buf))))
388 (setq buf (create-file-buffer filename))
389 (set-buffer buf)
390 (erase-buffer)
391 (condition-case ()
392 (insert-file-contents filename t)
393 (file-error
394 (setq error t)
395 ;; Run find-file-not-found-hooks until one returns non-nil.
396 (let ((hooks find-file-not-found-hooks))
397 (while (and hooks
398 (not (funcall (car hooks))))
399 (setq hooks (cdr hooks))))))
400 ;; Set buffer's default directory to that of the file.
401 (setq default-directory (file-name-directory filename))
402 ;; Turn off backup files for certain file names. Since
403 ;; this is a permanent local, the major mode won't eliminate it.
404 (and (not (funcall backup-enable-predicate buffer-file-name))
405 (progn
406 (make-local-variable 'backup-inhibited)
407 (setq backup-inhibited t)))
408 (after-find-file error (not nowarn))))
409 buf)))
410\f
411(defun after-find-file (&optional error warn)
412 "Called after finding a file and by the default revert function.
413Sets buffer mode, parses local variables.
414Optional args ERROR and WARN: ERROR non-nil means there was an
415error in reading the file. WARN non-nil means warn if there
416exists an auto-save file more recent than the visited file.
417Finishes by calling the functions in `find-file-hooks'."
418 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
419 (if noninteractive
420 nil
421 (let* (not-serious
422 (msg
423 (cond ((and error (file-attributes buffer-file-name))
424 (setq buffer-read-only t)
425 "File exists, but is read-protected.")
426 ((not buffer-read-only)
427 (if (and warn
428 (file-newer-than-file-p (make-auto-save-file-name)
429 buffer-file-name))
430 "Auto save file is newer; consider M-x recover-file"
431 (setq not-serious t)
432 (if error "(New file)" nil)))
433 ((not error)
434 (setq not-serious t)
435 "Note: file is write protected")
436 ((file-attributes (directory-file-name default-directory))
437 "File not found and directory write-protected")
438 (t
5bbbceb1
JB
439 ;; If the directory the buffer is in doesn't exist,
440 ;; offer to create it. It's better to do this now
441 ;; than when we save the buffer, because we want
442 ;; autosaving to work.
443 (setq buffer-read-only nil)
444 (or (file-exists-p (file-name-directory buffer-file-name))
445 (if (yes-or-no-p
446 (format
447 "The directory containing %s does not exist. Create? "
448 (abbreviate-file-name buffer-file-name)))
449 (make-directory-path
450 (file-name-directory buffer-file-name))))
451 nil))))
b4da00e9
RM
452 (if msg
453 (progn
454 (message msg)
455 (or not-serious (sit-for 1 nil t)))))
456 (if auto-save-default
457 (auto-save-mode t)))
458 (normal-mode t)
459 (mapcar 'funcall find-file-hooks))
460
461(defun normal-mode (&optional find-file)
462 "Choose the major mode for this buffer automatically.
463Also sets up any specified local variables of the file.
464Uses the visited file name, the -*- line, and the local variables spec.
465
466This function is called automatically from `find-file'. In that case,
467we may set up specified local variables depending on the value of
468`enable-local-variables': if it is t, we do; if it is nil, we don't;
469otherwise, we query. `enable-local-variables' is ignored if you
470run `normal-mode' explicitly."
471 (interactive)
472 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
473 (condition-case err
474 (set-auto-mode)
475 (error (message "File mode specification error: %s"
476 (prin1-to-string err))))
477 (condition-case err
7b3f3dc2
JB
478 (let ((enable-local-variables (or (not find-file)
479 enable-local-variables)))
480 (hack-local-variables))
b4da00e9
RM
481 (error (message "File local-variables error: %s"
482 (prin1-to-string err)))))
483
7b3f3dc2
JB
484(defvar auto-mode-alist (mapcar 'purecopy
485 '(("\\.text\\'" . text-mode)
486 ("\\.c\\'" . c-mode)
487 ("\\.h\\'" . c-mode)
488 ("\\.tex\\'" . TeX-mode)
489 ("\\.ltx\\'" . LaTeX-mode)
490 ("\\.el\\'" . emacs-lisp-mode)
491 ("\\.mm\\'" . nroff-mode)
492 ("\\.me\\'" . nroff-mode)
493 ("\\.[12345678]\\'" . nroff-mode)
494 ("\\.scm\\'" . scheme-mode)
495 ("\\.l\\'" . lisp-mode)
496 ("\\.lisp\\'" . lisp-mode)
497 ("\\.f\\'" . fortran-mode)
498 ("\\.for\\'" . fortran-mode)
499 ("\\.mss\\'" . scribe-mode)
500 ("\\.pl\\'" . prolog-mode)
501 ("\\.cc\\'" . c++-mode)
502 ("\\.C\\'" . c++-mode)
503;;; Less common extensions come here
504;;; so more common ones above are found faster.
505 ("\\.s\\'" . asm-mode)
506 ("ChangeLog\\'" . change-log-mode)
507 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
508 ("\\.TeX\\'" . TeX-mode)
509 ("\\.sty\\'" . LaTeX-mode)
510 ("\\.bbl\\'" . LaTeX-mode)
511 ("\\.bib\\'" . bibtex-mode)
512 ("\\.article\\'" . text-mode)
513 ("\\.letter\\'" . text-mode)
514 ("\\.texinfo\\'" . texinfo-mode)
fd5285f3 515 ("\\.texi\\'" . texinfo-mode)
7b3f3dc2
JB
516 ("\\.lsp\\'" . lisp-mode)
517 ("\\.awk\\'" . awk-mode)
518 ("\\.prolog\\'" . prolog-mode)
519 ;; Mailer puts message to be edited in
520 ;; /tmp/Re.... or Message
521 ("^/tmp/Re" . text-mode)
522 ("/Message[0-9]*\\'" . text-mode)
523 ;; some news reader is reported to use this
524 ("^/tmp/fol/" . text-mode)
525 ("\\.y\\'" . c-mode)
526 ("\\.oak\\'" . scheme-mode)
527 ("\\.scm.[0-9]*\\'" . scheme-mode)
528 ;; .emacs following a directory delimiter
529 ;; in either Unix or VMS syntax.
530 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
531 ("\\.ml\\'" . lisp-mode)))
532 "\
533Alist of filename patterns vs corresponding major mode functions.
534Each element looks like (REGEXP . FUNCTION).
535Visiting a file whose name matches REGEXP causes FUNCTION to be called.")
536
b4da00e9
RM
537(defun set-auto-mode ()
538 "Select major mode appropriate for current buffer.
7b3f3dc2
JB
539This checks for a -*- mode tag in the buffer's text, or
540compares the filename against the entries in auto-mode-alist. It does
541not check for the \"mode:\" local variable in the Local Variables
542section of the file; for that, use `hack-local-variables'.
543
544If enable-local-variables is nil, this function will not check for a
545-*- mode tag."
b4da00e9
RM
546 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
547 (let (beg end mode)
548 (save-excursion
549 (goto-char (point-min))
550 (skip-chars-forward " \t\n")
7b3f3dc2
JB
551 (if (and enable-local-variables
552 (search-forward "-*-" (save-excursion (end-of-line) (point)) t)
b4da00e9
RM
553 (progn
554 (skip-chars-forward " \t")
555 (setq beg (point))
7b3f3dc2
JB
556 (search-forward "-*-"
557 (save-excursion (end-of-line) (point))
558 t))
b4da00e9
RM
559 (progn
560 (forward-char -3)
561 (skip-chars-backward " \t")
562 (setq end (point))
563 (goto-char beg)
564 (if (search-forward ":" end t)
565 (progn
566 (goto-char beg)
567 (if (let ((case-fold-search t))
568 (search-forward "mode:" end t))
569 (progn
570 (skip-chars-forward " \t")
571 (setq beg (point))
572 (if (search-forward ";" end t)
573 (forward-char -1)
574 (goto-char end))
575 (skip-chars-backward " \t")
576 (setq mode (buffer-substring beg (point))))))
577 (setq mode (buffer-substring beg end)))))
578 (setq mode (intern (concat (downcase mode) "-mode")))
579 (let ((alist auto-mode-alist)
580 (name buffer-file-name))
581 (let ((case-fold-search (eq system-type 'vax-vms)))
582 ;; Remove backup-suffixes from file name.
583 (setq name (file-name-sans-versions name))
584 ;; Find first matching alist entry.
585 (while (and (not mode) alist)
586 (if (string-match (car (car alist)) name)
587 (setq mode (cdr (car alist))))
588 (setq alist (cdr alist)))))))
589 (if mode (funcall mode))))
590
7b3f3dc2 591(defun hack-local-variables ()
b4da00e9
RM
592 "Parse (and bind or evaluate as appropriate) any local variables
593for current buffer."
594 ;; Look for "Local variables:" line in last page.
595 (save-excursion
596 (goto-char (point-max))
597 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
598 (if (let ((case-fold-search t))
599 (and (search-forward "Local Variables:" nil t)
7b3f3dc2 600 (or (eq enable-local-variables t)
b4da00e9
RM
601 (and enable-local-variables
602 (save-window-excursion
603 (switch-to-buffer (current-buffer))
604 (save-excursion
605 (beginning-of-line)
606 (set-window-start (selected-window) (point)))
607 (y-or-n-p (format "Set local variables as specified at end of %s? "
608 (file-name-nondirectory buffer-file-name))))))))
609 (let ((continue t)
610 prefix prefixlen suffix beg)
611 ;; The prefix is what comes before "local variables:" in its line.
612 ;; The suffix is what comes after "local variables:" in its line.
613 (skip-chars-forward " \t")
614 (or (eolp)
615 (setq suffix (buffer-substring (point)
616 (progn (end-of-line) (point)))))
617 (goto-char (match-beginning 0))
618 (or (bolp)
619 (setq prefix
620 (buffer-substring (point)
621 (progn (beginning-of-line) (point)))))
7b3f3dc2 622
b4da00e9
RM
623 (if prefix (setq prefixlen (length prefix)
624 prefix (regexp-quote prefix)))
625 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
626 (while continue
627 ;; Look at next local variable spec.
628 (if selective-display (re-search-forward "[\n\C-m]")
629 (forward-line 1))
630 ;; Skip the prefix, if any.
631 (if prefix
632 (if (looking-at prefix)
633 (forward-char prefixlen)
634 (error "Local variables entry is missing the prefix")))
635 ;; Find the variable name; strip whitespace.
636 (skip-chars-forward " \t")
637 (setq beg (point))
638 (skip-chars-forward "^:\n")
639 (if (eolp) (error "Missing colon in local variables entry"))
640 (skip-chars-backward " \t")
641 (let* ((str (buffer-substring beg (point)))
642 (var (read str))
643 val)
644 ;; Setting variable named "end" means end of list.
645 (if (string-equal (downcase str) "end")
646 (setq continue nil)
647 ;; Otherwise read the variable value.
648 (skip-chars-forward "^:")
649 (forward-char 1)
650 (setq val (read (current-buffer)))
651 (skip-chars-backward "\n")
652 (skip-chars-forward " \t")
653 (or (if suffix (looking-at suffix) (eolp))
654 (error "Local variables entry is terminated incorrectly"))
655 ;; Set the variable. "Variables" mode and eval are funny.
656 (cond ((eq var 'mode)
657 (funcall (intern (concat (downcase (symbol-name val))
658 "-mode"))))
659 ((eq var 'eval)
d207b766
RS
660 (if (and (not (string= (user-login-name) "root"))
661 (or (eq enable-local-eval t)
662 (and enable-local-eval
663 (save-window-excursion
664 (switch-to-buffer (current-buffer))
665 (save-excursion
666 (beginning-of-line)
667 (set-window-start (selected-window) (point)))
668 (y-or-n-p (format "Process `eval' local variable in file %s? "
669 (file-name-nondirectory buffer-file-name)))))))
670 (save-excursion (eval val))
671 (message "Ignoring `eval:' in file's local variables")))
b4da00e9
RM
672 (t (make-local-variable var)
673 (set var val))))))))))
674\f
675(defun set-visited-file-name (filename)
676 "Change name of file visited in current buffer to FILENAME.
677The next time the buffer is saved it will go in the newly specified file.
678nil or empty string as argument means make buffer not be visiting any file.
679Remember to delete the initial contents of the minibuffer
680if you wish to pass an empty string as the argument."
681 (interactive "FSet visited file name: ")
682 (if filename
683 (setq filename
684 (if (string-equal filename "")
685 nil
686 (expand-file-name filename))))
687 (or (equal filename buffer-file-name)
688 (null filename)
689 (progn
690 (lock-buffer filename)
691 (unlock-buffer)))
692 (setq buffer-file-name filename)
693 (if filename ; make buffer name reflect filename.
5bbbceb1 694 (let ((new-name (file-name-nondirectory buffer-file-name)))
b4da00e9
RM
695 (if (string= new-name "")
696 (error "Empty file name"))
697 (if (eq system-type 'vax-vms)
698 (setq new-name (downcase new-name)))
699 (setq default-directory (file-name-directory buffer-file-name))
5bbbceb1 700 (rename-buffer new-name t)))
b4da00e9
RM
701 (setq buffer-backed-up nil)
702 (clear-visited-file-modtime)
703 ;; write-file-hooks is normally used for things like ftp-find-file
704 ;; that visit things that are not local files as if they were files.
705 ;; Changing to visit an ordinary local file instead should flush the hook.
706 (kill-local-variable 'write-file-hooks)
707 (kill-local-variable 'revert-buffer-function)
708 (kill-local-variable 'backup-inhibited)
709 ;; Turn off backup files for certain file names.
710 ;; Since this is a permanent local, the major mode won't eliminate it.
711 (and (not (funcall backup-enable-predicate buffer-file-name))
712 (progn
713 (make-local-variable 'backup-inhibited)
714 (setq backup-inhibited t)))
715 ;; If auto-save was not already on, turn it on if appropriate.
716 (if (not buffer-auto-save-file-name)
717 (auto-save-mode (and buffer-file-name auto-save-default)))
718 (if buffer-file-name
719 (set-buffer-modified-p t)))
720
721(defun write-file (filename)
722 "Write current buffer into file FILENAME.
723Makes buffer visit that file, and marks it not modified."
724;; (interactive "FWrite file: ")
725 (interactive
726 (list (if buffer-file-name
727 (read-file-name "Write file: "
728 nil nil nil nil)
729 (read-file-name "Write file: "
730 (cdr (assq 'default-directory
731 (buffer-local-variables)))
732 nil nil (buffer-name)))))
733 (or (null filename) (string-equal filename "")
734 (set-visited-file-name filename))
735 (set-buffer-modified-p t)
736 (save-buffer))
737\f
738(defun backup-buffer ()
739 "Make a backup of the disk file visited by the current buffer, if appropriate.
740This is normally done before saving the buffer the first time.
741If the value is non-nil, it is the result of `file-modes' on the original
742file; this means that the caller, after saving the buffer, should change
743the modes of the new file to agree with the old modes."
744 (if (and make-backup-files (not backup-inhibited)
745 (not buffer-backed-up)
746 (file-exists-p buffer-file-name)
747 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
748 '(?- ?l)))
749 (let ((real-file-name buffer-file-name)
750 backup-info backupname targets setmodes)
751 ;; If specified name is a symbolic link, chase it to the target.
752 ;; Thus we make the backups in the directory where the real file is.
753 (while (let ((tem (file-symlink-p real-file-name)))
754 (if tem
755 (setq real-file-name
756 (expand-file-name tem
757 (file-name-directory real-file-name))))
758 tem))
759 (setq backup-info (find-backup-file-name real-file-name)
760 backupname (car backup-info)
761 targets (cdr backup-info))
762;;; (if (file-directory-p buffer-file-name)
763;;; (error "Cannot save buffer in directory %s" buffer-file-name))
764 (condition-case ()
765 (let ((delete-old-versions
766 ;; If have old versions to maybe delete,
767 ;; ask the user to confirm now, before doing anything.
768 ;; But don't actually delete til later.
769 (and targets
6d74b528 770 (or (eq trim-versions-without-asking t) (eq trim-versions-without-asking nil))
b4da00e9
RM
771 (or trim-versions-without-asking
772 (y-or-n-p (format "Delete excess backup versions of %s? "
773 real-file-name))))))
774 ;; Actually write the back up file.
775 (condition-case ()
776 (if (or file-precious-flag
777; (file-symlink-p buffer-file-name)
778 backup-by-copying
779 (and backup-by-copying-when-linked
780 (> (file-nlinks real-file-name) 1))
781 (and backup-by-copying-when-mismatch
782 (let ((attr (file-attributes real-file-name)))
783 (or (nth 9 attr)
784 (/= (nth 2 attr) (user-uid))))))
785 (copy-file real-file-name backupname t t)
786; rename-file should delete old backup.
787; (condition-case ()
788; (delete-file backupname)
789; (file-error nil))
790 (rename-file real-file-name backupname t)
791 (setq setmodes (file-modes backupname)))
792 (file-error
793 ;; If trouble writing the backup, write it in ~.
794 (setq backupname (expand-file-name "~/%backup%~"))
795 (message "Cannot write backup file; backing up in ~/%%backup%%~")
796 (sleep-for 1)
797 (copy-file real-file-name backupname t t)))
798 (setq buffer-backed-up t)
799 ;; Now delete the old versions, if desired.
800 (if delete-old-versions
801 (while targets
802 (condition-case ()
803 (delete-file (car targets))
804 (file-error nil))
805 (setq targets (cdr targets))))
806 setmodes)
807 (file-error nil)))))
808
809(defun file-name-sans-versions (name)
810 "Return FILENAME sans backup versions or strings.
811This is a separate procedure so your site-init or startup file can
812redefine it."
813 (substring name 0
814 (if (eq system-type 'vax-vms)
815 ;; VMS version number is (a) semicolon, optional
816 ;; sign, zero or more digits or (b) period, option
817 ;; sign, zero or more digits, provided this is the
818 ;; second period encountered outside of the
819 ;; device/directory part of the file name.
820 (or (string-match ";[---+]?[0-9]*\\'" name)
821 (if (string-match "\\.[^]>:]*\\(\\.[---+]?[0-9]*\\)\\'"
822 name)
823 (match-beginning 1))
824 (length name))
825 (or (string-match "\\.~[0-9]+~\\'" name)
826 (string-match "~\\'" name)
827 (length name)))))
828
829(defun make-backup-file-name (file)
830 "Create the non-numeric backup file name for FILE.
831This is a separate function so you can redefine it for customization."
832 (concat file "~"))
833
834(defun backup-file-name-p (file)
835 "Return non-nil if FILE is a backup file name (numeric or not).
836This is a separate function so you can redefine it for customization.
837You may need to redefine `file-name-sans-versions' as well."
838 (string-match "~$" file))
839
840;; I believe there is no need to alter this behavior for VMS;
841;; since backup files are not made on VMS, it should not get called.
842(defun find-backup-file-name (fn)
843 "Find a file name for a backup file, and suggestions for deletions.
844Value is a list whose car is the name for the backup file
845 and whose cdr is a list of old versions to consider deleting now."
846 (if (eq version-control 'never)
847 (list (make-backup-file-name fn))
848 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
849 (bv-length (length base-versions))
850 (possibilities (file-name-all-completions
851 base-versions
852 (file-name-directory fn)))
79058860
JB
853 (versions (sort (mapcar
854 (function
855 (lambda (fn)
856 (if (and (string-match "[0-9]+~$" fn bv-length)
857 (= (match-beginning 0) bv-length))
858 (string-to-int (substring fn bv-length -1))
859 0)))
860 possibilities)
b4da00e9 861 '<))
5bbbceb1 862 (high-water-mark (apply 'max 0 versions))
b4da00e9
RM
863 (deserve-versions-p
864 (or version-control
865 (> high-water-mark 0)))
866 (number-to-delete (- (length versions)
867 kept-old-versions kept-new-versions -1)))
868 (if (not deserve-versions-p)
869 (list (make-backup-file-name fn))
870 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
871 (if (> number-to-delete 0)
872 (mapcar (function (lambda (n)
873 (concat fn ".~" (int-to-string n) "~")))
874 (let ((v (nthcdr kept-old-versions versions)))
875 (rplacd (nthcdr (1- number-to-delete) v) ())
876 v))))))))
877
b4da00e9
RM
878(defun file-nlinks (filename)
879 "Return number of names file FILENAME has."
880 (car (cdr (file-attributes filename))))
881\f
882(defun save-buffer (&optional args)
883 "Save current buffer in visited file if modified. Versions described below.
884By default, makes the previous version into a backup file
885 if previously requested or if this is the first save.
886With 1 or 3 \\[universal-argument]'s, marks this version
887 to become a backup when the next save is done.
888With 2 or 3 \\[universal-argument]'s,
889 unconditionally makes the previous version into a backup file.
890With argument of 0, never makes the previous version into a backup file.
891
892If a file's name is FOO, the names of its numbered backup versions are
893 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
894Numeric backups (rather than FOO~) will be made if value of
895 `version-control' is not the atom `never' and either there are already
896 numeric versions of the file being backed up, or `version-control' is
897 non-nil.
898We don't want excessive versions piling up, so there are variables
899 `kept-old-versions', which tells Emacs how many oldest versions to keep,
900 and `kept-new-versions', which tells how many newest versions to keep.
901 Defaults are 2 old versions and 2 new.
902`dired-kept-versions' controls dired's clean-directory (.) command.
903If `trim-versions-without-asking' is nil, system will query user
904 before trimming versions. Otherwise it does it silently."
905 (interactive "p")
906 (let ((modp (buffer-modified-p))
907 (large (> (buffer-size) 50000))
908 (make-backup-files (and make-backup-files (not (eq args 0)))))
909 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
910 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
911 (basic-save-buffer)
912 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
913
914(defun delete-auto-save-file-if-necessary (&optional force)
915 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
916Normally delete only if the file was written by this Emacs since
917the last real save, but optional arg FORCE non-nil means delete anyway."
918 (and buffer-auto-save-file-name delete-auto-save-files
919 (not (string= buffer-file-name buffer-auto-save-file-name))
920 (or force (recent-auto-save-p))
921 (progn
922 (condition-case ()
923 (delete-file buffer-auto-save-file-name)
924 (file-error nil))
925 (set-buffer-auto-saved))))
926
927(defun basic-save-buffer ()
928 "Save the current buffer in its visited file, if it has been modified."
929 (interactive)
930 (if (buffer-modified-p)
931 (let ((recent-save (recent-auto-save-p))
932 setmodes tempsetmodes)
933 ;; On VMS, rename file and buffer to get rid of version number.
934 (if (and (eq system-type 'vax-vms)
935 (not (string= buffer-file-name
936 (file-name-sans-versions buffer-file-name))))
937 (let (buffer-new-name)
938 ;; Strip VMS version number before save.
939 (setq buffer-file-name
940 (file-name-sans-versions buffer-file-name))
941 ;; Construct a (unique) buffer name to correspond.
942 (let ((buf (create-file-buffer (downcase buffer-file-name))))
943 (setq buffer-new-name (buffer-name buf))
944 (kill-buffer buf))
945 (rename-buffer buffer-new-name)))
946 ;; If buffer has no file name, ask user for one.
947 (or buffer-file-name
948 (progn
949 (setq buffer-file-name
950 (expand-file-name (read-file-name "File to save in: ") nil)
951 default-directory (file-name-directory buffer-file-name))
952 (auto-save-mode auto-save-default)))
953 (or (verify-visited-file-modtime (current-buffer))
954 (not (file-exists-p buffer-file-name))
955 (yes-or-no-p
956 (format "%s has changed since visited or saved. Save anyway? "
957 (file-name-nondirectory buffer-file-name)))
958 (error "Save not confirmed"))
959 (save-restriction
960 (widen)
961 (and (> (point-max) 1)
962 (/= (char-after (1- (point-max))) ?\n)
963 (or (eq require-final-newline t)
964 (and require-final-newline
965 (y-or-n-p
966 (format "Buffer %s does not end in newline. Add one? "
967 (buffer-name)))))
968 (save-excursion
969 (goto-char (point-max))
970 (insert ?\n)))
8c0e7b73 971 (let ((hooks (append write-contents-hooks write-file-hooks))
b4da00e9
RM
972 (done nil))
973 (while (and hooks
974 (not (setq done (funcall (car hooks)))))
975 (setq hooks (cdr hooks)))
976 ;; If a hook returned t, file is already "written".
977 (cond ((not done)
978 (if (not (file-writable-p buffer-file-name))
979 (let ((dir (file-name-directory buffer-file-name)))
980 (if (not (file-directory-p dir))
981 (error "%s is not a directory" dir)
982 (if (not (file-exists-p buffer-file-name))
983 (error "Directory %s write-protected" dir)
984 (if (yes-or-no-p
985 (format "File %s is write-protected; try to save anyway? "
986 (file-name-nondirectory
987 buffer-file-name)))
988 (setq tempsetmodes t)
989 (error "Attempt to save to a file which you aren't allowed to write"))))))
990 (or buffer-backed-up
991 (setq setmodes (backup-buffer)))
992 (if file-precious-flag
993 ;; If file is precious, rename it away before
994 ;; overwriting it.
995 (let ((rename t)
996 realname tempname temp)
997 ;; Chase symlinks; rename the ultimate actual file.
998 (setq realname buffer-file-name)
999 (while (setq temp (file-symlink-p realname))
1000 (setq realname temp))
1001 (setq tempname (concat realname "#"))
1002 (condition-case ()
1003 (progn (rename-file realname tempname t)
1004 (setq setmodes (file-modes tempname)))
1005 (file-error (setq rename nil tempname nil)))
1006 (if (file-directory-p realname)
1007 (error "%s is a directory" realname))
1008 (unwind-protect
1009 (progn (clear-visited-file-modtime)
1010 (write-region (point-min) (point-max)
1011 realname nil t)
1012 (setq rename nil))
1013 ;; If rename is still t, writing failed.
1014 ;; So rename the old file back to original name,
1015 (if rename
1016 (progn
1017 (rename-file tempname realname t)
1018 (clear-visited-file-modtime))
1019 ;; Otherwise we don't need the original file,
1020 ;; so flush it, if we still have it.
1021 ;; If rename failed due to name length restriction
1022 ;; then TEMPNAME is now nil.
1023 (if tempname
1024 (condition-case ()
1025 (delete-file tempname)
1026 (error nil))))))
1027 ;; If file not writable, see if we can make it writable
1028 ;; temporarily while we write it.
1029 ;; But no need to do so if we have just backed it up
1030 ;; (setmodes is set) because that says we're superseding.
1031 (cond ((and tempsetmodes (not setmodes))
1032 ;; Change the mode back, after writing.
1033 (setq setmodes (file-modes buffer-file-name))
1034 (set-file-modes buffer-file-name 511)))
1035 (write-region (point-min) (point-max)
1036 buffer-file-name nil t)))))
1037 (if setmodes
1038 (condition-case ()
1039 (set-file-modes buffer-file-name setmodes)
1040 (error nil))))
1041 ;; If the auto-save file was recent before this command,
1042 ;; delete it now.
1043 (delete-auto-save-file-if-necessary recent-save)
1044 (run-hooks 'after-save-hooks))
1045 (message "(No changes need to be saved)")))
1046
b4da00e9
RM
1047(defun save-some-buffers (&optional arg exiting)
1048 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
1049Optional argument (the prefix) non-nil means save all with no questions.
1050Optional second argument EXITING means ask about certain non-file buffers
1051 as well as about file buffers."
b4da00e9 1052 (interactive "P")
b5e86cb3
RM
1053 (save-excursion
1054 (if (zerop (map-y-or-n-p
1055 (function
1056 (lambda (buffer)
1057 (and (buffer-modified-p buffer)
1058 (or
1059 (buffer-file-name buffer)
1060 (and exiting
1061 (progn
1062 (set-buffer buffer)
1063 (and buffer-offer-save (> (buffer-size) 0)))))
1064 (if arg
1065 t
1066 (if (buffer-file-name buffer)
1067 (format "Save file %s? "
1068 (buffer-file-name buffer))
1069 (format "Save buffer %s? "
1070 (buffer-name buffer)))))))
1071 (function
1072 (lambda (buffer)
e065a56e
JB
1073 (set-buffer buffer)
1074 (save-buffer)))
b5e86cb3
RM
1075 (buffer-list)
1076 '("buffer" "buffers" "save")))
1077 (message "(No files need saving)"))))
b4da00e9
RM
1078\f
1079(defun not-modified (&optional arg)
1080 "Mark current buffer as unmodified, not needing to be saved.
1081With prefix arg, mark buffer as modified, so \\[save-buffer] will save."
1082 (interactive "P")
1083 (message (if arg "Modification-flag set"
1084 "Modification-flag cleared"))
1085 (set-buffer-modified-p arg))
1086
1087(defun toggle-read-only (&optional arg)
1088 "Change whether this buffer is visiting its file read-only.
1089With arg, set read-only iff arg is positive."
1090 (interactive "P")
1091 (setq buffer-read-only
1092 (if (null arg)
1093 (not buffer-read-only)
1094 (> (prefix-numeric-value arg) 0)))
1095 ;; Force mode-line redisplay
1096 (set-buffer-modified-p (buffer-modified-p)))
1097
1098(defun insert-file (filename)
1099 "Insert contents of file FILENAME into buffer after point.
1100Set mark after the inserted text.
1101
1102This function is meant for the user to run interactively.
1103Don't call it from programs! Use `insert-file-contents' instead.
1104\(Its calling sequence is different; see its documentation)."
1105 (interactive "fInsert file: ")
1106 (let ((tem (insert-file-contents filename)))
1107 (push-mark (+ (point) (car (cdr tem))))))
1108
1109(defun append-to-file (start end filename)
1110 "Append the contents of the region to the end of file FILENAME.
1111When called from a function, expects three arguments,
1112START, END and FILENAME. START and END are buffer positions
1113saying what text to write."
1114 (interactive "r\nFAppend to file: ")
1115 (write-region start end filename t))
1116
1117(defun file-newest-backup (filename)
1118 "Return most recent backup file for FILENAME or nil if no backups exist."
1119 (let* ((filename (expand-file-name filename))
1120 (file (file-name-nondirectory filename))
1121 (dir (file-name-directory filename))
1122 (comp (file-name-all-completions file dir))
1123 newest)
1124 (while comp
1125 (setq file (concat dir (car comp))
1126 comp (cdr comp))
1127 (if (and (backup-file-name-p file)
1128 (or (null newest) (file-newer-than-file-p file newest)))
1129 (setq newest file)))
1130 newest))
1131
1132(defun rename-uniquely ()
1133 "Rename current buffer to a similar name not already taken.
1134This function is useful for creating multiple shell process buffers
1135or multiple mail buffers, etc."
1136 (interactive)
1137 (let* ((new-buf (generate-new-buffer (buffer-name)))
1138 (name (buffer-name new-buf)))
1139 (kill-buffer new-buf)
1140 (rename-buffer name)
1141 (set-buffer-modified-p (buffer-modified-p)))) ; force mode line update
5bbbceb1
JB
1142
1143(defun make-directory-path (path)
1144 "Create all the directories along path that don't exist yet."
1145 (interactive "Fdirectory path to create: ")
1146 (let ((path (directory-file-name (expand-file-name path)))
1147 create-list)
1148 (while (not (file-exists-p path))
1149 (setq create-list (cons path create-list)
1150 path (directory-file-name (file-name-directory path))))
1151 (while create-list
1152 (make-directory (car create-list))
1153 (setq create-list (cdr create-list)))))
1154
b4da00e9
RM
1155\f
1156(put 'revert-buffer-function 'permanent-local t)
1157(defvar revert-buffer-function nil
1158 "Function to use to revert this buffer, or nil to do the default.")
1159
1160(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
1161(defvar revert-buffer-insert-file-contents-function nil
1162 "Function to use to insert contents when reverting this buffer.
1163Gets two args, first the nominal file name to use,
1164and second, t if reading the auto-save file.")
1165
8c0e7b73 1166(defun revert-buffer (&optional check-auto noconfirm)
b4da00e9
RM
1167 "Replace the buffer text with the text of the visited file on disk.
1168This undoes all changes since the file was visited or saved.
8c0e7b73
JB
1169With a prefix argument, offer to revert from latest auto-save file, if
1170that is more recent than the visited file.
1171When called from lisp, this is the first argument, CHECK-AUTO; it is optional.
b4da00e9
RM
1172Optional second argument NOCONFIRM means don't ask for confirmation at all.
1173
8c0e7b73
JB
1174If the value of `revert-buffer-function' is non-nil, it is called to
1175do the work."
b4da00e9
RM
1176 (interactive "P")
1177 (if revert-buffer-function
8c0e7b73 1178 (funcall revert-buffer-function (not check-auto) noconfirm)
b4da00e9 1179 (let* ((opoint (point))
8c0e7b73 1180 (auto-save-p (and check-auto (recent-auto-save-p)
b4da00e9
RM
1181 buffer-auto-save-file-name
1182 (file-readable-p buffer-auto-save-file-name)
1183 (y-or-n-p
1184 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
1185 (file-name (if auto-save-p
1186 buffer-auto-save-file-name
1187 buffer-file-name)))
1188 (cond ((null file-name)
1189 (error "Buffer does not seem to be associated with any file"))
1190 ((or noconfirm
1191 (yes-or-no-p (format "Revert buffer from file %s? "
1192 file-name)))
1193 ;; If file was backed up but has changed since,
1194 ;; we shd make another backup.
1195 (and (not auto-save-p)
5bbbceb1 1196 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
1197 (setq buffer-backed-up nil))
1198 ;; Get rid of all undo records for this buffer.
1199 (or (eq buffer-undo-list t)
1200 (setq buffer-undo-list nil))
1201 (let ((buffer-read-only nil)
1202 ;; Don't make undo records for the reversion.
1203 (buffer-undo-list t))
1204 (if revert-buffer-insert-file-contents-function
1205 (funcall revert-buffer-insert-file-contents-function
1206 file-name auto-save-p)
1207 (if (not (file-exists-p file-name))
1208 (error "File %s no longer exists!" file-name))
1209 ;; Bind buffer-file-name to nil
1210 ;; so that we don't try to lock the file.
1211 (let ((buffer-file-name nil))
1212 (or auto-save-p
1213 (unlock-buffer))
1214 (erase-buffer))
1215 (insert-file-contents file-name (not auto-save-p))))
1216 (goto-char (min opoint (point-max)))
1217 (after-find-file nil)
1218 t)))))
1219
1220(defun recover-file (file)
1221 "Visit file FILE, but get contents from its last auto-save file."
1222 (interactive
1223 (let ((prompt-file buffer-file-name)
1224 (file-name nil)
1225 (file-dir nil))
1226 (and prompt-file
1227 (setq file-name (file-name-nondirectory prompt-file)
1228 file-dir (file-name-directory prompt-file)))
1229 (list (read-file-name "Recover file: "
1230 file-dir nil nil file-name))))
1231 (setq file (expand-file-name file))
1232 (if (auto-save-file-name-p file) (error "%s is an auto-save file" file))
1233 (let ((file-name (let ((buffer-file-name file))
1234 (make-auto-save-file-name))))
1235 (cond ((not (file-newer-than-file-p file-name file))
1236 (error "Auto-save file %s not current" file-name))
1237 ((save-window-excursion
1238 (if (not (eq system-type 'vax-vms))
1239 (with-output-to-temp-buffer "*Directory*"
1240 (buffer-disable-undo standard-output)
1241 (call-process "ls" nil standard-output nil
2dc2b736
RS
1242 (if (file-symlink-p file) "-lL" "-l")
1243 file file-name)))
b4da00e9
RM
1244 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
1245 (switch-to-buffer (find-file-noselect file t))
1246 (let ((buffer-read-only nil))
1247 (erase-buffer)
1248 (insert-file-contents file-name nil))
1249 (after-find-file nil))
1250 (t (error "Recover-file cancelled.")))))
1251
1252(defun kill-some-buffers ()
1253 "For each buffer, ask whether to kill it."
1254 (interactive)
1255 (let ((list (buffer-list)))
1256 (while list
1257 (let* ((buffer (car list))
1258 (name (buffer-name buffer)))
1259 (and (not (string-equal name ""))
1260 (/= (aref name 0) ? )
1261 (yes-or-no-p
1262 (format "Buffer %s %s. Kill? "
1263 name
1264 (if (buffer-modified-p buffer)
1265 "HAS BEEN EDITED" "is unmodified")))
1266 (kill-buffer buffer)))
1267 (setq list (cdr list)))))
1268\f
1269(defun auto-save-mode (arg)
1270 "Toggle auto-saving of contents of current buffer.
1271With ARG, turn auto-saving on if positive, else off."
1272 (interactive "P")
1273 (setq buffer-auto-save-file-name
1274 (and (if (null arg)
1275 (not buffer-auto-save-file-name)
1276 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
1277 (if (and buffer-file-name auto-save-visited-file-name
1278 (not buffer-read-only))
1279 buffer-file-name
1280 (make-auto-save-file-name))))
1281 (if (interactive-p)
1282 (message "Auto-save %s (in this buffer)"
1283 (if buffer-auto-save-file-name "on" "off")))
1284 buffer-auto-save-file-name)
1285
1286(defun rename-auto-save-file ()
1287 "Adjust current buffer's auto save file name for current conditions.
1288Also rename any existing auto save file, if it was made in this session."
1289 (let ((osave buffer-auto-save-file-name))
1290 (setq buffer-auto-save-file-name
1291 (make-auto-save-file-name))
1292 (if (and osave buffer-auto-save-file-name
1293 (not (string= buffer-auto-save-file-name buffer-file-name))
1294 (not (string= buffer-auto-save-file-name osave))
1295 (file-exists-p osave)
1296 (recent-auto-save-p))
1297 (rename-file osave buffer-auto-save-file-name t))))
1298
1299(defun make-auto-save-file-name ()
1300 "Return file name to use for auto-saves of current buffer.
1301Does not consider `auto-save-visited-file-name' as that variable is checked
1302before calling this function. You can redefine this for customization.
1303See also `auto-save-file-name-p'."
1304 (if buffer-file-name
1305 (concat (file-name-directory buffer-file-name)
1306 "#"
1307 (file-name-nondirectory buffer-file-name)
1308 "#")
1309 ;; For non-file bfr, use bfr name and Emacs pid.
1310 (expand-file-name (format "#%s#%s#" (buffer-name) (make-temp-name "")))))
1311
1312(defun auto-save-file-name-p (filename)
1313 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
1314FILENAME should lack slashes. You can redefine this for customization."
1315 (string-match "^#.*#$" filename))
1316\f
1317(defconst list-directory-brief-switches
1318 (if (eq system-type 'vax-vms) "" "-CF")
1319 "*Switches for list-directory to pass to `ls' for brief listing,")
1320
1321(defconst list-directory-verbose-switches
1322 (if (eq system-type 'vax-vms)
1323 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
1324 "-l")
1325 "*Switches for list-directory to pass to `ls' for verbose listing,")
1326
1327(defun list-directory (dirname &optional verbose)
1328 "Display a list of files in or matching DIRNAME, a la `ls'.
1329DIRNAME is globbed by the shell if necessary.
1330Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
1331Actions controlled by variables `list-directory-brief-switches'
1332and `list-directory-verbose-switches'."
1333 (interactive (let ((pfx current-prefix-arg))
1334 (list (read-file-name (if pfx "List directory (verbose): "
1335 "List directory (brief): ")
1336 nil default-directory nil)
1337 pfx)))
1338 (let ((switches (if verbose list-directory-verbose-switches
1339 list-directory-brief-switches)))
1340 (or dirname (setq dirname default-directory))
1341 (setq dirname (expand-file-name dirname))
1342 (with-output-to-temp-buffer "*Directory*"
1343 (buffer-disable-undo standard-output)
1344 (princ "Directory ")
1345 (princ dirname)
1346 (terpri)
1347 (if (eq system-type 'vax-vms)
1348 (vms-read-directory dirname switches standard-output)
1349 (if (file-directory-p dirname)
1350 (save-excursion
1351 (set-buffer "*Directory*")
1352 (call-process "ls" nil standard-output nil switches
1353 (setq default-directory
1354 (file-name-as-directory dirname))))
1355 (let ((default-directory (file-name-directory dirname)))
1356 (if (file-exists-p default-directory)
1357 (call-process shell-file-name nil standard-output nil
1358 "-c" (concat "exec ls "
1359 switches " "
1360 (file-name-nondirectory dirname)))
1361 (princ "No such directory: ")
1362 (princ dirname)
1363 (terpri))))))))
1364
1365(defun save-buffers-kill-emacs (&optional arg)
1366 "Offer to save each buffer, then kill this Emacs process.
1367With prefix arg, silently save all file-visiting buffers, then kill."
1368 (interactive "P")
1369 (save-some-buffers arg t)
1370 (and (or (not (memq t (mapcar (function
1371 (lambda (buf) (and (buffer-file-name buf)
1372 (buffer-modified-p buf))))
1373 (buffer-list))))
1374 (yes-or-no-p "Modified buffers exist; exit anyway? "))
1375 (or (not (fboundp 'process-list))
1376 ;; process-list is not defined on VMS.
1377 (let ((processes (process-list))
1378 active)
1379 (while processes
528415e7 1380 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
1381 (let ((val (process-kill-without-query (car processes))))
1382 (process-kill-without-query (car processes) val)
1383 val)
1384 (setq active t))
1385 (setq processes (cdr processes)))
1386 (or (not active)
1387 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
1388 (kill-emacs)))
1389\f
1390(define-key ctl-x-map "\C-f" 'find-file)
1391(define-key ctl-x-map "\C-q" 'toggle-read-only)
1392(define-key ctl-x-map "\C-r" 'find-file-read-only)
1393(define-key ctl-x-map "\C-v" 'find-alternate-file)
1394(define-key ctl-x-map "\C-s" 'save-buffer)
1395(define-key ctl-x-map "s" 'save-some-buffers)
1396(define-key ctl-x-map "\C-w" 'write-file)
1397(define-key ctl-x-map "i" 'insert-file)
1398(define-key esc-map "~" 'not-modified)
1399(define-key ctl-x-map "\C-d" 'list-directory)
1400(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
1401
1402(define-key ctl-x-4-map "f" 'find-file-other-window)
1403(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
1404(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
1405(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
35aaf00c 1406(define-key ctl-x-4-map "o" 'display-buffer)
5bbbceb1 1407
f98955ea
JB
1408(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
1409(define-key ctl-x-5-map "f" 'find-file-other-frame)
1410(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
1411(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
1412
1413;;; files.el ends here