Disable scrollbars until fully functional.
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
a641f9a1 3;; Copyright (C) 1985, 86, 87, 92, 93, 94, 1995 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 31(defconst delete-auto-save-files t
d1739e52 32 "*Non-nil means delete auto-save file when a buffer is saved or killed.")
b4da00e9
RM
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
65151a1b
RS
42Do not use `~' in the TO strings.
43They should be ordinary absolute directory names.
44
b4da00e9
RM
45Use this feature when you have directories which you normally refer to
46via absolute symbolic links. Make TO the name of the link, and FROM
47the name it is linked to.")
48
49;;; Turn off backup files on VMS since it has version numbers.
50(defconst make-backup-files (not (eq system-type 'vax-vms))
4ea836c1 51 "*Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
52This can be done by renaming the file or by copying.
53
54Renaming means that Emacs renames the existing file so that it is a
55backup file, then writes the buffer into a new file. Any other names
56that the old file had will now refer to the backup file. The new file
57is owned by you and its group is defaulted.
58
59Copying means that Emacs copies the existing file into the backup
60file, then writes the buffer on top of the existing file. Any other
61names that the old file had will now refer to the new (edited) file.
62The file's owner and group are unchanged.
63
64The choice of renaming or copying is controlled by the variables
65`backup-by-copying', `backup-by-copying-when-linked' and
f862241d 66`backup-by-copying-when-mismatch'. See also `backup-inhibited'.")
b4da00e9
RM
67
68;; Do this so that local variables based on the file name
69;; are not overridden by the major mode.
70(defvar backup-inhibited nil
f862241d
RS
71 "Non-nil means don't make a backup, regardless of the other parameters.
72This variable is intended for use by making it local to a buffer.
73But it is local only if you make it local.")
b4da00e9
RM
74(put 'backup-inhibited 'permanent-local t)
75
76(defconst backup-by-copying nil
77 "*Non-nil means always use copying to create backup files.
78See documentation of variable `make-backup-files'.")
79
80(defconst backup-by-copying-when-linked nil
81 "*Non-nil means use copying to create backups for files with multiple names.
82This causes the alternate names to refer to the latest version as edited.
83This variable is relevant only if `backup-by-copying' is nil.")
84
85(defconst backup-by-copying-when-mismatch nil
86 "*Non-nil means create backups by copying if this preserves owner or group.
87Renaming may still be used (subject to control of other variables)
88when it would not result in changing the owner or group of the file;
89that is, for files which are owned by you and whose group matches
90the default for a new file created there by you.
91This variable is relevant only if `backup-by-copying' is nil.")
92
93(defvar backup-enable-predicate
94 '(lambda (name)
95 (or (< (length name) 5)
96 (not (string-equal "/tmp/" (substring name 0 5)))))
97 "Predicate that looks at a file name and decides whether to make backups.
98Called with an absolute file name as argument, it returns t to enable backup.")
99
100(defconst buffer-offer-save nil
101 "*Non-nil in a buffer means offer to save the buffer on exit
102even if the buffer is not visiting a file.
103Automatically local in all buffers.")
104(make-variable-buffer-local 'buffer-offer-save)
105
f3e23606
RS
106(defconst find-file-existing-other-name nil
107 "*Non-nil means find a file under alternative names, in existing buffers.
108This means if any existing buffer is visiting the file you want
109under another name, you get the existing buffer instead of a new buffer.")
110
111(defconst find-file-visit-truename nil
112 "*Non-nil means visit a file under its truename.
113The truename of a file is found by chasing all links
114both at the file level and at the levels of the containing directories.")
115
f3e23606
RS
116(defvar buffer-file-number nil
117 "The device number and file number of the file visited in the current buffer.
118The value is a list of the form (FILENUM DEVNUM).
119This pair of numbers uniquely identifies the file.
120If the buffer is visiting a new file, the value is nil.")
121(make-variable-buffer-local 'buffer-file-number)
122(put 'buffer-file-number 'permanent-local t)
123
b4da00e9
RM
124(defconst file-precious-flag nil
125 "*Non-nil means protect against I/O errors while saving files.
560f4415 126Some modes set this non-nil in particular buffers.
4b7271c1
KH
127
128This feature works by writing the new contents into a temporary file
129and then renaming the temporary file to replace the original.
130In this way, any I/O error in writing leaves the original untouched,
131and there is never any instant where the file is nonexistent.
132
133Note that this feature forces backups to be made by copying.
560f4415
KH
134Yet, at the same time, saving a precious file
135breaks any hard links between it and other files.")
b4da00e9
RM
136
137(defvar version-control nil
138 "*Control use of version numbers for backup files.
139t means make numeric backup versions unconditionally.
140nil means make them for files that have some already.
399f8dd6 141`never' means do not make them.")
b4da00e9
RM
142
143(defvar dired-kept-versions 2
144 "*When cleaning directory, number of versions to keep.")
145
de7d5e1b
RS
146(defvar delete-old-versions nil
147 "*If t, delete excess backup versions silently.
148If nil, ask confirmation. Any other value prevents any trimming.")
b4da00e9
RM
149
150(defvar kept-old-versions 2
151 "*Number of oldest versions to keep when a new numbered backup is made.")
152
153(defvar kept-new-versions 2
154 "*Number of newest versions to keep when a new numbered backup is made.
155Includes the new backup. Must be > 0")
156
157(defconst require-final-newline nil
158 "*Value of t says silently ensure a file ends in a newline when it is saved.
159Non-nil but not t says ask user whether to add a newline when there isn't one.
160nil means don't add newlines.")
161
162(defconst auto-save-default t
163 "*Non-nil says by default do auto-saving of every file-visiting buffer.")
164
165(defconst auto-save-visited-file-name nil
166 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
167Normally auto-save files are written under other names.")
168
169(defconst save-abbrevs nil
170 "*Non-nil means save word abbrevs too when files are saved.
171Loading an abbrev file sets this to t.")
172
173(defconst find-file-run-dired t
320b4233 174 "*Non-nil says run dired if `find-file' is given the name of a directory.")
b4da00e9 175
92966e6f
RS
176;;;It is not useful to make this a local variable.
177;;;(put 'find-file-not-found-hooks 'permanent-local t)
b4da00e9
RM
178(defvar find-file-not-found-hooks nil
179 "List of functions to be called for `find-file' on nonexistent file.
180These functions are called as soon as the error is detected.
181`buffer-file-name' is already set up.
182The functions are called in the order given until one of them returns non-nil.")
183
92966e6f
RS
184;;;It is not useful to make this a local variable.
185;;;(put 'find-file-hooks 'permanent-local t)
b4da00e9
RM
186(defvar find-file-hooks nil
187 "List of functions to be called after a buffer is loaded from a file.
188The buffer's local variables (if any) will have been processed before the
189functions are called.")
190
b4da00e9
RM
191(defvar write-file-hooks nil
192 "List of functions to be called before writing out a buffer to a file.
193If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
194and the rest are not called.
195These hooks are considered to pertain to the visited file.
196So this list is cleared if you change the visited file name.
c9dca4e0
RS
197See also `write-contents-hooks'.
198Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
b19f1da4
BF
199;;; However, in case someone does make it local...
200(put 'write-file-hooks 'permanent-local t)
c9dca4e0 201
c9dca4e0
RS
202(defvar local-write-file-hooks nil
203 "Just like `write-file-hooks', except intended for per-buffer use.
204The functions in this list are called before the ones in
205`write-file-hooks'.")
b19f1da4
BF
206(make-variable-buffer-local 'local-write-file-hooks)
207(put 'local-write-file-hooks 'permanent-local t)
8c0e7b73
JB
208
209(defvar write-contents-hooks nil
210 "List of functions to be called before writing out a buffer to a file.
211If one of them returns non-nil, the file is considered already written
212and the rest are not called.
213These hooks are considered to pertain to the buffer's contents,
214not to the particular visited file; thus, `set-visited-file-name' does
215not clear this variable, but changing the major mode does clear it.
216See also `write-file-hooks'.")
b4da00e9
RM
217
218(defconst enable-local-variables t
219 "*Control use of local-variables lists in files you visit.
220The value can be t, nil or something else.
221A value of t means local-variables lists are obeyed;
222nil means they are ignored; anything else means query.
223
224The command \\[normal-mode] always obeys local-variables lists
225and ignores this variable.")
226
2bba782c 227(defconst enable-local-eval 'maybe
d207b766
RS
228 "*Control processing of the \"variable\" `eval' in a file's local variables.
229The value can be t, nil or something else.
230A value of t means obey `eval' variables;
231nil means ignore them; anything else means query.
232
233The command \\[normal-mode] always obeys local-variables lists
234and ignores this variable.")
b4da00e9
RM
235
236;; Avoid losing in versions where CLASH_DETECTION is disabled.
237(or (fboundp 'lock-buffer)
231c4e10 238 (defalias 'lock-buffer 'ignore))
b4da00e9 239(or (fboundp 'unlock-buffer)
231c4e10 240 (defalias 'unlock-buffer 'ignore))
93fe0a35
RS
241
242;; This hook function provides support for ange-ftp host name
243;; completion. It runs the usual ange-ftp hook, but only for
244;; completion operations. Having this here avoids the need
245;; to load ange-ftp when it's not really in use.
246(defun ange-ftp-completion-hook-function (op &rest args)
247 (if (memq op '(file-name-completion file-name-all-completions))
248 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
249 (let ((inhibit-file-name-handlers
250 (cons 'ange-ftp-completion-hook-function
251 (and (eq inhibit-file-name-operation op)
252 inhibit-file-name-handlers)))
253 (inhibit-file-name-operation op))
93fe0a35 254 (apply op args))))
b4da00e9
RM
255\f
256(defun pwd ()
257 "Show the current default directory."
258 (interactive nil)
259 (message "Directory %s" default-directory))
260
231c4e10
ER
261(defvar cd-path nil
262 "Value of the CDPATH environment variable, as a list.
263Not actually set up until the first time you you use it.")
264
306faa42
RS
265(defvar path-separator ":"
266 "Character used to separate concatenated paths.")
267
231c4e10
ER
268(defun parse-colon-path (cd-path)
269 "Explode a colon-separated list of paths into a string list."
270 (and cd-path
271 (let (cd-prefix cd-list (cd-start 0) cd-colon)
306faa42
RS
272 (setq cd-path (concat cd-path path-separator))
273 (while (setq cd-colon (string-match path-separator cd-path cd-start))
231c4e10 274 (setq cd-list
9daefb36 275 (nconc cd-list
c52e4104
RS
276 (list (if (= cd-start cd-colon)
277 nil
278 (substitute-in-file-name
e33e80e4
RS
279 (file-name-as-directory
280 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
281 (setq cd-start (+ cd-colon 1)))
282 cd-list)))
283
284(defun cd-absolute (dir)
30c5ce9c 285 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
286 ;; Put the name into directory syntax now,
287 ;; because otherwise expand-file-name may give some bad results.
b4da00e9
RM
288 (if (not (eq system-type 'vax-vms))
289 (setq dir (file-name-as-directory dir)))
f4a0f59b 290 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9
RM
291 (if (not (file-directory-p dir))
292 (error "%s is not a directory" dir)
293 (if (file-executable-p dir)
294 (setq default-directory dir)
9daefb36 295 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 296
231c4e10
ER
297(defun cd (dir)
298 "Make DIR become the current buffer's default directory.
30c5ce9c
RS
299If your environment includes a `CDPATH' variable, try each one of that
300colon-separated list of directories when resolving a relative directory name."
dac4ea74
RS
301 (interactive
302 (list (read-file-name "Change default directory: "
2121cd9c
RM
303 default-directory default-directory
304 (and (member cd-path '(nil ("./")))
305 (null (getenv "CDPATH"))))))
30c5ce9c
RS
306 (if (file-name-absolute-p dir)
307 (cd-absolute (expand-file-name dir))
308 (if (null cd-path)
309 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
310 (setq cd-path (or trypath (list "./")))))
311 (if (not (catch 'found
312 (mapcar
313 (function (lambda (x)
314 (let ((f (expand-file-name (concat x dir))))
315 (if (file-directory-p f)
316 (progn
317 (cd-absolute f)
318 (throw 'found t))))))
319 cd-path)
320 nil))
321 (error "No such directory found via CDPATH environment variable"))))
231c4e10 322
b4da00e9
RM
323(defun load-file (file)
324 "Load the Lisp file named FILE."
325 (interactive "fLoad file: ")
326 (load (expand-file-name file) nil nil t))
327
328(defun load-library (library)
329 "Load the library named LIBRARY.
330This is an interface to the function `load'."
331 (interactive "sLoad library: ")
332 (load library))
5d68c2c2 333
7c4b8f8c 334(defun file-local-copy (file &optional buffer)
5d68c2c2
RS
335 "Copy the file FILE into a temporary file on this machine.
336Returns the name of the local copy, or nil, if FILE is directly
337accessible."
6eaebaa2 338 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
339 (if handler
340 (funcall handler 'file-local-copy file)
341 nil)))
f3e23606 342
05ef1cda 343(defun file-truename (filename &optional counter prev-dirs)
f3e23606
RS
344 "Return the truename of FILENAME, which should be absolute.
345The truename of a file name is found by chasing symbolic links
346both at the level of the file and at the level of the directories
05ef1cda
RS
347containing it, until no links are left at any level.
348
349The arguments COUNTER and PREV-DIRS are used only in recursive calls.
350Do not specify them in other calls."
351 ;; COUNTER can be a cons cell whose car is the count of how many more links
352 ;; to chase before getting an error.
353 ;; PREV-DIRS can be a cons cell whose car is an alist
354 ;; of truenames we've just recently computed.
cc37a58c 355
cc37a58c
SM
356 ;; The last test looks dubious, maybe `+' is meant here? --simon.
357 (if (or (string= filename "") (string= filename "~")
7a5a26a6
RS
358 (and (string= (substring filename 0 1) "~")
359 (string-match "~[^/]*" filename)))
1cc2fbeb
RS
360 (progn
361 (setq filename (expand-file-name filename))
362 (if (string= filename "")
363 (setq filename "/"))))
05ef1cda 364 (or counter (setq counter (list 100)))
b505828b
RS
365 (let (done
366 ;; For speed, remove the ange-ftp completion handler from the list.
367 ;; We know it's not needed here.
368 ;; For even more speed, do this only on the outermost call.
369 (file-name-handler-alist
370 (if prev-dirs file-name-handler-alist
371 (let ((tem (copy-sequence file-name-handler-alist)))
372 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
373 (or prev-dirs (setq prev-dirs (list nil)))
05ef1cda
RS
374 ;; If this file directly leads to a link, process that iteratively
375 ;; so that we don't use lots of stack.
376 (while (not done)
377 (setcar counter (1- (car counter)))
378 (if (< (car counter) 0)
379 (error "Apparent cycle of symbolic links for %s" filename))
380 (let ((handler (find-file-name-handler filename 'file-truename)))
381 ;; For file name that has a special handler, call handler.
382 ;; This is so that ange-ftp can save time by doing a no-op.
383 (if handler
384 (setq filename (funcall handler 'file-truename filename)
385 done t)
fb145562 386 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
387 target dirfile)
388 ;; Get the truename of the directory.
389 (setq dirfile (directory-file-name dir))
390 ;; If these are equal, we have the (or a) root directory.
391 (or (string= dir dirfile)
392 ;; If this is the same dir we last got the truename for,
393 ;; save time--don't recalculate.
394 (if (assoc dir (car prev-dirs))
395 (setq dir (cdr (assoc dir (car prev-dirs))))
396 (let ((old dir)
397 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
398 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
399 (setq dir new))))
400 (if (equal ".." (file-name-nondirectory filename))
401 (setq filename
402 (directory-file-name (file-name-directory (directory-file-name dir)))
403 done t)
404 (if (equal "." (file-name-nondirectory filename))
405 (setq filename (directory-file-name dir)
406 done t)
407 ;; Put it back on the file name.
408 (setq filename (concat dir (file-name-nondirectory filename)))
409 ;; Is the file name the name of a link?
410 (setq target (file-symlink-p filename))
411 (if target
412 ;; Yes => chase that link, then start all over
413 ;; since the link may point to a directory name that uses links.
414 ;; We can't safely use expand-file-name here
415 ;; since target might look like foo/../bar where foo
416 ;; is itself a link. Instead, we handle . and .. above.
417 (setq filename
418 (if (file-name-absolute-p target)
419 target
420 (concat dir target))
421 done nil)
422 ;; No, we are done!
423 (setq done t))))))))
424 filename))
5dbfdacd 425
5dadeb29
RS
426(defun file-chase-links (filename)
427 "Chase links in FILENAME until a name that is not a link.
428Does not examine containing directories for links,
429unlike `file-truename'."
430 (let (tem (count 100) (newname filename))
431 (while (setq tem (file-symlink-p newname))
432 (if (= count 0)
433 (error "Apparent cycle of symbolic links for %s" filename))
f01de0db
KH
434 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
435 (while (string-match "//+" tem)
436 (setq tem (concat (substring tem 0 (1+ (match-beginning 0)))
437 (substring tem (match-end 0)))))
cf65b429
RS
438 ;; Handle `..' by hand, since it needs to work in the
439 ;; target of any directory symlink.
440 ;; This code is not quite complete; it does not handle
441 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
f01de0db 442 (while (string-match "\\`\\.\\./" tem)
cf65b429
RS
443 (setq tem (substring tem 3))
444 (setq newname (file-name-as-directory
445 ;; Do the .. by hand.
446 (directory-file-name
447 (file-name-directory
448 ;; Chase links in the default dir of the symlink.
449 (file-chase-links
450 (directory-file-name
451 (file-name-directory newname))))))))
5dadeb29
RS
452 (setq newname (expand-file-name tem (file-name-directory newname)))
453 (setq count (1- count)))
454 newname))
b4da00e9
RM
455\f
456(defun switch-to-buffer-other-window (buffer)
457 "Select buffer BUFFER in another window."
458 (interactive "BSwitch to buffer in other window: ")
459 (let ((pop-up-windows t))
460 (pop-to-buffer buffer t)))
461
f98955ea
JB
462(defun switch-to-buffer-other-frame (buffer)
463 "Switch to buffer BUFFER in another frame."
464 (interactive "BSwitch to buffer in other frame: ")
465 (let ((pop-up-frames t))
336b7f41
RS
466 (pop-to-buffer buffer t)
467 (raise-frame (window-frame (selected-window)))))
5bbbceb1 468
b4da00e9
RM
469(defun find-file (filename)
470 "Edit file FILENAME.
471Switch to a buffer visiting file FILENAME,
472creating one if none already exists."
473 (interactive "FFind file: ")
474 (switch-to-buffer (find-file-noselect filename)))
475
476(defun find-file-other-window (filename)
477 "Edit file FILENAME, in another window.
478May create a new window, or reuse an existing one.
479See the function `display-buffer'."
480 (interactive "FFind file in other window: ")
481 (switch-to-buffer-other-window (find-file-noselect filename)))
482
f98955ea
JB
483(defun find-file-other-frame (filename)
484 "Edit file FILENAME, in another frame.
485May create a new frame, or reuse an existing one.
5bbbceb1 486See the function `display-buffer'."
f98955ea
JB
487 (interactive "FFind file in other frame: ")
488 (switch-to-buffer-other-frame (find-file-noselect filename)))
5bbbceb1 489
b4da00e9
RM
490(defun find-file-read-only (filename)
491 "Edit file FILENAME but don't allow changes.
492Like \\[find-file] but marks buffer as read-only.
493Use \\[toggle-read-only] to permit editing."
494 (interactive "fFind file read-only: ")
495 (find-file filename)
320b4233
RS
496 (setq buffer-read-only t)
497 (current-buffer))
b4da00e9
RM
498
499(defun find-file-read-only-other-window (filename)
500 "Edit file FILENAME in another window but don't allow changes.
501Like \\[find-file-other-window] but marks buffer as read-only.
502Use \\[toggle-read-only] to permit editing."
503 (interactive "fFind file read-only other window: ")
9466a1f6 504 (find-file-other-window filename)
320b4233
RS
505 (setq buffer-read-only t)
506 (current-buffer))
b4da00e9 507
f98955ea
JB
508(defun find-file-read-only-other-frame (filename)
509 "Edit file FILENAME in another frame but don't allow changes.
510Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 511Use \\[toggle-read-only] to permit editing."
f98955ea
JB
512 (interactive "fFind file read-only other frame: ")
513 (find-file-other-frame filename)
320b4233
RS
514 (setq buffer-read-only t)
515 (current-buffer))
5bbbceb1 516
60eaf370
RS
517(defun find-alternate-file-other-window (filename)
518 "Find file FILENAME as a replacement for the file in the next window.
519This command does not select that window."
520 (interactive
521 (save-selected-window
522 (other-window 1)
523 (let ((file buffer-file-name)
524 (file-name nil)
525 (file-dir nil))
526 (and file
527 (setq file-name (file-name-nondirectory file)
528 file-dir (file-name-directory file)))
529 (list (read-file-name
530 "Find alternate file: " file-dir nil nil file-name)))))
531 (if (one-window-p)
532 (find-file-other-window filename)
533 (save-selected-window
534 (other-window 1)
535 (find-alternate-file filename))))
536
b4da00e9
RM
537(defun find-alternate-file (filename)
538 "Find file FILENAME, select its buffer, kill previous buffer.
539If the current buffer now contains an empty file that you just visited
540\(presumably by mistake), use this command to visit the file you really want."
541 (interactive
542 (let ((file buffer-file-name)
543 (file-name nil)
544 (file-dir nil))
545 (and file
546 (setq file-name (file-name-nondirectory file)
547 file-dir (file-name-directory file)))
a61f59b4
JA
548 (list (read-file-name
549 "Find alternate file: " file-dir nil nil file-name))))
2aa8cc2d 550 (and (buffer-modified-p) (buffer-file-name)
b4da00e9
RM
551 ;; (not buffer-read-only)
552 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
553 (buffer-name))))
554 (error "Aborted"))
555 (let ((obuf (current-buffer))
556 (ofile buffer-file-name)
8bb27285
RS
557 (onum buffer-file-number)
558 (otrue buffer-file-truename)
b4da00e9 559 (oname (buffer-name)))
baf9b8c4
RS
560 (if (get-buffer " **lose**")
561 (kill-buffer " **lose**"))
b4da00e9
RM
562 (rename-buffer " **lose**")
563 (setq buffer-file-name nil)
8bb27285
RS
564 (setq buffer-file-number nil)
565 (setq buffer-file-truename nil)
b4da00e9
RM
566 (unwind-protect
567 (progn
568 (unlock-buffer)
569 (find-file filename))
570 (cond ((eq obuf (current-buffer))
571 (setq buffer-file-name ofile)
8bb27285
RS
572 (setq buffer-file-number onum)
573 (setq buffer-file-truename otrue)
b4da00e9
RM
574 (lock-buffer)
575 (rename-buffer oname))))
576 (or (eq (current-buffer) obuf)
577 (kill-buffer obuf))))
578
579(defun create-file-buffer (filename)
580 "Create a suitably named buffer for visiting FILENAME, and return it.
581FILENAME (sans directory) is used unchanged if that name is free;
582otherwise a string <2> or <3> or ... is appended to get an unused name."
583 (let ((lastname (file-name-nondirectory filename)))
584 (if (string= lastname "")
585 (setq lastname filename))
586 (generate-new-buffer lastname)))
587
5bbbceb1
JB
588(defun generate-new-buffer (name)
589 "Create and return a buffer with a name based on NAME.
29165787 590Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
591 (get-buffer-create (generate-new-buffer-name name)))
592
e373f201
JB
593(defconst automount-dir-prefix "^/tmp_mnt/"
594 "Regexp to match the automounter prefix in a directory name.")
595
ffb3a4db 596(defvar abbreviated-home-dir nil
292297c6 597 "The user's homedir abbreviated according to `directory-abbrev-list'.")
ffb3a4db 598
5bbbceb1 599(defun abbreviate-file-name (filename)
29165787 600 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
5bbbceb1 601This also substitutes \"~\" for the user's home directory.
29165787 602Type \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201
JB
603 ;; Get rid of the prefixes added by the automounter.
604 (if (and (string-match automount-dir-prefix filename)
605 (file-exists-p (file-name-directory
606 (substring filename (1- (match-end 0))))))
607 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 608 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
609 ;; If any elt of directory-abbrev-alist matches this name,
610 ;; abbreviate accordingly.
5bbbceb1
JB
611 (while tail
612 (if (string-match (car (car tail)) filename)
613 (setq filename
614 (concat (cdr (car tail)) (substring filename (match-end 0)))))
615 (setq tail (cdr tail)))
ffb3a4db
RS
616 ;; Compute and save the abbreviated homedir name.
617 ;; We defer computing this until the first time it's needed, to
618 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
619 ;; We include a slash at the end, to avoid spurious matches
620 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
621 (or abbreviated-home-dir
622 (setq abbreviated-home-dir
623 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
624 (concat "^" (abbreviate-file-name (expand-file-name "~"))
625 "\\(/\\|$\\)"))))
626
ffb3a4db
RS
627 ;; If FILENAME starts with the abbreviated homedir,
628 ;; make it start with `~' instead.
ca33ccb5
RS
629 (if (and (string-match abbreviated-home-dir filename)
630 ;; If the home dir is just /, don't change it.
631 (not (and (= (match-end 0) 1)
288201bd 632 (= (aref filename 0) ?/)))
c32d49e8
RS
633 (not (and (or (eq system-type 'ms-dos)
634 (eq system-type 'windows-nt))
288201bd
RS
635 (save-match-data
636 (string-match "^[a-zA-Z]:/$" filename)))))
5bbbceb1 637 (setq filename
28dbf501 638 (concat "~"
3a8a836d 639 (substring filename (match-beginning 1) (match-end 1))
28dbf501 640 (substring filename (match-end 0)))))
5bbbceb1
JB
641 filename))
642
1770543d
RS
643(defvar find-file-not-true-dirname-list nil
644 "*List of logical names for which visiting shouldn't save the true dirname.
645On VMS, when you visit a file using a logical name that searches a path,
646you may or may not want the visited file name to record the specific
647directory where the file was found. If you *do not* want that, add the logical
648name to this list as a string.")
649
138c44f6
KH
650(defun find-buffer-visiting (filename)
651 "Return the buffer visiting file FILENAME (a string).
652This is like `get-file-buffer', except that it checks for any buffer
653visiting the same file, possibly under a different name.
654If there is no such live buffer, return nil."
655 (let ((buf (get-file-buffer filename))
656 (truename (abbreviate-file-name (file-truename filename))))
657 (or buf
658 (let ((list (buffer-list)) found)
659 (while (and (not found) list)
660 (save-excursion
661 (set-buffer (car list))
662 (if (and buffer-file-name
663 (string= buffer-file-truename truename))
664 (setq found (car list))))
665 (setq list (cdr list)))
666 found)
0f933cf6 667 (let ((number (nthcdr 10 (file-attributes truename)))
138c44f6 668 (list (buffer-list)) found)
181c830f
RS
669 (and number
670 (while (and (not found) list)
671 (save-excursion
672 (set-buffer (car list))
d49ab5a0
RS
673 (if (and buffer-file-name
674 (equal buffer-file-number number)
181c830f
RS
675 ;; Verify this buffer's file number
676 ;; still belongs to its file.
677 (file-exists-p buffer-file-name)
678 (equal (nthcdr 10 (file-attributes buffer-file-name))
679 number))
680 (setq found (car list))))
681 (setq list (cdr list))))
138c44f6
KH
682 found))))
683
40dfe94d
RS
684(defun insert-file-contents-literally (filename &optional visit beg end replace)
685 "Like `insert-file-contents', q.v., but only reads in the file.
686A buffer may be modified in several ways after reading into the buffer due
687to advanced Emacs features, such as file-name-handlers, format decoding,
688find-file-hooks, etc.
689 This function ensures that none of these modifications will take place."
690 (let ((file-name-handler-alist nil)
691 (format-alist nil)
692 (after-insert-file-functions nil)
693 (find-buffer-file-type-function
694 (if (fboundp 'find-buffer-file-type)
695 (symbol-function 'find-buffer-file-type)
696 nil)))
697 (unwind-protect
698 (progn
699 (fset 'find-buffer-file-type (lambda (filename) t))
700 (insert-file-contents filename visit beg end replace))
701 (if find-buffer-file-type-function
702 (fset 'find-buffer-file-type find-buffer-file-type-function)
703 (fmakunbound 'find-buffer-file-type)))))
704
705(defun find-file-noselect (filename &optional nowarn rawfile)
b4da00e9
RM
706 "Read file FILENAME into a buffer and return the buffer.
707If a buffer exists visiting FILENAME, return that one, but
708verify that the file has not changed since visited or saved.
709The buffer is not selected, just returned to the caller."
e373f201
JB
710 (setq filename
711 (abbreviate-file-name
712 (expand-file-name filename)))
b4da00e9
RM
713 (if (file-directory-p filename)
714 (if find-file-run-dired
4147a3cc
KH
715 (dired-noselect (if find-file-visit-truename
716 (abbreviate-file-name (file-truename filename))
717 filename))
b4da00e9 718 (error "%s is a directory." filename))
f3e23606
RS
719 (let* ((buf (get-file-buffer filename))
720 (truename (abbreviate-file-name (file-truename filename)))
721 (number (nthcdr 10 (file-attributes truename)))
722 ;; Find any buffer for a file which has same truename.
138c44f6 723 (other (and (not buf) (find-buffer-visiting filename)))
f3e23606
RS
724 error)
725 ;; Let user know if there is a buffer with the same truename.
138c44f6
KH
726 (if other
727 (progn
327bebe8
RS
728 (or nowarn
729 (string-equal filename (buffer-file-name other))
730 (message "%s and %s are the same file"
731 filename (buffer-file-name other)))
138c44f6
KH
732 ;; Optionally also find that buffer.
733 (if (or find-file-existing-other-name find-file-visit-truename)
734 (setq buf other))))
b4da00e9
RM
735 (if buf
736 (or nowarn
737 (verify-visited-file-modtime buf)
738 (cond ((not (file-exists-p filename))
739 (error "File %s no longer exists!" filename))
740 ((yes-or-no-p
b7d19f4a
KH
741 (if (string= (file-name-nondirectory filename)
742 (buffer-name buf))
743 (format
744 (if (buffer-modified-p buf)
745 "File %s changed on disk. Discard your edits? "
746 "File %s changed on disk. Reread from disk? ")
747 (file-name-nondirectory filename))
748 (format
749 (if (buffer-modified-p buf)
750 "File %s changed on disk. Discard your edits in %s? "
751 "File %s changed on disk. Reread from disk into %s? ")
752 (file-name-nondirectory filename)
753 (buffer-name buf))))
b4da00e9
RM
754 (save-excursion
755 (set-buffer buf)
756 (revert-buffer t t)))))
757 (save-excursion
f3e23606
RS
758;;; The truename stuff makes this obsolete.
759;;; (let* ((link-name (car (file-attributes filename)))
760;;; (linked-buf (and (stringp link-name)
761;;; (get-file-buffer link-name))))
762;;; (if (bufferp linked-buf)
763;;; (message "Symbolic link to file in buffer %s"
764;;; (buffer-name linked-buf))))
b4da00e9 765 (setq buf (create-file-buffer filename))
a2e12c0c 766 (set-buffer-major-mode buf)
b4da00e9
RM
767 (set-buffer buf)
768 (erase-buffer)
40dfe94d
RS
769 (if rawfile
770 (condition-case ()
771 (insert-file-contents-literally filename t)
772 (file-error
773 ;; Unconditionally set error
774 (setq error t)))
775 (condition-case ()
776 (insert-file-contents filename t)
777 (file-error
778 ;; Run find-file-not-found-hooks until one returns non-nil.
779 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
780 ;; If they fail too, set error.
781 (setq error t)))))
f3e23606 782 ;; Find the file's truename, and maybe use that as visited name.
138c44f6 783 (setq buffer-file-truename truename)
1770543d
RS
784 (setq buffer-file-number number)
785 ;; On VMS, we may want to remember which directory in a search list
786 ;; the file was found in.
787 (and (eq system-type 'vax-vms)
788 (let (logical)
789 (if (string-match ":" (file-name-directory filename))
790 (setq logical (substring (file-name-directory filename)
791 0 (match-beginning 0))))
792 (not (member logical find-file-not-true-dirname-list)))
793 (setq buffer-file-name buffer-file-truename))
1cc2fbeb 794 (if find-file-visit-truename
27d0420c
RS
795 (setq buffer-file-name
796 (setq filename
797 (expand-file-name buffer-file-truename))))
b4da00e9
RM
798 ;; Set buffer's default directory to that of the file.
799 (setq default-directory (file-name-directory filename))
800 ;; Turn off backup files for certain file names. Since
801 ;; this is a permanent local, the major mode won't eliminate it.
802 (and (not (funcall backup-enable-predicate buffer-file-name))
803 (progn
804 (make-local-variable 'backup-inhibited)
805 (setq backup-inhibited t)))
40dfe94d
RS
806 (if rawfile
807 nil
808 (after-find-file error (not nowarn)))))
b4da00e9
RM
809 buf)))
810\f
f7d786d0
RS
811(defvar after-find-file-from-revert-buffer nil)
812
e0ab8879
RS
813(defun after-find-file (&optional error warn noauto
814 after-find-file-from-revert-buffer)
b4da00e9
RM
815 "Called after finding a file and by the default revert function.
816Sets buffer mode, parses local variables.
8cfb9d46 817Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
818error in reading the file. WARN non-nil means warn if there
819exists an auto-save file more recent than the visited file.
8cfb9d46 820NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
821Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
822 means this call was from `revert-buffer'.
b4da00e9
RM
823Finishes by calling the functions in `find-file-hooks'."
824 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
825 (if noninteractive
826 nil
827 (let* (not-serious
828 (msg
829 (cond ((and error (file-attributes buffer-file-name))
830 (setq buffer-read-only t)
ff78d520 831 "File exists, but cannot be read.")
b4da00e9
RM
832 ((not buffer-read-only)
833 (if (and warn
834 (file-newer-than-file-p (make-auto-save-file-name)
835 buffer-file-name))
836 "Auto save file is newer; consider M-x recover-file"
837 (setq not-serious t)
838 (if error "(New file)" nil)))
839 ((not error)
840 (setq not-serious t)
841 "Note: file is write protected")
842 ((file-attributes (directory-file-name default-directory))
843 "File not found and directory write-protected")
4e43240a
RS
844 ((file-exists-p (file-name-directory buffer-file-name))
845 (setq buffer-read-only nil))
b4da00e9 846 (t
5bbbceb1 847 (setq buffer-read-only nil)
4e43240a
RS
848 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
849 "Use M-x make-dir RET RET to create the directory"
850 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
b4da00e9
RM
851 (if msg
852 (progn
853 (message msg)
854 (or not-serious (sit-for 1 nil t)))))
8cfb9d46 855 (if (and auto-save-default (not noauto))
b4da00e9
RM
856 (auto-save-mode t)))
857 (normal-mode t)
a4f5efdc 858 (run-hooks 'find-file-hooks))
b4da00e9
RM
859
860(defun normal-mode (&optional find-file)
861 "Choose the major mode for this buffer automatically.
862Also sets up any specified local variables of the file.
863Uses the visited file name, the -*- line, and the local variables spec.
864
865This function is called automatically from `find-file'. In that case,
866we may set up specified local variables depending on the value of
867`enable-local-variables': if it is t, we do; if it is nil, we don't;
868otherwise, we query. `enable-local-variables' is ignored if you
869run `normal-mode' explicitly."
870 (interactive)
871 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
872 (condition-case err
873 (set-auto-mode)
874 (error (message "File mode specification error: %s"
875 (prin1-to-string err))))
876 (condition-case err
7b3f3dc2
JB
877 (let ((enable-local-variables (or (not find-file)
878 enable-local-variables)))
879 (hack-local-variables))
b4da00e9
RM
880 (error (message "File local-variables error: %s"
881 (prin1-to-string err)))))
882
f76e0cd0
RS
883(defvar auto-mode-alist
884 '(("\\.text\\'" . text-mode)
885 ("\\.c\\'" . c-mode)
886 ("\\.h\\'" . c-mode)
887 ("\\.tex\\'" . tex-mode)
888 ("\\.ltx\\'" . latex-mode)
889 ("\\.el\\'" . emacs-lisp-mode)
890 ("\\.mm\\'" . nroff-mode)
891 ("\\.me\\'" . nroff-mode)
892 ("\\.ms\\'" . nroff-mode)
893 ("\\.man\\'" . nroff-mode)
894 ("\\.scm\\'" . scheme-mode)
895 ("\\.l\\'" . lisp-mode)
896 ("\\.lisp\\'" . lisp-mode)
897 ("\\.f\\'" . fortran-mode)
898 ("\\.for\\'" . fortran-mode)
899 ("\\.p\\'" . pascal-mode)
900 ("\\.pas\\'" . pascal-mode)
901 ("\\.mss\\'" . scribe-mode)
902 ("\\.ad[abs]\\'" . ada-mode)
903 ("\\.icn\\'" . icon-mode)
904 ("\\.pl\\'" . perl-mode)
905 ("\\.cc\\'" . c++-mode)
906 ("\\.hh\\'" . c++-mode)
907 ("\\.C\\'" . c++-mode)
908 ("\\.H\\'" . c++-mode)
909 ("\\.cpp\\'" . c++-mode)
910 ("\\.cxx\\'" . c++-mode)
911 ("\\.hxx\\'" . c++-mode)
912 ("\\.c\\+\\+\\'" . c++-mode)
913 ("\\.h\\+\\+\\'" . c++-mode)
914 ("\\.mk\\'" . makefile-mode)
915 ("[Mm]akefile\\(.in\\)?\\'" . makefile-mode)
7b3f3dc2
JB
916;;; Less common extensions come here
917;;; so more common ones above are found faster.
f76e0cd0
RS
918 ("\\.texinfo\\'" . texinfo-mode)
919 ("\\.texi\\'" . texinfo-mode)
920 ("\\.s\\'" . asm-mode)
600a5f71
KH
921 ("\\.S\\'" . asm-mode)
922 ("\\.asm\\'" . asm-mode)
f76e0cd0
RS
923 ("ChangeLog\\'" . change-log-mode)
924 ("change.log\\'" . change-log-mode)
925 ("changelo\\'" . change-log-mode)
926 ("ChangeLog.[0-9]+\\'" . change-log-mode)
927 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
928 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
c1fe251a
KH
929;;; The following should come after the ChangeLog pattern
930;;; for the sake of ChangeLog.1, etc.
931;;; and after the .scm.[0-9] pattern too.
f76e0cd0
RS
932 ("\\.[12345678]\\'" . nroff-mode)
933 ("\\.TeX\\'" . tex-mode)
934 ("\\.sty\\'" . latex-mode)
935 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
936 ("\\.bbl\\'" . latex-mode)
937 ("\\.bib\\'" . bibtex-mode)
938 ("\\.article\\'" . text-mode)
939 ("\\.letter\\'" . text-mode)
940 ("\\.tcl\\'" . tcl-mode)
941 ("\\.f90\\'" . f90-mode)
942 ("\\.lsp\\'" . lisp-mode)
943 ("\\.awk\\'" . awk-mode)
944 ("\\.prolog\\'" . prolog-mode)
945 ("\\.tar\\'" . tar-mode)
946 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\)\\'" . archive-mode)
947 ;; Mailer puts message to be edited in
948 ;; /tmp/Re.... or Message
949 ("^/tmp/Re" . text-mode)
950 ("/Message[0-9]*\\'" . text-mode)
951 ("/drafts/[0-9]+\\'" . mh-letter-mode)
952 ;; some news reader is reported to use this
953 ("^/tmp/fol/" . text-mode)
954 ("\\.y\\'" . c-mode)
955 ("\\.lex\\'" . c-mode)
956 ("\\.oak\\'" . scheme-mode)
957 ("\\.sgm\\'" . sgml-mode)
958 ("\\.sgml\\'" . sgml-mode)
959 ("\\.dtd\\'" . sgml-mode)
960 ;; .emacs following a directory delimiter
961 ;; in either Unix or VMS syntax.
962 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
963 ;; _emacs following a directory delimiter
964 ;; in MsDos syntax
965 ("[:/]_emacs\\'" . emacs-lisp-mode)
966 ("\\.ml\\'" . lisp-mode))
7b3f3dc2
JB
967 "\
968Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
969Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
970\(NON-NIL stands for anything that is not nil; the value does not matter.)
971Visiting a file whose name matches REGEXP specifies FUNCTION as the
972mode function to use. FUNCTION will be called, unless it is nil.
973
974If the element has the form (REGEXP FUNCTION NON-NIL), then after
975calling FUNCTION (if it's not nil), we delete the suffix that matched
976REGEXP and search the list again for another match.")
7b3f3dc2 977
c907d156
RS
978(defconst interpreter-mode-alist
979 '(("perl" . perl-mode)
c907d156 980 ("wish" . tcl-mode)
e3998da1 981 ("wishx" . tcl-mode)
8db739de 982 ("tcl" . tcl-mode)
e3998da1 983 ("tclsh" . tcl-mode)
8db739de 984 ("awk" . awk-mode)
d4f567a1 985 ("nawk" . awk-mode)
8db739de
NF
986 ("gawk" . awk-mode)
987 ("scm" . scheme-mode))
c907d156
RS
988 "Alist mapping interpreter names to major modes.
989This alist applies to files whose first line starts with `#!'.
990Each element looks like (INTERPRETER . MODE).
991The car of each element is compared with
992the name of the interpreter specified in the first line.
993If it matches, mode MODE is selected.")
994
b20ff6d0 995(defconst inhibit-first-line-modes-regexps '("\\.tar\\'")
45fb3bb8 996 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 997
b20ff6d0
RS
998(defconst inhibit-first-line-modes-suffixes nil
999 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1000When checking `inhibit-first-line-modes-regexps', we first discard
1001from the end of the file name anything that matches one of these regexps.")
1002
bb157910
RS
1003(defvar user-init-file
1004 "" ; set by command-line
1005 "File name including directory of user's initialization file.")
1006
b4da00e9
RM
1007(defun set-auto-mode ()
1008 "Select major mode appropriate for current buffer.
e3998da1
RS
1009This checks for a -*- mode tag in the buffer's text,
1010compares the filename against the entries in `auto-mode-alist',
1011or checks the interpreter that runs this file against
1012`interpreter-mode-alist'.
1013
1014It does not check for the `mode:' local variable in the
1015Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 1016
f3e23606 1017If `enable-local-variables' is nil, this function does not check for a
7b3f3dc2 1018-*- mode tag."
b4da00e9 1019 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
d0fc03ef 1020 (let (beg end done modes)
b4da00e9
RM
1021 (save-excursion
1022 (goto-char (point-min))
1023 (skip-chars-forward " \t\n")
9fa7bfe5
RS
1024 (and enable-local-variables
1025 ;; Don't look for -*- if this file name matches any
45fb3bb8 1026 ;; of the regexps in inhibit-first-line-modes-regexps.
cae111fa 1027 (let ((temp inhibit-first-line-modes-regexps)
4bc3d240
RS
1028 (name (if buffer-file-name
1029 (file-name-sans-versions buffer-file-name)
1030 (buffer-name))))
38832b4c
KH
1031 (while (let ((sufs inhibit-first-line-modes-suffixes))
1032 (while (and sufs (not (string-match (car sufs) name)))
1033 (setq sufs (cdr sufs)))
1034 sufs)
1035 (setq name (substring name 0 (match-beginning 0))))
9fa7bfe5 1036 (while (and temp
b20ff6d0 1037 (not (string-match (car temp) name)))
9fa7bfe5
RS
1038 (setq temp (cdr temp)))
1039 (not temp))
1040 (search-forward "-*-" (save-excursion
1041 ;; If the file begins with "#!"
1042 ;; (exec interpreter magic), look
1043 ;; for mode frobs in the first two
1044 ;; lines. You cannot necessarily
1045 ;; put them in the first line of
1046 ;; such a file without screwing up
1047 ;; the interpreter invocation.
1048 (end-of-line (and (looking-at "^#!") 2))
1049 (point)) t)
1050 (progn
1051 (skip-chars-forward " \t")
1052 (setq beg (point))
1053 (search-forward "-*-"
1054 (save-excursion (end-of-line) (point))
1055 t))
1056 (progn
1057 (forward-char -3)
1058 (skip-chars-backward " \t")
1059 (setq end (point))
1060 (goto-char beg)
1061 (if (save-excursion (search-forward ":" end t))
1062 ;; Find all specifications for the `mode:' variable
57a0155c 1063 ;; and execute them left to right.
9fa7bfe5 1064 (while (let ((case-fold-search t))
6054fcc6
KH
1065 (or (and (looking-at "mode:")
1066 (goto-char (match-end 0)))
1067 (re-search-forward "[ \t;]mode:" end t)))
9fa7bfe5
RS
1068 (skip-chars-forward " \t")
1069 (setq beg (point))
1070 (if (search-forward ";" end t)
1071 (forward-char -1)
1072 (goto-char end))
1073 (skip-chars-backward " \t")
d0fc03ef
RS
1074 (setq modes (cons (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1075 modes)))
9fa7bfe5 1076 ;; Simple -*-MODE-*- case.
d0fc03ef
RS
1077 (setq modes (cons (intern (concat (downcase (buffer-substring beg end))
1078 "-mode"))
1079 modes))))))
1080 ;; If we found modes to use, invoke them now,
1081 ;; outside the save-excursion.
1082 (if modes
1083 (progn (mapcar 'funcall modes)
1084 (setq done t)))
1085 ;; If we didn't find a mode from a -*- line, try using the file name.
1086 (if (and (not done) buffer-file-name)
1087 (let ((name buffer-file-name)
1088 (keep-going t))
1089 ;; Remove backup-suffixes from file name.
1090 (setq name (file-name-sans-versions name))
1091 (while keep-going
1092 (setq keep-going nil)
1093 (let ((alist auto-mode-alist)
1094 (mode nil))
1095 ;; Find first matching alist entry.
1096 (let ((case-fold-search
1097 (memq system-type '(vax-vms windows-nt))))
1098 (while (and (not mode) alist)
1099 (if (string-match (car (car alist)) name)
1100 (if (and (consp (cdr (car alist)))
1101 (nth 2 (car alist)))
1102 (progn
1103 (setq mode (car (cdr (car alist)))
1104 name (substring name 0 (match-beginning 0))
1105 keep-going t))
1106 (setq mode (cdr (car alist))
1107 keep-going nil)))
1108 (setq alist (cdr alist))))
1109 (if mode
1110 (funcall mode)
1111 ;; If we can't deduce a mode from the file name,
1112 ;; look for an interpreter specified in the first line.
1540e4e9
KH
1113 ;; As a special case, allow for things like "#!/bin/env perl",
1114 ;; which finds the interpreter anywhere in $PATH.
d0fc03ef
RS
1115 (let ((interpreter
1116 (save-excursion
1117 (goto-char (point-min))
1540e4e9
KH
1118 (if (looking-at "#! *\\([^ \t\n]*/bin/env +\\)?\\([^ \t\n]+\\)")
1119 (buffer-substring (match-beginning 2)
1120 (match-end 2))
d0fc03ef
RS
1121 "")))
1122 elt)
1123 ;; Map interpreter name to a mode.
1124 (setq elt (assoc (file-name-nondirectory interpreter)
1125 interpreter-mode-alist))
1126 (if elt
1127 (funcall (cdr elt)))))))))))
b4da00e9 1128
f3e23606
RS
1129(defun hack-local-variables-prop-line ()
1130 ;; Set local variables specified in the -*- line.
9fa7bfe5
RS
1131 ;; Ignore any specification for `mode:';
1132 ;; set-auto-mode should already have handled that.
f3e23606
RS
1133 (save-excursion
1134 (goto-char (point-min))
13a66180
KH
1135 (let ((result nil)
1136 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
f3e23606
RS
1137 ;; Parse the -*- line into the `result' alist.
1138 (cond ((not (search-forward "-*-" end t))
1139 ;; doesn't have one.
1140 nil)
1141 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180
KH
1142 ;; Simple form: "-*- MODENAME -*-". Already handled.
1143 nil)
f3e23606
RS
1144 (t
1145 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1146 ;; (last ";" is optional).
1147 (save-excursion
1148 (if (search-forward "-*-" end t)
1149 (setq end (- (point) 3))
1150 (error "-*- not terminated before end of line")))
1151 (while (< (point) end)
1152 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1153 (error "malformed -*- line"))
1154 (goto-char (match-end 0))
1c26a6f3
KH
1155 ;; There used to be a downcase here,
1156 ;; but the manual didn't say so,
1157 ;; and people want to set var names that aren't all lc.
1158 (let ((key (intern (buffer-substring
1159 (match-beginning 1)
1160 (match-end 1))))
f3e23606
RS
1161 (val (save-restriction
1162 (narrow-to-region (point) end)
1163 (read (current-buffer)))))
13a66180
KH
1164 (or (eq key 'mode)
1165 (setq result (cons (cons key val) result)))
f3e23606
RS
1166 (skip-chars-forward " \t;")))
1167 (setq result (nreverse result))))
f3e23606
RS
1168
1169 (if (and result
1170 (or (eq enable-local-variables t)
1171 (and enable-local-variables
1172 (save-window-excursion
6f931919
RS
1173 (condition-case nil
1174 (switch-to-buffer (current-buffer))
1175 (error
1176 ;; If we fail to switch in the selected window,
1177 ;; it is probably a minibuffer.
1178 ;; So try another window.
1179 (condition-case nil
1180 (switch-to-buffer-other-window (current-buffer))
1181 (error
1182 (switch-to-buffer-other-frame (current-buffer))))))
f3e23606
RS
1183 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1184 (file-name-nondirectory buffer-file-name)))))))
1185 (while result
13a66180 1186 (hack-one-local-variable (car (car result)) (cdr (car result)))
9fa7bfe5 1187 (setq result (cdr result)))))))
f3e23606 1188
1d517019
RS
1189(defvar hack-local-variables-hook nil
1190 "Normal hook run after processing a file's local variables specs.
1191Major modes can use this to examine user-specified local variables
1192in order to initialize other data structure based on them.")
1193
7b3f3dc2 1194(defun hack-local-variables ()
5792c834 1195 "Parse and put into effect this buffer's local variables spec."
f3e23606 1196 (hack-local-variables-prop-line)
b4da00e9
RM
1197 ;; Look for "Local variables:" line in last page.
1198 (save-excursion
1199 (goto-char (point-max))
1200 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1201 (if (let ((case-fold-search t))
1202 (and (search-forward "Local Variables:" nil t)
7b3f3dc2 1203 (or (eq enable-local-variables t)
b4da00e9
RM
1204 (and enable-local-variables
1205 (save-window-excursion
1206 (switch-to-buffer (current-buffer))
1207 (save-excursion
1208 (beginning-of-line)
1209 (set-window-start (selected-window) (point)))
1210 (y-or-n-p (format "Set local variables as specified at end of %s? "
51de78c1
RS
1211 (if buffer-file-name
1212 (file-name-nondirectory
1213 buffer-file-name)
1214 (concat "buffer "
1215 (buffer-name))))))))))
b4da00e9 1216 (let ((continue t)
2bba782c
RS
1217 prefix prefixlen suffix beg
1218 (enable-local-eval enable-local-eval))
b4da00e9
RM
1219 ;; The prefix is what comes before "local variables:" in its line.
1220 ;; The suffix is what comes after "local variables:" in its line.
1221 (skip-chars-forward " \t")
1222 (or (eolp)
1223 (setq suffix (buffer-substring (point)
1224 (progn (end-of-line) (point)))))
1225 (goto-char (match-beginning 0))
1226 (or (bolp)
1227 (setq prefix
1228 (buffer-substring (point)
1229 (progn (beginning-of-line) (point)))))
7b3f3dc2 1230
b4da00e9
RM
1231 (if prefix (setq prefixlen (length prefix)
1232 prefix (regexp-quote prefix)))
1233 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1234 (while continue
1235 ;; Look at next local variable spec.
1236 (if selective-display (re-search-forward "[\n\C-m]")
1237 (forward-line 1))
1238 ;; Skip the prefix, if any.
1239 (if prefix
1240 (if (looking-at prefix)
1241 (forward-char prefixlen)
1242 (error "Local variables entry is missing the prefix")))
1243 ;; Find the variable name; strip whitespace.
1244 (skip-chars-forward " \t")
1245 (setq beg (point))
1246 (skip-chars-forward "^:\n")
1247 (if (eolp) (error "Missing colon in local variables entry"))
1248 (skip-chars-backward " \t")
1249 (let* ((str (buffer-substring beg (point)))
1250 (var (read str))
1251 val)
1252 ;; Setting variable named "end" means end of list.
1253 (if (string-equal (downcase str) "end")
1254 (setq continue nil)
1255 ;; Otherwise read the variable value.
1256 (skip-chars-forward "^:")
1257 (forward-char 1)
1258 (setq val (read (current-buffer)))
1259 (skip-chars-backward "\n")
1260 (skip-chars-forward " \t")
1261 (or (if suffix (looking-at suffix) (eolp))
1262 (error "Local variables entry is terminated incorrectly"))
1263 ;; Set the variable. "Variables" mode and eval are funny.
1d517019
RS
1264 (hack-one-local-variable var val)))))))
1265 (run-hooks 'hack-local-variables-hook))
f3e23606
RS
1266
1267(defconst ignored-local-variables
1268 '(enable-local-eval)
1269 "Variables to be ignored in a file's local variable spec.")
1270
be0218a8 1271;; Get confirmation before setting these variables as locals in a file.
05ef1cda 1272(put 'debugger 'risky-local-variable t)
f6fa3ee3 1273(put 'enable-local-eval 'risky-local-variable t)
fce47eea 1274(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
1275(put 'eval 'risky-local-variable t)
1276(put 'file-name-handler-alist 'risky-local-variable t)
1277(put 'minor-mode-map-alist 'risky-local-variable t)
1278(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3
RS
1279(put 'buffer-file-name 'risky-local-variable t)
1280(put 'buffer-auto-save-file-name 'risky-local-variable t)
1281(put 'buffer-file-truename 'risky-local-variable t)
b0ffcc0d
RS
1282(put 'exec-path 'risky-local-variable t)
1283(put 'load-path 'risky-local-variable t)
1284(put 'exec-directory 'risky-local-variable t)
1285(put 'process-environment 'risky-local-variable t)
9afa8bf7
RS
1286;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1287(put 'outline-level 'risky-local-variable t)
d98b741d 1288(put 'rmail-output-file-alist 'risky-local-variable t)
f6fa3ee3 1289
6672c42b
RS
1290;; This one is safe because the user gets to check it before it is used.
1291(put 'compile-command 'safe-local-variable t)
1292
d0bd3513
RS
1293(defun hack-one-local-variable-quotep (exp)
1294 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1295
f3e23606
RS
1296;; "Set" one variable in a local variables spec.
1297;; A few variable names are treated specially.
1298(defun hack-one-local-variable (var val)
1299 (cond ((eq var 'mode)
1300 (funcall (intern (concat (downcase (symbol-name val))
1301 "-mode"))))
1302 ((memq var ignored-local-variables)
1303 nil)
1304 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 1305 ;; Likewise for setting hook variables.
be0218a8 1306 ((or (get var 'risky-local-variable)
6672c42b
RS
1307 (and
1308 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1309 (symbol-name var))
1310 (not (get var 'safe-local-variable))))
d0bd3513
RS
1311 ;; Permit evaling a put of a harmless property
1312 ;; if the args do nothing tricky.
1313 (if (or (and (eq var 'eval)
1314 (consp val)
1315 (eq (car val) 'put)
1316 (hack-one-local-variable-quotep (nth 1 val))
1317 (hack-one-local-variable-quotep (nth 2 val))
1318 ;; Only allow safe values of lisp-indent-hook;
1319 ;; not functions.
1320 (or (numberp (nth 3 val))
dc417415 1321 (equal (nth 3 val) ''defun))
d0bd3513
RS
1322 (memq (nth 1 (nth 2 val))
1323 '(lisp-indent-hook)))
1324 ;; Permit eval if not root and user says ok.
c7e62660 1325 (and (not (zerop (user-uid)))
d0bd3513
RS
1326 (or (eq enable-local-eval t)
1327 (and enable-local-eval
1328 (save-window-excursion
1329 (switch-to-buffer (current-buffer))
1330 (save-excursion
1331 (beginning-of-line)
1332 (set-window-start (selected-window) (point)))
1333 (setq enable-local-eval
1334 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1335 (file-name-nondirectory buffer-file-name)))))))))
7d3221d7
RS
1336 (if (eq var 'eval)
1337 (save-excursion (eval val))
1338 (make-local-variable var)
1339 (set var val))
f3e23606
RS
1340 (message "Ignoring `eval:' in file's local variables")))
1341 ;; Ordinary variable, really set it.
1342 (t (make-local-variable var)
1343 (set var val))))
1344
b4da00e9
RM
1345\f
1346(defun set-visited-file-name (filename)
1347 "Change name of file visited in current buffer to FILENAME.
1348The next time the buffer is saved it will go in the newly specified file.
1349nil or empty string as argument means make buffer not be visiting any file.
1350Remember to delete the initial contents of the minibuffer
1351if you wish to pass an empty string as the argument."
1352 (interactive "FSet visited file name: ")
c11a94fe
RS
1353 (if (buffer-base-buffer)
1354 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
1355 (let (truename)
1356 (if filename
1357 (setq filename
1358 (if (string-equal filename "")
1359 nil
1360 (expand-file-name filename))))
1361 (if filename
1362 (progn
1363 (setq truename (file-truename filename))
1364 (if find-file-visit-truename
a522e5bf
RS
1365 (setq filename truename))))
1366 (or (equal filename buffer-file-name)
1367 (progn
1368 (and filename (lock-buffer filename))
1369 (unlock-buffer)))
1370 (setq buffer-file-name filename)
1371 (if filename ; make buffer name reflect filename.
1372 (let ((new-name (file-name-nondirectory buffer-file-name)))
1373 (if (string= new-name "")
1374 (error "Empty file name"))
1375 (if (eq system-type 'vax-vms)
1376 (setq new-name (downcase new-name)))
1377 (setq default-directory (file-name-directory buffer-file-name))
1378 (or (string= new-name (buffer-name))
1379 (rename-buffer new-name t))))
1380 (setq buffer-backed-up nil)
1381 (clear-visited-file-modtime)
8ccdc29e 1382 ;; Abbreviate the file names of the buffer.
4826e97f 1383 (if truename
8ccdc29e
RS
1384 (progn
1385 (setq buffer-file-truename (abbreviate-file-name truename))
1386 (if find-file-visit-truename
1387 (setq buffer-file-name buffer-file-truename))))
a522e5bf
RS
1388 (setq buffer-file-number
1389 (if filename
2a47b4f5 1390 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 1391 nil)))
b4da00e9
RM
1392 ;; write-file-hooks is normally used for things like ftp-find-file
1393 ;; that visit things that are not local files as if they were files.
1394 ;; Changing to visit an ordinary local file instead should flush the hook.
1395 (kill-local-variable 'write-file-hooks)
c9dca4e0 1396 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
1397 (kill-local-variable 'revert-buffer-function)
1398 (kill-local-variable 'backup-inhibited)
ee81c959
RS
1399 ;; If buffer was read-only because of version control,
1400 ;; that reason is gone now, so make it writable.
1401 (if vc-mode
1402 (setq buffer-read-only nil))
1403 (kill-local-variable 'vc-mode)
b4da00e9
RM
1404 ;; Turn off backup files for certain file names.
1405 ;; Since this is a permanent local, the major mode won't eliminate it.
1406 (and (not (funcall backup-enable-predicate buffer-file-name))
1407 (progn
1408 (make-local-variable 'backup-inhibited)
1409 (setq backup-inhibited t)))
c77a81cf
RS
1410 (let ((oauto buffer-auto-save-file-name))
1411 ;; If auto-save was not already on, turn it on if appropriate.
1412 (if (not buffer-auto-save-file-name)
1413 (and buffer-file-name auto-save-default
1414 (auto-save-mode t))
1415 ;; If auto save is on, start using a new name.
1416 ;; We deliberately don't rename or delete the old auto save
1417 ;; for the old visited file name. This is because perhaps
1418 ;; the user wants to save the new state and then compare with the
1419 ;; previous state from the auto save file.
1420 (setq buffer-auto-save-file-name
1421 (make-auto-save-file-name)))
1422 ;; Rename the old auto save file if any.
1423 (and oauto buffer-auto-save-file-name
e6f0e76c 1424 (file-exists-p oauto)
c77a81cf 1425 (rename-file oauto buffer-auto-save-file-name t)))
b4da00e9
RM
1426 (if buffer-file-name
1427 (set-buffer-modified-p t)))
1428
c2fb8488 1429(defun write-file (filename &optional confirm)
b4da00e9 1430 "Write current buffer into file FILENAME.
41f48cb1
RS
1431Makes buffer visit that file, and marks it not modified.
1432If the buffer is already visiting a file, you can specify
1433a directory name as FILENAME, to write a file of the same
c2fb8488
RS
1434old name in that directory.
1435If optional second arg CONFIRM is non-nil,
1436ask for confirmation for overwriting an existing file."
b4da00e9
RM
1437;; (interactive "FWrite file: ")
1438 (interactive
1439 (list (if buffer-file-name
1440 (read-file-name "Write file: "
1441 nil nil nil nil)
1442 (read-file-name "Write file: "
1443 (cdr (assq 'default-directory
1444 (buffer-local-variables)))
c2fb8488
RS
1445 nil nil (buffer-name)))
1446 t))
b4da00e9 1447 (or (null filename) (string-equal filename "")
41f48cb1
RS
1448 (progn
1449 ;; If arg is just a directory,
1450 ;; use same file name, but in that directory.
1451 (if (and (file-directory-p filename) buffer-file-name)
1452 (setq filename (concat (file-name-as-directory filename)
1453 (file-name-nondirectory buffer-file-name))))
c2fb8488
RS
1454 (and confirm
1455 (file-exists-p filename)
1456 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1457 (error "Canceled")))
41f48cb1 1458 (set-visited-file-name filename)))
b4da00e9
RM
1459 (set-buffer-modified-p t)
1460 (save-buffer))
1461\f
1462(defun backup-buffer ()
1463 "Make a backup of the disk file visited by the current buffer, if appropriate.
1464This is normally done before saving the buffer the first time.
1465If the value is non-nil, it is the result of `file-modes' on the original
1466file; this means that the caller, after saving the buffer, should change
1467the modes of the new file to agree with the old modes."
1468 (if (and make-backup-files (not backup-inhibited)
1469 (not buffer-backed-up)
1470 (file-exists-p buffer-file-name)
1471 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1472 '(?- ?l)))
1473 (let ((real-file-name buffer-file-name)
1474 backup-info backupname targets setmodes)
1475 ;; If specified name is a symbolic link, chase it to the target.
1476 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 1477 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
1478 (setq backup-info (find-backup-file-name real-file-name)
1479 backupname (car backup-info)
1480 targets (cdr backup-info))
1481;;; (if (file-directory-p buffer-file-name)
1482;;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
1483 (if backup-info
1484 (condition-case ()
1485 (let ((delete-old-versions
1486 ;; If have old versions to maybe delete,
1487 ;; ask the user to confirm now, before doing anything.
1488 ;; But don't actually delete til later.
1489 (and targets
1490 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1491 (or delete-old-versions
1492 (y-or-n-p (format "Delete excess backup versions of %s? "
1493 real-file-name))))))
1494 ;; Actually write the back up file.
1495 (condition-case ()
1496 (if (or file-precious-flag
1497 ; (file-symlink-p buffer-file-name)
1498 backup-by-copying
1499 (and backup-by-copying-when-linked
1500 (> (file-nlinks real-file-name) 1))
1501 (and backup-by-copying-when-mismatch
1502 (let ((attr (file-attributes real-file-name)))
1503 (or (nth 9 attr)
1504 (not (file-ownership-preserved-p real-file-name))))))
1505 (condition-case ()
1506 (copy-file real-file-name backupname t t)
1507 (file-error
1508 ;; If copying fails because file BACKUPNAME
1509 ;; is not writable, delete that file and try again.
1510 (if (and (file-exists-p backupname)
1511 (not (file-writable-p backupname)))
1512 (delete-file backupname))
1513 (copy-file real-file-name backupname t t)))
1514 ;; rename-file should delete old backup.
1515 (rename-file real-file-name backupname t)
1516 (setq setmodes (file-modes backupname)))
1517 (file-error
1518 ;; If trouble writing the backup, write it in ~.
1519 (setq backupname (expand-file-name "~/%backup%~"))
1520 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1521 (sleep-for 1)
1522 (condition-case ()
1523 (copy-file real-file-name backupname t t)
1524 (file-error
1525 ;; If copying fails because file BACKUPNAME
1526 ;; is not writable, delete that file and try again.
1527 (if (and (file-exists-p backupname)
1528 (not (file-writable-p backupname)))
1529 (delete-file backupname))
1530 (copy-file real-file-name backupname t t)))))
1531 (setq buffer-backed-up t)
1532 ;; Now delete the old versions, if desired.
1533 (if delete-old-versions
1534 (while targets
1535 (condition-case ()
1536 (delete-file (car targets))
1537 (file-error nil))
1538 (setq targets (cdr targets))))
1539 setmodes)
1540 (file-error nil))))))
b4da00e9 1541
c3554e95 1542(defun file-name-sans-versions (name &optional keep-backup-version)
b4da00e9
RM
1543 "Return FILENAME sans backup versions or strings.
1544This is a separate procedure so your site-init or startup file can
c3554e95
RS
1545redefine it.
1546If the optional argument KEEP-BACKUP-VERSION is non-nil,
1547we do not remove backup version numbers, only true file version numbers."
6eaebaa2 1548 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
1549 (if handler
1550 (funcall handler 'file-name-sans-versions name keep-backup-version)
1551 (substring name 0
1552 (if (eq system-type 'vax-vms)
1553 ;; VMS version number is (a) semicolon, optional
1554 ;; sign, zero or more digits or (b) period, option
1555 ;; sign, zero or more digits, provided this is the
1556 ;; second period encountered outside of the
1557 ;; device/directory part of the file name.
26add1bf
KH
1558 (or (string-match ";[-+]?[0-9]*\\'" name)
1559 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
1560 name)
1561 (match-beginning 1))
1562 (length name))
1563 (if keep-backup-version
1564 (length name)
dbb12f2c 1565 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
1566 (string-match "~\\'" name)
1567 (length name))))))))
b4da00e9 1568
cb0cd911
RS
1569(defun file-ownership-preserved-p (file)
1570 "Returns t if deleting FILE and rewriting it would preserve the owner."
1571 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1572 (if handler
1573 (funcall handler 'file-ownership-preserved-p file)
ec5533be 1574 (let ((attributes (file-attributes file)))
306faa42
RS
1575 ;; Return t if the file doesn't exist, since it's true that no
1576 ;; information would be lost by an (attempted) delete and create.
1577 (or (null attributes)
1578 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 1579
20b5d24c
RS
1580(defun file-name-sans-extension (filename)
1581 "Return FILENAME sans final \"extension\".
1582The extension, in a file name, is the part that follows the last `.'."
1583 (save-match-data
1584 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1585 directory)
1586 (if (string-match "\\.[^.]*\\'" file)
1587 (if (setq directory (file-name-directory filename))
1588 (expand-file-name (substring file 0 (match-beginning 0))
1589 directory)
1590 (substring file 0 (match-beginning 0)))
1591 filename))))
1592
b4da00e9
RM
1593(defun make-backup-file-name (file)
1594 "Create the non-numeric backup file name for FILE.
1595This is a separate function so you can redefine it for customization."
bb157910
RS
1596 (if (eq system-type 'ms-dos)
1597 (let ((fn (file-name-nondirectory file)))
1598 (concat (file-name-directory file)
066327ae
KH
1599 (or
1600 (and (string-match "\\`[^.]+\\'" fn)
1601 (concat (match-string 0 fn) ".~"))
1602 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
1603 (concat (match-string 0 fn) "~")))))
bb157910 1604 (concat file "~")))
b4da00e9
RM
1605
1606(defun backup-file-name-p (file)
1607 "Return non-nil if FILE is a backup file name (numeric or not).
1608This is a separate function so you can redefine it for customization.
1609You may need to redefine `file-name-sans-versions' as well."
066327ae 1610 (string-match "~\\'" file))
b4da00e9 1611
2d051399
RS
1612;; This is used in various files.
1613;; The usage of bv-length is not very clean,
1614;; but I can't see a good alternative,
1615;; so as of now I am leaving it alone.
1616(defun backup-extract-version (fn)
1617 "Given the name of a numeric backup file, return the backup number.
1618Uses the free variable `bv-length', whose value should be
1619the index in the name where the version number begins."
1620 (if (and (string-match "[0-9]+~$" fn bv-length)
1621 (= (match-beginning 0) bv-length))
1622 (string-to-int (substring fn bv-length -1))
1623 0))
1624
b4da00e9
RM
1625;; I believe there is no need to alter this behavior for VMS;
1626;; since backup files are not made on VMS, it should not get called.
1627(defun find-backup-file-name (fn)
1628 "Find a file name for a backup file, and suggestions for deletions.
1629Value is a list whose car is the name for the backup file
eb650569
RS
1630 and whose cdr is a list of old versions to consider deleting now.
1631If the value is nil, don't make a backup."
1632 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
1633 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1634 (if handler
1635 (funcall handler 'find-backup-file-name fn)
1636 (if (eq version-control 'never)
b4da00e9 1637 (list (make-backup-file-name fn))
eb650569
RS
1638 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1639 (bv-length (length base-versions))
1640 possibilities
1641 (versions nil)
1642 (high-water-mark 0)
1643 (deserve-versions-p nil)
1644 (number-to-delete 0))
1645 (condition-case ()
1646 (setq possibilities (file-name-all-completions
1647 base-versions
1648 (file-name-directory fn))
1649 versions (sort (mapcar
1650 (function backup-extract-version)
1651 possibilities)
1652 '<)
1653 high-water-mark (apply 'max 0 versions)
1654 deserve-versions-p (or version-control
1655 (> high-water-mark 0))
1656 number-to-delete (- (length versions)
1657 kept-old-versions kept-new-versions -1))
1658 (file-error
1659 (setq possibilities nil)))
1660 (if (not deserve-versions-p)
1661 (list (make-backup-file-name fn))
1662 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1663 (if (and (> number-to-delete 0)
1664 ;; Delete nothing if there is overflow
1665 ;; in the number of versions to keep.
1666 (>= (+ kept-new-versions kept-old-versions -1) 0))
1667 (mapcar (function (lambda (n)
1668 (concat fn ".~" (int-to-string n) "~")))
1669 (let ((v (nthcdr kept-old-versions versions)))
1670 (rplacd (nthcdr (1- number-to-delete) v) ())
1671 v))))))))))
b4da00e9 1672
b4da00e9
RM
1673(defun file-nlinks (filename)
1674 "Return number of names file FILENAME has."
1675 (car (cdr (file-attributes filename))))
6c636af9
RM
1676
1677(defun file-relative-name (filename &optional directory)
1678 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1679 (setq filename (expand-file-name filename)
77fb6aed
RS
1680 directory (file-name-as-directory (expand-file-name
1681 (or directory default-directory))))
b1fa544f
KH
1682 (let ((ancestor ""))
1683 (while (not (string-match (concat "^" (regexp-quote directory)) filename))
1684 (setq directory (file-name-directory (substring directory 0 -1))
1685 ancestor (concat "../" ancestor)))
1686 (concat ancestor (substring filename (match-end 0)))))
b4da00e9
RM
1687\f
1688(defun save-buffer (&optional args)
1689 "Save current buffer in visited file if modified. Versions described below.
1690By default, makes the previous version into a backup file
1691 if previously requested or if this is the first save.
ac9650be 1692With 1 \\[universal-argument], marks this version
b4da00e9 1693 to become a backup when the next save is done.
ac9650be 1694With 2 \\[universal-argument]'s,
b4da00e9 1695 unconditionally makes the previous version into a backup file.
ac9650be
RS
1696With 3 \\[universal-argument]'s, marks this version
1697 to become a backup when the next save is done,
1698 and unconditionally makes the previous version into a backup file.
1699
b4da00e9
RM
1700With argument of 0, never makes the previous version into a backup file.
1701
1702If a file's name is FOO, the names of its numbered backup versions are
1703 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1704Numeric backups (rather than FOO~) will be made if value of
1705 `version-control' is not the atom `never' and either there are already
1706 numeric versions of the file being backed up, or `version-control' is
1707 non-nil.
1708We don't want excessive versions piling up, so there are variables
1709 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1710 and `kept-new-versions', which tells how many newest versions to keep.
1711 Defaults are 2 old versions and 2 new.
1712`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 1713If `delete-old-versions' is nil, system will query user
b4da00e9
RM
1714 before trimming versions. Otherwise it does it silently."
1715 (interactive "p")
1716 (let ((modp (buffer-modified-p))
1717 (large (> (buffer-size) 50000))
b5a8e0fc
RS
1718 (make-backup-files (or (and make-backup-files (not (eq args 0)))
1719 (memq args '(16 64)))))
b4da00e9
RM
1720 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1721 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1722 (basic-save-buffer)
1723 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1724
1725(defun delete-auto-save-file-if-necessary (&optional force)
1726 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1727Normally delete only if the file was written by this Emacs since
1728the last real save, but optional arg FORCE non-nil means delete anyway."
1729 (and buffer-auto-save-file-name delete-auto-save-files
1730 (not (string= buffer-file-name buffer-auto-save-file-name))
1731 (or force (recent-auto-save-p))
1732 (progn
1733 (condition-case ()
1734 (delete-file buffer-auto-save-file-name)
1735 (file-error nil))
1736 (set-buffer-auto-saved))))
1737
1cc852cc
RS
1738(defvar after-save-hook nil
1739 "Normal hook that is run after a buffer is saved to its file.")
1740
b4da00e9 1741(defun basic-save-buffer ()
1cc852cc
RS
1742 "Save the current buffer in its visited file, if it has been modified.
1743After saving the buffer, run `after-save-hook'."
b4da00e9 1744 (interactive)
c11a94fe
RS
1745 (save-excursion
1746 ;; In an indirect buffer, save its base buffer instead.
1747 (if (buffer-base-buffer)
1748 (set-buffer (buffer-base-buffer)))
1749 (if (buffer-modified-p)
1750 (let ((recent-save (recent-auto-save-p))
1751 setmodes tempsetmodes)
1752 ;; On VMS, rename file and buffer to get rid of version number.
1753 (if (and (eq system-type 'vax-vms)
1754 (not (string= buffer-file-name
1755 (file-name-sans-versions buffer-file-name))))
1756 (let (buffer-new-name)
1757 ;; Strip VMS version number before save.
1758 (setq buffer-file-name
1759 (file-name-sans-versions buffer-file-name))
1760 ;; Construct a (unique) buffer name to correspond.
1761 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1762 (setq buffer-new-name (buffer-name buf))
1763 (kill-buffer buf))
1764 (rename-buffer buffer-new-name)))
1765 ;; If buffer has no file name, ask user for one.
1766 (or buffer-file-name
182891ef
RS
1767 (let ((filename
1768 (expand-file-name
1769 (read-file-name "File to save in: ") nil)))
1770 (and (file-exists-p filename)
1771 (or (y-or-n-p (format "File `%s' exists; overwrite? "
1772 filename))
1773 (error "Canceled")))
1774 (set-visited-file-name filename)))
c11a94fe
RS
1775 (or (verify-visited-file-modtime (current-buffer))
1776 (not (file-exists-p buffer-file-name))
1777 (yes-or-no-p
1778 (format "%s has changed since visited or saved. Save anyway? "
1779 (file-name-nondirectory buffer-file-name)))
1780 (error "Save not confirmed"))
1781 (save-restriction
1782 (widen)
1783 (and (> (point-max) 1)
1784 (/= (char-after (1- (point-max))) ?\n)
1785 (not (and (eq selective-display t)
1786 (= (char-after (1- (point-max))) ?\r)))
1787 (or (eq require-final-newline t)
1788 (and require-final-newline
1789 (y-or-n-p
1790 (format "Buffer %s does not end in newline. Add one? "
1791 (buffer-name)))))
1792 (save-excursion
1793 (goto-char (point-max))
1794 (insert ?\n)))
1795 (or (run-hook-with-args-until-success 'write-contents-hooks)
1796 (run-hook-with-args-until-success 'local-write-file-hooks)
1797 (run-hook-with-args-until-success 'write-file-hooks)
1798 ;; If a hook returned t, file is already "written".
1799 ;; Otherwise, write it the usual way now.
1800 (setq setmodes (basic-save-buffer-1)))
2a47b4f5
RS
1801 (setq buffer-file-number
1802 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
1803 (if setmodes
1804 (condition-case ()
1805 (set-file-modes buffer-file-name setmodes)
1806 (error nil))))
1807 ;; If the auto-save file was recent before this command,
1808 ;; delete it now.
1809 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
1810 ;; Support VC `implicit' locking.
1811 (vc-after-save)
c11a94fe
RS
1812 (run-hooks 'after-save-hook))
1813 (message "(No changes need to be saved)"))))
b4da00e9 1814
87d26afc
RS
1815;; This does the "real job" of writing a buffer into its visited file
1816;; and making a backup file. This is what is normally done
1817;; but inhibited if one of write-file-hooks returns non-nil.
1818;; It returns a value to store in setmodes.
1819(defun basic-save-buffer-1 ()
1820 (let (tempsetmodes setmodes)
1821 (if (not (file-writable-p buffer-file-name))
1822 (let ((dir (file-name-directory buffer-file-name)))
1823 (if (not (file-directory-p dir))
1824 (error "%s is not a directory" dir)
1825 (if (not (file-exists-p buffer-file-name))
1826 (error "Directory %s write-protected" dir)
1827 (if (yes-or-no-p
1828 (format "File %s is write-protected; try to save anyway? "
1829 (file-name-nondirectory
1830 buffer-file-name)))
1831 (setq tempsetmodes t)
1832 (error "Attempt to save to a file which you aren't allowed to write"))))))
1833 (or buffer-backed-up
1834 (setq setmodes (backup-buffer)))
f4a0f59b
RS
1835 (let ((dir (file-name-directory buffer-file-name)))
1836 (if (and file-precious-flag
1837 (file-writable-p dir))
1838 ;; If file is precious, write temp name, then rename it.
1839 ;; This requires write access to the containing dir,
1840 ;; which is why we don't try it if we don't have that access.
1841 (let ((realname buffer-file-name)
6782610c
RS
1842 tempname temp nogood i succeed
1843 (old-modtime (visited-file-modtime)))
f4a0f59b
RS
1844 (setq i 0)
1845 (setq nogood t)
1846 ;; Find the temporary name to write under.
1847 (while nogood
1848 (setq tempname (format "%s#tmp#%d" dir i))
1849 (setq nogood (file-exists-p tempname))
1850 (setq i (1+ i)))
1851 (unwind-protect
1852 (progn (clear-visited-file-modtime)
1853 (write-region (point-min) (point-max)
89095962
RS
1854 tempname nil realname
1855 buffer-file-truename)
f4a0f59b
RS
1856 (setq succeed t))
1857 ;; If writing the temp file fails,
1858 ;; delete the temp file.
6782610c
RS
1859 (or succeed
1860 (progn
1861 (delete-file tempname)
1862 (set-visited-file-modtime old-modtime))))
f4a0f59b
RS
1863 ;; Since we have created an entirely new file
1864 ;; and renamed it, make sure it gets the
1865 ;; right permission bits set.
1866 (setq setmodes (file-modes buffer-file-name))
1867 ;; We succeeded in writing the temp file,
1868 ;; so rename it.
1869 (rename-file tempname buffer-file-name t))
1870 ;; If file not writable, see if we can make it writable
1871 ;; temporarily while we write it.
1872 ;; But no need to do so if we have just backed it up
1873 ;; (setmodes is set) because that says we're superseding.
1874 (cond ((and tempsetmodes (not setmodes))
1875 ;; Change the mode back, after writing.
1876 (setq setmodes (file-modes buffer-file-name))
1877 (set-file-modes buffer-file-name 511)))
1878 (write-region (point-min) (point-max)
89095962 1879 buffer-file-name nil t buffer-file-truename)))
87d26afc
RS
1880 setmodes))
1881
b4da00e9
RM
1882(defun save-some-buffers (&optional arg exiting)
1883 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
1884Optional argument (the prefix) non-nil means save all with no questions.
1885Optional second argument EXITING means ask about certain non-file buffers
1886 as well as about file buffers."
b4da00e9 1887 (interactive "P")
907482b9 1888 (save-window-excursion
5625c2fc
RS
1889 (let ((files-done
1890 (map-y-or-n-p
1891 (function
1892 (lambda (buffer)
1893 (and (buffer-modified-p buffer)
c11a94fe 1894 (not (buffer-base-buffer buffer))
5625c2fc
RS
1895 (or
1896 (buffer-file-name buffer)
1897 (and exiting
1898 (progn
1899 (set-buffer buffer)
1900 (and buffer-offer-save (> (buffer-size) 0)))))
1901 (if arg
1902 t
1903 (if (buffer-file-name buffer)
1904 (format "Save file %s? "
1905 (buffer-file-name buffer))
1906 (format "Save buffer %s? "
1907 (buffer-name buffer)))))))
1908 (function
1909 (lambda (buffer)
1910 (set-buffer buffer)
1911 (save-buffer)))
1912 (buffer-list)
1913 '("buffer" "buffers" "save")
1914 (list (list ?\C-r (lambda (buf)
1915 (view-buffer buf)
1916 (setq view-exit-action
1917 '(lambda (ignore)
1918 (exit-recursive-edit)))
1919 (recursive-edit)
1920 ;; Return nil to ask about BUF again.
1921 nil)
1922 "display the current buffer"))))
1923 (abbrevs-done
1924 (and save-abbrevs abbrevs-changed
1925 (progn
1926 (if (or arg
1927 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
1928 (write-abbrev-file nil))
1929 ;; Don't keep bothering user if he says no.
1930 (setq abbrevs-changed nil)
1931 t))))
1932 (or (> files-done 0) abbrevs-done
1933 (message "(No files need saving)")))))
b4da00e9
RM
1934\f
1935(defun not-modified (&optional arg)
1936 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
1937With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
1938
1939It is not a good idea to use this function in Lisp programs, because it
1940prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
1941 (interactive "P")
1942 (message (if arg "Modification-flag set"
1943 "Modification-flag cleared"))
1944 (set-buffer-modified-p arg))
1945
1946(defun toggle-read-only (&optional arg)
1947 "Change whether this buffer is visiting its file read-only.
1948With arg, set read-only iff arg is positive."
1949 (interactive "P")
1950 (setq buffer-read-only
1951 (if (null arg)
1952 (not buffer-read-only)
1953 (> (prefix-numeric-value arg) 0)))
3941fe2c 1954 (force-mode-line-update))
b4da00e9
RM
1955
1956(defun insert-file (filename)
1957 "Insert contents of file FILENAME into buffer after point.
1958Set mark after the inserted text.
1959
1960This function is meant for the user to run interactively.
1961Don't call it from programs! Use `insert-file-contents' instead.
1962\(Its calling sequence is different; see its documentation)."
6f931919 1963 (interactive "*fInsert file: ")
3be6243a
RS
1964 (if (file-directory-p filename)
1965 (signal 'file-error (list "Opening input file" "file is a directory"
1966 filename)))
b4da00e9
RM
1967 (let ((tem (insert-file-contents filename)))
1968 (push-mark (+ (point) (car (cdr tem))))))
1969
1970(defun append-to-file (start end filename)
1971 "Append the contents of the region to the end of file FILENAME.
1972When called from a function, expects three arguments,
1973START, END and FILENAME. START and END are buffer positions
1974saying what text to write."
1975 (interactive "r\nFAppend to file: ")
1976 (write-region start end filename t))
1977
1978(defun file-newest-backup (filename)
1979 "Return most recent backup file for FILENAME or nil if no backups exist."
1980 (let* ((filename (expand-file-name filename))
1981 (file (file-name-nondirectory filename))
1982 (dir (file-name-directory filename))
1983 (comp (file-name-all-completions file dir))
1984 newest)
1985 (while comp
1986 (setq file (concat dir (car comp))
1987 comp (cdr comp))
1988 (if (and (backup-file-name-p file)
1989 (or (null newest) (file-newer-than-file-p file newest)))
1990 (setq newest file)))
1991 newest))
1992
1993(defun rename-uniquely ()
1994 "Rename current buffer to a similar name not already taken.
1995This function is useful for creating multiple shell process buffers
1996or multiple mail buffers, etc."
1997 (interactive)
40eb8038 1998 (save-match-data
ed34f320
RS
1999 (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
2000 (not (and buffer-file-name
2001 (string= (buffer-name)
2002 (file-name-nondirectory
2003 buffer-file-name)))))
2004 ;; If the existing buffer name has a <NNN>,
2005 ;; which isn't part of the file name (if any),
2006 ;; then get rid of that.
40eb8038
RS
2007 (substring (buffer-name) 0 (match-beginning 0))
2008 (buffer-name)))
2009 (new-buf (generate-new-buffer base-name))
2010 (name (buffer-name new-buf)))
2011 (kill-buffer new-buf)
2012 (rename-buffer name)
3941fe2c 2013 (force-mode-line-update))))
5bbbceb1 2014
4e43240a 2015(defun make-directory (dir &optional parents)
5ce8bb89
RS
2016 "Create the directory DIR and any nonexistent parent dirs.
2017Interactively, the default choice of directory to create
2018is the current default directory for file names.
2019That is useful when you have visited a file in a nonexistint directory.
2020
2021Noninteractively, the second (optional) argument PARENTS says whether
2022to create parent directories if they don't exist."
2023 (interactive
2024 (list (read-file-name "Make directory: " default-directory default-directory
2025 nil nil)
2026 t))
6eaebaa2 2027 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
2028 (if handler
2029 (funcall handler 'make-directory dir parents)
2030 (if (not parents)
2031 (make-directory-internal dir)
2032 (let ((dir (directory-file-name (expand-file-name dir)))
2033 create-list)
2034 (while (not (file-exists-p dir))
2035 (setq create-list (cons dir create-list)
2036 dir (directory-file-name (file-name-directory dir))))
2037 (while create-list
2038 (make-directory-internal (car create-list))
2039 (setq create-list (cdr create-list))))))))
b4da00e9
RM
2040\f
2041(put 'revert-buffer-function 'permanent-local t)
2042(defvar revert-buffer-function nil
0973d78b
RS
2043 "Function to use to revert this buffer, or nil to do the default.
2044The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2045which are the arguments that `revert-buffer' received.")
b4da00e9
RM
2046
2047(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2048(defvar revert-buffer-insert-file-contents-function nil
2049 "Function to use to insert contents when reverting this buffer.
2050Gets two args, first the nominal file name to use,
2051and second, t if reading the auto-save file.")
2052
5f76e7d4
KH
2053(defvar before-revert-hook nil
2054 "Normal hook for `revert-buffer' to run before reverting.
2055If `revert-buffer-function' is used to override the normal revert
2056mechanism, this hook is not used.")
2057
2058(defvar after-revert-hook nil
2059 "Normal hook for `revert-buffer' to run after reverting.
2060Note that the hook value that it runs is the value that was in effect
2061before reverting; that makes a difference if you have buffer-local
2062hook functions.
2063
2064If `revert-buffer-function' is used to override the normal revert
2065mechanism, this hook is not used.")
2066
1ab31687 2067(defun revert-buffer (&optional ignore-auto noconfirm)
b4da00e9
RM
2068 "Replace the buffer text with the text of the visited file on disk.
2069This undoes all changes since the file was visited or saved.
8c0e7b73
JB
2070With a prefix argument, offer to revert from latest auto-save file, if
2071that is more recent than the visited file.
1ab31687 2072
65ee6096 2073When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
2074to revert from the auto-save file when this is nil. Note that the
2075sense of this argument is the reverse of the prefix argument, for the
2076sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2077to nil.
2078
2079Optional second argument NOCONFIRM means don't ask for confirmation at
2080all.
b4da00e9 2081
8c0e7b73 2082If the value of `revert-buffer-function' is non-nil, it is called to
fb6208a6
RS
2083do the work.
2084
4fbf62ee
KH
2085The default revert function runs the hook `before-revert-hook' at the
2086beginning and `after-revert-hook' at the end."
1ab31687
JB
2087 ;; I admit it's odd to reverse the sense of the prefix argument, but
2088 ;; there is a lot of code out there which assumes that the first
2089 ;; argument should be t to avoid consulting the auto-save file, and
2090 ;; there's no straightforward way to encourage authors to notice a
2091 ;; reversal of the argument sense. So I'm just changing the user
2092 ;; interface, but leaving the programmatic interface the same.
e0867e99 2093 (interactive (list (not current-prefix-arg)))
b4da00e9 2094 (if revert-buffer-function
1ab31687 2095 (funcall revert-buffer-function ignore-auto noconfirm)
b4da00e9 2096 (let* ((opoint (point))
1ab31687
JB
2097 (auto-save-p (and (not ignore-auto)
2098 (recent-auto-save-p)
b4da00e9
RM
2099 buffer-auto-save-file-name
2100 (file-readable-p buffer-auto-save-file-name)
2101 (y-or-n-p
2102 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2103 (file-name (if auto-save-p
2104 buffer-auto-save-file-name
2105 buffer-file-name)))
2106 (cond ((null file-name)
2107 (error "Buffer does not seem to be associated with any file"))
2108 ((or noconfirm
2109 (yes-or-no-p (format "Revert buffer from file %s? "
2110 file-name)))
4fbf62ee 2111 (run-hooks 'before-revert-hook)
b4da00e9
RM
2112 ;; If file was backed up but has changed since,
2113 ;; we shd make another backup.
2114 (and (not auto-save-p)
5bbbceb1 2115 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
2116 (setq buffer-backed-up nil))
2117 ;; Get rid of all undo records for this buffer.
2118 (or (eq buffer-undo-list t)
2119 (setq buffer-undo-list nil))
ba5c8c93
KH
2120 ;; Effectively copy the after-revert-hook status,
2121 ;; since after-find-file will clobber it.
2122 (let ((global-hook (default-value 'after-revert-hook))
2123 (local-hook-p (local-variable-p 'after-revert-hook))
2124 (local-hook (and (local-variable-p 'after-revert-hook)
2125 after-revert-hook)))
2126 (let (buffer-read-only
2127 ;; Don't make undo records for the reversion.
2128 (buffer-undo-list t))
2129 (if revert-buffer-insert-file-contents-function
2130 (funcall revert-buffer-insert-file-contents-function
2131 file-name auto-save-p)
2132 (if (not (file-exists-p file-name))
2133 (error "File %s no longer exists!" file-name))
2134 ;; Bind buffer-file-name to nil
2135 ;; so that we don't try to lock the file.
2136 (let ((buffer-file-name nil))
2137 (or auto-save-p
2138 (unlock-buffer)))
2139 (widen)
2140 (insert-file-contents file-name (not auto-save-p)
2141 nil nil t)))
2142 (goto-char (min opoint (point-max)))
2143 ;; Recompute the truename in case changes in symlinks
2144 ;; have changed the truename.
2145 (setq buffer-file-truename
2146 (abbreviate-file-name (file-truename buffer-file-name)))
2147 (after-find-file nil nil t t)
2148 ;; Run after-revert-hook as it was before we reverted.
2149 (setq-default revert-buffer-internal-hook global-hook)
2150 (if local-hook-p
2151 (progn
2152 (make-local-variable 'revert-buffer-internal-hook)
2153 (setq revert-buffer-internal-hook local-hook))
2154 (kill-local-variable 'revert-buffer-internal-hook))
2155 (run-hooks 'revert-buffer-internal-hook))
4fbf62ee 2156 t)))))
b4da00e9
RM
2157
2158(defun recover-file (file)
2159 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
2160 ;; Actually putting the file name in the minibuffer should be used
2161 ;; only rarely.
2162 ;; Not just because users often use the default.
e1dadc17 2163 (interactive "FRecover file: ")
b4da00e9 2164 (setq file (expand-file-name file))
f7da6740
RS
2165 (if (auto-save-file-name-p (file-name-nondirectory file))
2166 (error "%s is an auto-save file" file))
b4da00e9
RM
2167 (let ((file-name (let ((buffer-file-name file))
2168 (make-auto-save-file-name))))
945e1965
RS
2169 (cond ((if (file-exists-p file)
2170 (not (file-newer-than-file-p file-name file))
2171 (not (file-exists-p file-name)))
b4da00e9
RM
2172 (error "Auto-save file %s not current" file-name))
2173 ((save-window-excursion
2174 (if (not (eq system-type 'vax-vms))
2175 (with-output-to-temp-buffer "*Directory*"
2176 (buffer-disable-undo standard-output)
2177 (call-process "ls" nil standard-output nil
2dc2b736
RS
2178 (if (file-symlink-p file) "-lL" "-l")
2179 file file-name)))
b4da00e9
RM
2180 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2181 (switch-to-buffer (find-file-noselect file t))
2182 (let ((buffer-read-only nil))
2183 (erase-buffer)
2184 (insert-file-contents file-name nil))
8cfb9d46 2185 (after-find-file nil nil t))
b4da00e9
RM
2186 (t (error "Recover-file cancelled.")))))
2187
6598027d 2188(defun recover-session ()
9aee5392
RS
2189 "Recover auto save files from a previous Emacs session.
2190This command first displays a Dired buffer showing you the
2191previous sessions that you could recover from.
2192To choose one, move point to the proper line and then type C-c C-c.
2193Then you'll be asked about a number of files to recover."
2194 (interactive)
5bcb0278 2195 (dired (concat auto-save-list-file-prefix "*"))
9aee5392
RS
2196 (goto-char (point-min))
2197 (or (looking-at "Move to the session you want to recover,")
2198 (let ((inhibit-read-only t))
033ef863
RS
2199 (insert "Move to the session you want to recover,\n"
2200 "then type C-c C-c to select it.\n\n"
2201 "You can also delete some of these files;\n"
2202 "type d on a line to mark that file for deletion.\n\n")))
9aee5392 2203 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 2204 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 2205
80280bb7 2206(defun recover-session-finish ()
9aee5392
RS
2207 "Choose one saved session to recover auto-save files from.
2208This command is used in the special Dired buffer created by
80280bb7 2209\\[recover-session]."
9aee5392
RS
2210 (interactive)
2211 ;; Get the name of the session file to recover from.
2212 (let ((file (dired-get-filename))
953a03b2 2213 files
9aee5392 2214 (buffer (get-buffer-create " *recover*")))
033ef863 2215 (dired-do-flagged-delete t)
9aee5392
RS
2216 (unwind-protect
2217 (save-excursion
2218 ;; Read in the auto-save-list file.
2219 (set-buffer buffer)
2220 (erase-buffer)
2221 (insert-file-contents file)
953a03b2
RS
2222 ;; Loop thru the text of that file
2223 ;; and get out the names of the files to recover.
2224 (while (not (eobp))
2225 (let (thisfile autofile)
2226 (if (eolp)
2227 ;; This is a pair of lines for a non-file-visiting buffer.
2228 ;; Get the auto-save file name and manufacture
2229 ;; a "visited file name" from that.
2230 (progn
2231 (forward-line 1)
2232 (setq autofile
2233 (buffer-substring-no-properties
2234 (point)
2235 (save-excursion
2236 (end-of-line)
2237 (point))))
2238 (setq thisfile
2239 (expand-file-name
2240 (substring
2241 (file-name-nondirectory autofile)
2242 1 -1)
2243 (file-name-directory autofile)))
2244 (forward-line 1))
2245 ;; This pair of lines is a file-visiting
2246 ;; buffer. Use the visited file name.
2247 (progn
2248 (setq thisfile
2249 (buffer-substring-no-properties
2250 (point) (progn (end-of-line) (point))))
2251 (forward-line 1)
2252 (setq autofile
2253 (buffer-substring-no-properties
2254 (point) (progn (end-of-line) (point))))
2255 (forward-line 1)))
2256 ;; Ignore a file if its auto-save file does not exist now.
2257 (if (file-exists-p autofile)
2258 (setq files (cons thisfile files)))))
2259 (setq files (nreverse files))
945e1965
RS
2260 ;; The file contains a pair of line for each auto-saved buffer.
2261 ;; The first line of the pair contains the visited file name
2262 ;; or is empty if the buffer was not visiting a file.
2263 ;; The second line is the auto-save file name.
953a03b2
RS
2264 (if files
2265 (map-y-or-n-p "Recover %s? "
2266 (lambda (file)
2267 (condition-case nil
2268 (save-excursion (recover-file file))
2269 (error
2270 "Failed to recover `%s'" file)))
2271 files
2272 '("file" "files" "recover"))
2273 (message "No files can be recovered from this session now")))
9aee5392
RS
2274 (kill-buffer buffer))))
2275
b4da00e9
RM
2276(defun kill-some-buffers ()
2277 "For each buffer, ask whether to kill it."
2278 (interactive)
2279 (let ((list (buffer-list)))
2280 (while list
2281 (let* ((buffer (car list))
2282 (name (buffer-name buffer)))
2283 (and (not (string-equal name ""))
2284 (/= (aref name 0) ? )
2285 (yes-or-no-p
2286 (format "Buffer %s %s. Kill? "
2287 name
2288 (if (buffer-modified-p buffer)
2289 "HAS BEEN EDITED" "is unmodified")))
2290 (kill-buffer buffer)))
2291 (setq list (cdr list)))))
2292\f
2293(defun auto-save-mode (arg)
2294 "Toggle auto-saving of contents of current buffer.
f3e23606 2295With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
2296 (interactive "P")
2297 (setq buffer-auto-save-file-name
2298 (and (if (null arg)
74b9c2af
RS
2299 (or (not buffer-auto-save-file-name)
2300 ;; If autosave is off because buffer has shrunk,
2301 ;; then toggling should turn it on.
2302 (< buffer-saved-size 0))
b4da00e9
RM
2303 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2304 (if (and buffer-file-name auto-save-visited-file-name
2305 (not buffer-read-only))
2306 buffer-file-name
2307 (make-auto-save-file-name))))
0b7f1ef2
RS
2308 ;; If -1 was stored here, to temporarily turn off saving,
2309 ;; turn it back on.
2310 (and (< buffer-saved-size 0)
2311 (setq buffer-saved-size 0))
b4da00e9
RM
2312 (if (interactive-p)
2313 (message "Auto-save %s (in this buffer)"
2314 (if buffer-auto-save-file-name "on" "off")))
2315 buffer-auto-save-file-name)
2316
2317(defun rename-auto-save-file ()
2318 "Adjust current buffer's auto save file name for current conditions.
2319Also rename any existing auto save file, if it was made in this session."
2320 (let ((osave buffer-auto-save-file-name))
2321 (setq buffer-auto-save-file-name
2322 (make-auto-save-file-name))
2323 (if (and osave buffer-auto-save-file-name
2324 (not (string= buffer-auto-save-file-name buffer-file-name))
2325 (not (string= buffer-auto-save-file-name osave))
2326 (file-exists-p osave)
2327 (recent-auto-save-p))
2328 (rename-file osave buffer-auto-save-file-name t))))
2329
2330(defun make-auto-save-file-name ()
2331 "Return file name to use for auto-saves of current buffer.
2332Does not consider `auto-save-visited-file-name' as that variable is checked
2333before calling this function. You can redefine this for customization.
2334See also `auto-save-file-name-p'."
2335 (if buffer-file-name
2336 (concat (file-name-directory buffer-file-name)
2337 "#"
2338 (file-name-nondirectory buffer-file-name)
2339 "#")
0a1763b4
RS
2340
2341 ;; Deal with buffers that don't have any associated files. (Mail
2342 ;; mode tends to create a good number of these.)
2343
7d483e8c 2344 (let ((buffer-name (buffer-name))
0a1763b4
RS
2345 (limit 0))
2346 ;; Use technique from Sebastian Kremer's auto-save
2347 ;; package to turn slashes into \\!. This ensures that
2348 ;; the auto-save buffer name is unique.
2349
2350 (while (string-match "[/\\]" buffer-name limit)
2351 (setq buffer-name (concat (substring buffer-name 0 (match-beginning 0))
2352 (if (string= (substring buffer-name
2353 (match-beginning 0)
2354 (match-end 0))
2355 "/")
2356 "\\!"
2357 "\\\\")
2358 (substring buffer-name (match-end 0))))
2359 (setq limit (1+ (match-end 0))))
2360
7d483e8c 2361 (expand-file-name (format "#%s#%s#" buffer-name (make-temp-name ""))))))
b4da00e9
RM
2362
2363(defun auto-save-file-name-p (filename)
2364 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2365FILENAME should lack slashes. You can redefine this for customization."
2366 (string-match "^#.*#$" filename))
2367\f
2368(defconst list-directory-brief-switches
2369 (if (eq system-type 'vax-vms) "" "-CF")
2370 "*Switches for list-directory to pass to `ls' for brief listing,")
2371
2372(defconst list-directory-verbose-switches
2373 (if (eq system-type 'vax-vms)
2374 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2375 "-l")
2376 "*Switches for list-directory to pass to `ls' for verbose listing,")
2377
2378(defun list-directory (dirname &optional verbose)
2379 "Display a list of files in or matching DIRNAME, a la `ls'.
2380DIRNAME is globbed by the shell if necessary.
2381Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2382Actions controlled by variables `list-directory-brief-switches'
2383and `list-directory-verbose-switches'."
2384 (interactive (let ((pfx current-prefix-arg))
2385 (list (read-file-name (if pfx "List directory (verbose): "
2386 "List directory (brief): ")
2387 nil default-directory nil)
2388 pfx)))
2389 (let ((switches (if verbose list-directory-verbose-switches
2390 list-directory-brief-switches)))
2391 (or dirname (setq dirname default-directory))
2392 (setq dirname (expand-file-name dirname))
2393 (with-output-to-temp-buffer "*Directory*"
2394 (buffer-disable-undo standard-output)
2395 (princ "Directory ")
2396 (princ dirname)
2397 (terpri)
c3554e95
RS
2398 (save-excursion
2399 (set-buffer "*Directory*")
a513a2f8 2400 (setq default-directory (file-name-directory dirname))
c3554e95
RS
2401 (let ((wildcard (not (file-directory-p dirname))))
2402 (insert-directory dirname switches wildcard (not wildcard)))))))
2403
2404(defvar insert-directory-program "ls"
2405 "Absolute or relative name of the `ls' program used by `insert-directory'.")
2406
2407;; insert-directory
2408;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2409;; FULL-DIRECTORY-P is nil.
2410;; The single line of output must display FILE's name as it was
2411;; given, namely, an absolute path name.
2412;; - must insert exactly one line for each file if WILDCARD or
2413;; FULL-DIRECTORY-P is t, plus one optional "total" line
2414;; before the file lines, plus optional text after the file lines.
2415;; Lines are delimited by "\n", so filenames containing "\n" are not
2416;; allowed.
2417;; File lines should display the basename.
2418;; - must be consistent with
2419;; - functions dired-move-to-filename, (these two define what a file line is)
2420;; dired-move-to-end-of-filename,
2421;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2422;; dired-insert-headerline
2423;; dired-after-subdir-garbage (defines what a "total" line is)
2424;; - variable dired-subdir-regexp
2425(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 2426 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 2427Leaves point after the inserted text.
727d277d 2428SWITCHES may be a string of options, or a list of strings.
c3554e95
RS
2429Optional third arg WILDCARD means treat FILE as shell wildcard.
2430Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2431switches do not contain `d', so that a full listing is expected.
2432
2433This works by running a directory listing program
406e12d9 2434whose name is in the variable `insert-directory-program'.
c3554e95 2435If WILDCARD, it also runs the shell specified by `shell-file-name'."
c870ab8e
RS
2436 ;; We need the directory in order to find the right handler.
2437 (let ((handler (find-file-name-handler (expand-file-name file)
2438 'insert-directory)))
c3554e95
RS
2439 (if handler
2440 (funcall handler 'insert-directory file switches
2441 wildcard full-directory-p)
b4da00e9 2442 (if (eq system-type 'vax-vms)
c3554e95
RS
2443 (vms-read-directory file switches (current-buffer))
2444 (if wildcard
a9fa0bd5
RS
2445 ;; Run ls in the directory of the file pattern we asked for.
2446 (let ((default-directory
2447 (if (file-name-absolute-p file)
2448 (file-name-directory file)
6e2dc7cb
RS
2449 (file-name-directory (expand-file-name file))))
2450 (pattern (file-name-nondirectory file))
2451 (beg 0))
2452 ;; Quote some characters that have special meanings in shells;
2453 ;; but don't quote the wildcards--we want them to be special.
2454 ;; We also currently don't quote the quoting characters
2455 ;; in case people want to use them explicitly to quote
2456 ;; wildcard characters.
d1739e52 2457 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
6e2dc7cb
RS
2458 (setq pattern
2459 (concat (substring pattern 0 (match-beginning 0))
2460 "\\"
2461 (substring pattern (match-beginning 0)))
2462 beg (1+ (match-end 0))))
c3554e95 2463 (call-process shell-file-name nil t nil
108aa1b5
RS
2464 "-c" (concat "\\" ;; Disregard shell aliases!
2465 insert-directory-program
727d277d
RS
2466 " -d "
2467 (if (stringp switches)
2468 switches
eb51e665 2469 (mapconcat 'identity switches " "))
727d277d 2470 " "
eb51e665 2471 pattern)))
a18b7c81
JB
2472 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2473 ;; directory if FILE is a symbolic link.
727d277d
RS
2474 (apply 'call-process
2475 insert-directory-program nil t nil
2476 (let (list)
9700caaf 2477 (if (listp switches)
727d277d 2478 (setq list switches)
9700caaf
RS
2479 (if (not (equal switches ""))
2480 (progn
2481 ;; Split the switches at any spaces
2482 ;; so we can pass separate options as separate args.
2483 (while (string-match " " switches)
2484 (setq list (cons (substring switches 0 (match-beginning 0))
2485 list)
2486 switches (substring switches (match-end 0))))
2487 (setq list (cons switches list)))))
727d277d
RS
2488 (append list
2489 (list
2490 (if full-directory-p
2491 (concat (file-name-as-directory file) ".")
2492 file))))))))))
b4da00e9 2493
88902b35 2494(defvar kill-emacs-query-functions nil
65d5c6de 2495 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
2496If any of these functions returns nil, killing Emacs is cancelled.
2497`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
2498but `kill-emacs', the low level primitive, does not.
2499See also `kill-emacs-hook'.")
88902b35 2500
b4da00e9
RM
2501(defun save-buffers-kill-emacs (&optional arg)
2502 "Offer to save each buffer, then kill this Emacs process.
2503With prefix arg, silently save all file-visiting buffers, then kill."
2504 (interactive "P")
2505 (save-some-buffers arg t)
2506 (and (or (not (memq t (mapcar (function
2507 (lambda (buf) (and (buffer-file-name buf)
2508 (buffer-modified-p buf))))
2509 (buffer-list))))
2510 (yes-or-no-p "Modified buffers exist; exit anyway? "))
2511 (or (not (fboundp 'process-list))
2512 ;; process-list is not defined on VMS.
2513 (let ((processes (process-list))
2514 active)
2515 (while processes
528415e7 2516 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
2517 (let ((val (process-kill-without-query (car processes))))
2518 (process-kill-without-query (car processes) val)
2519 val)
2520 (setq active t))
2521 (setq processes (cdr processes)))
2522 (or (not active)
2523 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 2524 ;; Query the user for other things, perhaps.
fb15c113 2525 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
b4da00e9
RM
2526 (kill-emacs)))
2527\f
2528(define-key ctl-x-map "\C-f" 'find-file)
2529(define-key ctl-x-map "\C-q" 'toggle-read-only)
2530(define-key ctl-x-map "\C-r" 'find-file-read-only)
2531(define-key ctl-x-map "\C-v" 'find-alternate-file)
2532(define-key ctl-x-map "\C-s" 'save-buffer)
2533(define-key ctl-x-map "s" 'save-some-buffers)
2534(define-key ctl-x-map "\C-w" 'write-file)
2535(define-key ctl-x-map "i" 'insert-file)
2536(define-key esc-map "~" 'not-modified)
2537(define-key ctl-x-map "\C-d" 'list-directory)
2538(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
2539
2540(define-key ctl-x-4-map "f" 'find-file-other-window)
2541(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
2542(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
2543(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 2544(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 2545
f98955ea
JB
2546(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
2547(define-key ctl-x-5-map "f" 'find-file-other-frame)
2548(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
2549(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
2550
2551;;; files.el ends here