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