(gud-dbx-directories): New variable.
[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
715 (dired-noselect filename)
716 (error "%s is a directory." filename))
f3e23606
RS
717 (let* ((buf (get-file-buffer filename))
718 (truename (abbreviate-file-name (file-truename filename)))
719 (number (nthcdr 10 (file-attributes truename)))
720 ;; Find any buffer for a file which has same truename.
138c44f6 721 (other (and (not buf) (find-buffer-visiting filename)))
f3e23606
RS
722 error)
723 ;; Let user know if there is a buffer with the same truename.
138c44f6
KH
724 (if other
725 (progn
327bebe8
RS
726 (or nowarn
727 (string-equal filename (buffer-file-name other))
728 (message "%s and %s are the same file"
729 filename (buffer-file-name other)))
138c44f6
KH
730 ;; Optionally also find that buffer.
731 (if (or find-file-existing-other-name find-file-visit-truename)
732 (setq buf other))))
b4da00e9
RM
733 (if buf
734 (or nowarn
735 (verify-visited-file-modtime buf)
736 (cond ((not (file-exists-p filename))
737 (error "File %s no longer exists!" filename))
738 ((yes-or-no-p
b7d19f4a
KH
739 (if (string= (file-name-nondirectory filename)
740 (buffer-name buf))
741 (format
742 (if (buffer-modified-p buf)
743 "File %s changed on disk. Discard your edits? "
744 "File %s changed on disk. Reread from disk? ")
745 (file-name-nondirectory filename))
746 (format
747 (if (buffer-modified-p buf)
748 "File %s changed on disk. Discard your edits in %s? "
749 "File %s changed on disk. Reread from disk into %s? ")
750 (file-name-nondirectory filename)
751 (buffer-name buf))))
b4da00e9
RM
752 (save-excursion
753 (set-buffer buf)
754 (revert-buffer t t)))))
755 (save-excursion
f3e23606
RS
756;;; The truename stuff makes this obsolete.
757;;; (let* ((link-name (car (file-attributes filename)))
758;;; (linked-buf (and (stringp link-name)
759;;; (get-file-buffer link-name))))
760;;; (if (bufferp linked-buf)
761;;; (message "Symbolic link to file in buffer %s"
762;;; (buffer-name linked-buf))))
b4da00e9 763 (setq buf (create-file-buffer filename))
a2e12c0c 764 (set-buffer-major-mode buf)
b4da00e9
RM
765 (set-buffer buf)
766 (erase-buffer)
40dfe94d
RS
767 (if rawfile
768 (condition-case ()
769 (insert-file-contents-literally filename t)
770 (file-error
771 ;; Unconditionally set error
772 (setq error t)))
773 (condition-case ()
774 (insert-file-contents filename t)
775 (file-error
776 ;; Run find-file-not-found-hooks until one returns non-nil.
777 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
778 ;; If they fail too, set error.
779 (setq error t)))))
f3e23606 780 ;; Find the file's truename, and maybe use that as visited name.
138c44f6 781 (setq buffer-file-truename truename)
1770543d
RS
782 (setq buffer-file-number number)
783 ;; On VMS, we may want to remember which directory in a search list
784 ;; the file was found in.
785 (and (eq system-type 'vax-vms)
786 (let (logical)
787 (if (string-match ":" (file-name-directory filename))
788 (setq logical (substring (file-name-directory filename)
789 0 (match-beginning 0))))
790 (not (member logical find-file-not-true-dirname-list)))
791 (setq buffer-file-name buffer-file-truename))
1cc2fbeb 792 (if find-file-visit-truename
27d0420c
RS
793 (setq buffer-file-name
794 (setq filename
795 (expand-file-name buffer-file-truename))))
b4da00e9
RM
796 ;; Set buffer's default directory to that of the file.
797 (setq default-directory (file-name-directory filename))
798 ;; Turn off backup files for certain file names. Since
799 ;; this is a permanent local, the major mode won't eliminate it.
800 (and (not (funcall backup-enable-predicate buffer-file-name))
801 (progn
802 (make-local-variable 'backup-inhibited)
803 (setq backup-inhibited t)))
40dfe94d
RS
804 (if rawfile
805 nil
806 (after-find-file error (not nowarn)))))
b4da00e9
RM
807 buf)))
808\f
f7d786d0
RS
809(defvar after-find-file-from-revert-buffer nil)
810
e0ab8879
RS
811(defun after-find-file (&optional error warn noauto
812 after-find-file-from-revert-buffer)
b4da00e9
RM
813 "Called after finding a file and by the default revert function.
814Sets buffer mode, parses local variables.
8cfb9d46 815Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
816error in reading the file. WARN non-nil means warn if there
817exists an auto-save file more recent than the visited file.
8cfb9d46 818NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
819Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
820 means this call was from `revert-buffer'.
b4da00e9
RM
821Finishes by calling the functions in `find-file-hooks'."
822 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
823 (if noninteractive
824 nil
825 (let* (not-serious
826 (msg
827 (cond ((and error (file-attributes buffer-file-name))
828 (setq buffer-read-only t)
ff78d520 829 "File exists, but cannot be read.")
b4da00e9
RM
830 ((not buffer-read-only)
831 (if (and warn
832 (file-newer-than-file-p (make-auto-save-file-name)
833 buffer-file-name))
834 "Auto save file is newer; consider M-x recover-file"
835 (setq not-serious t)
836 (if error "(New file)" nil)))
837 ((not error)
838 (setq not-serious t)
839 "Note: file is write protected")
840 ((file-attributes (directory-file-name default-directory))
841 "File not found and directory write-protected")
4e43240a
RS
842 ((file-exists-p (file-name-directory buffer-file-name))
843 (setq buffer-read-only nil))
b4da00e9 844 (t
5bbbceb1 845 (setq buffer-read-only nil)
4e43240a
RS
846 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
847 "Use M-x make-dir RET RET to create the directory"
848 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
b4da00e9
RM
849 (if msg
850 (progn
851 (message msg)
852 (or not-serious (sit-for 1 nil t)))))
8cfb9d46 853 (if (and auto-save-default (not noauto))
b4da00e9
RM
854 (auto-save-mode t)))
855 (normal-mode t)
a4f5efdc 856 (run-hooks 'find-file-hooks))
b4da00e9
RM
857
858(defun normal-mode (&optional find-file)
859 "Choose the major mode for this buffer automatically.
860Also sets up any specified local variables of the file.
861Uses the visited file name, the -*- line, and the local variables spec.
862
863This function is called automatically from `find-file'. In that case,
864we may set up specified local variables depending on the value of
865`enable-local-variables': if it is t, we do; if it is nil, we don't;
866otherwise, we query. `enable-local-variables' is ignored if you
867run `normal-mode' explicitly."
868 (interactive)
869 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
870 (condition-case err
871 (set-auto-mode)
872 (error (message "File mode specification error: %s"
873 (prin1-to-string err))))
874 (condition-case err
7b3f3dc2
JB
875 (let ((enable-local-variables (or (not find-file)
876 enable-local-variables)))
877 (hack-local-variables))
b4da00e9
RM
878 (error (message "File local-variables error: %s"
879 (prin1-to-string err)))))
880
7b3f3dc2
JB
881(defvar auto-mode-alist (mapcar 'purecopy
882 '(("\\.text\\'" . text-mode)
883 ("\\.c\\'" . c-mode)
884 ("\\.h\\'" . c-mode)
c11a94fe
RS
885 ("\\.tex\\'" . tex-mode)
886 ("\\.ltx\\'" . latex-mode)
7b3f3dc2
JB
887 ("\\.el\\'" . emacs-lisp-mode)
888 ("\\.mm\\'" . nroff-mode)
889 ("\\.me\\'" . nroff-mode)
c80d2575
ER
890 ("\\.ms\\'" . nroff-mode)
891 ("\\.man\\'" . nroff-mode)
7b3f3dc2
JB
892 ("\\.scm\\'" . scheme-mode)
893 ("\\.l\\'" . lisp-mode)
894 ("\\.lisp\\'" . lisp-mode)
895 ("\\.f\\'" . fortran-mode)
896 ("\\.for\\'" . fortran-mode)
e70991d4
RS
897 ("\\.p\\'" . pascal-mode)
898 ("\\.pas\\'" . pascal-mode)
7b3f3dc2 899 ("\\.mss\\'" . scribe-mode)
f804f4e4 900 ("\\.ad[abs]\\'" . ada-mode)
b9952c29 901 ("\\.icn\\'" . icon-mode)
d23e6f97 902 ("\\.pl\\'" . perl-mode)
7b3f3dc2 903 ("\\.cc\\'" . c++-mode)
2b845a8c 904 ("\\.hh\\'" . c++-mode)
7b3f3dc2 905 ("\\.C\\'" . c++-mode)
2b845a8c 906 ("\\.H\\'" . c++-mode)
c76a164a
RS
907 ("\\.cpp\\'" . c++-mode)
908 ("\\.cxx\\'" . c++-mode)
909 ("\\.hxx\\'" . c++-mode)
71679121
RS
910 ("\\.c\\+\\+\\'" . c++-mode)
911 ("\\.h\\+\\+\\'" . c++-mode)
6cf85938
RS
912 ("\\.mk\\'" . makefile-mode)
913 ("[Mm]akefile\\(.in\\)?\\'" . makefile-mode)
7b3f3dc2
JB
914;;; Less common extensions come here
915;;; so more common ones above are found faster.
7ca1d903
RS
916 ("\\.texinfo\\'" . texinfo-mode)
917 ("\\.texi\\'" . texinfo-mode)
7b3f3dc2
JB
918 ("\\.s\\'" . asm-mode)
919 ("ChangeLog\\'" . change-log-mode)
bb157910 920 ("change.log\\'" . change-log-mode)
9bb004f6 921 ("changelo\\'" . change-log-mode)
7adc58e5 922 ("ChangeLog.[0-9]+\\'" . change-log-mode)
7b3f3dc2 923 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
c1fe251a
KH
924 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
925;;; The following should come after the ChangeLog pattern
926;;; for the sake of ChangeLog.1, etc.
927;;; and after the .scm.[0-9] pattern too.
7adc58e5 928 ("\\.[12345678]\\'" . nroff-mode)
c11a94fe
RS
929 ("\\.TeX\\'" . tex-mode)
930 ("\\.sty\\'" . latex-mode)
04eae667 931 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
c11a94fe 932 ("\\.bbl\\'" . latex-mode)
7b3f3dc2
JB
933 ("\\.bib\\'" . bibtex-mode)
934 ("\\.article\\'" . text-mode)
935 ("\\.letter\\'" . text-mode)
7ca1d903 936 ("\\.tcl\\'" . tcl-mode)
bccfd936 937 ("\\.f90\\'" . f90-mode)
7b3f3dc2
JB
938 ("\\.lsp\\'" . lisp-mode)
939 ("\\.awk\\'" . awk-mode)
940 ("\\.prolog\\'" . prolog-mode)
c80d2575 941 ("\\.tar\\'" . tar-mode)
1d354180 942 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\)\\'" . archive-mode)
7b3f3dc2
JB
943 ;; Mailer puts message to be edited in
944 ;; /tmp/Re.... or Message
945 ("^/tmp/Re" . text-mode)
946 ("/Message[0-9]*\\'" . text-mode)
04eae667 947 ("/drafts/[0-9]+\\'" . mh-letter-mode)
7b3f3dc2
JB
948 ;; some news reader is reported to use this
949 ("^/tmp/fol/" . text-mode)
950 ("\\.y\\'" . c-mode)
c80d2575 951 ("\\.lex\\'" . c-mode)
7b3f3dc2 952 ("\\.oak\\'" . scheme-mode)
278584fb
RS
953 ("\\.sgm\\'" . sgml-mode)
954 ("\\.sgml\\'" . sgml-mode)
955 ("\\.dtd\\'" . sgml-mode)
7b3f3dc2
JB
956 ;; .emacs following a directory delimiter
957 ;; in either Unix or VMS syntax.
958 ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
bb157910
RS
959 ;; _emacs following a directory delimiter
960 ;; in MsDos syntax
961 ("[:/]_emacs\\'" . emacs-lisp-mode)
7b3f3dc2
JB
962 ("\\.ml\\'" . lisp-mode)))
963 "\
964Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
965Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
966\(NON-NIL stands for anything that is not nil; the value does not matter.)
967Visiting a file whose name matches REGEXP specifies FUNCTION as the
968mode function to use. FUNCTION will be called, unless it is nil.
969
970If the element has the form (REGEXP FUNCTION NON-NIL), then after
971calling FUNCTION (if it's not nil), we delete the suffix that matched
972REGEXP and search the list again for another match.")
7b3f3dc2 973
c907d156
RS
974(defconst interpreter-mode-alist
975 '(("perl" . perl-mode)
c907d156 976 ("wish" . tcl-mode)
e3998da1 977 ("wishx" . tcl-mode)
8db739de 978 ("tcl" . tcl-mode)
e3998da1 979 ("tclsh" . tcl-mode)
8db739de 980 ("awk" . awk-mode)
d4f567a1 981 ("nawk" . awk-mode)
8db739de
NF
982 ("gawk" . awk-mode)
983 ("scm" . scheme-mode))
c907d156
RS
984 "Alist mapping interpreter names to major modes.
985This alist applies to files whose first line starts with `#!'.
986Each element looks like (INTERPRETER . MODE).
987The car of each element is compared with
988the name of the interpreter specified in the first line.
989If it matches, mode MODE is selected.")
990
b20ff6d0 991(defconst inhibit-first-line-modes-regexps '("\\.tar\\'")
45fb3bb8 992 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 993
b20ff6d0
RS
994(defconst inhibit-first-line-modes-suffixes nil
995 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
996When checking `inhibit-first-line-modes-regexps', we first discard
997from the end of the file name anything that matches one of these regexps.")
998
bb157910
RS
999(defvar user-init-file
1000 "" ; set by command-line
1001 "File name including directory of user's initialization file.")
1002
b4da00e9
RM
1003(defun set-auto-mode ()
1004 "Select major mode appropriate for current buffer.
e3998da1
RS
1005This checks for a -*- mode tag in the buffer's text,
1006compares the filename against the entries in `auto-mode-alist',
1007or checks the interpreter that runs this file against
1008`interpreter-mode-alist'.
1009
1010It does not check for the `mode:' local variable in the
1011Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 1012
f3e23606 1013If `enable-local-variables' is nil, this function does not check for a
7b3f3dc2 1014-*- mode tag."
b4da00e9 1015 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
9fa7bfe5 1016 (let (beg end done)
b4da00e9
RM
1017 (save-excursion
1018 (goto-char (point-min))
1019 (skip-chars-forward " \t\n")
9fa7bfe5
RS
1020 (and enable-local-variables
1021 ;; Don't look for -*- if this file name matches any
45fb3bb8 1022 ;; of the regexps in inhibit-first-line-modes-regexps.
cae111fa 1023 (let ((temp inhibit-first-line-modes-regexps)
4bc3d240
RS
1024 (name (if buffer-file-name
1025 (file-name-sans-versions buffer-file-name)
1026 (buffer-name))))
38832b4c
KH
1027 (while (let ((sufs inhibit-first-line-modes-suffixes))
1028 (while (and sufs (not (string-match (car sufs) name)))
1029 (setq sufs (cdr sufs)))
1030 sufs)
1031 (setq name (substring name 0 (match-beginning 0))))
9fa7bfe5 1032 (while (and temp
b20ff6d0 1033 (not (string-match (car temp) name)))
9fa7bfe5
RS
1034 (setq temp (cdr temp)))
1035 (not temp))
1036 (search-forward "-*-" (save-excursion
1037 ;; If the file begins with "#!"
1038 ;; (exec interpreter magic), look
1039 ;; for mode frobs in the first two
1040 ;; lines. You cannot necessarily
1041 ;; put them in the first line of
1042 ;; such a file without screwing up
1043 ;; the interpreter invocation.
1044 (end-of-line (and (looking-at "^#!") 2))
1045 (point)) t)
1046 (progn
1047 (skip-chars-forward " \t")
1048 (setq beg (point))
1049 (search-forward "-*-"
1050 (save-excursion (end-of-line) (point))
1051 t))
1052 (progn
1053 (forward-char -3)
1054 (skip-chars-backward " \t")
1055 (setq end (point))
1056 (goto-char beg)
1057 (if (save-excursion (search-forward ":" end t))
1058 ;; Find all specifications for the `mode:' variable
57a0155c 1059 ;; and execute them left to right.
9fa7bfe5 1060 (while (let ((case-fold-search t))
6054fcc6
KH
1061 (or (and (looking-at "mode:")
1062 (goto-char (match-end 0)))
1063 (re-search-forward "[ \t;]mode:" end t)))
9fa7bfe5
RS
1064 (skip-chars-forward " \t")
1065 (setq beg (point))
1066 (if (search-forward ";" end t)
1067 (forward-char -1)
1068 (goto-char end))
1069 (skip-chars-backward " \t")
fb69dfa5
RS
1070 (funcall (intern (concat (downcase (buffer-substring beg (point))) "-mode")))
1071 (setq done t))
9fa7bfe5 1072 ;; Simple -*-MODE-*- case.
fb69dfa5
RS
1073 (funcall (intern (concat (downcase (buffer-substring beg end)) "-mode")))
1074 (setq done t))))
9fa7bfe5
RS
1075 ;; If we didn't find a mode from a -*- line, try using the file name.
1076 (if (and (not done) buffer-file-name)
81860e46 1077 (let ((name buffer-file-name)
81860e46
RS
1078 (keep-going t))
1079 ;; Remove backup-suffixes from file name.
1080 (setq name (file-name-sans-versions name))
1081 (while keep-going
1082 (setq keep-going nil)
1083 (let ((alist auto-mode-alist)
1084 (mode nil))
1085 ;; Find first matching alist entry.
64ce1458
KH
1086 (let ((case-fold-search
1087 (memq system-type '(vax-vms windows-nt))))
f4a0f59b
RS
1088 (while (and (not mode) alist)
1089 (if (string-match (car (car alist)) name)
1090 (if (and (consp (cdr (car alist)))
1091 (nth 2 (car alist)))
1092 (progn
1093 (setq mode (car (cdr (car alist)))
1094 name (substring name 0 (match-beginning 0))
1095 keep-going t))
1096 (setq mode (cdr (car alist))
1097 keep-going nil)))
1098 (setq alist (cdr alist))))
c907d156
RS
1099 (if mode
1100 (funcall mode)
1101 ;; If we can't deduce a mode from the file name,
1102 ;; look for an interpreter specified in the first line.
1103 (let ((interpreter
1104 (save-excursion
1105 (goto-char (point-min))
e3998da1
RS
1106 (if (looking-at "#! *\\([^ \t\n]+\\)")
1107 (buffer-substring (match-beginning 1)
1108 (match-end 1))
c907d156
RS
1109 "")))
1110 elt)
1111 ;; Map interpreter name to a mode.
1112 (setq elt (assoc (file-name-nondirectory interpreter)
1113 interpreter-mode-alist))
1114 (if elt
1115 (funcall (cdr elt))))))))))))
b4da00e9 1116
f3e23606
RS
1117(defun hack-local-variables-prop-line ()
1118 ;; Set local variables specified in the -*- line.
9fa7bfe5
RS
1119 ;; Ignore any specification for `mode:';
1120 ;; set-auto-mode should already have handled that.
f3e23606
RS
1121 (save-excursion
1122 (goto-char (point-min))
13a66180
KH
1123 (let ((result nil)
1124 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
f3e23606
RS
1125 ;; Parse the -*- line into the `result' alist.
1126 (cond ((not (search-forward "-*-" end t))
1127 ;; doesn't have one.
1128 nil)
1129 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180
KH
1130 ;; Simple form: "-*- MODENAME -*-". Already handled.
1131 nil)
f3e23606
RS
1132 (t
1133 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1134 ;; (last ";" is optional).
1135 (save-excursion
1136 (if (search-forward "-*-" end t)
1137 (setq end (- (point) 3))
1138 (error "-*- not terminated before end of line")))
1139 (while (< (point) end)
1140 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1141 (error "malformed -*- line"))
1142 (goto-char (match-end 0))
1c26a6f3
KH
1143 ;; There used to be a downcase here,
1144 ;; but the manual didn't say so,
1145 ;; and people want to set var names that aren't all lc.
1146 (let ((key (intern (buffer-substring
1147 (match-beginning 1)
1148 (match-end 1))))
f3e23606
RS
1149 (val (save-restriction
1150 (narrow-to-region (point) end)
1151 (read (current-buffer)))))
13a66180
KH
1152 (or (eq key 'mode)
1153 (setq result (cons (cons key val) result)))
f3e23606
RS
1154 (skip-chars-forward " \t;")))
1155 (setq result (nreverse result))))
f3e23606
RS
1156
1157 (if (and result
1158 (or (eq enable-local-variables t)
1159 (and enable-local-variables
1160 (save-window-excursion
6f931919
RS
1161 (condition-case nil
1162 (switch-to-buffer (current-buffer))
1163 (error
1164 ;; If we fail to switch in the selected window,
1165 ;; it is probably a minibuffer.
1166 ;; So try another window.
1167 (condition-case nil
1168 (switch-to-buffer-other-window (current-buffer))
1169 (error
1170 (switch-to-buffer-other-frame (current-buffer))))))
f3e23606
RS
1171 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1172 (file-name-nondirectory buffer-file-name)))))))
1173 (while result
13a66180 1174 (hack-one-local-variable (car (car result)) (cdr (car result)))
9fa7bfe5 1175 (setq result (cdr result)))))))
f3e23606 1176
1d517019
RS
1177(defvar hack-local-variables-hook nil
1178 "Normal hook run after processing a file's local variables specs.
1179Major modes can use this to examine user-specified local variables
1180in order to initialize other data structure based on them.")
1181
7b3f3dc2 1182(defun hack-local-variables ()
5792c834 1183 "Parse and put into effect this buffer's local variables spec."
f3e23606 1184 (hack-local-variables-prop-line)
b4da00e9
RM
1185 ;; Look for "Local variables:" line in last page.
1186 (save-excursion
1187 (goto-char (point-max))
1188 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1189 (if (let ((case-fold-search t))
1190 (and (search-forward "Local Variables:" nil t)
7b3f3dc2 1191 (or (eq enable-local-variables t)
b4da00e9
RM
1192 (and enable-local-variables
1193 (save-window-excursion
1194 (switch-to-buffer (current-buffer))
1195 (save-excursion
1196 (beginning-of-line)
1197 (set-window-start (selected-window) (point)))
1198 (y-or-n-p (format "Set local variables as specified at end of %s? "
51de78c1
RS
1199 (if buffer-file-name
1200 (file-name-nondirectory
1201 buffer-file-name)
1202 (concat "buffer "
1203 (buffer-name))))))))))
b4da00e9 1204 (let ((continue t)
2bba782c
RS
1205 prefix prefixlen suffix beg
1206 (enable-local-eval enable-local-eval))
b4da00e9
RM
1207 ;; The prefix is what comes before "local variables:" in its line.
1208 ;; The suffix is what comes after "local variables:" in its line.
1209 (skip-chars-forward " \t")
1210 (or (eolp)
1211 (setq suffix (buffer-substring (point)
1212 (progn (end-of-line) (point)))))
1213 (goto-char (match-beginning 0))
1214 (or (bolp)
1215 (setq prefix
1216 (buffer-substring (point)
1217 (progn (beginning-of-line) (point)))))
7b3f3dc2 1218
b4da00e9
RM
1219 (if prefix (setq prefixlen (length prefix)
1220 prefix (regexp-quote prefix)))
1221 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1222 (while continue
1223 ;; Look at next local variable spec.
1224 (if selective-display (re-search-forward "[\n\C-m]")
1225 (forward-line 1))
1226 ;; Skip the prefix, if any.
1227 (if prefix
1228 (if (looking-at prefix)
1229 (forward-char prefixlen)
1230 (error "Local variables entry is missing the prefix")))
1231 ;; Find the variable name; strip whitespace.
1232 (skip-chars-forward " \t")
1233 (setq beg (point))
1234 (skip-chars-forward "^:\n")
1235 (if (eolp) (error "Missing colon in local variables entry"))
1236 (skip-chars-backward " \t")
1237 (let* ((str (buffer-substring beg (point)))
1238 (var (read str))
1239 val)
1240 ;; Setting variable named "end" means end of list.
1241 (if (string-equal (downcase str) "end")
1242 (setq continue nil)
1243 ;; Otherwise read the variable value.
1244 (skip-chars-forward "^:")
1245 (forward-char 1)
1246 (setq val (read (current-buffer)))
1247 (skip-chars-backward "\n")
1248 (skip-chars-forward " \t")
1249 (or (if suffix (looking-at suffix) (eolp))
1250 (error "Local variables entry is terminated incorrectly"))
1251 ;; Set the variable. "Variables" mode and eval are funny.
1d517019
RS
1252 (hack-one-local-variable var val)))))))
1253 (run-hooks 'hack-local-variables-hook))
f3e23606
RS
1254
1255(defconst ignored-local-variables
1256 '(enable-local-eval)
1257 "Variables to be ignored in a file's local variable spec.")
1258
be0218a8 1259;; Get confirmation before setting these variables as locals in a file.
05ef1cda 1260(put 'debugger 'risky-local-variable t)
f6fa3ee3 1261(put 'enable-local-eval 'risky-local-variable t)
fce47eea 1262(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
1263(put 'eval 'risky-local-variable t)
1264(put 'file-name-handler-alist 'risky-local-variable t)
1265(put 'minor-mode-map-alist 'risky-local-variable t)
1266(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3
RS
1267(put 'buffer-file-name 'risky-local-variable t)
1268(put 'buffer-auto-save-file-name 'risky-local-variable t)
1269(put 'buffer-file-truename 'risky-local-variable t)
b0ffcc0d
RS
1270(put 'exec-path 'risky-local-variable t)
1271(put 'load-path 'risky-local-variable t)
1272(put 'exec-directory 'risky-local-variable t)
1273(put 'process-environment 'risky-local-variable t)
9afa8bf7
RS
1274;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1275(put 'outline-level 'risky-local-variable t)
d98b741d 1276(put 'rmail-output-file-alist 'risky-local-variable t)
f6fa3ee3 1277
6672c42b
RS
1278;; This one is safe because the user gets to check it before it is used.
1279(put 'compile-command 'safe-local-variable t)
1280
d0bd3513
RS
1281(defun hack-one-local-variable-quotep (exp)
1282 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1283
f3e23606
RS
1284;; "Set" one variable in a local variables spec.
1285;; A few variable names are treated specially.
1286(defun hack-one-local-variable (var val)
1287 (cond ((eq var 'mode)
1288 (funcall (intern (concat (downcase (symbol-name val))
1289 "-mode"))))
1290 ((memq var ignored-local-variables)
1291 nil)
1292 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 1293 ;; Likewise for setting hook variables.
be0218a8 1294 ((or (get var 'risky-local-variable)
6672c42b
RS
1295 (and
1296 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$"
1297 (symbol-name var))
1298 (not (get var 'safe-local-variable))))
d0bd3513
RS
1299 ;; Permit evaling a put of a harmless property
1300 ;; if the args do nothing tricky.
1301 (if (or (and (eq var 'eval)
1302 (consp val)
1303 (eq (car val) 'put)
1304 (hack-one-local-variable-quotep (nth 1 val))
1305 (hack-one-local-variable-quotep (nth 2 val))
1306 ;; Only allow safe values of lisp-indent-hook;
1307 ;; not functions.
1308 (or (numberp (nth 3 val))
dc417415 1309 (equal (nth 3 val) ''defun))
d0bd3513
RS
1310 (memq (nth 1 (nth 2 val))
1311 '(lisp-indent-hook)))
1312 ;; Permit eval if not root and user says ok.
c7e62660 1313 (and (not (zerop (user-uid)))
d0bd3513
RS
1314 (or (eq enable-local-eval t)
1315 (and enable-local-eval
1316 (save-window-excursion
1317 (switch-to-buffer (current-buffer))
1318 (save-excursion
1319 (beginning-of-line)
1320 (set-window-start (selected-window) (point)))
1321 (setq enable-local-eval
1322 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1323 (file-name-nondirectory buffer-file-name)))))))))
7d3221d7
RS
1324 (if (eq var 'eval)
1325 (save-excursion (eval val))
1326 (make-local-variable var)
1327 (set var val))
f3e23606
RS
1328 (message "Ignoring `eval:' in file's local variables")))
1329 ;; Ordinary variable, really set it.
1330 (t (make-local-variable var)
1331 (set var val))))
1332
b4da00e9
RM
1333\f
1334(defun set-visited-file-name (filename)
1335 "Change name of file visited in current buffer to FILENAME.
1336The next time the buffer is saved it will go in the newly specified file.
1337nil or empty string as argument means make buffer not be visiting any file.
1338Remember to delete the initial contents of the minibuffer
1339if you wish to pass an empty string as the argument."
1340 (interactive "FSet visited file name: ")
c11a94fe
RS
1341 (if (buffer-base-buffer)
1342 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
1343 (let (truename)
1344 (if filename
1345 (setq filename
1346 (if (string-equal filename "")
1347 nil
1348 (expand-file-name filename))))
1349 (if filename
1350 (progn
1351 (setq truename (file-truename filename))
1352 (if find-file-visit-truename
1353 ;; Do not use the abbreviated filename, because
1354 ;; write-region will reset it to the expanded filename
1355 (setq filename truename))))
1356 (or (equal filename buffer-file-name)
1357 (progn
1358 (and filename (lock-buffer filename))
1359 (unlock-buffer)))
1360 (setq buffer-file-name filename)
1361 (if filename ; make buffer name reflect filename.
1362 (let ((new-name (file-name-nondirectory buffer-file-name)))
1363 (if (string= new-name "")
1364 (error "Empty file name"))
1365 (if (eq system-type 'vax-vms)
1366 (setq new-name (downcase new-name)))
1367 (setq default-directory (file-name-directory buffer-file-name))
1368 (or (string= new-name (buffer-name))
1369 (rename-buffer new-name t))))
1370 (setq buffer-backed-up nil)
1371 (clear-visited-file-modtime)
4826e97f
RS
1372 (if truename
1373 (setq buffer-file-truename (abbreviate-file-name truename)))
a522e5bf
RS
1374 (setq buffer-file-number
1375 (if filename
1376 (nth 10 (file-attributes buffer-file-name))
1377 nil)))
b4da00e9
RM
1378 ;; write-file-hooks is normally used for things like ftp-find-file
1379 ;; that visit things that are not local files as if they were files.
1380 ;; Changing to visit an ordinary local file instead should flush the hook.
1381 (kill-local-variable 'write-file-hooks)
c9dca4e0 1382 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
1383 (kill-local-variable 'revert-buffer-function)
1384 (kill-local-variable 'backup-inhibited)
ee81c959
RS
1385 ;; If buffer was read-only because of version control,
1386 ;; that reason is gone now, so make it writable.
1387 (if vc-mode
1388 (setq buffer-read-only nil))
1389 (kill-local-variable 'vc-mode)
b4da00e9
RM
1390 ;; Turn off backup files for certain file names.
1391 ;; Since this is a permanent local, the major mode won't eliminate it.
1392 (and (not (funcall backup-enable-predicate buffer-file-name))
1393 (progn
1394 (make-local-variable 'backup-inhibited)
1395 (setq backup-inhibited t)))
c77a81cf
RS
1396 (let ((oauto buffer-auto-save-file-name))
1397 ;; If auto-save was not already on, turn it on if appropriate.
1398 (if (not buffer-auto-save-file-name)
1399 (and buffer-file-name auto-save-default
1400 (auto-save-mode t))
1401 ;; If auto save is on, start using a new name.
1402 ;; We deliberately don't rename or delete the old auto save
1403 ;; for the old visited file name. This is because perhaps
1404 ;; the user wants to save the new state and then compare with the
1405 ;; previous state from the auto save file.
1406 (setq buffer-auto-save-file-name
1407 (make-auto-save-file-name)))
1408 ;; Rename the old auto save file if any.
1409 (and oauto buffer-auto-save-file-name
e6f0e76c 1410 (file-exists-p oauto)
c77a81cf 1411 (rename-file oauto buffer-auto-save-file-name t)))
b4da00e9
RM
1412 (if buffer-file-name
1413 (set-buffer-modified-p t)))
1414
c2fb8488 1415(defun write-file (filename &optional confirm)
b4da00e9 1416 "Write current buffer into file FILENAME.
41f48cb1
RS
1417Makes buffer visit that file, and marks it not modified.
1418If the buffer is already visiting a file, you can specify
1419a directory name as FILENAME, to write a file of the same
c2fb8488
RS
1420old name in that directory.
1421If optional second arg CONFIRM is non-nil,
1422ask for confirmation for overwriting an existing file."
b4da00e9
RM
1423;; (interactive "FWrite file: ")
1424 (interactive
1425 (list (if buffer-file-name
1426 (read-file-name "Write file: "
1427 nil nil nil nil)
1428 (read-file-name "Write file: "
1429 (cdr (assq 'default-directory
1430 (buffer-local-variables)))
c2fb8488
RS
1431 nil nil (buffer-name)))
1432 t))
b4da00e9 1433 (or (null filename) (string-equal filename "")
41f48cb1
RS
1434 (progn
1435 ;; If arg is just a directory,
1436 ;; use same file name, but in that directory.
1437 (if (and (file-directory-p filename) buffer-file-name)
1438 (setq filename (concat (file-name-as-directory filename)
1439 (file-name-nondirectory buffer-file-name))))
c2fb8488
RS
1440 (and confirm
1441 (file-exists-p filename)
1442 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1443 (error "Canceled")))
41f48cb1 1444 (set-visited-file-name filename)))
b4da00e9
RM
1445 (set-buffer-modified-p t)
1446 (save-buffer))
1447\f
1448(defun backup-buffer ()
1449 "Make a backup of the disk file visited by the current buffer, if appropriate.
1450This is normally done before saving the buffer the first time.
1451If the value is non-nil, it is the result of `file-modes' on the original
1452file; this means that the caller, after saving the buffer, should change
1453the modes of the new file to agree with the old modes."
1454 (if (and make-backup-files (not backup-inhibited)
1455 (not buffer-backed-up)
1456 (file-exists-p buffer-file-name)
1457 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1458 '(?- ?l)))
1459 (let ((real-file-name buffer-file-name)
1460 backup-info backupname targets setmodes)
1461 ;; If specified name is a symbolic link, chase it to the target.
1462 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 1463 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
1464 (setq backup-info (find-backup-file-name real-file-name)
1465 backupname (car backup-info)
1466 targets (cdr backup-info))
1467;;; (if (file-directory-p buffer-file-name)
1468;;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
1469 (if backup-info
1470 (condition-case ()
1471 (let ((delete-old-versions
1472 ;; If have old versions to maybe delete,
1473 ;; ask the user to confirm now, before doing anything.
1474 ;; But don't actually delete til later.
1475 (and targets
1476 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1477 (or delete-old-versions
1478 (y-or-n-p (format "Delete excess backup versions of %s? "
1479 real-file-name))))))
1480 ;; Actually write the back up file.
1481 (condition-case ()
1482 (if (or file-precious-flag
1483 ; (file-symlink-p buffer-file-name)
1484 backup-by-copying
1485 (and backup-by-copying-when-linked
1486 (> (file-nlinks real-file-name) 1))
1487 (and backup-by-copying-when-mismatch
1488 (let ((attr (file-attributes real-file-name)))
1489 (or (nth 9 attr)
1490 (not (file-ownership-preserved-p real-file-name))))))
1491 (condition-case ()
1492 (copy-file real-file-name backupname t t)
1493 (file-error
1494 ;; If copying fails because file BACKUPNAME
1495 ;; is not writable, delete that file and try again.
1496 (if (and (file-exists-p backupname)
1497 (not (file-writable-p backupname)))
1498 (delete-file backupname))
1499 (copy-file real-file-name backupname t t)))
1500 ;; rename-file should delete old backup.
1501 (rename-file real-file-name backupname t)
1502 (setq setmodes (file-modes backupname)))
1503 (file-error
1504 ;; If trouble writing the backup, write it in ~.
1505 (setq backupname (expand-file-name "~/%backup%~"))
1506 (message "Cannot write backup file; backing up in ~/%%backup%%~")
1507 (sleep-for 1)
1508 (condition-case ()
1509 (copy-file real-file-name backupname t t)
1510 (file-error
1511 ;; If copying fails because file BACKUPNAME
1512 ;; is not writable, delete that file and try again.
1513 (if (and (file-exists-p backupname)
1514 (not (file-writable-p backupname)))
1515 (delete-file backupname))
1516 (copy-file real-file-name backupname t t)))))
1517 (setq buffer-backed-up t)
1518 ;; Now delete the old versions, if desired.
1519 (if delete-old-versions
1520 (while targets
1521 (condition-case ()
1522 (delete-file (car targets))
1523 (file-error nil))
1524 (setq targets (cdr targets))))
1525 setmodes)
1526 (file-error nil))))))
b4da00e9 1527
c3554e95 1528(defun file-name-sans-versions (name &optional keep-backup-version)
b4da00e9
RM
1529 "Return FILENAME sans backup versions or strings.
1530This is a separate procedure so your site-init or startup file can
c3554e95
RS
1531redefine it.
1532If the optional argument KEEP-BACKUP-VERSION is non-nil,
1533we do not remove backup version numbers, only true file version numbers."
6eaebaa2 1534 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
1535 (if handler
1536 (funcall handler 'file-name-sans-versions name keep-backup-version)
1537 (substring name 0
1538 (if (eq system-type 'vax-vms)
1539 ;; VMS version number is (a) semicolon, optional
1540 ;; sign, zero or more digits or (b) period, option
1541 ;; sign, zero or more digits, provided this is the
1542 ;; second period encountered outside of the
1543 ;; device/directory part of the file name.
26add1bf
KH
1544 (or (string-match ";[-+]?[0-9]*\\'" name)
1545 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
1546 name)
1547 (match-beginning 1))
1548 (length name))
1549 (if keep-backup-version
1550 (length name)
dbb12f2c 1551 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
1552 (string-match "~\\'" name)
1553 (length name))))))))
b4da00e9 1554
cb0cd911
RS
1555(defun file-ownership-preserved-p (file)
1556 "Returns t if deleting FILE and rewriting it would preserve the owner."
1557 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1558 (if handler
1559 (funcall handler 'file-ownership-preserved-p file)
ec5533be 1560 (let ((attributes (file-attributes file)))
306faa42
RS
1561 ;; Return t if the file doesn't exist, since it's true that no
1562 ;; information would be lost by an (attempted) delete and create.
1563 (or (null attributes)
1564 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 1565
20b5d24c
RS
1566(defun file-name-sans-extension (filename)
1567 "Return FILENAME sans final \"extension\".
1568The extension, in a file name, is the part that follows the last `.'."
1569 (save-match-data
1570 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1571 directory)
1572 (if (string-match "\\.[^.]*\\'" file)
1573 (if (setq directory (file-name-directory filename))
1574 (expand-file-name (substring file 0 (match-beginning 0))
1575 directory)
1576 (substring file 0 (match-beginning 0)))
1577 filename))))
1578
b4da00e9
RM
1579(defun make-backup-file-name (file)
1580 "Create the non-numeric backup file name for FILE.
1581This is a separate function so you can redefine it for customization."
bb157910
RS
1582 (if (eq system-type 'ms-dos)
1583 (let ((fn (file-name-nondirectory file)))
1584 (concat (file-name-directory file)
1585 (if (string-match "\\([^.]*\\)\\(\\..*\\)?" fn)
1586 (substring fn 0 (match-end 1)))
1587 ".bak"))
1588 (concat file "~")))
b4da00e9
RM
1589
1590(defun backup-file-name-p (file)
1591 "Return non-nil if FILE is a backup file name (numeric or not).
1592This is a separate function so you can redefine it for customization.
1593You may need to redefine `file-name-sans-versions' as well."
bb157910
RS
1594 (if (eq system-type 'ms-dos)
1595 (string-match "\\.bak$" file)
1596 (string-match "~$" file)))
b4da00e9 1597
2d051399
RS
1598;; This is used in various files.
1599;; The usage of bv-length is not very clean,
1600;; but I can't see a good alternative,
1601;; so as of now I am leaving it alone.
1602(defun backup-extract-version (fn)
1603 "Given the name of a numeric backup file, return the backup number.
1604Uses the free variable `bv-length', whose value should be
1605the index in the name where the version number begins."
1606 (if (and (string-match "[0-9]+~$" fn bv-length)
1607 (= (match-beginning 0) bv-length))
1608 (string-to-int (substring fn bv-length -1))
1609 0))
1610
b4da00e9
RM
1611;; I believe there is no need to alter this behavior for VMS;
1612;; since backup files are not made on VMS, it should not get called.
1613(defun find-backup-file-name (fn)
1614 "Find a file name for a backup file, and suggestions for deletions.
1615Value is a list whose car is the name for the backup file
eb650569
RS
1616 and whose cdr is a list of old versions to consider deleting now.
1617If the value is nil, don't make a backup."
1618 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
1619 ;; Run a handler for this function so that ange-ftp can refuse to do it.
1620 (if handler
1621 (funcall handler 'find-backup-file-name fn)
1622 (if (eq version-control 'never)
b4da00e9 1623 (list (make-backup-file-name fn))
eb650569
RS
1624 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
1625 (bv-length (length base-versions))
1626 possibilities
1627 (versions nil)
1628 (high-water-mark 0)
1629 (deserve-versions-p nil)
1630 (number-to-delete 0))
1631 (condition-case ()
1632 (setq possibilities (file-name-all-completions
1633 base-versions
1634 (file-name-directory fn))
1635 versions (sort (mapcar
1636 (function backup-extract-version)
1637 possibilities)
1638 '<)
1639 high-water-mark (apply 'max 0 versions)
1640 deserve-versions-p (or version-control
1641 (> high-water-mark 0))
1642 number-to-delete (- (length versions)
1643 kept-old-versions kept-new-versions -1))
1644 (file-error
1645 (setq possibilities nil)))
1646 (if (not deserve-versions-p)
1647 (list (make-backup-file-name fn))
1648 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
1649 (if (and (> number-to-delete 0)
1650 ;; Delete nothing if there is overflow
1651 ;; in the number of versions to keep.
1652 (>= (+ kept-new-versions kept-old-versions -1) 0))
1653 (mapcar (function (lambda (n)
1654 (concat fn ".~" (int-to-string n) "~")))
1655 (let ((v (nthcdr kept-old-versions versions)))
1656 (rplacd (nthcdr (1- number-to-delete) v) ())
1657 v))))))))))
b4da00e9 1658
b4da00e9
RM
1659(defun file-nlinks (filename)
1660 "Return number of names file FILENAME has."
1661 (car (cdr (file-attributes filename))))
6c636af9
RM
1662
1663(defun file-relative-name (filename &optional directory)
1664 "Convert FILENAME to be relative to DIRECTORY (default: default-directory)."
1665 (setq filename (expand-file-name filename)
77fb6aed
RS
1666 directory (file-name-as-directory (expand-file-name
1667 (or directory default-directory))))
b1fa544f
KH
1668 (let ((ancestor ""))
1669 (while (not (string-match (concat "^" (regexp-quote directory)) filename))
1670 (setq directory (file-name-directory (substring directory 0 -1))
1671 ancestor (concat "../" ancestor)))
1672 (concat ancestor (substring filename (match-end 0)))))
b4da00e9
RM
1673\f
1674(defun save-buffer (&optional args)
1675 "Save current buffer in visited file if modified. Versions described below.
1676By default, makes the previous version into a backup file
1677 if previously requested or if this is the first save.
1678With 1 or 3 \\[universal-argument]'s, marks this version
1679 to become a backup when the next save is done.
1680With 2 or 3 \\[universal-argument]'s,
1681 unconditionally makes the previous version into a backup file.
1682With argument of 0, never makes the previous version into a backup file.
1683
1684If a file's name is FOO, the names of its numbered backup versions are
1685 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
1686Numeric backups (rather than FOO~) will be made if value of
1687 `version-control' is not the atom `never' and either there are already
1688 numeric versions of the file being backed up, or `version-control' is
1689 non-nil.
1690We don't want excessive versions piling up, so there are variables
1691 `kept-old-versions', which tells Emacs how many oldest versions to keep,
1692 and `kept-new-versions', which tells how many newest versions to keep.
1693 Defaults are 2 old versions and 2 new.
1694`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 1695If `delete-old-versions' is nil, system will query user
b4da00e9
RM
1696 before trimming versions. Otherwise it does it silently."
1697 (interactive "p")
1698 (let ((modp (buffer-modified-p))
1699 (large (> (buffer-size) 50000))
b5a8e0fc
RS
1700 (make-backup-files (or (and make-backup-files (not (eq args 0)))
1701 (memq args '(16 64)))))
b4da00e9
RM
1702 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
1703 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
1704 (basic-save-buffer)
1705 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
1706
1707(defun delete-auto-save-file-if-necessary (&optional force)
1708 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
1709Normally delete only if the file was written by this Emacs since
1710the last real save, but optional arg FORCE non-nil means delete anyway."
1711 (and buffer-auto-save-file-name delete-auto-save-files
1712 (not (string= buffer-file-name buffer-auto-save-file-name))
1713 (or force (recent-auto-save-p))
1714 (progn
1715 (condition-case ()
1716 (delete-file buffer-auto-save-file-name)
1717 (file-error nil))
1718 (set-buffer-auto-saved))))
1719
1cc852cc
RS
1720(defvar after-save-hook nil
1721 "Normal hook that is run after a buffer is saved to its file.")
1722
b4da00e9 1723(defun basic-save-buffer ()
1cc852cc
RS
1724 "Save the current buffer in its visited file, if it has been modified.
1725After saving the buffer, run `after-save-hook'."
b4da00e9 1726 (interactive)
c11a94fe
RS
1727 (save-excursion
1728 ;; In an indirect buffer, save its base buffer instead.
1729 (if (buffer-base-buffer)
1730 (set-buffer (buffer-base-buffer)))
1731 (if (buffer-modified-p)
1732 (let ((recent-save (recent-auto-save-p))
1733 setmodes tempsetmodes)
1734 ;; On VMS, rename file and buffer to get rid of version number.
1735 (if (and (eq system-type 'vax-vms)
1736 (not (string= buffer-file-name
1737 (file-name-sans-versions buffer-file-name))))
1738 (let (buffer-new-name)
1739 ;; Strip VMS version number before save.
1740 (setq buffer-file-name
1741 (file-name-sans-versions buffer-file-name))
1742 ;; Construct a (unique) buffer name to correspond.
1743 (let ((buf (create-file-buffer (downcase buffer-file-name))))
1744 (setq buffer-new-name (buffer-name buf))
1745 (kill-buffer buf))
1746 (rename-buffer buffer-new-name)))
1747 ;; If buffer has no file name, ask user for one.
1748 (or buffer-file-name
182891ef
RS
1749 (let ((filename
1750 (expand-file-name
1751 (read-file-name "File to save in: ") nil)))
1752 (and (file-exists-p filename)
1753 (or (y-or-n-p (format "File `%s' exists; overwrite? "
1754 filename))
1755 (error "Canceled")))
1756 (set-visited-file-name filename)))
c11a94fe
RS
1757 (or (verify-visited-file-modtime (current-buffer))
1758 (not (file-exists-p buffer-file-name))
1759 (yes-or-no-p
1760 (format "%s has changed since visited or saved. Save anyway? "
1761 (file-name-nondirectory buffer-file-name)))
1762 (error "Save not confirmed"))
1763 (save-restriction
1764 (widen)
1765 (and (> (point-max) 1)
1766 (/= (char-after (1- (point-max))) ?\n)
1767 (not (and (eq selective-display t)
1768 (= (char-after (1- (point-max))) ?\r)))
1769 (or (eq require-final-newline t)
1770 (and require-final-newline
1771 (y-or-n-p
1772 (format "Buffer %s does not end in newline. Add one? "
1773 (buffer-name)))))
1774 (save-excursion
1775 (goto-char (point-max))
1776 (insert ?\n)))
1777 (or (run-hook-with-args-until-success 'write-contents-hooks)
1778 (run-hook-with-args-until-success 'local-write-file-hooks)
1779 (run-hook-with-args-until-success 'write-file-hooks)
1780 ;; If a hook returned t, file is already "written".
1781 ;; Otherwise, write it the usual way now.
1782 (setq setmodes (basic-save-buffer-1)))
1783 (setq buffer-file-number (nth 10 (file-attributes buffer-file-name)))
1784 (if setmodes
1785 (condition-case ()
1786 (set-file-modes buffer-file-name setmodes)
1787 (error nil))))
1788 ;; If the auto-save file was recent before this command,
1789 ;; delete it now.
1790 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
1791 ;; Support VC `implicit' locking.
1792 (vc-after-save)
c11a94fe
RS
1793 (run-hooks 'after-save-hook))
1794 (message "(No changes need to be saved)"))))
b4da00e9 1795
87d26afc
RS
1796;; This does the "real job" of writing a buffer into its visited file
1797;; and making a backup file. This is what is normally done
1798;; but inhibited if one of write-file-hooks returns non-nil.
1799;; It returns a value to store in setmodes.
1800(defun basic-save-buffer-1 ()
1801 (let (tempsetmodes setmodes)
1802 (if (not (file-writable-p buffer-file-name))
1803 (let ((dir (file-name-directory buffer-file-name)))
1804 (if (not (file-directory-p dir))
1805 (error "%s is not a directory" dir)
1806 (if (not (file-exists-p buffer-file-name))
1807 (error "Directory %s write-protected" dir)
1808 (if (yes-or-no-p
1809 (format "File %s is write-protected; try to save anyway? "
1810 (file-name-nondirectory
1811 buffer-file-name)))
1812 (setq tempsetmodes t)
1813 (error "Attempt to save to a file which you aren't allowed to write"))))))
1814 (or buffer-backed-up
1815 (setq setmodes (backup-buffer)))
f4a0f59b
RS
1816 (let ((dir (file-name-directory buffer-file-name)))
1817 (if (and file-precious-flag
1818 (file-writable-p dir))
1819 ;; If file is precious, write temp name, then rename it.
1820 ;; This requires write access to the containing dir,
1821 ;; which is why we don't try it if we don't have that access.
1822 (let ((realname buffer-file-name)
6782610c
RS
1823 tempname temp nogood i succeed
1824 (old-modtime (visited-file-modtime)))
f4a0f59b
RS
1825 (setq i 0)
1826 (setq nogood t)
1827 ;; Find the temporary name to write under.
1828 (while nogood
1829 (setq tempname (format "%s#tmp#%d" dir i))
1830 (setq nogood (file-exists-p tempname))
1831 (setq i (1+ i)))
1832 (unwind-protect
1833 (progn (clear-visited-file-modtime)
1834 (write-region (point-min) (point-max)
89095962
RS
1835 tempname nil realname
1836 buffer-file-truename)
f4a0f59b
RS
1837 (setq succeed t))
1838 ;; If writing the temp file fails,
1839 ;; delete the temp file.
6782610c
RS
1840 (or succeed
1841 (progn
1842 (delete-file tempname)
1843 (set-visited-file-modtime old-modtime))))
f4a0f59b
RS
1844 ;; Since we have created an entirely new file
1845 ;; and renamed it, make sure it gets the
1846 ;; right permission bits set.
1847 (setq setmodes (file-modes buffer-file-name))
1848 ;; We succeeded in writing the temp file,
1849 ;; so rename it.
1850 (rename-file tempname buffer-file-name t))
1851 ;; If file not writable, see if we can make it writable
1852 ;; temporarily while we write it.
1853 ;; But no need to do so if we have just backed it up
1854 ;; (setmodes is set) because that says we're superseding.
1855 (cond ((and tempsetmodes (not setmodes))
1856 ;; Change the mode back, after writing.
1857 (setq setmodes (file-modes buffer-file-name))
1858 (set-file-modes buffer-file-name 511)))
1859 (write-region (point-min) (point-max)
89095962 1860 buffer-file-name nil t buffer-file-truename)))
87d26afc
RS
1861 setmodes))
1862
b4da00e9
RM
1863(defun save-some-buffers (&optional arg exiting)
1864 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
1865Optional argument (the prefix) non-nil means save all with no questions.
1866Optional second argument EXITING means ask about certain non-file buffers
1867 as well as about file buffers."
b4da00e9 1868 (interactive "P")
907482b9 1869 (save-window-excursion
5625c2fc
RS
1870 (let ((files-done
1871 (map-y-or-n-p
1872 (function
1873 (lambda (buffer)
1874 (and (buffer-modified-p buffer)
c11a94fe 1875 (not (buffer-base-buffer buffer))
5625c2fc
RS
1876 (or
1877 (buffer-file-name buffer)
1878 (and exiting
1879 (progn
1880 (set-buffer buffer)
1881 (and buffer-offer-save (> (buffer-size) 0)))))
1882 (if arg
1883 t
1884 (if (buffer-file-name buffer)
1885 (format "Save file %s? "
1886 (buffer-file-name buffer))
1887 (format "Save buffer %s? "
1888 (buffer-name buffer)))))))
1889 (function
1890 (lambda (buffer)
1891 (set-buffer buffer)
1892 (save-buffer)))
1893 (buffer-list)
1894 '("buffer" "buffers" "save")
1895 (list (list ?\C-r (lambda (buf)
1896 (view-buffer buf)
1897 (setq view-exit-action
1898 '(lambda (ignore)
1899 (exit-recursive-edit)))
1900 (recursive-edit)
1901 ;; Return nil to ask about BUF again.
1902 nil)
1903 "display the current buffer"))))
1904 (abbrevs-done
1905 (and save-abbrevs abbrevs-changed
1906 (progn
1907 (if (or arg
1908 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name)))
1909 (write-abbrev-file nil))
1910 ;; Don't keep bothering user if he says no.
1911 (setq abbrevs-changed nil)
1912 t))))
1913 (or (> files-done 0) abbrevs-done
1914 (message "(No files need saving)")))))
b4da00e9
RM
1915\f
1916(defun not-modified (&optional arg)
1917 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
1918With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
1919
1920It is not a good idea to use this function in Lisp programs, because it
1921prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
1922 (interactive "P")
1923 (message (if arg "Modification-flag set"
1924 "Modification-flag cleared"))
1925 (set-buffer-modified-p arg))
1926
1927(defun toggle-read-only (&optional arg)
1928 "Change whether this buffer is visiting its file read-only.
1929With arg, set read-only iff arg is positive."
1930 (interactive "P")
1931 (setq buffer-read-only
1932 (if (null arg)
1933 (not buffer-read-only)
1934 (> (prefix-numeric-value arg) 0)))
3941fe2c 1935 (force-mode-line-update))
b4da00e9
RM
1936
1937(defun insert-file (filename)
1938 "Insert contents of file FILENAME into buffer after point.
1939Set mark after the inserted text.
1940
1941This function is meant for the user to run interactively.
1942Don't call it from programs! Use `insert-file-contents' instead.
1943\(Its calling sequence is different; see its documentation)."
6f931919 1944 (interactive "*fInsert file: ")
3be6243a
RS
1945 (if (file-directory-p filename)
1946 (signal 'file-error (list "Opening input file" "file is a directory"
1947 filename)))
b4da00e9
RM
1948 (let ((tem (insert-file-contents filename)))
1949 (push-mark (+ (point) (car (cdr tem))))))
1950
1951(defun append-to-file (start end filename)
1952 "Append the contents of the region to the end of file FILENAME.
1953When called from a function, expects three arguments,
1954START, END and FILENAME. START and END are buffer positions
1955saying what text to write."
1956 (interactive "r\nFAppend to file: ")
1957 (write-region start end filename t))
1958
1959(defun file-newest-backup (filename)
1960 "Return most recent backup file for FILENAME or nil if no backups exist."
1961 (let* ((filename (expand-file-name filename))
1962 (file (file-name-nondirectory filename))
1963 (dir (file-name-directory filename))
1964 (comp (file-name-all-completions file dir))
1965 newest)
1966 (while comp
1967 (setq file (concat dir (car comp))
1968 comp (cdr comp))
1969 (if (and (backup-file-name-p file)
1970 (or (null newest) (file-newer-than-file-p file newest)))
1971 (setq newest file)))
1972 newest))
1973
1974(defun rename-uniquely ()
1975 "Rename current buffer to a similar name not already taken.
1976This function is useful for creating multiple shell process buffers
1977or multiple mail buffers, etc."
1978 (interactive)
40eb8038 1979 (save-match-data
ed34f320
RS
1980 (let* ((base-name (if (and (string-match "<[0-9]+>\\'" (buffer-name))
1981 (not (and buffer-file-name
1982 (string= (buffer-name)
1983 (file-name-nondirectory
1984 buffer-file-name)))))
1985 ;; If the existing buffer name has a <NNN>,
1986 ;; which isn't part of the file name (if any),
1987 ;; then get rid of that.
40eb8038
RS
1988 (substring (buffer-name) 0 (match-beginning 0))
1989 (buffer-name)))
1990 (new-buf (generate-new-buffer base-name))
1991 (name (buffer-name new-buf)))
1992 (kill-buffer new-buf)
1993 (rename-buffer name)
3941fe2c 1994 (force-mode-line-update))))
5bbbceb1 1995
4e43240a 1996(defun make-directory (dir &optional parents)
5ce8bb89
RS
1997 "Create the directory DIR and any nonexistent parent dirs.
1998Interactively, the default choice of directory to create
1999is the current default directory for file names.
2000That is useful when you have visited a file in a nonexistint directory.
2001
2002Noninteractively, the second (optional) argument PARENTS says whether
2003to create parent directories if they don't exist."
2004 (interactive
2005 (list (read-file-name "Make directory: " default-directory default-directory
2006 nil nil)
2007 t))
6eaebaa2 2008 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
2009 (if handler
2010 (funcall handler 'make-directory dir parents)
2011 (if (not parents)
2012 (make-directory-internal dir)
2013 (let ((dir (directory-file-name (expand-file-name dir)))
2014 create-list)
2015 (while (not (file-exists-p dir))
2016 (setq create-list (cons dir create-list)
2017 dir (directory-file-name (file-name-directory dir))))
2018 (while create-list
2019 (make-directory-internal (car create-list))
2020 (setq create-list (cdr create-list))))))))
b4da00e9
RM
2021\f
2022(put 'revert-buffer-function 'permanent-local t)
2023(defvar revert-buffer-function nil
0973d78b
RS
2024 "Function to use to revert this buffer, or nil to do the default.
2025The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2026which are the arguments that `revert-buffer' received.")
b4da00e9
RM
2027
2028(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2029(defvar revert-buffer-insert-file-contents-function nil
2030 "Function to use to insert contents when reverting this buffer.
2031Gets two args, first the nominal file name to use,
2032and second, t if reading the auto-save file.")
2033
5f76e7d4
KH
2034(defvar before-revert-hook nil
2035 "Normal hook for `revert-buffer' to run before reverting.
2036If `revert-buffer-function' is used to override the normal revert
2037mechanism, this hook is not used.")
2038
2039(defvar after-revert-hook nil
2040 "Normal hook for `revert-buffer' to run after reverting.
2041Note that the hook value that it runs is the value that was in effect
2042before reverting; that makes a difference if you have buffer-local
2043hook functions.
2044
2045If `revert-buffer-function' is used to override the normal revert
2046mechanism, this hook is not used.")
2047
1ab31687 2048(defun revert-buffer (&optional ignore-auto noconfirm)
b4da00e9
RM
2049 "Replace the buffer text with the text of the visited file on disk.
2050This undoes all changes since the file was visited or saved.
8c0e7b73
JB
2051With a prefix argument, offer to revert from latest auto-save file, if
2052that is more recent than the visited file.
1ab31687 2053
65ee6096 2054When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
2055to revert from the auto-save file when this is nil. Note that the
2056sense of this argument is the reverse of the prefix argument, for the
2057sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2058to nil.
2059
2060Optional second argument NOCONFIRM means don't ask for confirmation at
2061all.
b4da00e9 2062
8c0e7b73 2063If the value of `revert-buffer-function' is non-nil, it is called to
fb6208a6
RS
2064do the work.
2065
4fbf62ee
KH
2066The default revert function runs the hook `before-revert-hook' at the
2067beginning and `after-revert-hook' at the end."
1ab31687
JB
2068 ;; I admit it's odd to reverse the sense of the prefix argument, but
2069 ;; there is a lot of code out there which assumes that the first
2070 ;; argument should be t to avoid consulting the auto-save file, and
2071 ;; there's no straightforward way to encourage authors to notice a
2072 ;; reversal of the argument sense. So I'm just changing the user
2073 ;; interface, but leaving the programmatic interface the same.
e0867e99 2074 (interactive (list (not current-prefix-arg)))
b4da00e9 2075 (if revert-buffer-function
1ab31687 2076 (funcall revert-buffer-function ignore-auto noconfirm)
b4da00e9 2077 (let* ((opoint (point))
1ab31687
JB
2078 (auto-save-p (and (not ignore-auto)
2079 (recent-auto-save-p)
b4da00e9
RM
2080 buffer-auto-save-file-name
2081 (file-readable-p buffer-auto-save-file-name)
2082 (y-or-n-p
2083 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2084 (file-name (if auto-save-p
2085 buffer-auto-save-file-name
2086 buffer-file-name)))
2087 (cond ((null file-name)
2088 (error "Buffer does not seem to be associated with any file"))
2089 ((or noconfirm
2090 (yes-or-no-p (format "Revert buffer from file %s? "
2091 file-name)))
4fbf62ee 2092 (run-hooks 'before-revert-hook)
b4da00e9
RM
2093 ;; If file was backed up but has changed since,
2094 ;; we shd make another backup.
2095 (and (not auto-save-p)
5bbbceb1 2096 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
2097 (setq buffer-backed-up nil))
2098 ;; Get rid of all undo records for this buffer.
2099 (or (eq buffer-undo-list t)
2100 (setq buffer-undo-list nil))
ba5c8c93
KH
2101 ;; Effectively copy the after-revert-hook status,
2102 ;; since after-find-file will clobber it.
2103 (let ((global-hook (default-value 'after-revert-hook))
2104 (local-hook-p (local-variable-p 'after-revert-hook))
2105 (local-hook (and (local-variable-p 'after-revert-hook)
2106 after-revert-hook)))
2107 (let (buffer-read-only
2108 ;; Don't make undo records for the reversion.
2109 (buffer-undo-list t))
2110 (if revert-buffer-insert-file-contents-function
2111 (funcall revert-buffer-insert-file-contents-function
2112 file-name auto-save-p)
2113 (if (not (file-exists-p file-name))
2114 (error "File %s no longer exists!" file-name))
2115 ;; Bind buffer-file-name to nil
2116 ;; so that we don't try to lock the file.
2117 (let ((buffer-file-name nil))
2118 (or auto-save-p
2119 (unlock-buffer)))
2120 (widen)
2121 (insert-file-contents file-name (not auto-save-p)
2122 nil nil t)))
2123 (goto-char (min opoint (point-max)))
2124 ;; Recompute the truename in case changes in symlinks
2125 ;; have changed the truename.
2126 (setq buffer-file-truename
2127 (abbreviate-file-name (file-truename buffer-file-name)))
2128 (after-find-file nil nil t t)
2129 ;; Run after-revert-hook as it was before we reverted.
2130 (setq-default revert-buffer-internal-hook global-hook)
2131 (if local-hook-p
2132 (progn
2133 (make-local-variable 'revert-buffer-internal-hook)
2134 (setq revert-buffer-internal-hook local-hook))
2135 (kill-local-variable 'revert-buffer-internal-hook))
2136 (run-hooks 'revert-buffer-internal-hook))
4fbf62ee 2137 t)))))
b4da00e9
RM
2138
2139(defun recover-file (file)
2140 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
2141 ;; Actually putting the file name in the minibuffer should be used
2142 ;; only rarely.
2143 ;; Not just because users often use the default.
2144 (interactive "fRecover file: ")
b4da00e9 2145 (setq file (expand-file-name file))
f7da6740
RS
2146 (if (auto-save-file-name-p (file-name-nondirectory file))
2147 (error "%s is an auto-save file" file))
b4da00e9
RM
2148 (let ((file-name (let ((buffer-file-name file))
2149 (make-auto-save-file-name))))
945e1965
RS
2150 (cond ((if (file-exists-p file)
2151 (not (file-newer-than-file-p file-name file))
2152 (not (file-exists-p file-name)))
b4da00e9
RM
2153 (error "Auto-save file %s not current" file-name))
2154 ((save-window-excursion
2155 (if (not (eq system-type 'vax-vms))
2156 (with-output-to-temp-buffer "*Directory*"
2157 (buffer-disable-undo standard-output)
2158 (call-process "ls" nil standard-output nil
2dc2b736
RS
2159 (if (file-symlink-p file) "-lL" "-l")
2160 file file-name)))
b4da00e9
RM
2161 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2162 (switch-to-buffer (find-file-noselect file t))
2163 (let ((buffer-read-only nil))
2164 (erase-buffer)
2165 (insert-file-contents file-name nil))
8cfb9d46 2166 (after-find-file nil nil t))
b4da00e9
RM
2167 (t (error "Recover-file cancelled.")))))
2168
6598027d 2169(defun recover-session ()
9aee5392
RS
2170 "Recover auto save files from a previous Emacs session.
2171This command first displays a Dired buffer showing you the
2172previous sessions that you could recover from.
2173To choose one, move point to the proper line and then type C-c C-c.
2174Then you'll be asked about a number of files to recover."
2175 (interactive)
5bcb0278 2176 (dired (concat auto-save-list-file-prefix "*"))
9aee5392
RS
2177 (goto-char (point-min))
2178 (or (looking-at "Move to the session you want to recover,")
2179 (let ((inhibit-read-only t))
033ef863
RS
2180 (insert "Move to the session you want to recover,\n"
2181 "then type C-c C-c to select it.\n\n"
2182 "You can also delete some of these files;\n"
2183 "type d on a line to mark that file for deletion.\n\n")))
9aee5392 2184 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 2185 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 2186
80280bb7 2187(defun recover-session-finish ()
9aee5392
RS
2188 "Choose one saved session to recover auto-save files from.
2189This command is used in the special Dired buffer created by
80280bb7 2190\\[recover-session]."
9aee5392
RS
2191 (interactive)
2192 ;; Get the name of the session file to recover from.
2193 (let ((file (dired-get-filename))
953a03b2 2194 files
9aee5392 2195 (buffer (get-buffer-create " *recover*")))
033ef863 2196 (dired-do-flagged-delete t)
9aee5392
RS
2197 (unwind-protect
2198 (save-excursion
2199 ;; Read in the auto-save-list file.
2200 (set-buffer buffer)
2201 (erase-buffer)
2202 (insert-file-contents file)
953a03b2
RS
2203 ;; Loop thru the text of that file
2204 ;; and get out the names of the files to recover.
2205 (while (not (eobp))
2206 (let (thisfile autofile)
2207 (if (eolp)
2208 ;; This is a pair of lines for a non-file-visiting buffer.
2209 ;; Get the auto-save file name and manufacture
2210 ;; a "visited file name" from that.
2211 (progn
2212 (forward-line 1)
2213 (setq autofile
2214 (buffer-substring-no-properties
2215 (point)
2216 (save-excursion
2217 (end-of-line)
2218 (point))))
2219 (setq thisfile
2220 (expand-file-name
2221 (substring
2222 (file-name-nondirectory autofile)
2223 1 -1)
2224 (file-name-directory autofile)))
2225 (forward-line 1))
2226 ;; This pair of lines is a file-visiting
2227 ;; buffer. Use the visited file name.
2228 (progn
2229 (setq thisfile
2230 (buffer-substring-no-properties
2231 (point) (progn (end-of-line) (point))))
2232 (forward-line 1)
2233 (setq autofile
2234 (buffer-substring-no-properties
2235 (point) (progn (end-of-line) (point))))
2236 (forward-line 1)))
2237 ;; Ignore a file if its auto-save file does not exist now.
2238 (if (file-exists-p autofile)
2239 (setq files (cons thisfile files)))))
2240 (setq files (nreverse files))
945e1965
RS
2241 ;; The file contains a pair of line for each auto-saved buffer.
2242 ;; The first line of the pair contains the visited file name
2243 ;; or is empty if the buffer was not visiting a file.
2244 ;; The second line is the auto-save file name.
953a03b2
RS
2245 (if files
2246 (map-y-or-n-p "Recover %s? "
2247 (lambda (file)
2248 (condition-case nil
2249 (save-excursion (recover-file file))
2250 (error
2251 "Failed to recover `%s'" file)))
2252 files
2253 '("file" "files" "recover"))
2254 (message "No files can be recovered from this session now")))
9aee5392
RS
2255 (kill-buffer buffer))))
2256
b4da00e9
RM
2257(defun kill-some-buffers ()
2258 "For each buffer, ask whether to kill it."
2259 (interactive)
2260 (let ((list (buffer-list)))
2261 (while list
2262 (let* ((buffer (car list))
2263 (name (buffer-name buffer)))
2264 (and (not (string-equal name ""))
2265 (/= (aref name 0) ? )
2266 (yes-or-no-p
2267 (format "Buffer %s %s. Kill? "
2268 name
2269 (if (buffer-modified-p buffer)
2270 "HAS BEEN EDITED" "is unmodified")))
2271 (kill-buffer buffer)))
2272 (setq list (cdr list)))))
2273\f
2274(defun auto-save-mode (arg)
2275 "Toggle auto-saving of contents of current buffer.
f3e23606 2276With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
2277 (interactive "P")
2278 (setq buffer-auto-save-file-name
2279 (and (if (null arg)
74b9c2af
RS
2280 (or (not buffer-auto-save-file-name)
2281 ;; If autosave is off because buffer has shrunk,
2282 ;; then toggling should turn it on.
2283 (< buffer-saved-size 0))
b4da00e9
RM
2284 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2285 (if (and buffer-file-name auto-save-visited-file-name
2286 (not buffer-read-only))
2287 buffer-file-name
2288 (make-auto-save-file-name))))
0b7f1ef2
RS
2289 ;; If -1 was stored here, to temporarily turn off saving,
2290 ;; turn it back on.
2291 (and (< buffer-saved-size 0)
2292 (setq buffer-saved-size 0))
b4da00e9
RM
2293 (if (interactive-p)
2294 (message "Auto-save %s (in this buffer)"
2295 (if buffer-auto-save-file-name "on" "off")))
2296 buffer-auto-save-file-name)
2297
2298(defun rename-auto-save-file ()
2299 "Adjust current buffer's auto save file name for current conditions.
2300Also rename any existing auto save file, if it was made in this session."
2301 (let ((osave buffer-auto-save-file-name))
2302 (setq buffer-auto-save-file-name
2303 (make-auto-save-file-name))
2304 (if (and osave buffer-auto-save-file-name
2305 (not (string= buffer-auto-save-file-name buffer-file-name))
2306 (not (string= buffer-auto-save-file-name osave))
2307 (file-exists-p osave)
2308 (recent-auto-save-p))
2309 (rename-file osave buffer-auto-save-file-name t))))
2310
2311(defun make-auto-save-file-name ()
2312 "Return file name to use for auto-saves of current buffer.
2313Does not consider `auto-save-visited-file-name' as that variable is checked
2314before calling this function. You can redefine this for customization.
2315See also `auto-save-file-name-p'."
2316 (if buffer-file-name
2317 (concat (file-name-directory buffer-file-name)
2318 "#"
2319 (file-name-nondirectory buffer-file-name)
2320 "#")
0a1763b4
RS
2321
2322 ;; Deal with buffers that don't have any associated files. (Mail
2323 ;; mode tends to create a good number of these.)
2324
7d483e8c 2325 (let ((buffer-name (buffer-name))
0a1763b4
RS
2326 (limit 0))
2327 ;; Use technique from Sebastian Kremer's auto-save
2328 ;; package to turn slashes into \\!. This ensures that
2329 ;; the auto-save buffer name is unique.
2330
2331 (while (string-match "[/\\]" buffer-name limit)
2332 (setq buffer-name (concat (substring buffer-name 0 (match-beginning 0))
2333 (if (string= (substring buffer-name
2334 (match-beginning 0)
2335 (match-end 0))
2336 "/")
2337 "\\!"
2338 "\\\\")
2339 (substring buffer-name (match-end 0))))
2340 (setq limit (1+ (match-end 0))))
2341
7d483e8c 2342 (expand-file-name (format "#%s#%s#" buffer-name (make-temp-name ""))))))
b4da00e9
RM
2343
2344(defun auto-save-file-name-p (filename)
2345 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2346FILENAME should lack slashes. You can redefine this for customization."
2347 (string-match "^#.*#$" filename))
2348\f
2349(defconst list-directory-brief-switches
2350 (if (eq system-type 'vax-vms) "" "-CF")
2351 "*Switches for list-directory to pass to `ls' for brief listing,")
2352
2353(defconst list-directory-verbose-switches
2354 (if (eq system-type 'vax-vms)
2355 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2356 "-l")
2357 "*Switches for list-directory to pass to `ls' for verbose listing,")
2358
2359(defun list-directory (dirname &optional verbose)
2360 "Display a list of files in or matching DIRNAME, a la `ls'.
2361DIRNAME is globbed by the shell if necessary.
2362Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2363Actions controlled by variables `list-directory-brief-switches'
2364and `list-directory-verbose-switches'."
2365 (interactive (let ((pfx current-prefix-arg))
2366 (list (read-file-name (if pfx "List directory (verbose): "
2367 "List directory (brief): ")
2368 nil default-directory nil)
2369 pfx)))
2370 (let ((switches (if verbose list-directory-verbose-switches
2371 list-directory-brief-switches)))
2372 (or dirname (setq dirname default-directory))
2373 (setq dirname (expand-file-name dirname))
2374 (with-output-to-temp-buffer "*Directory*"
2375 (buffer-disable-undo standard-output)
2376 (princ "Directory ")
2377 (princ dirname)
2378 (terpri)
c3554e95
RS
2379 (save-excursion
2380 (set-buffer "*Directory*")
a513a2f8 2381 (setq default-directory (file-name-directory dirname))
c3554e95
RS
2382 (let ((wildcard (not (file-directory-p dirname))))
2383 (insert-directory dirname switches wildcard (not wildcard)))))))
2384
2385(defvar insert-directory-program "ls"
2386 "Absolute or relative name of the `ls' program used by `insert-directory'.")
2387
2388;; insert-directory
2389;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2390;; FULL-DIRECTORY-P is nil.
2391;; The single line of output must display FILE's name as it was
2392;; given, namely, an absolute path name.
2393;; - must insert exactly one line for each file if WILDCARD or
2394;; FULL-DIRECTORY-P is t, plus one optional "total" line
2395;; before the file lines, plus optional text after the file lines.
2396;; Lines are delimited by "\n", so filenames containing "\n" are not
2397;; allowed.
2398;; File lines should display the basename.
2399;; - must be consistent with
2400;; - functions dired-move-to-filename, (these two define what a file line is)
2401;; dired-move-to-end-of-filename,
2402;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2403;; dired-insert-headerline
2404;; dired-after-subdir-garbage (defines what a "total" line is)
2405;; - variable dired-subdir-regexp
2406(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 2407 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 2408Leaves point after the inserted text.
727d277d 2409SWITCHES may be a string of options, or a list of strings.
c3554e95
RS
2410Optional third arg WILDCARD means treat FILE as shell wildcard.
2411Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2412switches do not contain `d', so that a full listing is expected.
2413
2414This works by running a directory listing program
406e12d9 2415whose name is in the variable `insert-directory-program'.
c3554e95 2416If WILDCARD, it also runs the shell specified by `shell-file-name'."
c870ab8e
RS
2417 ;; We need the directory in order to find the right handler.
2418 (let ((handler (find-file-name-handler (expand-file-name file)
2419 'insert-directory)))
c3554e95
RS
2420 (if handler
2421 (funcall handler 'insert-directory file switches
2422 wildcard full-directory-p)
b4da00e9 2423 (if (eq system-type 'vax-vms)
c3554e95
RS
2424 (vms-read-directory file switches (current-buffer))
2425 (if wildcard
a9fa0bd5
RS
2426 ;; Run ls in the directory of the file pattern we asked for.
2427 (let ((default-directory
2428 (if (file-name-absolute-p file)
2429 (file-name-directory file)
6e2dc7cb
RS
2430 (file-name-directory (expand-file-name file))))
2431 (pattern (file-name-nondirectory file))
2432 (beg 0))
2433 ;; Quote some characters that have special meanings in shells;
2434 ;; but don't quote the wildcards--we want them to be special.
2435 ;; We also currently don't quote the quoting characters
2436 ;; in case people want to use them explicitly to quote
2437 ;; wildcard characters.
d1739e52 2438 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
6e2dc7cb
RS
2439 (setq pattern
2440 (concat (substring pattern 0 (match-beginning 0))
2441 "\\"
2442 (substring pattern (match-beginning 0)))
2443 beg (1+ (match-end 0))))
c3554e95 2444 (call-process shell-file-name nil t nil
108aa1b5
RS
2445 "-c" (concat "\\" ;; Disregard shell aliases!
2446 insert-directory-program
727d277d
RS
2447 " -d "
2448 (if (stringp switches)
2449 switches
eb51e665 2450 (mapconcat 'identity switches " "))
727d277d 2451 " "
eb51e665 2452 pattern)))
a18b7c81
JB
2453 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
2454 ;; directory if FILE is a symbolic link.
727d277d
RS
2455 (apply 'call-process
2456 insert-directory-program nil t nil
2457 (let (list)
9700caaf 2458 (if (listp switches)
727d277d 2459 (setq list switches)
9700caaf
RS
2460 (if (not (equal switches ""))
2461 (progn
2462 ;; Split the switches at any spaces
2463 ;; so we can pass separate options as separate args.
2464 (while (string-match " " switches)
2465 (setq list (cons (substring switches 0 (match-beginning 0))
2466 list)
2467 switches (substring switches (match-end 0))))
2468 (setq list (cons switches list)))))
727d277d
RS
2469 (append list
2470 (list
2471 (if full-directory-p
2472 (concat (file-name-as-directory file) ".")
2473 file))))))))))
b4da00e9 2474
88902b35 2475(defvar kill-emacs-query-functions nil
65d5c6de 2476 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
2477If any of these functions returns nil, killing Emacs is cancelled.
2478`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
2479but `kill-emacs', the low level primitive, does not.
2480See also `kill-emacs-hook'.")
88902b35 2481
b4da00e9
RM
2482(defun save-buffers-kill-emacs (&optional arg)
2483 "Offer to save each buffer, then kill this Emacs process.
2484With prefix arg, silently save all file-visiting buffers, then kill."
2485 (interactive "P")
2486 (save-some-buffers arg t)
2487 (and (or (not (memq t (mapcar (function
2488 (lambda (buf) (and (buffer-file-name buf)
2489 (buffer-modified-p buf))))
2490 (buffer-list))))
2491 (yes-or-no-p "Modified buffers exist; exit anyway? "))
2492 (or (not (fboundp 'process-list))
2493 ;; process-list is not defined on VMS.
2494 (let ((processes (process-list))
2495 active)
2496 (while processes
528415e7 2497 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
2498 (let ((val (process-kill-without-query (car processes))))
2499 (process-kill-without-query (car processes) val)
2500 val)
2501 (setq active t))
2502 (setq processes (cdr processes)))
2503 (or (not active)
2504 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 2505 ;; Query the user for other things, perhaps.
fb15c113 2506 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
b4da00e9
RM
2507 (kill-emacs)))
2508\f
2509(define-key ctl-x-map "\C-f" 'find-file)
2510(define-key ctl-x-map "\C-q" 'toggle-read-only)
2511(define-key ctl-x-map "\C-r" 'find-file-read-only)
2512(define-key ctl-x-map "\C-v" 'find-alternate-file)
2513(define-key ctl-x-map "\C-s" 'save-buffer)
2514(define-key ctl-x-map "s" 'save-some-buffers)
2515(define-key ctl-x-map "\C-w" 'write-file)
2516(define-key ctl-x-map "i" 'insert-file)
2517(define-key esc-map "~" 'not-modified)
2518(define-key ctl-x-map "\C-d" 'list-directory)
2519(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
2520
2521(define-key ctl-x-4-map "f" 'find-file-other-window)
2522(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
2523(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
2524(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 2525(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 2526
f98955ea
JB
2527(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
2528(define-key ctl-x-5-map "f" 'find-file-other-frame)
2529(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
2530(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
2531
2532;;; files.el ends here