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