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