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