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