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