(archive-tmpdir): Make the prefix of the temporary
[bpt/emacs.git] / lisp / files.el
CommitLineData
c0274f38
ER
1;;; files.el --- file input and output commands for Emacs
2
9596811a 3;; Copyright (C) 1985, 86, 87, 92, 93,
b0d2a9e7 4;; 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
b4da00e9 5
3a801d0c
ER
6;; Maintainer: FSF
7
b4da00e9
RM
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
e5167999 12;; the Free Software Foundation; either version 2, or (at your option)
b4da00e9
RM
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
693f800d
RS
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
b4da00e9 24
e41b2db1
ER
25;;; Commentary:
26
27;; Defines most of Emacs's file- and directory-handling functions,
28;; including basic file visiting, backup generation, link handling,
29;; ITS-id version control, load- and write-hook handling, and the like.
30
e5167999
ER
31;;; Code:
32
21540597
RS
33(defgroup backup nil
34 "Backups of edited data files."
2a9fe1e2 35 :group 'files)
b4da00e9 36
21540597 37(defgroup find-file nil
2a9fe1e2
RS
38 "Finding files."
39 :group 'files)
21540597
RS
40
41
42(defcustom delete-auto-save-files t
92631216
EZ
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
44
45Note that auto-save file will not be deleted if the buffer is killed
46when it has unsaved changes."
21540597
RS
47 :type 'boolean
48 :group 'auto-save)
49
50(defcustom directory-abbrev-alist
b4da00e9
RM
51 nil
52 "*Alist of abbreviations for file directories.
53A list of elements of the form (FROM . TO), each meaning to replace
54FROM with TO when it appears in a directory name. This replacement is
55done when setting up the default directory of a newly visited file.
56*Every* FROM string should start with `^'.
57
65151a1b
RS
58Do not use `~' in the TO strings.
59They should be ordinary absolute directory names.
60
b4da00e9
RM
61Use this feature when you have directories which you normally refer to
62via absolute symbolic links. Make TO the name of the link, and FROM
21540597
RS
63the name it is linked to."
64 :type '(repeat (cons :format "%v"
65 :value ("" . "")
66 (regexp :tag "From")
67 (regexp :tag "To")))
68 :group 'abbrev
69 :group 'find-file)
b4da00e9
RM
70
71;;; Turn off backup files on VMS since it has version numbers.
21540597 72(defcustom make-backup-files (not (eq system-type 'vax-vms))
4ea836c1 73 "*Non-nil means make a backup of a file the first time it is saved.
b4da00e9
RM
74This can be done by renaming the file or by copying.
75
76Renaming means that Emacs renames the existing file so that it is a
77backup file, then writes the buffer into a new file. Any other names
78that the old file had will now refer to the backup file. The new file
79is owned by you and its group is defaulted.
80
81Copying means that Emacs copies the existing file into the backup
82file, then writes the buffer on top of the existing file. Any other
83names that the old file had will now refer to the new (edited) file.
84The file's owner and group are unchanged.
85
86The choice of renaming or copying is controlled by the variables
87`backup-by-copying', `backup-by-copying-when-linked' and
21540597
RS
88`backup-by-copying-when-mismatch'. See also `backup-inhibited'."
89 :type 'boolean
90 :group 'backup)
b4da00e9
RM
91
92;; Do this so that local variables based on the file name
93;; are not overridden by the major mode.
94(defvar backup-inhibited nil
f862241d
RS
95 "Non-nil means don't make a backup, regardless of the other parameters.
96This variable is intended for use by making it local to a buffer.
97But it is local only if you make it local.")
b4da00e9
RM
98(put 'backup-inhibited 'permanent-local t)
99
21540597 100(defcustom backup-by-copying nil
b4da00e9 101 "*Non-nil means always use copying to create backup files.
21540597
RS
102See documentation of variable `make-backup-files'."
103 :type 'boolean
104 :group 'backup)
b4da00e9 105
21540597 106(defcustom backup-by-copying-when-linked nil
b4da00e9
RM
107 "*Non-nil means use copying to create backups for files with multiple names.
108This causes the alternate names to refer to the latest version as edited.
21540597
RS
109This variable is relevant only if `backup-by-copying' is nil."
110 :type 'boolean
111 :group 'backup)
b4da00e9 112
21540597 113(defcustom backup-by-copying-when-mismatch nil
b4da00e9
RM
114 "*Non-nil means create backups by copying if this preserves owner or group.
115Renaming may still be used (subject to control of other variables)
116when it would not result in changing the owner or group of the file;
117that is, for files which are owned by you and whose group matches
118the default for a new file created there by you.
21540597
RS
119This variable is relevant only if `backup-by-copying' is nil."
120 :type 'boolean
121 :group 'backup)
b4da00e9
RM
122
123(defvar backup-enable-predicate
124 '(lambda (name)
125 (or (< (length name) 5)
126 (not (string-equal "/tmp/" (substring name 0 5)))))
127 "Predicate that looks at a file name and decides whether to make backups.
128Called with an absolute file name as argument, it returns t to enable backup.")
129
21540597 130(defcustom buffer-offer-save nil
b4da00e9
RM
131 "*Non-nil in a buffer means offer to save the buffer on exit
132even if the buffer is not visiting a file.
21540597
RS
133Automatically local in all buffers."
134 :type 'boolean
135 :group 'backup)
b4da00e9
RM
136(make-variable-buffer-local 'buffer-offer-save)
137
21540597 138(defcustom find-file-existing-other-name t
f3e23606
RS
139 "*Non-nil means find a file under alternative names, in existing buffers.
140This means if any existing buffer is visiting the file you want
21540597
RS
141under another name, you get the existing buffer instead of a new buffer."
142 :type 'boolean
143 :group 'find-file)
f3e23606 144
21540597 145(defcustom find-file-visit-truename nil
f3e23606
RS
146 "*Non-nil means visit a file under its truename.
147The truename of a file is found by chasing all links
21540597
RS
148both at the file level and at the levels of the containing directories."
149 :type 'boolean
150 :group 'find-file)
f3e23606 151
db8c4866 152(defcustom revert-without-query
d7fa5aa2 153 nil
ebeb898f
RS
154 "*Specify which files should be reverted without query.
155The value is a list of regular expressions.
156If the file name matches one of these regular expressions,
db8c4866 157then `revert-buffer' reverts the file without querying
21540597 158if the file has changed on disk and you have not edited the buffer."
a0d809f2 159 :type '(repeat regexp)
21540597 160 :group 'find-file)
ebeb898f 161
f3e23606
RS
162(defvar buffer-file-number nil
163 "The device number and file number of the file visited in the current buffer.
164The value is a list of the form (FILENUM DEVNUM).
165This pair of numbers uniquely identifies the file.
166If the buffer is visiting a new file, the value is nil.")
167(make-variable-buffer-local 'buffer-file-number)
168(put 'buffer-file-number 'permanent-local t)
169
de88363f
RS
170(defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
171 "Non-nil means that buffer-file-number uniquely identifies files.")
172
21540597 173(defcustom file-precious-flag nil
b4da00e9 174 "*Non-nil means protect against I/O errors while saving files.
560f4415 175Some modes set this non-nil in particular buffers.
4b7271c1
KH
176
177This feature works by writing the new contents into a temporary file
178and then renaming the temporary file to replace the original.
179In this way, any I/O error in writing leaves the original untouched,
180and there is never any instant where the file is nonexistent.
181
182Note that this feature forces backups to be made by copying.
560f4415 183Yet, at the same time, saving a precious file
21540597
RS
184breaks any hard links between it and other files."
185 :type 'boolean
186 :group 'backup)
b4da00e9 187
21540597 188(defcustom version-control nil
b4da00e9
RM
189 "*Control use of version numbers for backup files.
190t means make numeric backup versions unconditionally.
191nil means make them for files that have some already.
21540597
RS
192`never' means do not make them."
193 :type 'boolean
194 :group 'backup
195 :group 'vc)
196
197(defcustom dired-kept-versions 2
198 "*When cleaning directory, number of versions to keep."
199 :type 'integer
200 :group 'backup
201 :group 'dired)
202
203(defcustom delete-old-versions nil
de7d5e1b 204 "*If t, delete excess backup versions silently.
21540597
RS
205If nil, ask confirmation. Any other value prevents any trimming."
206 :type '(choice (const :tag "Delete" t)
207 (const :tag "Ask" nil)
208 (sexp :tag "Leave" :format "%t\n" other))
209 :group 'backup)
210
211(defcustom kept-old-versions 2
212 "*Number of oldest versions to keep when a new numbered backup is made."
213 :type 'integer
214 :group 'backup)
215
216(defcustom kept-new-versions 2
b4da00e9 217 "*Number of newest versions to keep when a new numbered backup is made.
21540597
RS
218Includes the new backup. Must be > 0"
219 :type 'integer
220 :group 'backup)
b4da00e9 221
21540597 222(defcustom require-final-newline nil
b4da00e9
RM
223 "*Value of t says silently ensure a file ends in a newline when it is saved.
224Non-nil but not t says ask user whether to add a newline when there isn't one.
21540597 225nil means don't add newlines."
ad375092
RS
226 :type '(choice (const :tag "Off" nil)
227 (const :tag "Add" t)
228 (sexp :tag "Ask" :format "%t\n" ask))
21540597 229 :group 'editing-basics)
b4da00e9 230
21540597
RS
231(defcustom auto-save-default t
232 "*Non-nil says by default do auto-saving of every file-visiting buffer."
233 :type 'boolean
234 :group 'auto-save)
b4da00e9 235
21540597 236(defcustom auto-save-visited-file-name nil
b4da00e9 237 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
21540597
RS
238Normally auto-save files are written under other names."
239 :type 'boolean
240 :group 'auto-save)
b4da00e9 241
21540597 242(defcustom save-abbrevs nil
b4da00e9 243 "*Non-nil means save word abbrevs too when files are saved.
21540597
RS
244Loading an abbrev file sets this to t."
245 :type 'boolean
246 :group 'abbrev)
b4da00e9 247
21540597
RS
248(defcustom find-file-run-dired t
249 "*Non-nil says run dired if `find-file' is given the name of a directory."
250 :type 'boolean
251 :group 'find-file)
b4da00e9 252
92966e6f
RS
253;;;It is not useful to make this a local variable.
254;;;(put 'find-file-not-found-hooks 'permanent-local t)
b4da00e9
RM
255(defvar find-file-not-found-hooks nil
256 "List of functions to be called for `find-file' on nonexistent file.
257These functions are called as soon as the error is detected.
258`buffer-file-name' is already set up.
259The functions are called in the order given until one of them returns non-nil.")
260
92966e6f
RS
261;;;It is not useful to make this a local variable.
262;;;(put 'find-file-hooks 'permanent-local t)
b4da00e9
RM
263(defvar find-file-hooks nil
264 "List of functions to be called after a buffer is loaded from a file.
265The buffer's local variables (if any) will have been processed before the
266functions are called.")
267
b4da00e9
RM
268(defvar write-file-hooks nil
269 "List of functions to be called before writing out a buffer to a file.
270If one of them returns non-nil, the file is considered already written
8c0e7b73
JB
271and the rest are not called.
272These hooks are considered to pertain to the visited file.
273So this list is cleared if you change the visited file name.
f82966e4
KH
274
275Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
276See also `write-contents-hooks'.")
b19f1da4
BF
277;;; However, in case someone does make it local...
278(put 'write-file-hooks 'permanent-local t)
c9dca4e0 279
c9dca4e0
RS
280(defvar local-write-file-hooks nil
281 "Just like `write-file-hooks', except intended for per-buffer use.
282The functions in this list are called before the ones in
f82966e4
KH
283`write-file-hooks'.
284
285This variable is meant to be used for hooks that have to do with a
286particular visited file. Therefore, it is a permanent local, so that
287changing the major mode does not clear it. However, calling
288`set-visited-file-name' does clear it.")
b19f1da4
BF
289(make-variable-buffer-local 'local-write-file-hooks)
290(put 'local-write-file-hooks 'permanent-local t)
8c0e7b73
JB
291
292(defvar write-contents-hooks nil
293 "List of functions to be called before writing out a buffer to a file.
294If one of them returns non-nil, the file is considered already written
295and the rest are not called.
f82966e4
KH
296
297This variable is meant to be used for hooks that pertain to the
298buffer's contents, not to the particular visited file; thus,
299`set-visited-file-name' does not clear this variable; but changing the
693f800d
RS
300major mode does clear it.
301
302This variable automatically becomes buffer-local whenever it is set.
659ebcc6 303If you use `add-hook' to add elements to the list, use nil for the
693f800d 304LOCAL argument.
f82966e4 305
8c0e7b73 306See also `write-file-hooks'.")
f82966e4 307(make-variable-buffer-local 'write-contents-hooks)
b4da00e9 308
21540597 309(defcustom enable-local-variables t
93a2702d 310 "*Control use of local variables in files you visit.
b4da00e9 311The value can be t, nil or something else.
93a2702d 312A value of t means file local variables specifications are obeyed;
b4da00e9
RM
313nil means they are ignored; anything else means query.
314
93a2702d 315The command \\[normal-mode] always obeys file local variable
21540597
RS
316specifications and ignores this variable."
317 :type '(choice (const :tag "Obey" t)
318 (const :tag "Ignore" nil)
319 (sexp :tag "Query" :format "%t\n" other))
320 :group 'find-file)
b4da00e9 321
21540597 322(defcustom enable-local-eval 'maybe
d207b766
RS
323 "*Control processing of the \"variable\" `eval' in a file's local variables.
324The value can be t, nil or something else.
325A value of t means obey `eval' variables;
326nil means ignore them; anything else means query.
327
328The command \\[normal-mode] always obeys local-variables lists
21540597
RS
329and ignores this variable."
330 :type '(choice (const :tag "Obey" t)
331 (const :tag "Ignore" nil)
332 (sexp :tag "Query" :format "%t\n" other))
333 :group 'find-file)
b4da00e9
RM
334
335;; Avoid losing in versions where CLASH_DETECTION is disabled.
336(or (fboundp 'lock-buffer)
231c4e10 337 (defalias 'lock-buffer 'ignore))
b4da00e9 338(or (fboundp 'unlock-buffer)
231c4e10 339 (defalias 'unlock-buffer 'ignore))
a7305f6e
RS
340(or (fboundp 'file-locked-p)
341 (defalias 'file-locked-p 'ignore))
93fe0a35 342
2a9fe1e2
RS
343(defvar view-read-only nil
344 "*Non-nil means buffers visiting files read-only, do it in view mode.")
345
93fe0a35
RS
346;; This hook function provides support for ange-ftp host name
347;; completion. It runs the usual ange-ftp hook, but only for
348;; completion operations. Having this here avoids the need
349;; to load ange-ftp when it's not really in use.
350(defun ange-ftp-completion-hook-function (op &rest args)
351 (if (memq op '(file-name-completion file-name-all-completions))
352 (apply 'ange-ftp-hook-function op args)
57e81f57
RS
353 (let ((inhibit-file-name-handlers
354 (cons 'ange-ftp-completion-hook-function
355 (and (eq inhibit-file-name-operation op)
356 inhibit-file-name-handlers)))
357 (inhibit-file-name-operation op))
93fe0a35 358 (apply op args))))
567c1ca9
RS
359
360(defun convert-standard-filename (filename)
361 "Convert a standard file's name to something suitable for the current OS.
362This function's standard definition is trivial; it just returns the argument.
363However, on some systems, the function is redefined
364with a definition that really does change some file names."
365 filename)
b4da00e9
RM
366\f
367(defun pwd ()
368 "Show the current default directory."
369 (interactive nil)
370 (message "Directory %s" default-directory))
371
231c4e10
ER
372(defvar cd-path nil
373 "Value of the CDPATH environment variable, as a list.
374Not actually set up until the first time you you use it.")
375
376(defun parse-colon-path (cd-path)
db8c4866 377 "Explode a colon-separated search path into a list of directory names."
231c4e10
ER
378 (and cd-path
379 (let (cd-prefix cd-list (cd-start 0) cd-colon)
306faa42
RS
380 (setq cd-path (concat cd-path path-separator))
381 (while (setq cd-colon (string-match path-separator cd-path cd-start))
231c4e10 382 (setq cd-list
9daefb36 383 (nconc cd-list
c52e4104
RS
384 (list (if (= cd-start cd-colon)
385 nil
386 (substitute-in-file-name
e33e80e4
RS
387 (file-name-as-directory
388 (substring cd-path cd-start cd-colon)))))))
231c4e10
ER
389 (setq cd-start (+ cd-colon 1)))
390 cd-list)))
391
392(defun cd-absolute (dir)
30c5ce9c 393 "Change current directory to given absolute file name DIR."
f4a0f59b
RS
394 ;; Put the name into directory syntax now,
395 ;; because otherwise expand-file-name may give some bad results.
b4da00e9
RM
396 (if (not (eq system-type 'vax-vms))
397 (setq dir (file-name-as-directory dir)))
f4a0f59b 398 (setq dir (abbreviate-file-name (expand-file-name dir)))
b4da00e9 399 (if (not (file-directory-p dir))
83c6f446
RS
400 (if (file-exists-p dir)
401 (error "%s is not a directory" dir)
31c691c1 402 (error "%s: no such directory" dir))
b4da00e9
RM
403 (if (file-executable-p dir)
404 (setq default-directory dir)
9daefb36 405 (error "Cannot cd to %s: Permission denied" dir))))
b4da00e9 406
231c4e10
ER
407(defun cd (dir)
408 "Make DIR become the current buffer's default directory.
30c5ce9c
RS
409If your environment includes a `CDPATH' variable, try each one of that
410colon-separated list of directories when resolving a relative directory name."
dac4ea74
RS
411 (interactive
412 (list (read-file-name "Change default directory: "
2121cd9c
RM
413 default-directory default-directory
414 (and (member cd-path '(nil ("./")))
415 (null (getenv "CDPATH"))))))
30c5ce9c
RS
416 (if (file-name-absolute-p dir)
417 (cd-absolute (expand-file-name dir))
418 (if (null cd-path)
419 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
420 (setq cd-path (or trypath (list "./")))))
421 (if (not (catch 'found
422 (mapcar
423 (function (lambda (x)
424 (let ((f (expand-file-name (concat x dir))))
425 (if (file-directory-p f)
426 (progn
427 (cd-absolute f)
428 (throw 'found t))))))
429 cd-path)
430 nil))
431 (error "No such directory found via CDPATH environment variable"))))
231c4e10 432
b4da00e9
RM
433(defun load-file (file)
434 "Load the Lisp file named FILE."
435 (interactive "fLoad file: ")
436 (load (expand-file-name file) nil nil t))
437
438(defun load-library (library)
439 "Load the library named LIBRARY.
440This is an interface to the function `load'."
441 (interactive "sLoad library: ")
442 (load library))
5d68c2c2 443
7c4b8f8c 444(defun file-local-copy (file &optional buffer)
5d68c2c2
RS
445 "Copy the file FILE into a temporary file on this machine.
446Returns the name of the local copy, or nil, if FILE is directly
447accessible."
6eaebaa2 448 (let ((handler (find-file-name-handler file 'file-local-copy)))
5d68c2c2
RS
449 (if handler
450 (funcall handler 'file-local-copy file)
451 nil)))
f3e23606 452
05ef1cda 453(defun file-truename (filename &optional counter prev-dirs)
f3e23606
RS
454 "Return the truename of FILENAME, which should be absolute.
455The truename of a file name is found by chasing symbolic links
456both at the level of the file and at the level of the directories
05ef1cda
RS
457containing it, until no links are left at any level.
458
459The arguments COUNTER and PREV-DIRS are used only in recursive calls.
460Do not specify them in other calls."
461 ;; COUNTER can be a cons cell whose car is the count of how many more links
462 ;; to chase before getting an error.
463 ;; PREV-DIRS can be a cons cell whose car is an alist
464 ;; of truenames we've just recently computed.
cc37a58c 465
cc37a58c
SM
466 ;; The last test looks dubious, maybe `+' is meant here? --simon.
467 (if (or (string= filename "") (string= filename "~")
7a5a26a6
RS
468 (and (string= (substring filename 0 1) "~")
469 (string-match "~[^/]*" filename)))
1cc2fbeb
RS
470 (progn
471 (setq filename (expand-file-name filename))
472 (if (string= filename "")
473 (setq filename "/"))))
05ef1cda 474 (or counter (setq counter (list 100)))
b505828b
RS
475 (let (done
476 ;; For speed, remove the ange-ftp completion handler from the list.
477 ;; We know it's not needed here.
478 ;; For even more speed, do this only on the outermost call.
479 (file-name-handler-alist
480 (if prev-dirs file-name-handler-alist
481 (let ((tem (copy-sequence file-name-handler-alist)))
482 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
483 (or prev-dirs (setq prev-dirs (list nil)))
b1667e6c
GV
484
485 ;; andrewi@harlequin.co.uk - none of the following code (except for
486 ;; invoking the file-name handler) currently applies on Windows
487 ;; (ie. there are no native symlinks), but there is an issue with
488 ;; case differences being ignored by the OS, and short "8.3 DOS"
489 ;; name aliases existing for all files. (The short names are not
490 ;; reported by directory-files, but can be used to refer to files.)
491 ;; It seems appropriate for file-truename to resolve these issues in
492 ;; the most natural way, which on Windows is to call the function
493 ;; `w32-long-file-name' - this returns the exact name of a file as
494 ;; it is stored on disk (expanding short name aliases with the full
495 ;; name in the process).
496 (if (eq system-type 'windows-nt)
497 (let ((handler (find-file-name-handler filename 'file-truename))
498 newname)
499 ;; For file name that has a special handler, call handler.
500 ;; This is so that ange-ftp can save time by doing a no-op.
501 (if handler
502 (setq filename (funcall handler 'file-truename filename))
503 ;; If filename contains a wildcard, newname will be the old name.
504 (if (string-match "[*?]" filename)
505 (setq newname filename)
506 ;; If filename doesn't exist, newname will be nil.
507 (setq newname (w32-long-file-name filename)))
508 (setq filename (or newname filename)))
509 (setq done t)))
510
05ef1cda
RS
511 ;; If this file directly leads to a link, process that iteratively
512 ;; so that we don't use lots of stack.
513 (while (not done)
514 (setcar counter (1- (car counter)))
515 (if (< (car counter) 0)
516 (error "Apparent cycle of symbolic links for %s" filename))
517 (let ((handler (find-file-name-handler filename 'file-truename)))
518 ;; For file name that has a special handler, call handler.
519 ;; This is so that ange-ftp can save time by doing a no-op.
520 (if handler
521 (setq filename (funcall handler 'file-truename filename)
522 done t)
fb145562 523 (let ((dir (or (file-name-directory filename) default-directory))
05ef1cda
RS
524 target dirfile)
525 ;; Get the truename of the directory.
526 (setq dirfile (directory-file-name dir))
527 ;; If these are equal, we have the (or a) root directory.
528 (or (string= dir dirfile)
529 ;; If this is the same dir we last got the truename for,
530 ;; save time--don't recalculate.
531 (if (assoc dir (car prev-dirs))
532 (setq dir (cdr (assoc dir (car prev-dirs))))
533 (let ((old dir)
534 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
535 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
536 (setq dir new))))
537 (if (equal ".." (file-name-nondirectory filename))
538 (setq filename
539 (directory-file-name (file-name-directory (directory-file-name dir)))
540 done t)
541 (if (equal "." (file-name-nondirectory filename))
542 (setq filename (directory-file-name dir)
543 done t)
544 ;; Put it back on the file name.
545 (setq filename (concat dir (file-name-nondirectory filename)))
546 ;; Is the file name the name of a link?
547 (setq target (file-symlink-p filename))
548 (if target
549 ;; Yes => chase that link, then start all over
550 ;; since the link may point to a directory name that uses links.
551 ;; We can't safely use expand-file-name here
552 ;; since target might look like foo/../bar where foo
553 ;; is itself a link. Instead, we handle . and .. above.
554 (setq filename
555 (if (file-name-absolute-p target)
556 target
557 (concat dir target))
558 done nil)
559 ;; No, we are done!
560 (setq done t))))))))
561 filename))
5dbfdacd 562
5dadeb29
RS
563(defun file-chase-links (filename)
564 "Chase links in FILENAME until a name that is not a link.
565Does not examine containing directories for links,
566unlike `file-truename'."
567 (let (tem (count 100) (newname filename))
568 (while (setq tem (file-symlink-p newname))
9695aac6
RS
569 (save-match-data
570 (if (= count 0)
571 (error "Apparent cycle of symbolic links for %s" filename))
572 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
573 (while (string-match "//+" tem)
574 (setq tem (replace-match "/" nil nil tem)))
575 ;; Handle `..' by hand, since it needs to work in the
576 ;; target of any directory symlink.
577 ;; This code is not quite complete; it does not handle
578 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
579 (while (string-match "\\`\\.\\./" tem)
580 (setq tem (substring tem 3))
581 (setq newname (expand-file-name newname))
582 ;; Chase links in the default dir of the symlink.
583 (setq newname
584 (file-chase-links
585 (directory-file-name (file-name-directory newname))))
586 ;; Now find the parent of that dir.
587 (setq newname (file-name-directory newname)))
588 (setq newname (expand-file-name tem (file-name-directory newname)))
589 (setq count (1- count))))
5dadeb29 590 newname))
b4da00e9 591\f
467ff692
RS
592(defun switch-to-buffer-other-window (buffer &optional norecord)
593 "Select buffer BUFFER in another window.
594Optional second arg NORECORD non-nil means
595do not put this buffer at the front of the list of recently selected ones."
b4da00e9
RM
596 (interactive "BSwitch to buffer in other window: ")
597 (let ((pop-up-windows t))
467ff692 598 (pop-to-buffer buffer t norecord)))
b4da00e9 599
467ff692
RS
600(defun switch-to-buffer-other-frame (buffer &optional norecord)
601 "Switch to buffer BUFFER in another frame.
602Optional second arg NORECORD non-nil means
603do not put this buffer at the front of the list of recently selected ones."
f98955ea
JB
604 (interactive "BSwitch to buffer in other frame: ")
605 (let ((pop-up-frames t))
467ff692 606 (pop-to-buffer buffer t norecord)
336b7f41 607 (raise-frame (window-frame (selected-window)))))
5bbbceb1 608
912192d1 609(defun find-file (filename)
b4da00e9
RM
610 "Edit file FILENAME.
611Switch to a buffer visiting file FILENAME,
912192d1
KH
612creating one if none already exists."
613 (interactive "FFind file: ")
614 (switch-to-buffer (find-file-noselect filename)))
82d0954a 615
912192d1 616(defun find-file-other-window (filename)
b4da00e9
RM
617 "Edit file FILENAME, in another window.
618May create a new window, or reuse an existing one.
619See the function `display-buffer'."
912192d1
KH
620 (interactive "FFind file in other window: ")
621 (switch-to-buffer-other-window (find-file-noselect filename)))
b4da00e9 622
912192d1 623(defun find-file-other-frame (filename)
f98955ea
JB
624 "Edit file FILENAME, in another frame.
625May create a new frame, or reuse an existing one.
5bbbceb1 626See the function `display-buffer'."
912192d1
KH
627 (interactive "FFind file in other frame: ")
628 (switch-to-buffer-other-frame (find-file-noselect filename)))
5bbbceb1 629
912192d1 630(defun find-file-read-only (filename)
b4da00e9
RM
631 "Edit file FILENAME but don't allow changes.
632Like \\[find-file] but marks buffer as read-only.
633Use \\[toggle-read-only] to permit editing."
912192d1
KH
634 (interactive "fFind file read-only: ")
635 (find-file filename)
2a9fe1e2 636 (toggle-read-only 1)
320b4233 637 (current-buffer))
b4da00e9 638
912192d1 639(defun find-file-read-only-other-window (filename)
b4da00e9
RM
640 "Edit file FILENAME in another window but don't allow changes.
641Like \\[find-file-other-window] but marks buffer as read-only.
642Use \\[toggle-read-only] to permit editing."
912192d1
KH
643 (interactive "fFind file read-only other window: ")
644 (find-file-other-window filename)
2a9fe1e2 645 (toggle-read-only 1)
320b4233 646 (current-buffer))
b4da00e9 647
912192d1 648(defun find-file-read-only-other-frame (filename)
f98955ea
JB
649 "Edit file FILENAME in another frame but don't allow changes.
650Like \\[find-file-other-frame] but marks buffer as read-only.
5bbbceb1 651Use \\[toggle-read-only] to permit editing."
912192d1
KH
652 (interactive "fFind file read-only other frame: ")
653 (find-file-other-frame filename)
2a9fe1e2 654 (toggle-read-only 1)
320b4233 655 (current-buffer))
5bbbceb1 656
912192d1 657(defun find-alternate-file-other-window (filename)
60eaf370 658 "Find file FILENAME as a replacement for the file in the next window.
912192d1 659This command does not select that window."
60eaf370
RS
660 (interactive
661 (save-selected-window
662 (other-window 1)
663 (let ((file buffer-file-name)
664 (file-name nil)
665 (file-dir nil))
666 (and file
667 (setq file-name (file-name-nondirectory file)
668 file-dir (file-name-directory file)))
669 (list (read-file-name
912192d1 670 "Find alternate file: " file-dir nil nil file-name)))))
60eaf370 671 (if (one-window-p)
912192d1 672 (find-file-other-window filename)
60eaf370
RS
673 (save-selected-window
674 (other-window 1)
912192d1 675 (find-alternate-file filename))))
60eaf370 676
912192d1 677(defun find-alternate-file (filename)
b4da00e9
RM
678 "Find file FILENAME, select its buffer, kill previous buffer.
679If the current buffer now contains an empty file that you just visited
912192d1 680\(presumably by mistake), use this command to visit the file you really want."
b4da00e9
RM
681 (interactive
682 (let ((file buffer-file-name)
683 (file-name nil)
684 (file-dir nil))
685 (and file
686 (setq file-name (file-name-nondirectory file)
687 file-dir (file-name-directory file)))
a61f59b4 688 (list (read-file-name
912192d1 689 "Find alternate file: " file-dir nil nil file-name))))
2aa8cc2d 690 (and (buffer-modified-p) (buffer-file-name)
b4da00e9
RM
691 ;; (not buffer-read-only)
692 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
693 (buffer-name))))
694 (error "Aborted"))
695 (let ((obuf (current-buffer))
696 (ofile buffer-file-name)
8bb27285
RS
697 (onum buffer-file-number)
698 (otrue buffer-file-truename)
b4da00e9 699 (oname (buffer-name)))
baf9b8c4
RS
700 (if (get-buffer " **lose**")
701 (kill-buffer " **lose**"))
b4da00e9 702 (rename-buffer " **lose**")
b4da00e9
RM
703 (unwind-protect
704 (progn
705 (unlock-buffer)
a4ad4d96
RS
706 (setq buffer-file-name nil)
707 (setq buffer-file-number nil)
708 (setq buffer-file-truename nil)
912192d1 709 (find-file filename))
b4da00e9
RM
710 (cond ((eq obuf (current-buffer))
711 (setq buffer-file-name ofile)
8bb27285
RS
712 (setq buffer-file-number onum)
713 (setq buffer-file-truename otrue)
b4da00e9
RM
714 (lock-buffer)
715 (rename-buffer oname))))
716 (or (eq (current-buffer) obuf)
717 (kill-buffer obuf))))
9b8ef27d 718\f
b4da00e9
RM
719(defun create-file-buffer (filename)
720 "Create a suitably named buffer for visiting FILENAME, and return it.
721FILENAME (sans directory) is used unchanged if that name is free;
722otherwise a string <2> or <3> or ... is appended to get an unused name."
723 (let ((lastname (file-name-nondirectory filename)))
724 (if (string= lastname "")
725 (setq lastname filename))
726 (generate-new-buffer lastname)))
727
5bbbceb1
JB
728(defun generate-new-buffer (name)
729 "Create and return a buffer with a name based on NAME.
29165787 730Choose the buffer's name using `generate-new-buffer-name'."
5bbbceb1
JB
731 (get-buffer-create (generate-new-buffer-name name)))
732
d7fa5aa2 733(defvar automount-dir-prefix "^/tmp_mnt/"
e373f201
JB
734 "Regexp to match the automounter prefix in a directory name.")
735
ffb3a4db 736(defvar abbreviated-home-dir nil
292297c6 737 "The user's homedir abbreviated according to `directory-abbrev-list'.")
ffb3a4db 738
5bbbceb1 739(defun abbreviate-file-name (filename)
29165787 740 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
5bbbceb1 741This also substitutes \"~\" for the user's home directory.
29165787 742Type \\[describe-variable] directory-abbrev-alist RET for more information."
e373f201 743 ;; Get rid of the prefixes added by the automounter.
a8f34fc0
RS
744 (if (and automount-dir-prefix
745 (string-match automount-dir-prefix filename)
e373f201
JB
746 (file-exists-p (file-name-directory
747 (substring filename (1- (match-end 0))))))
748 (setq filename (substring filename (1- (match-end 0)))))
5bbbceb1 749 (let ((tail directory-abbrev-alist))
ffb3a4db
RS
750 ;; If any elt of directory-abbrev-alist matches this name,
751 ;; abbreviate accordingly.
5bbbceb1
JB
752 (while tail
753 (if (string-match (car (car tail)) filename)
754 (setq filename
755 (concat (cdr (car tail)) (substring filename (match-end 0)))))
756 (setq tail (cdr tail)))
ffb3a4db
RS
757 ;; Compute and save the abbreviated homedir name.
758 ;; We defer computing this until the first time it's needed, to
759 ;; give time for directory-abbrev-alist to be set properly.
e98dda89
RS
760 ;; We include a slash at the end, to avoid spurious matches
761 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
ffb3a4db
RS
762 (or abbreviated-home-dir
763 (setq abbreviated-home-dir
764 (let ((abbreviated-home-dir "$foo"))
3a8a836d
RS
765 (concat "^" (abbreviate-file-name (expand-file-name "~"))
766 "\\(/\\|$\\)"))))
76d5492b 767
ffb3a4db
RS
768 ;; If FILENAME starts with the abbreviated homedir,
769 ;; make it start with `~' instead.
ca33ccb5
RS
770 (if (and (string-match abbreviated-home-dir filename)
771 ;; If the home dir is just /, don't change it.
772 (not (and (= (match-end 0) 1)
288201bd 773 (= (aref filename 0) ?/)))
567c1ca9
RS
774 ;; MS-DOS root directories can come with a drive letter;
775 ;; Novell Netware allows drive letters beyond `Z:'.
76d5492b 776 (not (and (or (eq system-type 'ms-dos)
c32d49e8 777 (eq system-type 'windows-nt))
288201bd 778 (save-match-data
567c1ca9 779 (string-match "^[a-zA-`]:/$" filename)))))
5bbbceb1 780 (setq filename
28dbf501 781 (concat "~"
3a8a836d 782 (substring filename (match-beginning 1) (match-end 1))
28dbf501 783 (substring filename (match-end 0)))))
5bbbceb1
JB
784 filename))
785
21540597 786(defcustom find-file-not-true-dirname-list nil
1770543d
RS
787 "*List of logical names for which visiting shouldn't save the true dirname.
788On VMS, when you visit a file using a logical name that searches a path,
789you may or may not want the visited file name to record the specific
790directory where the file was found. If you *do not* want that, add the logical
21540597
RS
791name to this list as a string."
792 :type '(repeat (string :tag "Name"))
793 :group 'find-file)
1770543d 794
138c44f6
KH
795(defun find-buffer-visiting (filename)
796 "Return the buffer visiting file FILENAME (a string).
797This is like `get-file-buffer', except that it checks for any buffer
798visiting the same file, possibly under a different name.
799If there is no such live buffer, return nil."
800 (let ((buf (get-file-buffer filename))
801 (truename (abbreviate-file-name (file-truename filename))))
802 (or buf
803 (let ((list (buffer-list)) found)
804 (while (and (not found) list)
805 (save-excursion
806 (set-buffer (car list))
807 (if (and buffer-file-name
808 (string= buffer-file-truename truename))
809 (setq found (car list))))
810 (setq list (cdr list)))
811 found)
0f933cf6 812 (let ((number (nthcdr 10 (file-attributes truename)))
138c44f6 813 (list (buffer-list)) found)
de88363f
RS
814 (and buffer-file-numbers-unique
815 number
181c830f
RS
816 (while (and (not found) list)
817 (save-excursion
818 (set-buffer (car list))
d49ab5a0
RS
819 (if (and buffer-file-name
820 (equal buffer-file-number number)
181c830f
RS
821 ;; Verify this buffer's file number
822 ;; still belongs to its file.
823 (file-exists-p buffer-file-name)
824 (equal (nthcdr 10 (file-attributes buffer-file-name))
825 number))
826 (setq found (car list))))
827 (setq list (cdr list))))
138c44f6 828 found))))
9b8ef27d 829\f
40dfe94d 830(defun find-file-noselect (filename &optional nowarn rawfile)
b4da00e9
RM
831 "Read file FILENAME into a buffer and return the buffer.
832If a buffer exists visiting FILENAME, return that one, but
833verify that the file has not changed since visited or saved.
82d0954a
KH
834The buffer is not selected, just returned to the caller.
835Optional first arg NOWARN non-nil means suppress any warning messages.
e65db7b8 836Optional second arg RAWFILE non-nil means the file is read literally."
e373f201
JB
837 (setq filename
838 (abbreviate-file-name
839 (expand-file-name filename)))
b4da00e9
RM
840 (if (file-directory-p filename)
841 (if find-file-run-dired
4147a3cc
KH
842 (dired-noselect (if find-file-visit-truename
843 (abbreviate-file-name (file-truename filename))
844 filename))
ba369f54 845 (error "%s is a directory" filename))
f3e23606
RS
846 (let* ((buf (get-file-buffer filename))
847 (truename (abbreviate-file-name (file-truename filename)))
848 (number (nthcdr 10 (file-attributes truename)))
849 ;; Find any buffer for a file which has same truename.
138c44f6 850 (other (and (not buf) (find-buffer-visiting filename)))
f3e23606
RS
851 error)
852 ;; Let user know if there is a buffer with the same truename.
138c44f6
KH
853 (if other
854 (progn
327bebe8
RS
855 (or nowarn
856 (string-equal filename (buffer-file-name other))
857 (message "%s and %s are the same file"
858 filename (buffer-file-name other)))
138c44f6
KH
859 ;; Optionally also find that buffer.
860 (if (or find-file-existing-other-name find-file-visit-truename)
861 (setq buf other))))
b4da00e9
RM
862 (if buf
863 (or nowarn
864 (verify-visited-file-modtime buf)
865 (cond ((not (file-exists-p filename))
866 (error "File %s no longer exists!" filename))
ebeb898f
RS
867 ;; Certain files should be reverted automatically
868 ;; if they have changed on disk and not in the buffer.
869 ((and (not (buffer-modified-p buf))
db8c4866 870 (let ((tail revert-without-query)
ebeb898f
RS
871 (found nil))
872 (while tail
873 (if (string-match (car tail) filename)
874 (setq found t))
875 (setq tail (cdr tail)))
876 found))
877 (with-current-buffer buf
878 (message "Reverting file %s..." filename)
879 (revert-buffer t t)
880 (message "Reverting file %s...done" filename)))
b4da00e9 881 ((yes-or-no-p
b7d19f4a
KH
882 (if (string= (file-name-nondirectory filename)
883 (buffer-name buf))
884 (format
885 (if (buffer-modified-p buf)
886 "File %s changed on disk. Discard your edits? "
887 "File %s changed on disk. Reread from disk? ")
888 (file-name-nondirectory filename))
889 (format
890 (if (buffer-modified-p buf)
891 "File %s changed on disk. Discard your edits in %s? "
892 "File %s changed on disk. Reread from disk into %s? ")
893 (file-name-nondirectory filename)
894 (buffer-name buf))))
ebeb898f 895 (with-current-buffer buf
9b8ef27d
RS
896 (revert-buffer t t)))
897 ((not (eq rawfile (not (null find-file-literally))))
898 (if rawfile
899 (message "File is already visited, and not literally")
900 (message "File is already visited, and visited literally")))))
b4da00e9 901 (save-excursion
f3e23606
RS
902;;; The truename stuff makes this obsolete.
903;;; (let* ((link-name (car (file-attributes filename)))
904;;; (linked-buf (and (stringp link-name)
905;;; (get-file-buffer link-name))))
906;;; (if (bufferp linked-buf)
907;;; (message "Symbolic link to file in buffer %s"
908;;; (buffer-name linked-buf))))
b4da00e9 909 (setq buf (create-file-buffer filename))
a2e12c0c 910 (set-buffer-major-mode buf)
b4da00e9
RM
911 (set-buffer buf)
912 (erase-buffer)
40dfe94d
RS
913 (if rawfile
914 (condition-case ()
915 (insert-file-contents-literally filename t)
916 (file-error
7b3d6b9c
RS
917 (when (and (file-exists-p filename)
918 (not (file-readable-p filename)))
944ef994
RS
919 (kill-buffer buf)
920 (signal 'file-error (list "File is not readable"
921 filename)))
40dfe94d
RS
922 ;; Unconditionally set error
923 (setq error t)))
924 (condition-case ()
925 (insert-file-contents filename t)
926 (file-error
7b3d6b9c
RS
927 (when (and (file-exists-p filename)
928 (not (file-readable-p filename)))
944ef994
RS
929 (kill-buffer buf)
930 (signal 'file-error (list "File is not readable"
931 filename)))
40dfe94d
RS
932 ;; Run find-file-not-found-hooks until one returns non-nil.
933 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
934 ;; If they fail too, set error.
935 (setq error t)))))
f3e23606 936 ;; Find the file's truename, and maybe use that as visited name.
138c44f6 937 (setq buffer-file-truename truename)
1770543d
RS
938 (setq buffer-file-number number)
939 ;; On VMS, we may want to remember which directory in a search list
940 ;; the file was found in.
941 (and (eq system-type 'vax-vms)
942 (let (logical)
943 (if (string-match ":" (file-name-directory filename))
944 (setq logical (substring (file-name-directory filename)
945 0 (match-beginning 0))))
946 (not (member logical find-file-not-true-dirname-list)))
947 (setq buffer-file-name buffer-file-truename))
1cc2fbeb 948 (if find-file-visit-truename
27d0420c
RS
949 (setq buffer-file-name
950 (setq filename
951 (expand-file-name buffer-file-truename))))
b4da00e9
RM
952 ;; Set buffer's default directory to that of the file.
953 (setq default-directory (file-name-directory filename))
954 ;; Turn off backup files for certain file names. Since
955 ;; this is a permanent local, the major mode won't eliminate it.
956 (and (not (funcall backup-enable-predicate buffer-file-name))
957 (progn
958 (make-local-variable 'backup-inhibited)
959 (setq backup-inhibited t)))
40dfe94d 960 (if rawfile
9b8ef27d 961 (progn
2fa149b6 962 (set-buffer-multibyte nil)
26dd83e6 963 (setq buffer-file-coding-system 'no-conversion)
9b8ef27d
RS
964 (make-local-variable 'find-file-literally)
965 (setq find-file-literally t))
fa660969
KH
966 (after-find-file error (not nowarn))
967 (setq buf (current-buffer)))))
b4da00e9 968 buf)))
9b8ef27d
RS
969\f
970(defun insert-file-contents-literally (filename &optional visit beg end replace)
971 "Like `insert-file-contents', but only reads in the file literally.
972A buffer may be modified in several ways after reading into the buffer,
973to Emacs features such as format decoding, character code
974conversion, find-file-hooks, automatic uncompression, etc.
975
976This function ensures that none of these modifications will take place."
977 (let ((format-alist nil)
978 (after-insert-file-functions nil)
979 (coding-system-for-read 'no-conversion)
980 (coding-system-for-write 'no-conversion)
981 (jka-compr-compression-info-list nil)
982 (find-buffer-file-type-function
983 (if (fboundp 'find-buffer-file-type)
984 (symbol-function 'find-buffer-file-type)
985 nil)))
986 (unwind-protect
987 (progn
988 (fset 'find-buffer-file-type (lambda (filename) t))
989 (insert-file-contents filename visit beg end replace))
990 (if find-buffer-file-type-function
991 (fset 'find-buffer-file-type find-buffer-file-type-function)
992 (fmakunbound 'find-buffer-file-type)))))
993
994(defun insert-file-literally (filename)
995 "Insert contents of file FILENAME into buffer after point with no conversion.
996
997This function is meant for the user to run interactively.
998Don't call it from programs! Use `insert-file-contents-literally' instead.
999\(Its calling sequence is different; see its documentation)."
1000 (interactive "*fInsert file literally: ")
1001 (if (file-directory-p filename)
1002 (signal 'file-error (list "Opening input file" "file is a directory"
1003 filename)))
1004 (let ((tem (insert-file-contents-literally filename)))
1005 (push-mark (+ (point) (car (cdr tem))))))
1006
1007(defvar find-file-literally nil
1008 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1009This is a permanent local.")
1010(put 'find-file-literally 'permanent-local t)
5fc196af
RS
1011
1012(defun find-file-literally (filename)
1013 "Visit file FILENAME with no conversion of any kind.
1014Format conversion and character code conversion are both disabled,
1015and multibyte characters are disabled in the resulting buffer.
e65db7b8
RS
1016The major mode used is Fundamental mode regardless of the file name,
1017and local variable specifications in the file are ignored.
9b8ef27d
RS
1018Automatic uncompression is also disabled.
1019
1020You cannot absolutely rely on this function to result in
b9aa9537 1021visiting the file literally. If Emacs already has a buffer
9b8ef27d
RS
1022which is visiting the file, you get the existing buffer,
1023regardless of whether it was created literally or not.
1024
1025In a Lisp program, if you want to be sure of accessing a file's
1026contents literally, you should create a temporary buffer and then read
1027the file contents into it using `insert-file-contents-literally'."
5fc196af 1028 (interactive "FFind file literally: ")
9b8ef27d 1029 (switch-to-buffer (find-file-noselect filename nil t)))
b4da00e9 1030\f
f7d786d0
RS
1031(defvar after-find-file-from-revert-buffer nil)
1032
e0ab8879 1033(defun after-find-file (&optional error warn noauto
9a30563f
RS
1034 after-find-file-from-revert-buffer
1035 nomodes)
b4da00e9
RM
1036 "Called after finding a file and by the default revert function.
1037Sets buffer mode, parses local variables.
8cfb9d46 1038Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
b4da00e9
RM
1039error in reading the file. WARN non-nil means warn if there
1040exists an auto-save file more recent than the visited file.
8cfb9d46 1041NOAUTO means don't mess with auto-save mode.
e0ab8879
RS
1042Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1043 means this call was from `revert-buffer'.
9a30563f
RS
1044Fifth arg NOMODES non-nil means don't alter the file's modes.
1045Finishes by calling the functions in `find-file-hooks'
1046unless NOMODES is non-nil."
b4da00e9
RM
1047 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1048 (if noninteractive
1049 nil
1050 (let* (not-serious
1051 (msg
1052 (cond ((and error (file-attributes buffer-file-name))
1053 (setq buffer-read-only t)
ff78d520 1054 "File exists, but cannot be read.")
b4da00e9
RM
1055 ((not buffer-read-only)
1056 (if (and warn
1057 (file-newer-than-file-p (make-auto-save-file-name)
1058 buffer-file-name))
6a6a0b8b
RS
1059 (format "%s has auto save data; consider M-x recover-file"
1060 (file-name-nondirectory buffer-file-name))
b4da00e9
RM
1061 (setq not-serious t)
1062 (if error "(New file)" nil)))
1063 ((not error)
1064 (setq not-serious t)
1065 "Note: file is write protected")
1066 ((file-attributes (directory-file-name default-directory))
1067 "File not found and directory write-protected")
4e43240a
RS
1068 ((file-exists-p (file-name-directory buffer-file-name))
1069 (setq buffer-read-only nil))
b4da00e9 1070 (t
5bbbceb1 1071 (setq buffer-read-only nil)
4e43240a
RS
1072 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1073 "Use M-x make-dir RET RET to create the directory"
1074 "Use C-u M-x make-dir RET RET to create directory and its parents")))))
b4da00e9
RM
1075 (if msg
1076 (progn
1077 (message msg)
1078 (or not-serious (sit-for 1 nil t)))))
8cfb9d46 1079 (if (and auto-save-default (not noauto))
b4da00e9 1080 (auto-save-mode t)))
9a30563f
RS
1081 (if nomodes
1082 nil
1083 (normal-mode t)
2a9fe1e2
RS
1084 (if (and buffer-read-only view-read-only
1085 (not (eq (get major-mode 'mode-class) 'special)))
1086 (view-mode-enter))
9a30563f 1087 (run-hooks 'find-file-hooks)))
b4da00e9
RM
1088
1089(defun normal-mode (&optional find-file)
1090 "Choose the major mode for this buffer automatically.
1091Also sets up any specified local variables of the file.
1092Uses the visited file name, the -*- line, and the local variables spec.
1093
1094This function is called automatically from `find-file'. In that case,
1095we may set up specified local variables depending on the value of
1096`enable-local-variables': if it is t, we do; if it is nil, we don't;
1097otherwise, we query. `enable-local-variables' is ignored if you
1098run `normal-mode' explicitly."
1099 (interactive)
1100 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1101 (condition-case err
1102 (set-auto-mode)
1103 (error (message "File mode specification error: %s"
1104 (prin1-to-string err))))
1105 (condition-case err
7b3f3dc2
JB
1106 (let ((enable-local-variables (or (not find-file)
1107 enable-local-variables)))
1108 (hack-local-variables))
b4da00e9
RM
1109 (error (message "File local-variables error: %s"
1110 (prin1-to-string err)))))
1111
f76e0cd0 1112(defvar auto-mode-alist
567c1ca9 1113 '(("\\.te?xt\\'" . text-mode)
f76e0cd0
RS
1114 ("\\.c\\'" . c-mode)
1115 ("\\.h\\'" . c-mode)
1116 ("\\.tex\\'" . tex-mode)
1117 ("\\.ltx\\'" . latex-mode)
1118 ("\\.el\\'" . emacs-lisp-mode)
1119 ("\\.mm\\'" . nroff-mode)
1120 ("\\.me\\'" . nroff-mode)
1121 ("\\.ms\\'" . nroff-mode)
1122 ("\\.man\\'" . nroff-mode)
1123 ("\\.scm\\'" . scheme-mode)
1124 ("\\.l\\'" . lisp-mode)
1125 ("\\.lisp\\'" . lisp-mode)
1126 ("\\.f\\'" . fortran-mode)
0254679b 1127 ("\\.F\\'" . fortran-mode)
f76e0cd0
RS
1128 ("\\.for\\'" . fortran-mode)
1129 ("\\.p\\'" . pascal-mode)
1130 ("\\.pas\\'" . pascal-mode)
f76e0cd0 1131 ("\\.ad[abs]\\'" . ada-mode)
ebff6b7d 1132 ("\\.\\([pP][Llm]\\|al\\)\\'" . perl-mode)
f89cbd61 1133 ("\\.s?html?\\'" . html-mode)
f76e0cd0
RS
1134 ("\\.cc\\'" . c++-mode)
1135 ("\\.hh\\'" . c++-mode)
bfc6cac9 1136 ("\\.hpp\\'" . c++-mode)
f76e0cd0
RS
1137 ("\\.C\\'" . c++-mode)
1138 ("\\.H\\'" . c++-mode)
1139 ("\\.cpp\\'" . c++-mode)
1140 ("\\.cxx\\'" . c++-mode)
1141 ("\\.hxx\\'" . c++-mode)
1142 ("\\.c\\+\\+\\'" . c++-mode)
1143 ("\\.h\\+\\+\\'" . c++-mode)
1fbd6d0f 1144 ("\\.m\\'" . objc-mode)
95b53225 1145 ("\\.java\\'" . java-mode)
f76e0cd0 1146 ("\\.mk\\'" . makefile-mode)
5da565f8 1147 ("\\(M\\|m\\|GNUm\\)akefile\\(.in\\)?\\'" . makefile-mode)
3ad08c11 1148 ("\\.am\\'" . makefile-mode) ;For Automake.
7b3f3dc2
JB
1149;;; Less common extensions come here
1150;;; so more common ones above are found faster.
f76e0cd0 1151 ("\\.texinfo\\'" . texinfo-mode)
567c1ca9 1152 ("\\.te?xi\\'" . texinfo-mode)
f76e0cd0 1153 ("\\.s\\'" . asm-mode)
600a5f71
KH
1154 ("\\.S\\'" . asm-mode)
1155 ("\\.asm\\'" . asm-mode)
f76e0cd0
RS
1156 ("ChangeLog\\'" . change-log-mode)
1157 ("change.log\\'" . change-log-mode)
1158 ("changelo\\'" . change-log-mode)
1159 ("ChangeLog.[0-9]+\\'" . change-log-mode)
6e6f5d9e
RS
1160 ;; for MSDOS and MS-Windows (which are case-insensitive)
1161 ("changelog\\'" . change-log-mode)
1162 ("changelog.[0-9]+\\'" . change-log-mode)
f76e0cd0
RS
1163 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1164 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
7458cc35 1165 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
d1194c85
RS
1166 ("/\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1167 ("/\\.\\(bash_logout\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1168 ("/\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
c1fe251a
KH
1169;;; The following should come after the ChangeLog pattern
1170;;; for the sake of ChangeLog.1, etc.
1171;;; and after the .scm.[0-9] pattern too.
f76e0cd0
RS
1172 ("\\.[12345678]\\'" . nroff-mode)
1173 ("\\.TeX\\'" . tex-mode)
1174 ("\\.sty\\'" . latex-mode)
1175 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
16cb44dd 1176 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
f76e0cd0
RS
1177 ("\\.bbl\\'" . latex-mode)
1178 ("\\.bib\\'" . bibtex-mode)
6c4fd436
RS
1179 ("\\.m4\\'" . m4-mode)
1180 ("\\.mc\\'" . m4-mode)
16cb44dd
RS
1181 ("\\.mf\\'" . metafont-mode)
1182 ("\\.mp\\'" . metapost-mode)
798f4b0a 1183 ("\\.vhdl?\\'" . vhdl-mode)
f76e0cd0
RS
1184 ("\\.article\\'" . text-mode)
1185 ("\\.letter\\'" . text-mode)
1186 ("\\.tcl\\'" . tcl-mode)
e1ec01c2 1187 ("\\.exp\\'" . tcl-mode)
c87c4cda
KH
1188 ("\\.itcl\\'" . tcl-mode)
1189 ("\\.itk\\'" . tcl-mode)
f89cbd61
RS
1190 ("\\.icn\\'" . icon-mode)
1191 ("\\.sim\\'" . simula-mode)
1192 ("\\.mss\\'" . scribe-mode)
f76e0cd0
RS
1193 ("\\.f90\\'" . f90-mode)
1194 ("\\.lsp\\'" . lisp-mode)
1195 ("\\.awk\\'" . awk-mode)
1196 ("\\.prolog\\'" . prolog-mode)
1197 ("\\.tar\\'" . tar-mode)
b1667e6c
GV
1198 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode)
1199 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode)
f76e0cd0
RS
1200 ;; Mailer puts message to be edited in
1201 ;; /tmp/Re.... or Message
628b6035 1202 ("\\`/tmp/Re" . text-mode)
f76e0cd0
RS
1203 ("/Message[0-9]*\\'" . text-mode)
1204 ("/drafts/[0-9]+\\'" . mh-letter-mode)
e13322a0 1205 ("\\.zone\\'" . zone-mode)
f76e0cd0 1206 ;; some news reader is reported to use this
628b6035 1207 ("\\`/tmp/fol/" . text-mode)
f76e0cd0
RS
1208 ("\\.y\\'" . c-mode)
1209 ("\\.lex\\'" . c-mode)
1210 ("\\.oak\\'" . scheme-mode)
693f800d 1211 ("\\.sgml?\\'" . sgml-mode)
f76e0cd0 1212 ("\\.dtd\\'" . sgml-mode)
c2c84cd7 1213 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
f76e0cd0 1214 ;; .emacs following a directory delimiter
24813e13
RS
1215 ;; in Unix, MSDOG or VMS syntax.
1216 ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode)
f76e0cd0
RS
1217 ;; _emacs following a directory delimiter
1218 ;; in MsDos syntax
1219 ("[:/]_emacs\\'" . emacs-lisp-mode)
1220 ("\\.ml\\'" . lisp-mode))
7b3f3dc2
JB
1221 "\
1222Alist of filename patterns vs corresponding major mode functions.
116987ba
RS
1223Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1224\(NON-NIL stands for anything that is not nil; the value does not matter.)
1225Visiting a file whose name matches REGEXP specifies FUNCTION as the
1226mode function to use. FUNCTION will be called, unless it is nil.
1227
1228If the element has the form (REGEXP FUNCTION NON-NIL), then after
1229calling FUNCTION (if it's not nil), we delete the suffix that matched
1230REGEXP and search the list again for another match.")
7b3f3dc2 1231
e13322a0 1232
d7fa5aa2 1233(defvar interpreter-mode-alist
c907d156 1234 '(("perl" . perl-mode)
e049945b 1235 ("perl5" . perl-mode)
ebff6b7d 1236 ("miniperl" . perl-mode)
c907d156 1237 ("wish" . tcl-mode)
e3998da1 1238 ("wishx" . tcl-mode)
8db739de 1239 ("tcl" . tcl-mode)
e3998da1 1240 ("tclsh" . tcl-mode)
8db739de 1241 ("awk" . awk-mode)
dfeadd84 1242 ("mawk" . awk-mode)
d4f567a1 1243 ("nawk" . awk-mode)
8db739de 1244 ("gawk" . awk-mode)
d1194c85
RS
1245 ("scm" . scheme-mode)
1246 ("ash" . sh-mode)
1247 ("bash" . sh-mode)
1248 ("csh" . sh-mode)
1249 ("dtksh" . sh-mode)
1250 ("es" . sh-mode)
1251 ("itcsh" . sh-mode)
1252 ("jsh" . sh-mode)
1253 ("ksh" . sh-mode)
1254 ("oash" . sh-mode)
1255 ("pdksh" . sh-mode)
1256 ("rc" . sh-mode)
1257 ("sh" . sh-mode)
1258 ("sh5" . sh-mode)
1259 ("tcsh" . sh-mode)
1260 ("wksh" . sh-mode)
1261 ("wsh" . sh-mode)
1262 ("zsh" . sh-mode)
1263 ("tail" . text-mode)
1264 ("more" . text-mode)
1265 ("less" . text-mode)
1266 ("pg" . text-mode))
c907d156
RS
1267 "Alist mapping interpreter names to major modes.
1268This alist applies to files whose first line starts with `#!'.
1269Each element looks like (INTERPRETER . MODE).
1270The car of each element is compared with
1271the name of the interpreter specified in the first line.
1272If it matches, mode MODE is selected.")
1273
d7fa5aa2 1274(defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
45fb3bb8 1275 "List of regexps; if one matches a file name, don't look for `-*-'.")
a0c9f21b 1276
d7fa5aa2 1277(defvar inhibit-first-line-modes-suffixes nil
b20ff6d0
RS
1278 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1279When checking `inhibit-first-line-modes-regexps', we first discard
1280from the end of the file name anything that matches one of these regexps.")
1281
bb157910
RS
1282(defvar user-init-file
1283 "" ; set by command-line
1284 "File name including directory of user's initialization file.")
1285
9de9b6a2 1286(defun set-auto-mode (&optional just-from-file-name)
b4da00e9 1287 "Select major mode appropriate for current buffer.
e3998da1
RS
1288This checks for a -*- mode tag in the buffer's text,
1289compares the filename against the entries in `auto-mode-alist',
1290or checks the interpreter that runs this file against
1291`interpreter-mode-alist'.
1292
1293It does not check for the `mode:' local variable in the
1294Local Variables section of the file; for that, use `hack-local-variables'.
7b3f3dc2 1295
f3e23606 1296If `enable-local-variables' is nil, this function does not check for a
9de9b6a2
RS
1297-*- mode tag.
1298
1299If the optional argument JUST-FROM-FILE-NAME is non-nil,
1300then we do not set anything but the major mode,
1301and we don't even do that unless it would come from the file name."
b4da00e9 1302 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
d0fc03ef 1303 (let (beg end done modes)
b4da00e9
RM
1304 (save-excursion
1305 (goto-char (point-min))
1306 (skip-chars-forward " \t\n")
9fa7bfe5
RS
1307 (and enable-local-variables
1308 ;; Don't look for -*- if this file name matches any
45fb3bb8 1309 ;; of the regexps in inhibit-first-line-modes-regexps.
cae111fa 1310 (let ((temp inhibit-first-line-modes-regexps)
4bc3d240
RS
1311 (name (if buffer-file-name
1312 (file-name-sans-versions buffer-file-name)
1313 (buffer-name))))
38832b4c
KH
1314 (while (let ((sufs inhibit-first-line-modes-suffixes))
1315 (while (and sufs (not (string-match (car sufs) name)))
1316 (setq sufs (cdr sufs)))
1317 sufs)
1318 (setq name (substring name 0 (match-beginning 0))))
9fa7bfe5 1319 (while (and temp
b20ff6d0 1320 (not (string-match (car temp) name)))
9fa7bfe5
RS
1321 (setq temp (cdr temp)))
1322 (not temp))
1323 (search-forward "-*-" (save-excursion
1324 ;; If the file begins with "#!"
1325 ;; (exec interpreter magic), look
1326 ;; for mode frobs in the first two
1327 ;; lines. You cannot necessarily
1328 ;; put them in the first line of
1329 ;; such a file without screwing up
1330 ;; the interpreter invocation.
1331 (end-of-line (and (looking-at "^#!") 2))
1332 (point)) t)
1333 (progn
1334 (skip-chars-forward " \t")
1335 (setq beg (point))
1336 (search-forward "-*-"
1337 (save-excursion (end-of-line) (point))
1338 t))
1339 (progn
1340 (forward-char -3)
1341 (skip-chars-backward " \t")
1342 (setq end (point))
1343 (goto-char beg)
1344 (if (save-excursion (search-forward ":" end t))
1345 ;; Find all specifications for the `mode:' variable
57a0155c 1346 ;; and execute them left to right.
9fa7bfe5 1347 (while (let ((case-fold-search t))
6054fcc6
KH
1348 (or (and (looking-at "mode:")
1349 (goto-char (match-end 0)))
1350 (re-search-forward "[ \t;]mode:" end t)))
9fa7bfe5
RS
1351 (skip-chars-forward " \t")
1352 (setq beg (point))
1353 (if (search-forward ";" end t)
1354 (forward-char -1)
1355 (goto-char end))
1356 (skip-chars-backward " \t")
d0fc03ef
RS
1357 (setq modes (cons (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1358 modes)))
9fa7bfe5 1359 ;; Simple -*-MODE-*- case.
d0fc03ef
RS
1360 (setq modes (cons (intern (concat (downcase (buffer-substring beg end))
1361 "-mode"))
1362 modes))))))
1363 ;; If we found modes to use, invoke them now,
1364 ;; outside the save-excursion.
83c6f446
RS
1365 (when modes
1366 (unless just-from-file-name
1367 (mapcar 'funcall (nreverse modes)))
1368 (setq done t))
d0fc03ef
RS
1369 ;; If we didn't find a mode from a -*- line, try using the file name.
1370 (if (and (not done) buffer-file-name)
1371 (let ((name buffer-file-name)
1372 (keep-going t))
1373 ;; Remove backup-suffixes from file name.
1374 (setq name (file-name-sans-versions name))
1375 (while keep-going
1376 (setq keep-going nil)
1377 (let ((alist auto-mode-alist)
1378 (mode nil))
1379 ;; Find first matching alist entry.
76d5492b 1380 (let ((case-fold-search
d0fc03ef
RS
1381 (memq system-type '(vax-vms windows-nt))))
1382 (while (and (not mode) alist)
1383 (if (string-match (car (car alist)) name)
1384 (if (and (consp (cdr (car alist)))
1385 (nth 2 (car alist)))
1386 (progn
1387 (setq mode (car (cdr (car alist)))
1388 name (substring name 0 (match-beginning 0))
1389 keep-going t))
1390 (setq mode (cdr (car alist))
1391 keep-going nil)))
1392 (setq alist (cdr alist))))
1393 (if mode
3b9ffb77
RS
1394 ;; When JUST-FROM-FILE-NAME is set,
1395 ;; we are working on behalf of set-visited-file-name.
1396 ;; In that case, if the major mode specified is the
1397 ;; same one we already have, don't actually reset it.
1398 ;; We don't want to lose minor modes such as Font Lock.
1399 (unless (and just-from-file-name (eq mode major-mode))
1400 (funcall mode))
d0fc03ef
RS
1401 ;; If we can't deduce a mode from the file name,
1402 ;; look for an interpreter specified in the first line.
1540e4e9
KH
1403 ;; As a special case, allow for things like "#!/bin/env perl",
1404 ;; which finds the interpreter anywhere in $PATH.
d0fc03ef
RS
1405 (let ((interpreter
1406 (save-excursion
1407 (goto-char (point-min))
dfeadd84 1408 (if (looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)")
1540e4e9
KH
1409 (buffer-substring (match-beginning 2)
1410 (match-end 2))
d0fc03ef
RS
1411 "")))
1412 elt)
1413 ;; Map interpreter name to a mode.
1414 (setq elt (assoc (file-name-nondirectory interpreter)
1415 interpreter-mode-alist))
9de9b6a2
RS
1416 (unless just-from-file-name
1417 (if elt
1418 (funcall (cdr elt))))))))))))
b4da00e9 1419
f3e23606
RS
1420(defun hack-local-variables-prop-line ()
1421 ;; Set local variables specified in the -*- line.
3fa0a9aa
KH
1422 ;; Ignore any specification for `mode:' and `coding:';
1423 ;; set-auto-mode should already have handled `mode:',
1424 ;; set-auto-coding should already have handled `coding:'.
f3e23606
RS
1425 (save-excursion
1426 (goto-char (point-min))
13a66180
KH
1427 (let ((result nil)
1428 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
f3e23606
RS
1429 ;; Parse the -*- line into the `result' alist.
1430 (cond ((not (search-forward "-*-" end t))
1431 ;; doesn't have one.
1432 nil)
1433 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
13a66180
KH
1434 ;; Simple form: "-*- MODENAME -*-". Already handled.
1435 nil)
f3e23606
RS
1436 (t
1437 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1438 ;; (last ";" is optional).
1439 (save-excursion
1440 (if (search-forward "-*-" end t)
1441 (setq end (- (point) 3))
1442 (error "-*- not terminated before end of line")))
1443 (while (< (point) end)
1444 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1445 (error "malformed -*- line"))
1446 (goto-char (match-end 0))
1c26a6f3
KH
1447 ;; There used to be a downcase here,
1448 ;; but the manual didn't say so,
1449 ;; and people want to set var names that aren't all lc.
1450 (let ((key (intern (buffer-substring
1451 (match-beginning 1)
1452 (match-end 1))))
f3e23606
RS
1453 (val (save-restriction
1454 (narrow-to-region (point) end)
1455 (read (current-buffer)))))
93a2702d
RS
1456 ;; It is traditional to ignore
1457 ;; case when checking for `mode' in set-auto-mode,
1458 ;; so we must do that here as well.
1459 ;; That is inconsistent, but we're stuck with it.
3fa0a9aa 1460 ;; The same can be said for `coding' in set-auto-coding.
93a2702d 1461 (or (equal (downcase (symbol-name key)) "mode")
3fa0a9aa 1462 (equal (downcase (symbol-name key)) "coding")
13a66180 1463 (setq result (cons (cons key val) result)))
f3e23606
RS
1464 (skip-chars-forward " \t;")))
1465 (setq result (nreverse result))))
76d5492b 1466
f3e23606
RS
1467 (if (and result
1468 (or (eq enable-local-variables t)
1469 (and enable-local-variables
1470 (save-window-excursion
6f931919
RS
1471 (condition-case nil
1472 (switch-to-buffer (current-buffer))
1473 (error
1474 ;; If we fail to switch in the selected window,
1475 ;; it is probably a minibuffer.
1476 ;; So try another window.
1477 (condition-case nil
1478 (switch-to-buffer-other-window (current-buffer))
1479 (error
1480 (switch-to-buffer-other-frame (current-buffer))))))
f3e23606
RS
1481 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1482 (file-name-nondirectory buffer-file-name)))))))
2837b9df
RS
1483 (let ((enable-local-eval enable-local-eval))
1484 (while result
1485 (hack-one-local-variable (car (car result)) (cdr (car result)))
1486 (setq result (cdr result))))))))
f3e23606 1487
1d517019
RS
1488(defvar hack-local-variables-hook nil
1489 "Normal hook run after processing a file's local variables specs.
1490Major modes can use this to examine user-specified local variables
1491in order to initialize other data structure based on them.")
1492
9de9b6a2
RS
1493(defun hack-local-variables (&optional mode-only)
1494 "Parse and put into effect this buffer's local variables spec.
1495If MODE-ONLY is non-nil, all we do is check whether the major mode
1496is specified, returning t if it is specified."
1497 (unless mode-only
1498 (hack-local-variables-prop-line))
b4da00e9 1499 ;; Look for "Local variables:" line in last page.
9de9b6a2
RS
1500 (let (mode-specified)
1501 (save-excursion
1502 (goto-char (point-max))
1503 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1504 (if (let ((case-fold-search t))
1505 (and (search-forward "Local Variables:" nil t)
1506 (or (eq enable-local-variables t)
1507 mode-only
1508 (and enable-local-variables
1509 (save-window-excursion
1510 (switch-to-buffer (current-buffer))
1511 (save-excursion
1512 (beginning-of-line)
1513 (set-window-start (selected-window) (point)))
1514 (y-or-n-p (format "Set local variables as specified at end of %s? "
1515 (if buffer-file-name
1516 (file-name-nondirectory
1517 buffer-file-name)
1518 (concat "buffer "
1519 (buffer-name))))))))))
1520 (let ((continue t)
1521 prefix prefixlen suffix beg
1522 mode-specified
1523 (enable-local-eval enable-local-eval))
1524 ;; The prefix is what comes before "local variables:" in its line.
1525 ;; The suffix is what comes after "local variables:" in its line.
b4da00e9 1526 (skip-chars-forward " \t")
9de9b6a2
RS
1527 (or (eolp)
1528 (setq suffix (buffer-substring (point)
1529 (progn (end-of-line) (point)))))
1530 (goto-char (match-beginning 0))
1531 (or (bolp)
1532 (setq prefix
1533 (buffer-substring (point)
1534 (progn (beginning-of-line) (point)))))
1535
1536 (if prefix (setq prefixlen (length prefix)
1537 prefix (regexp-quote prefix)))
1538 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1539 (while continue
1540 ;; Look at next local variable spec.
1541 (if selective-display (re-search-forward "[\n\C-m]")
1542 (forward-line 1))
1543 ;; Skip the prefix, if any.
1544 (if prefix
1545 (if (looking-at prefix)
1546 (forward-char prefixlen)
1547 (error "Local variables entry is missing the prefix")))
1548 ;; Find the variable name; strip whitespace.
1549 (skip-chars-forward " \t")
1550 (setq beg (point))
1551 (skip-chars-forward "^:\n")
1552 (if (eolp) (error "Missing colon in local variables entry"))
1553 (skip-chars-backward " \t")
1554 (let* ((str (buffer-substring beg (point)))
1555 (var (read str))
1556 val)
1557 ;; Setting variable named "end" means end of list.
1558 (if (string-equal (downcase str) "end")
1559 (setq continue nil)
1560 ;; Otherwise read the variable value.
1561 (skip-chars-forward "^:")
1562 (forward-char 1)
1563 (setq val (read (current-buffer)))
1564 (skip-chars-backward "\n")
1565 (skip-chars-forward " \t")
1566 (or (if suffix (looking-at suffix) (eolp))
1567 (error "Local variables entry is terminated incorrectly"))
1568 (if mode-only
1569 (if (eq var 'mode)
1570 (setq mode-specified t))
1571 ;; Set the variable. "Variables" mode and eval are funny.
1572 (hack-one-local-variable var val))))))))
1573 (unless mode-only
1574 (run-hooks 'hack-local-variables-hook))
1575 mode-specified))
f3e23606 1576
d7fa5aa2 1577(defvar ignored-local-variables
f3e23606
RS
1578 '(enable-local-eval)
1579 "Variables to be ignored in a file's local variable spec.")
1580
be0218a8 1581;; Get confirmation before setting these variables as locals in a file.
05ef1cda 1582(put 'debugger 'risky-local-variable t)
f6fa3ee3 1583(put 'enable-local-eval 'risky-local-variable t)
fce47eea 1584(put 'ignored-local-variables 'risky-local-variable t)
be0218a8
RS
1585(put 'eval 'risky-local-variable t)
1586(put 'file-name-handler-alist 'risky-local-variable t)
1587(put 'minor-mode-map-alist 'risky-local-variable t)
1588(put 'after-load-alist 'risky-local-variable t)
f6fa3ee3
RS
1589(put 'buffer-file-name 'risky-local-variable t)
1590(put 'buffer-auto-save-file-name 'risky-local-variable t)
1591(put 'buffer-file-truename 'risky-local-variable t)
b0ffcc0d
RS
1592(put 'exec-path 'risky-local-variable t)
1593(put 'load-path 'risky-local-variable t)
1594(put 'exec-directory 'risky-local-variable t)
1595(put 'process-environment 'risky-local-variable t)
eba1c87a
RS
1596(put 'dabbrev-case-fold-search 'risky-local-variable t)
1597(put 'dabbrev-case-replace 'risky-local-variable t)
9afa8bf7
RS
1598;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1599(put 'outline-level 'risky-local-variable t)
d98b741d 1600(put 'rmail-output-file-alist 'risky-local-variable t)
f6fa3ee3 1601
6672c42b
RS
1602;; This one is safe because the user gets to check it before it is used.
1603(put 'compile-command 'safe-local-variable t)
1604
d0bd3513
RS
1605(defun hack-one-local-variable-quotep (exp)
1606 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1607
f3e23606
RS
1608;; "Set" one variable in a local variables spec.
1609;; A few variable names are treated specially.
1610(defun hack-one-local-variable (var val)
1611 (cond ((eq var 'mode)
1612 (funcall (intern (concat (downcase (symbol-name val))
1613 "-mode"))))
3fa0a9aa
KH
1614 ((eq var 'coding)
1615 ;; We have already handled coding: tag in set-auto-coding.
1616 nil)
f3e23606
RS
1617 ((memq var ignored-local-variables)
1618 nil)
1619 ;; "Setting" eval means either eval it or do nothing.
7d3221d7 1620 ;; Likewise for setting hook variables.
be0218a8 1621 ((or (get var 'risky-local-variable)
6672c42b 1622 (and
04d807e6 1623 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$"
6672c42b
RS
1624 (symbol-name var))
1625 (not (get var 'safe-local-variable))))
0225ae5e 1626 ;; Permit evalling a put of a harmless property.
d0bd3513
RS
1627 ;; if the args do nothing tricky.
1628 (if (or (and (eq var 'eval)
1629 (consp val)
1630 (eq (car val) 'put)
1631 (hack-one-local-variable-quotep (nth 1 val))
1632 (hack-one-local-variable-quotep (nth 2 val))
1633 ;; Only allow safe values of lisp-indent-hook;
1634 ;; not functions.
1635 (or (numberp (nth 3 val))
dc417415 1636 (equal (nth 3 val) ''defun))
d0bd3513
RS
1637 (memq (nth 1 (nth 2 val))
1638 '(lisp-indent-hook)))
1639 ;; Permit eval if not root and user says ok.
c7e62660 1640 (and (not (zerop (user-uid)))
d0bd3513
RS
1641 (or (eq enable-local-eval t)
1642 (and enable-local-eval
1643 (save-window-excursion
1644 (switch-to-buffer (current-buffer))
1645 (save-excursion
1646 (beginning-of-line)
1647 (set-window-start (selected-window) (point)))
1648 (setq enable-local-eval
1649 (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
1650 (file-name-nondirectory buffer-file-name)))))))))
7d3221d7
RS
1651 (if (eq var 'eval)
1652 (save-excursion (eval val))
1653 (make-local-variable var)
1654 (set var val))
f3e23606
RS
1655 (message "Ignoring `eval:' in file's local variables")))
1656 ;; Ordinary variable, really set it.
1657 (t (make-local-variable var)
1658 (set var val))))
1659
b4da00e9 1660\f
21540597 1661(defcustom change-major-mode-with-file-name t
9de9b6a2
RS
1662 "*Non-nil means \\[write-file] should set the major mode from the file name.
1663However, the mode will not be changed if
1664\(1) a local variables list or the `-*-' line specifies a major mode, or
1665\(2) the current major mode is a \"special\" mode,
8609911b 1666\ not suitable for ordinary files, or
21540597
RS
1667\(3) the new file name does not particularly specify any mode."
1668 :type 'boolean
1669 :group 'editing-basics)
9de9b6a2 1670
f36012a6 1671(defun set-visited-file-name (filename &optional no-query along-with-file)
b4da00e9
RM
1672 "Change name of file visited in current buffer to FILENAME.
1673The next time the buffer is saved it will go in the newly specified file.
1674nil or empty string as argument means make buffer not be visiting any file.
1675Remember to delete the initial contents of the minibuffer
6a6b62f8
RS
1676if you wish to pass an empty string as the argument.
1677
1678The optional second argument NO-QUERY, if non-nil, inhibits asking for
f36012a6
RS
1679confirmation in the case where another buffer is already visiting FILENAME.
1680
1681The optional third argument ALONG-WITH-FILE, if non-nil, means that
1682the old visited file has been renamed to the new name FILENAME."
b4da00e9 1683 (interactive "FSet visited file name: ")
c11a94fe
RS
1684 (if (buffer-base-buffer)
1685 (error "An indirect buffer cannot visit a file"))
a522e5bf
RS
1686 (let (truename)
1687 (if filename
1688 (setq filename
1689 (if (string-equal filename "")
1690 nil
1691 (expand-file-name filename))))
1692 (if filename
1693 (progn
1694 (setq truename (file-truename filename))
1695 (if find-file-visit-truename
a522e5bf 1696 (setq filename truename))))
11e314fa 1697 (let ((buffer (and filename (find-buffer-visiting filename))))
7b89d38e 1698 (and buffer (not (eq buffer (current-buffer)))
6a6b62f8 1699 (not no-query)
7b89d38e
RS
1700 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1701 filename)))
1702 (error "Aborted")))
a522e5bf
RS
1703 (or (equal filename buffer-file-name)
1704 (progn
1705 (and filename (lock-buffer filename))
1706 (unlock-buffer)))
1707 (setq buffer-file-name filename)
1708 (if filename ; make buffer name reflect filename.
1709 (let ((new-name (file-name-nondirectory buffer-file-name)))
1710 (if (string= new-name "")
1711 (error "Empty file name"))
1712 (if (eq system-type 'vax-vms)
1713 (setq new-name (downcase new-name)))
1714 (setq default-directory (file-name-directory buffer-file-name))
1715 (or (string= new-name (buffer-name))
1716 (rename-buffer new-name t))))
1717 (setq buffer-backed-up nil)
f36012a6
RS
1718 (or along-with-file
1719 (clear-visited-file-modtime))
8ccdc29e 1720 ;; Abbreviate the file names of the buffer.
4826e97f 1721 (if truename
8ccdc29e
RS
1722 (progn
1723 (setq buffer-file-truename (abbreviate-file-name truename))
1724 (if find-file-visit-truename
1725 (setq buffer-file-name buffer-file-truename))))
a522e5bf
RS
1726 (setq buffer-file-number
1727 (if filename
2a47b4f5 1728 (nthcdr 10 (file-attributes buffer-file-name))
a522e5bf 1729 nil)))
b4da00e9
RM
1730 ;; write-file-hooks is normally used for things like ftp-find-file
1731 ;; that visit things that are not local files as if they were files.
1732 ;; Changing to visit an ordinary local file instead should flush the hook.
1733 (kill-local-variable 'write-file-hooks)
c9dca4e0 1734 (kill-local-variable 'local-write-file-hooks)
b4da00e9
RM
1735 (kill-local-variable 'revert-buffer-function)
1736 (kill-local-variable 'backup-inhibited)
ee81c959
RS
1737 ;; If buffer was read-only because of version control,
1738 ;; that reason is gone now, so make it writable.
1739 (if vc-mode
1740 (setq buffer-read-only nil))
1741 (kill-local-variable 'vc-mode)
b4da00e9
RM
1742 ;; Turn off backup files for certain file names.
1743 ;; Since this is a permanent local, the major mode won't eliminate it.
4d49551a
KH
1744 (and buffer-file-name
1745 (not (funcall backup-enable-predicate buffer-file-name))
b4da00e9
RM
1746 (progn
1747 (make-local-variable 'backup-inhibited)
1748 (setq backup-inhibited t)))
c77a81cf
RS
1749 (let ((oauto buffer-auto-save-file-name))
1750 ;; If auto-save was not already on, turn it on if appropriate.
1751 (if (not buffer-auto-save-file-name)
1752 (and buffer-file-name auto-save-default
1753 (auto-save-mode t))
1754 ;; If auto save is on, start using a new name.
1755 ;; We deliberately don't rename or delete the old auto save
1756 ;; for the old visited file name. This is because perhaps
1757 ;; the user wants to save the new state and then compare with the
1758 ;; previous state from the auto save file.
1759 (setq buffer-auto-save-file-name
1760 (make-auto-save-file-name)))
1761 ;; Rename the old auto save file if any.
1762 (and oauto buffer-auto-save-file-name
e6f0e76c 1763 (file-exists-p oauto)
c77a81cf 1764 (rename-file oauto buffer-auto-save-file-name t)))
f36012a6
RS
1765 (and buffer-file-name
1766 (not along-with-file)
9de9b6a2
RS
1767 (set-buffer-modified-p t))
1768 ;; Update the major mode, if the file name determines it.
1769 (condition-case nil
1770 ;; Don't change the mode if it is special.
1771 (or (not change-major-mode-with-file-name)
1772 (get major-mode 'mode-class)
1773 ;; Don't change the mode if the local variable list specifies it.
1774 (hack-local-variables t)
1775 (set-auto-mode t))
1776 (error nil)))
b4da00e9 1777
912192d1 1778(defun write-file (filename &optional confirm)
b4da00e9 1779 "Write current buffer into file FILENAME.
41f48cb1
RS
1780Makes buffer visit that file, and marks it not modified.
1781If the buffer is already visiting a file, you can specify
1782a directory name as FILENAME, to write a file of the same
c2fb8488 1783old name in that directory.
7458cc35 1784
c2fb8488 1785If optional second arg CONFIRM is non-nil,
7458cc35 1786ask for confirmation for overwriting an existing file.
912192d1 1787Interactively, confirmation is required unless you supply a prefix argument."
b4da00e9
RM
1788;; (interactive "FWrite file: ")
1789 (interactive
1790 (list (if buffer-file-name
1791 (read-file-name "Write file: "
1792 nil nil nil nil)
1793 (read-file-name "Write file: "
1794 (cdr (assq 'default-directory
1795 (buffer-local-variables)))
04d807e6 1796 nil nil (file-name-nondirectory (buffer-name))))
912192d1 1797 (not current-prefix-arg)))
b4da00e9 1798 (or (null filename) (string-equal filename "")
41f48cb1
RS
1799 (progn
1800 ;; If arg is just a directory,
1801 ;; use same file name, but in that directory.
1802 (if (and (file-directory-p filename) buffer-file-name)
1803 (setq filename (concat (file-name-as-directory filename)
1804 (file-name-nondirectory buffer-file-name))))
c2fb8488
RS
1805 (and confirm
1806 (file-exists-p filename)
1807 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
1808 (error "Canceled")))
5f65549e 1809 (set-visited-file-name filename (not confirm))))
b4da00e9 1810 (set-buffer-modified-p t)
6492b55d
KH
1811 ;; Make buffer writable if file is writable.
1812 (and buffer-file-name
1813 (file-writable-p buffer-file-name)
1814 (setq buffer-read-only nil))
912192d1 1815 (save-buffer))
b4da00e9
RM
1816\f
1817(defun backup-buffer ()
1818 "Make a backup of the disk file visited by the current buffer, if appropriate.
1819This is normally done before saving the buffer the first time.
1820If the value is non-nil, it is the result of `file-modes' on the original
1821file; this means that the caller, after saving the buffer, should change
27ab6944
KH
1822the modes of the new file to agree with the old modes.
1823
1824A backup may be done by renaming or by copying; see documentation of
1825variable `make-backup-files'. If it's done by renaming, then the file is
1826no longer accessible under its old name."
b4da00e9
RM
1827 (if (and make-backup-files (not backup-inhibited)
1828 (not buffer-backed-up)
1829 (file-exists-p buffer-file-name)
1830 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
1831 '(?- ?l)))
1832 (let ((real-file-name buffer-file-name)
1833 backup-info backupname targets setmodes)
1834 ;; If specified name is a symbolic link, chase it to the target.
1835 ;; Thus we make the backups in the directory where the real file is.
5dadeb29 1836 (setq real-file-name (file-chase-links real-file-name))
b4da00e9
RM
1837 (setq backup-info (find-backup-file-name real-file-name)
1838 backupname (car backup-info)
1839 targets (cdr backup-info))
1840;;; (if (file-directory-p buffer-file-name)
1841;;; (error "Cannot save buffer in directory %s" buffer-file-name))
eb650569
RS
1842 (if backup-info
1843 (condition-case ()
1844 (let ((delete-old-versions
1845 ;; If have old versions to maybe delete,
1846 ;; ask the user to confirm now, before doing anything.
1847 ;; But don't actually delete til later.
1848 (and targets
1849 (or (eq delete-old-versions t) (eq delete-old-versions nil))
1850 (or delete-old-versions
1851 (y-or-n-p (format "Delete excess backup versions of %s? "
1852 real-file-name))))))
1853 ;; Actually write the back up file.
1854 (condition-case ()
1855 (if (or file-precious-flag
1856 ; (file-symlink-p buffer-file-name)
1857 backup-by-copying
1858 (and backup-by-copying-when-linked
1859 (> (file-nlinks real-file-name) 1))
1860 (and backup-by-copying-when-mismatch
1861 (let ((attr (file-attributes real-file-name)))
1862 (or (nth 9 attr)
1863 (not (file-ownership-preserved-p real-file-name))))))
1864 (condition-case ()
1865 (copy-file real-file-name backupname t t)
1866 (file-error
1867 ;; If copying fails because file BACKUPNAME
1868 ;; is not writable, delete that file and try again.
1869 (if (and (file-exists-p backupname)
1870 (not (file-writable-p backupname)))
1871 (delete-file backupname))
1872 (copy-file real-file-name backupname t t)))
1873 ;; rename-file should delete old backup.
1874 (rename-file real-file-name backupname t)
1875 (setq setmodes (file-modes backupname)))
1876 (file-error
1877 ;; If trouble writing the backup, write it in ~.
567c1ca9
RS
1878 (setq backupname (expand-file-name
1879 (convert-standard-filename
1880 "~/%backup%~")))
1881 (message "Cannot write backup file; backing up in %s"
1882 (file-name-nondirectory backupname))
eb650569
RS
1883 (sleep-for 1)
1884 (condition-case ()
1885 (copy-file real-file-name backupname t t)
1886 (file-error
1887 ;; If copying fails because file BACKUPNAME
1888 ;; is not writable, delete that file and try again.
1889 (if (and (file-exists-p backupname)
1890 (not (file-writable-p backupname)))
1891 (delete-file backupname))
1892 (copy-file real-file-name backupname t t)))))
1893 (setq buffer-backed-up t)
1894 ;; Now delete the old versions, if desired.
1895 (if delete-old-versions
1896 (while targets
1897 (condition-case ()
1898 (delete-file (car targets))
1899 (file-error nil))
1900 (setq targets (cdr targets))))
1901 setmodes)
1902 (file-error nil))))))
b4da00e9 1903
c3554e95 1904(defun file-name-sans-versions (name &optional keep-backup-version)
b4da00e9
RM
1905 "Return FILENAME sans backup versions or strings.
1906This is a separate procedure so your site-init or startup file can
c3554e95
RS
1907redefine it.
1908If the optional argument KEEP-BACKUP-VERSION is non-nil,
1909we do not remove backup version numbers, only true file version numbers."
6eaebaa2 1910 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
c3554e95
RS
1911 (if handler
1912 (funcall handler 'file-name-sans-versions name keep-backup-version)
1913 (substring name 0
1914 (if (eq system-type 'vax-vms)
1915 ;; VMS version number is (a) semicolon, optional
1916 ;; sign, zero or more digits or (b) period, option
1917 ;; sign, zero or more digits, provided this is the
1918 ;; second period encountered outside of the
1919 ;; device/directory part of the file name.
26add1bf
KH
1920 (or (string-match ";[-+]?[0-9]*\\'" name)
1921 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
c3554e95
RS
1922 name)
1923 (match-beginning 1))
1924 (length name))
1925 (if keep-backup-version
1926 (length name)
dbb12f2c 1927 (or (string-match "\\.~[0-9.]+~\\'" name)
c3554e95
RS
1928 (string-match "~\\'" name)
1929 (length name))))))))
b4da00e9 1930
cb0cd911
RS
1931(defun file-ownership-preserved-p (file)
1932 "Returns t if deleting FILE and rewriting it would preserve the owner."
1933 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
1934 (if handler
1935 (funcall handler 'file-ownership-preserved-p file)
ec5533be 1936 (let ((attributes (file-attributes file)))
306faa42
RS
1937 ;; Return t if the file doesn't exist, since it's true that no
1938 ;; information would be lost by an (attempted) delete and create.
1939 (or (null attributes)
1940 (= (nth 2 attributes) (user-uid)))))))
cb0cd911 1941
20b5d24c
RS
1942(defun file-name-sans-extension (filename)
1943 "Return FILENAME sans final \"extension\".
1944The extension, in a file name, is the part that follows the last `.'."
1945 (save-match-data
1946 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
1947 directory)
1948 (if (string-match "\\.[^.]*\\'" file)
1949 (if (setq directory (file-name-directory filename))
1950 (expand-file-name (substring file 0 (match-beginning 0))
1951 directory)
1952 (substring file 0 (match-beginning 0)))
1953 filename))))
1954
93a2702d
RS
1955(defun file-name-extension (filename &optional period)
1956 "Return FILENAME's final \"extension\".
1957The extension, in a file name, is the part that follows the last `.'.
1958Return nil for extensionless file names such as `foo'.
1959Return the empty string for file names such as `foo.'.
1960
1961If PERIOD is non-nil, then the returned value includes the period
1962that delimits the extension, and if FILENAME has no extension,
1963the value is \"\"."
1964 (save-match-data
1965 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
1966 (if (string-match "\\.[^.]*\\'" file)
1967 (substring file (+ (match-beginning 0) (if period 0 1)))
1968 (if period
1969 "")))))
1970
b4da00e9
RM
1971(defun make-backup-file-name (file)
1972 "Create the non-numeric backup file name for FILE.
1973This is a separate function so you can redefine it for customization."
28ee503c
KH
1974 (if (and (eq system-type 'ms-dos)
1975 (not (msdos-long-file-names)))
bb157910
RS
1976 (let ((fn (file-name-nondirectory file)))
1977 (concat (file-name-directory file)
066327ae
KH
1978 (or
1979 (and (string-match "\\`[^.]+\\'" fn)
1980 (concat (match-string 0 fn) ".~"))
1981 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
1982 (concat (match-string 0 fn) "~")))))
bb157910 1983 (concat file "~")))
b4da00e9
RM
1984
1985(defun backup-file-name-p (file)
1986 "Return non-nil if FILE is a backup file name (numeric or not).
1987This is a separate function so you can redefine it for customization.
1988You may need to redefine `file-name-sans-versions' as well."
066327ae 1989 (string-match "~\\'" file))
b4da00e9 1990
e2b30772
RS
1991(defvar backup-extract-version-start)
1992
2d051399
RS
1993;; This is used in various files.
1994;; The usage of bv-length is not very clean,
1995;; but I can't see a good alternative,
1996;; so as of now I am leaving it alone.
1997(defun backup-extract-version (fn)
1998 "Given the name of a numeric backup file, return the backup number.
e2b30772 1999Uses the free variable `backup-extract-version-start', whose value should be
2d051399 2000the index in the name where the version number begins."
e2b30772
RS
2001 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2002 (= (match-beginning 0) backup-extract-version-start))
2003 (string-to-int (substring fn backup-extract-version-start -1))
2d051399
RS
2004 0))
2005
b4da00e9
RM
2006;; I believe there is no need to alter this behavior for VMS;
2007;; since backup files are not made on VMS, it should not get called.
2008(defun find-backup-file-name (fn)
2009 "Find a file name for a backup file, and suggestions for deletions.
2010Value is a list whose car is the name for the backup file
eb650569
RS
2011 and whose cdr is a list of old versions to consider deleting now.
2012If the value is nil, don't make a backup."
2013 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2014 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2015 (if handler
2016 (funcall handler 'find-backup-file-name fn)
2017 (if (eq version-control 'never)
b4da00e9 2018 (list (make-backup-file-name fn))
eb650569 2019 (let* ((base-versions (concat (file-name-nondirectory fn) ".~"))
e2b30772 2020 (backup-extract-version-start (length base-versions))
eb650569
RS
2021 possibilities
2022 (versions nil)
2023 (high-water-mark 0)
2024 (deserve-versions-p nil)
2025 (number-to-delete 0))
2026 (condition-case ()
2027 (setq possibilities (file-name-all-completions
2028 base-versions
2029 (file-name-directory fn))
2030 versions (sort (mapcar
2031 (function backup-extract-version)
2032 possibilities)
2033 '<)
2034 high-water-mark (apply 'max 0 versions)
2035 deserve-versions-p (or version-control
2036 (> high-water-mark 0))
2037 number-to-delete (- (length versions)
2038 kept-old-versions kept-new-versions -1))
2039 (file-error
2040 (setq possibilities nil)))
2041 (if (not deserve-versions-p)
2042 (list (make-backup-file-name fn))
2043 (cons (concat fn ".~" (int-to-string (1+ high-water-mark)) "~")
2044 (if (and (> number-to-delete 0)
2045 ;; Delete nothing if there is overflow
2046 ;; in the number of versions to keep.
2047 (>= (+ kept-new-versions kept-old-versions -1) 0))
2048 (mapcar (function (lambda (n)
2049 (concat fn ".~" (int-to-string n) "~")))
2050 (let ((v (nthcdr kept-old-versions versions)))
2051 (rplacd (nthcdr (1- number-to-delete) v) ())
2052 v))))))))))
b4da00e9 2053
b4da00e9
RM
2054(defun file-nlinks (filename)
2055 "Return number of names file FILENAME has."
2056 (car (cdr (file-attributes filename))))
6c636af9
RM
2057
2058(defun file-relative-name (filename &optional directory)
2d6562a5
RS
2059 "Convert FILENAME to be relative to DIRECTORY (default: default-directory).
2060This function returns a relative file name which is equivalent to FILENAME
2061when used with that default directory as the default.
2062If this is impossible (which can happen on MSDOS and Windows
2063when the file name and directory use different drive names)
2064then it returns FILENAME."
96c188b0 2065 (save-match-data
e2b30772
RS
2066 (let ((fname (expand-file-name filename)))
2067 (setq directory (file-name-as-directory
2068 (expand-file-name (or directory default-directory))))
2069 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2070 ;; drive names, they can't be relative, so return the absolute name.
2071 (if (and (or (eq system-type 'ms-dos)
2072 (eq system-type 'windows-nt))
2073 (not (string-equal (substring fname 0 2)
2074 (substring directory 0 2))))
2075 filename
9695aac6
RS
2076 (let ((ancestor ".")
2077 (fname-dir (file-name-as-directory fname)))
2078 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2079 (not (string-match (concat "^" (regexp-quote directory)) fname)))
e2b30772 2080 (setq directory (file-name-directory (substring directory 0 -1))
9695aac6
RS
2081 ancestor (if (equal ancestor ".")
2082 ".."
2083 (concat "../" ancestor))))
2084 ;; Now ancestor is empty, or .., or ../.., etc.
2085 (if (string-match (concat "^" (regexp-quote directory)) fname)
2086 ;; We matched within FNAME's directory part.
2087 ;; Add the rest of FNAME onto ANCESTOR.
2088 (let ((rest (substring fname (match-end 0))))
2089 (if (and (equal ancestor ".")
2090 (not (equal rest "")))
2091 ;; But don't bother with ANCESTOR if it would give us `./'.
2092 rest
2093 (concat (file-name-as-directory ancestor) rest)))
2094 ;; We matched FNAME's directory equivalent.
2095 ancestor))))))
b4da00e9
RM
2096\f
2097(defun save-buffer (&optional args)
2098 "Save current buffer in visited file if modified. Versions described below.
2099By default, makes the previous version into a backup file
2100 if previously requested or if this is the first save.
ac9650be 2101With 1 \\[universal-argument], marks this version
b4da00e9 2102 to become a backup when the next save is done.
ac9650be 2103With 2 \\[universal-argument]'s,
b4da00e9 2104 unconditionally makes the previous version into a backup file.
ac9650be
RS
2105With 3 \\[universal-argument]'s, marks this version
2106 to become a backup when the next save is done,
2107 and unconditionally makes the previous version into a backup file.
2108
b4da00e9
RM
2109With argument of 0, never makes the previous version into a backup file.
2110
2111If a file's name is FOO, the names of its numbered backup versions are
2112 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2113Numeric backups (rather than FOO~) will be made if value of
2114 `version-control' is not the atom `never' and either there are already
2115 numeric versions of the file being backed up, or `version-control' is
2116 non-nil.
2117We don't want excessive versions piling up, so there are variables
2118 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2119 and `kept-new-versions', which tells how many newest versions to keep.
2120 Defaults are 2 old versions and 2 new.
2121`dired-kept-versions' controls dired's clean-directory (.) command.
de7d5e1b 2122If `delete-old-versions' is nil, system will query user
b4da00e9
RM
2123 before trimming versions. Otherwise it does it silently."
2124 (interactive "p")
2125 (let ((modp (buffer-modified-p))
2126 (large (> (buffer-size) 50000))
b5a8e0fc
RS
2127 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2128 (memq args '(16 64)))))
b4da00e9
RM
2129 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2130 (if (and modp large) (message "Saving file %s..." (buffer-file-name)))
2131 (basic-save-buffer)
2132 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2133
2134(defun delete-auto-save-file-if-necessary (&optional force)
2135 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2136Normally delete only if the file was written by this Emacs since
2137the last real save, but optional arg FORCE non-nil means delete anyway."
2138 (and buffer-auto-save-file-name delete-auto-save-files
2139 (not (string= buffer-file-name buffer-auto-save-file-name))
2140 (or force (recent-auto-save-p))
2141 (progn
2142 (condition-case ()
2143 (delete-file buffer-auto-save-file-name)
2144 (file-error nil))
2145 (set-buffer-auto-saved))))
2146
1cc852cc
RS
2147(defvar after-save-hook nil
2148 "Normal hook that is run after a buffer is saved to its file.")
2149
0516edee
RS
2150(defvar save-buffer-coding-system nil
2151 "If non-nil, use this coding system for saving the buffer.
2152More precisely, use this coding system in place of the
2153value of `buffer-file-coding-system', when saving the buffer.
2154Calling `write-region' for any purpose other than saving the buffer
2155will still use `buffer-file-coding-system'; this variable has no effect
2156in such cases.")
2157
b4da00e9 2158(defun basic-save-buffer ()
1cc852cc
RS
2159 "Save the current buffer in its visited file, if it has been modified.
2160After saving the buffer, run `after-save-hook'."
b4da00e9 2161 (interactive)
19618231 2162 (save-current-buffer
c11a94fe
RS
2163 ;; In an indirect buffer, save its base buffer instead.
2164 (if (buffer-base-buffer)
2165 (set-buffer (buffer-base-buffer)))
2166 (if (buffer-modified-p)
2167 (let ((recent-save (recent-auto-save-p))
2168 setmodes tempsetmodes)
2169 ;; On VMS, rename file and buffer to get rid of version number.
2170 (if (and (eq system-type 'vax-vms)
2171 (not (string= buffer-file-name
2172 (file-name-sans-versions buffer-file-name))))
2173 (let (buffer-new-name)
2174 ;; Strip VMS version number before save.
2175 (setq buffer-file-name
2176 (file-name-sans-versions buffer-file-name))
2177 ;; Construct a (unique) buffer name to correspond.
2178 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2179 (setq buffer-new-name (buffer-name buf))
2180 (kill-buffer buf))
2181 (rename-buffer buffer-new-name)))
2182 ;; If buffer has no file name, ask user for one.
2183 (or buffer-file-name
182891ef
RS
2184 (let ((filename
2185 (expand-file-name
2186 (read-file-name "File to save in: ") nil)))
2187 (and (file-exists-p filename)
2188 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2189 filename))
2190 (error "Canceled")))
2191 (set-visited-file-name filename)))
c11a94fe
RS
2192 (or (verify-visited-file-modtime (current-buffer))
2193 (not (file-exists-p buffer-file-name))
2194 (yes-or-no-p
2195 (format "%s has changed since visited or saved. Save anyway? "
2196 (file-name-nondirectory buffer-file-name)))
2197 (error "Save not confirmed"))
2198 (save-restriction
2199 (widen)
19618231
RS
2200 (save-excursion
2201 (and (> (point-max) 1)
2202 (/= (char-after (1- (point-max))) ?\n)
2203 (not (and (eq selective-display t)
2204 (= (char-after (1- (point-max))) ?\r)))
2205 (or (eq require-final-newline t)
2206 (and require-final-newline
2207 (y-or-n-p
2208 (format "Buffer %s does not end in newline. Add one? "
2209 (buffer-name)))))
2210 (save-excursion
2211 (goto-char (point-max))
2212 (insert ?\n))))
c11a94fe
RS
2213 (or (run-hook-with-args-until-success 'write-contents-hooks)
2214 (run-hook-with-args-until-success 'local-write-file-hooks)
2215 (run-hook-with-args-until-success 'write-file-hooks)
2216 ;; If a hook returned t, file is already "written".
2217 ;; Otherwise, write it the usual way now.
2218 (setq setmodes (basic-save-buffer-1)))
d6e8ea6f
KH
2219 ;; Now we have saved the current buffer. Let's make sure
2220 ;; that buffer-file-coding-system is fixed to what
2221 ;; actually used for saving by binding it locally.
0516edee
RS
2222 (if save-buffer-coding-system
2223 (setq save-buffer-coding-system last-coding-system-used)
2224 (setq buffer-file-coding-system last-coding-system-used))
2a47b4f5
RS
2225 (setq buffer-file-number
2226 (nthcdr 10 (file-attributes buffer-file-name)))
c11a94fe
RS
2227 (if setmodes
2228 (condition-case ()
2229 (set-file-modes buffer-file-name setmodes)
2230 (error nil))))
2231 ;; If the auto-save file was recent before this command,
2232 ;; delete it now.
2233 (delete-auto-save-file-if-necessary recent-save)
49530862
RS
2234 ;; Support VC `implicit' locking.
2235 (vc-after-save)
c11a94fe
RS
2236 (run-hooks 'after-save-hook))
2237 (message "(No changes need to be saved)"))))
b4da00e9 2238
87d26afc
RS
2239;; This does the "real job" of writing a buffer into its visited file
2240;; and making a backup file. This is what is normally done
2241;; but inhibited if one of write-file-hooks returns non-nil.
2242;; It returns a value to store in setmodes.
2243(defun basic-save-buffer-1 ()
0516edee
RS
2244 (let ((buffer-file-coding-system
2245 (or save-buffer-coding-system
2246 buffer-file-coding-system))
2247 tempsetmodes setmodes)
87d26afc
RS
2248 (if (not (file-writable-p buffer-file-name))
2249 (let ((dir (file-name-directory buffer-file-name)))
2250 (if (not (file-directory-p dir))
83c6f446
RS
2251 (if (file-exists-p dir)
2252 (error "%s is not a directory" dir)
cb2fdcfa 2253 (error "%s: no such directory" buffer-file-name))
87d26afc
RS
2254 (if (not (file-exists-p buffer-file-name))
2255 (error "Directory %s write-protected" dir)
2256 (if (yes-or-no-p
2257 (format "File %s is write-protected; try to save anyway? "
2258 (file-name-nondirectory
2259 buffer-file-name)))
2260 (setq tempsetmodes t)
2261 (error "Attempt to save to a file which you aren't allowed to write"))))))
2262 (or buffer-backed-up
2263 (setq setmodes (backup-buffer)))
76d5492b 2264 (let ((dir (file-name-directory buffer-file-name)))
f4a0f59b
RS
2265 (if (and file-precious-flag
2266 (file-writable-p dir))
2267 ;; If file is precious, write temp name, then rename it.
2268 ;; This requires write access to the containing dir,
2269 ;; which is why we don't try it if we don't have that access.
2270 (let ((realname buffer-file-name)
6782610c
RS
2271 tempname temp nogood i succeed
2272 (old-modtime (visited-file-modtime)))
f4a0f59b
RS
2273 (setq i 0)
2274 (setq nogood t)
2275 ;; Find the temporary name to write under.
2276 (while nogood
567c1ca9 2277 (setq tempname (format
28ee503c
KH
2278 (if (and (eq system-type 'ms-dos)
2279 (not (msdos-long-file-names)))
567c1ca9
RS
2280 "%s#%d.tm#" ; MSDOS limits files to 8+3
2281 "%s#tmp#%d")
2282 dir i))
f4a0f59b
RS
2283 (setq nogood (file-exists-p tempname))
2284 (setq i (1+ i)))
2285 (unwind-protect
2286 (progn (clear-visited-file-modtime)
2287 (write-region (point-min) (point-max)
89095962
RS
2288 tempname nil realname
2289 buffer-file-truename)
f4a0f59b
RS
2290 (setq succeed t))
2291 ;; If writing the temp file fails,
2292 ;; delete the temp file.
76d5492b 2293 (or succeed
6782610c
RS
2294 (progn
2295 (delete-file tempname)
2296 (set-visited-file-modtime old-modtime))))
f4a0f59b
RS
2297 ;; Since we have created an entirely new file
2298 ;; and renamed it, make sure it gets the
2299 ;; right permission bits set.
2300 (setq setmodes (file-modes buffer-file-name))
2301 ;; We succeeded in writing the temp file,
2302 ;; so rename it.
2303 (rename-file tempname buffer-file-name t))
2304 ;; If file not writable, see if we can make it writable
2305 ;; temporarily while we write it.
2306 ;; But no need to do so if we have just backed it up
2307 ;; (setmodes is set) because that says we're superseding.
2308 (cond ((and tempsetmodes (not setmodes))
2309 ;; Change the mode back, after writing.
2310 (setq setmodes (file-modes buffer-file-name))
2311 (set-file-modes buffer-file-name 511)))
2312 (write-region (point-min) (point-max)
89095962 2313 buffer-file-name nil t buffer-file-truename)))
87d26afc
RS
2314 setmodes))
2315
b4da00e9
RM
2316(defun save-some-buffers (&optional arg exiting)
2317 "Save some modified file-visiting buffers. Asks user about each one.
5bbbceb1
JB
2318Optional argument (the prefix) non-nil means save all with no questions.
2319Optional second argument EXITING means ask about certain non-file buffers
2320 as well as about file buffers."
b4da00e9 2321 (interactive "P")
907482b9 2322 (save-window-excursion
76d5492b
RM
2323 (let* ((queried nil)
2324 (files-done
2325 (map-y-or-n-p
2326 (function
2327 (lambda (buffer)
2328 (and (buffer-modified-p buffer)
2329 (not (buffer-base-buffer buffer))
2330 (or
2331 (buffer-file-name buffer)
2332 (and exiting
2333 (progn
2334 (set-buffer buffer)
2335 (and buffer-offer-save (> (buffer-size) 0)))))
2336 (if arg
2337 t
2338 (setq queried t)
2339 (if (buffer-file-name buffer)
2340 (format "Save file %s? "
2341 (buffer-file-name buffer))
2342 (format "Save buffer %s? "
2343 (buffer-name buffer)))))))
2344 (function
2345 (lambda (buffer)
2346 (set-buffer buffer)
2347 (save-buffer)))
2348 (buffer-list)
2349 '("buffer" "buffers" "save")
2350 (list (list ?\C-r (lambda (buf)
2a9fe1e2
RS
2351 (view-buffer buf
2352 (function
2353 (lambda (ignore)
2354 (exit-recursive-edit))))
76d5492b
RM
2355 (recursive-edit)
2356 ;; Return nil to ask about BUF again.
2357 nil)
2358 "display the current buffer"))))
2359 (abbrevs-done
2360 (and save-abbrevs abbrevs-changed
2361 (progn
2362 (if (or arg
2363 (y-or-n-p (format "Save abbrevs in %s? "
2364 abbrev-file-name)))
2365 (write-abbrev-file nil))
2366 ;; Don't keep bothering user if he says no.
2367 (setq abbrevs-changed nil)
2368 t))))
2369 (or queried (> files-done 0) abbrevs-done
5625c2fc 2370 (message "(No files need saving)")))))
b4da00e9
RM
2371\f
2372(defun not-modified (&optional arg)
2373 "Mark current buffer as unmodified, not needing to be saved.
a641f9a1
RM
2374With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2375
2376It is not a good idea to use this function in Lisp programs, because it
2377prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
b4da00e9
RM
2378 (interactive "P")
2379 (message (if arg "Modification-flag set"
2380 "Modification-flag cleared"))
2381 (set-buffer-modified-p arg))
2382
2383(defun toggle-read-only (&optional arg)
2384 "Change whether this buffer is visiting its file read-only.
2a9fe1e2
RS
2385With arg, set read-only iff arg is positive.
2386If visiting file read-only and `view-read-only' is non-nil, enter view mode."
b4da00e9 2387 (interactive "P")
2a9fe1e2
RS
2388 (cond
2389 ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only
2390 (not buffer-read-only))) ; If buffer-read-only is set correctly,
2391 nil) ; do nothing.
2392 ;; Toggle.
2393 ((and buffer-read-only view-mode)
2394 (View-exit-and-edit)) ; Must leave view mode.
2395 ((and (not buffer-read-only) view-read-only
2396 (not (eq (get major-mode 'mode-class) 'special)))
2397 (view-mode-enter))
2398 (t (setq buffer-read-only (not buffer-read-only))
2399 (force-mode-line-update))))
b4da00e9 2400
912192d1 2401(defun insert-file (filename)
b4da00e9
RM
2402 "Insert contents of file FILENAME into buffer after point.
2403Set mark after the inserted text.
2404
2405This function is meant for the user to run interactively.
2406Don't call it from programs! Use `insert-file-contents' instead.
2407\(Its calling sequence is different; see its documentation)."
912192d1 2408 (interactive "*fInsert file: ")
3be6243a
RS
2409 (if (file-directory-p filename)
2410 (signal 'file-error (list "Opening input file" "file is a directory"
2411 filename)))
912192d1 2412 (let ((tem (insert-file-contents filename)))
b4da00e9
RM
2413 (push-mark (+ (point) (car (cdr tem))))))
2414
912192d1 2415(defun append-to-file (start end filename)
b4da00e9
RM
2416 "Append the contents of the region to the end of file FILENAME.
2417When called from a function, expects three arguments,
2418START, END and FILENAME. START and END are buffer positions
da30bf98 2419saying what text to write."
912192d1
KH
2420 (interactive "r\nFAppend to file: ")
2421 (write-region start end filename t))
b4da00e9
RM
2422
2423(defun file-newest-backup (filename)
2424 "Return most recent backup file for FILENAME or nil if no backups exist."
2425 (let* ((filename (expand-file-name filename))
2426 (file (file-name-nondirectory filename))
2427 (dir (file-name-directory filename))
2428 (comp (file-name-all-completions file dir))
cf7e94a0
RS
2429 (newest nil)
2430 tem)
b4da00e9 2431 (while comp
cf7e94a0 2432 (setq tem (car comp)
b4da00e9 2433 comp (cdr comp))
cf7e94a0
RS
2434 (cond ((and (backup-file-name-p tem)
2435 (string= (file-name-sans-versions tem) file))
2436 (setq tem (concat dir tem))
2437 (if (or (null newest)
2438 (file-newer-than-file-p tem newest))
2439 (setq newest tem)))))
b4da00e9
RM
2440 newest))
2441
2442(defun rename-uniquely ()
2443 "Rename current buffer to a similar name not already taken.
2444This function is useful for creating multiple shell process buffers
2445or multiple mail buffers, etc."
2446 (interactive)
40eb8038 2447 (save-match-data
e0df3aef
KH
2448 (let ((base-name (buffer-name)))
2449 (and (string-match "<[0-9]+>\\'" base-name)
2450 (not (and buffer-file-name
2451 (string= base-name
2452 (file-name-nondirectory buffer-file-name))))
2453 ;; If the existing buffer name has a <NNN>,
2454 ;; which isn't part of the file name (if any),
2455 ;; then get rid of that.
2456 (setq base-name (substring base-name 0 (match-beginning 0))))
2457 (rename-buffer (generate-new-buffer-name base-name))
3941fe2c 2458 (force-mode-line-update))))
5bbbceb1 2459
4e43240a 2460(defun make-directory (dir &optional parents)
5ce8bb89
RS
2461 "Create the directory DIR and any nonexistent parent dirs.
2462Interactively, the default choice of directory to create
2463is the current default directory for file names.
0225ae5e 2464That is useful when you have visited a file in a nonexistent directory.
5ce8bb89
RS
2465
2466Noninteractively, the second (optional) argument PARENTS says whether
2467to create parent directories if they don't exist."
2468 (interactive
2469 (list (read-file-name "Make directory: " default-directory default-directory
2470 nil nil)
2471 t))
6eaebaa2 2472 (let ((handler (find-file-name-handler dir 'make-directory)))
4e43240a
RS
2473 (if handler
2474 (funcall handler 'make-directory dir parents)
2475 (if (not parents)
2476 (make-directory-internal dir)
2477 (let ((dir (directory-file-name (expand-file-name dir)))
2478 create-list)
2479 (while (not (file-exists-p dir))
76d5492b 2480 (setq create-list (cons dir create-list)
4e43240a
RS
2481 dir (directory-file-name (file-name-directory dir))))
2482 (while create-list
2483 (make-directory-internal (car create-list))
2484 (setq create-list (cdr create-list))))))))
b4da00e9
RM
2485\f
2486(put 'revert-buffer-function 'permanent-local t)
2487(defvar revert-buffer-function nil
0973d78b
RS
2488 "Function to use to revert this buffer, or nil to do the default.
2489The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2490which are the arguments that `revert-buffer' received.")
b4da00e9
RM
2491
2492(put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2493(defvar revert-buffer-insert-file-contents-function nil
2494 "Function to use to insert contents when reverting this buffer.
2495Gets two args, first the nominal file name to use,
2496and second, t if reading the auto-save file.")
2497
5f76e7d4
KH
2498(defvar before-revert-hook nil
2499 "Normal hook for `revert-buffer' to run before reverting.
2500If `revert-buffer-function' is used to override the normal revert
2501mechanism, this hook is not used.")
2502
2503(defvar after-revert-hook nil
2504 "Normal hook for `revert-buffer' to run after reverting.
2505Note that the hook value that it runs is the value that was in effect
2506before reverting; that makes a difference if you have buffer-local
2507hook functions.
2508
2509If `revert-buffer-function' is used to override the normal revert
2510mechanism, this hook is not used.")
2511
9a30563f 2512(defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
7e7c9c4e 2513 "Replace current buffer text with the text of the visited file on disk.
b4da00e9 2514This undoes all changes since the file was visited or saved.
8c0e7b73
JB
2515With a prefix argument, offer to revert from latest auto-save file, if
2516that is more recent than the visited file.
1ab31687 2517
7e7c9c4e
RS
2518This command also works for special buffers that contain text which
2519doesn't come from a file, but reflects some other data base instead:
2520for example, Dired buffers and buffer-list buffers. In these cases,
2521it reconstructs the buffer contents from the appropriate data base.
2522
65ee6096 2523When called from Lisp, the first argument is IGNORE-AUTO; only offer
1ab31687
JB
2524to revert from the auto-save file when this is nil. Note that the
2525sense of this argument is the reverse of the prefix argument, for the
2526sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2527to nil.
2528
2529Optional second argument NOCONFIRM means don't ask for confirmation at
2530all.
b4da00e9 2531
5b2b26d5
RS
2532Optional third argument PRESERVE-MODES non-nil means don't alter
2533the files modes. Normally we reinitialize them using `normal-mode'.
2534
8c0e7b73 2535If the value of `revert-buffer-function' is non-nil, it is called to
7e7c9c4e
RS
2536do all the work for this command. Otherwise, the hooks
2537`before-revert-hook' and `after-revert-hook' are run at the beginning
2538and the end, and if `revert-buffer-insert-file-contents-function' is
2539non-nil, it is called instead of rereading visited file contents."
fb6208a6 2540
1ab31687
JB
2541 ;; I admit it's odd to reverse the sense of the prefix argument, but
2542 ;; there is a lot of code out there which assumes that the first
2543 ;; argument should be t to avoid consulting the auto-save file, and
2544 ;; there's no straightforward way to encourage authors to notice a
2545 ;; reversal of the argument sense. So I'm just changing the user
2546 ;; interface, but leaving the programmatic interface the same.
e0867e99 2547 (interactive (list (not current-prefix-arg)))
b4da00e9 2548 (if revert-buffer-function
1ab31687 2549 (funcall revert-buffer-function ignore-auto noconfirm)
b4da00e9 2550 (let* ((opoint (point))
1ab31687
JB
2551 (auto-save-p (and (not ignore-auto)
2552 (recent-auto-save-p)
b4da00e9
RM
2553 buffer-auto-save-file-name
2554 (file-readable-p buffer-auto-save-file-name)
2555 (y-or-n-p
2556 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
2557 (file-name (if auto-save-p
2558 buffer-auto-save-file-name
2559 buffer-file-name)))
2560 (cond ((null file-name)
2561 (error "Buffer does not seem to be associated with any file"))
2562 ((or noconfirm
db8c4866
RS
2563 (and (not (buffer-modified-p))
2564 (let ((tail revert-without-query)
2565 (found nil))
2566 (while tail
2567 (if (string-match (car tail) file-name)
2568 (setq found t))
2569 (setq tail (cdr tail)))
2570 found))
b4da00e9
RM
2571 (yes-or-no-p (format "Revert buffer from file %s? "
2572 file-name)))
4fbf62ee 2573 (run-hooks 'before-revert-hook)
b4da00e9
RM
2574 ;; If file was backed up but has changed since,
2575 ;; we shd make another backup.
2576 (and (not auto-save-p)
5bbbceb1 2577 (not (verify-visited-file-modtime (current-buffer)))
b4da00e9
RM
2578 (setq buffer-backed-up nil))
2579 ;; Get rid of all undo records for this buffer.
2580 (or (eq buffer-undo-list t)
2581 (setq buffer-undo-list nil))
ba5c8c93
KH
2582 ;; Effectively copy the after-revert-hook status,
2583 ;; since after-find-file will clobber it.
2584 (let ((global-hook (default-value 'after-revert-hook))
2585 (local-hook-p (local-variable-p 'after-revert-hook))
2586 (local-hook (and (local-variable-p 'after-revert-hook)
2587 after-revert-hook)))
2588 (let (buffer-read-only
2589 ;; Don't make undo records for the reversion.
2590 (buffer-undo-list t))
2591 (if revert-buffer-insert-file-contents-function
2592 (funcall revert-buffer-insert-file-contents-function
2593 file-name auto-save-p)
2594 (if (not (file-exists-p file-name))
2595 (error "File %s no longer exists!" file-name))
2596 ;; Bind buffer-file-name to nil
2597 ;; so that we don't try to lock the file.
2598 (let ((buffer-file-name nil))
2599 (or auto-save-p
2600 (unlock-buffer)))
2601 (widen)
b77d8211
KH
2602 (let ((coding-system-for-read
2603 ;; Auto-saved file shoule be read without
2604 ;; any code conversion.
2605 (if auto-save-p 'no-conversion
2606 coding-system-for-read)))
2607 (insert-file-contents file-name (not auto-save-p)
2608 nil nil t))))
ba5c8c93
KH
2609 (goto-char (min opoint (point-max)))
2610 ;; Recompute the truename in case changes in symlinks
2611 ;; have changed the truename.
2612 (setq buffer-file-truename
2613 (abbreviate-file-name (file-truename buffer-file-name)))
9a30563f 2614 (after-find-file nil nil t t preserve-modes)
ba5c8c93
KH
2615 ;; Run after-revert-hook as it was before we reverted.
2616 (setq-default revert-buffer-internal-hook global-hook)
2617 (if local-hook-p
2618 (progn
2619 (make-local-variable 'revert-buffer-internal-hook)
2620 (setq revert-buffer-internal-hook local-hook))
2621 (kill-local-variable 'revert-buffer-internal-hook))
2622 (run-hooks 'revert-buffer-internal-hook))
4fbf62ee 2623 t)))))
b4da00e9
RM
2624
2625(defun recover-file (file)
2626 "Visit file FILE, but get contents from its last auto-save file."
10f7c7fc
RS
2627 ;; Actually putting the file name in the minibuffer should be used
2628 ;; only rarely.
2629 ;; Not just because users often use the default.
e1dadc17 2630 (interactive "FRecover file: ")
b4da00e9 2631 (setq file (expand-file-name file))
f7da6740
RS
2632 (if (auto-save-file-name-p (file-name-nondirectory file))
2633 (error "%s is an auto-save file" file))
b4da00e9
RM
2634 (let ((file-name (let ((buffer-file-name file))
2635 (make-auto-save-file-name))))
945e1965
RS
2636 (cond ((if (file-exists-p file)
2637 (not (file-newer-than-file-p file-name file))
2638 (not (file-exists-p file-name)))
b4da00e9
RM
2639 (error "Auto-save file %s not current" file-name))
2640 ((save-window-excursion
b1667e6c 2641 (if (not (memq system-type '(vax-vms windows-nt)))
b4da00e9
RM
2642 (with-output-to-temp-buffer "*Directory*"
2643 (buffer-disable-undo standard-output)
2644 (call-process "ls" nil standard-output nil
2dc2b736
RS
2645 (if (file-symlink-p file) "-lL" "-l")
2646 file file-name)))
b4da00e9
RM
2647 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
2648 (switch-to-buffer (find-file-noselect file t))
82d0954a
KH
2649 (let ((buffer-read-only nil)
2650 ;; Auto-saved file shoule be read without any code conversion.
2651 (coding-system-for-read 'no-conversion))
b4da00e9
RM
2652 (erase-buffer)
2653 (insert-file-contents file-name nil))
8cfb9d46 2654 (after-find-file nil nil t))
ffa7ab70 2655 (t (error "Recover-file cancelled")))))
b4da00e9 2656
6598027d 2657(defun recover-session ()
9aee5392
RS
2658 "Recover auto save files from a previous Emacs session.
2659This command first displays a Dired buffer showing you the
2660previous sessions that you could recover from.
2661To choose one, move point to the proper line and then type C-c C-c.
2662Then you'll be asked about a number of files to recover."
2663 (interactive)
363a5030
RS
2664 (if (null auto-save-list-file-prefix)
2665 (error "You set `auto-save-list-file-prefix' to disable making session files"))
6f4983e6 2666 (let ((ls-lisp-support-shell-wildcards t))
7b3478a5
RS
2667 (dired (concat auto-save-list-file-prefix "*")
2668 (concat dired-listing-switches "t")))
9aee5392
RS
2669 (goto-char (point-min))
2670 (or (looking-at "Move to the session you want to recover,")
2671 (let ((inhibit-read-only t))
033ef863
RS
2672 (insert "Move to the session you want to recover,\n"
2673 "then type C-c C-c to select it.\n\n"
2674 "You can also delete some of these files;\n"
2675 "type d on a line to mark that file for deletion.\n\n")))
9aee5392 2676 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
80280bb7 2677 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
9aee5392 2678
80280bb7 2679(defun recover-session-finish ()
9aee5392
RS
2680 "Choose one saved session to recover auto-save files from.
2681This command is used in the special Dired buffer created by
80280bb7 2682\\[recover-session]."
9aee5392
RS
2683 (interactive)
2684 ;; Get the name of the session file to recover from.
2685 (let ((file (dired-get-filename))
953a03b2 2686 files
9aee5392 2687 (buffer (get-buffer-create " *recover*")))
033ef863 2688 (dired-do-flagged-delete t)
9aee5392
RS
2689 (unwind-protect
2690 (save-excursion
2691 ;; Read in the auto-save-list file.
2692 (set-buffer buffer)
2693 (erase-buffer)
2694 (insert-file-contents file)
953a03b2
RS
2695 ;; Loop thru the text of that file
2696 ;; and get out the names of the files to recover.
2697 (while (not (eobp))
2698 (let (thisfile autofile)
2699 (if (eolp)
2700 ;; This is a pair of lines for a non-file-visiting buffer.
2701 ;; Get the auto-save file name and manufacture
2702 ;; a "visited file name" from that.
2703 (progn
2704 (forward-line 1)
2705 (setq autofile
2706 (buffer-substring-no-properties
2707 (point)
2708 (save-excursion
2709 (end-of-line)
2710 (point))))
2711 (setq thisfile
2712 (expand-file-name
2713 (substring
2714 (file-name-nondirectory autofile)
2715 1 -1)
2716 (file-name-directory autofile)))
2717 (forward-line 1))
2718 ;; This pair of lines is a file-visiting
2719 ;; buffer. Use the visited file name.
2720 (progn
2721 (setq thisfile
2722 (buffer-substring-no-properties
2723 (point) (progn (end-of-line) (point))))
2724 (forward-line 1)
2725 (setq autofile
2726 (buffer-substring-no-properties
2727 (point) (progn (end-of-line) (point))))
2728 (forward-line 1)))
2729 ;; Ignore a file if its auto-save file does not exist now.
2730 (if (file-exists-p autofile)
2731 (setq files (cons thisfile files)))))
2732 (setq files (nreverse files))
945e1965
RS
2733 ;; The file contains a pair of line for each auto-saved buffer.
2734 ;; The first line of the pair contains the visited file name
2735 ;; or is empty if the buffer was not visiting a file.
2736 ;; The second line is the auto-save file name.
953a03b2
RS
2737 (if files
2738 (map-y-or-n-p "Recover %s? "
2739 (lambda (file)
2740 (condition-case nil
2741 (save-excursion (recover-file file))
76d5492b 2742 (error
953a03b2
RS
2743 "Failed to recover `%s'" file)))
2744 files
2745 '("file" "files" "recover"))
2746 (message "No files can be recovered from this session now")))
9aee5392
RS
2747 (kill-buffer buffer))))
2748
73ba610a
RS
2749(defun kill-some-buffers (&optional list)
2750 "For each buffer in LIST, ask whether to kill it.
2751LIST defaults to all existing live buffers."
b4da00e9 2752 (interactive)
73ba610a
RS
2753 (if (null list)
2754 (setq list (buffer-list)))
2755 (while list
2756 (let* ((buffer (car list))
2757 (name (buffer-name buffer)))
2758 (and (not (string-equal name ""))
2759 (/= (aref name 0) ? )
2760 (yes-or-no-p
2761 (format "Buffer %s %s. Kill? "
2762 name
2763 (if (buffer-modified-p buffer)
2764 "HAS BEEN EDITED" "is unmodified")))
2765 (kill-buffer buffer)))
2766 (setq list (cdr list))))
b4da00e9
RM
2767\f
2768(defun auto-save-mode (arg)
2769 "Toggle auto-saving of contents of current buffer.
f3e23606 2770With prefix argument ARG, turn auto-saving on if positive, else off."
b4da00e9
RM
2771 (interactive "P")
2772 (setq buffer-auto-save-file-name
2773 (and (if (null arg)
74b9c2af
RS
2774 (or (not buffer-auto-save-file-name)
2775 ;; If autosave is off because buffer has shrunk,
2776 ;; then toggling should turn it on.
2777 (< buffer-saved-size 0))
b4da00e9
RM
2778 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
2779 (if (and buffer-file-name auto-save-visited-file-name
2780 (not buffer-read-only))
2781 buffer-file-name
2782 (make-auto-save-file-name))))
0b7f1ef2
RS
2783 ;; If -1 was stored here, to temporarily turn off saving,
2784 ;; turn it back on.
2785 (and (< buffer-saved-size 0)
2786 (setq buffer-saved-size 0))
b4da00e9
RM
2787 (if (interactive-p)
2788 (message "Auto-save %s (in this buffer)"
2789 (if buffer-auto-save-file-name "on" "off")))
2790 buffer-auto-save-file-name)
2791
2792(defun rename-auto-save-file ()
2793 "Adjust current buffer's auto save file name for current conditions.
2794Also rename any existing auto save file, if it was made in this session."
2795 (let ((osave buffer-auto-save-file-name))
2796 (setq buffer-auto-save-file-name
2797 (make-auto-save-file-name))
2798 (if (and osave buffer-auto-save-file-name
2799 (not (string= buffer-auto-save-file-name buffer-file-name))
2800 (not (string= buffer-auto-save-file-name osave))
2801 (file-exists-p osave)
2802 (recent-auto-save-p))
2803 (rename-file osave buffer-auto-save-file-name t))))
2804
2805(defun make-auto-save-file-name ()
2806 "Return file name to use for auto-saves of current buffer.
2807Does not consider `auto-save-visited-file-name' as that variable is checked
2808before calling this function. You can redefine this for customization.
2809See also `auto-save-file-name-p'."
2810 (if buffer-file-name
28ee503c
KH
2811 (if (and (eq system-type 'ms-dos)
2812 (not (msdos-long-file-names)))
4503dacb 2813 (let ((fn (file-name-nondirectory buffer-file-name)))
5b4dd2e2 2814 (string-match "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" fn)
4503dacb
RS
2815 (concat (file-name-directory buffer-file-name)
2816 "#" (match-string 1 fn)
2817 "." (match-string 3 fn) "#"))
2818 (concat (file-name-directory buffer-file-name)
2819 "#"
2820 (file-name-nondirectory buffer-file-name)
2821 "#"))
0a1763b4
RS
2822
2823 ;; Deal with buffers that don't have any associated files. (Mail
2824 ;; mode tends to create a good number of these.)
2825
7d483e8c 2826 (let ((buffer-name (buffer-name))
0a1763b4 2827 (limit 0))
c3348e10
RS
2828 ;; Eliminate all slashes and backslashes by
2829 ;; replacing them with sequences that start with %.
2830 ;; Quote % also, to keep distinct names distinct.
2831 (while (string-match "[/\\%]" buffer-name limit)
2832 (let* ((character (aref buffer-name (match-beginning 0)))
2833 (replacement
2834 (cond ((eq character ?%) "%%")
2835 ((eq character ?/) "%+")
2836 ((eq character ?\\) "%-"))))
2837 (setq buffer-name (replace-match replacement t t buffer-name))
2838 (setq limit (1+ (match-end 0)))))
a8abaf83
RS
2839 ;; Generate the file name.
2840 (expand-file-name
2841 (format "#%s#%s#" buffer-name (make-temp-name ""))
2842 ;; Try a few alternative directories, to get one we can write it.
2843 (cond
2844 ((file-writable-p default-directory) default-directory)
2845 ((file-writable-p "/var/tmp/") "/var/tmp/")
2846 ("~/"))))))
b4da00e9
RM
2847
2848(defun auto-save-file-name-p (filename)
2849 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
2850FILENAME should lack slashes. You can redefine this for customization."
2851 (string-match "^#.*#$" filename))
2852\f
6f4983e6
RS
2853(defun wildcard-to-regexp (wildcard)
2854 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
2855The generated regexp will match a filename iff the filename
2856matches that wildcard according to shell rules. Only wildcards known
2857by `sh' are supported."
2858 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
2859 ;; Copy the initial run of non-special characters.
2860 (result (substring wildcard 0 i))
2861 (len (length wildcard)))
2862 ;; If no special characters, we're almost done.
2863 (if i
2864 (while (< i len)
2865 (let ((ch (aref wildcard i))
2866 j)
2867 (setq
2868 result
2869 (concat result
2870 (cond
7e7c9c4e
RS
2871 ((and (eq ch ?\[)
2872 (< (1+ i) len)
2873 (eq (aref wildcard (1+ i)) ?\]))
2874 "\\[")
6f4983e6
RS
2875 ((eq ch ?\[) ; [...] maps to regexp char class
2876 (progn
2877 (setq i (1+ i))
2878 (concat
2879 (cond
2880 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
2881 (progn
2882 (setq i (1+ i))
2883 (if (eq (aref wildcard i) ?\])
2884 (progn
2885 (setq i (1+ i))
2886 "[^]")
2887 "[^")))
2888 ((eq (aref wildcard i) ?^)
2889 ;; Found "[^". Insert a `\0' character
2890 ;; (which cannot happen in a filename)
2891 ;; into the character class, so that `^'
2892 ;; is not the first character after `[',
2893 ;; and thus non-special in a regexp.
2894 (progn
2895 (setq i (1+ i))
2896 "[\000^"))
2897 ((eq (aref wildcard i) ?\])
2898 ;; I don't think `]' can appear in a
2899 ;; character class in a wildcard, but
2900 ;; let's be general here.
2901 (progn
2902 (setq i (1+ i))
2903 "[]"))
2904 (t "["))
2905 (prog1 ; copy everything upto next `]'.
2906 (substring wildcard
2907 i
2908 (setq j (string-match
2909 "]" wildcard i)))
2910 (setq i (if j (1- j) (1- len)))))))
2911 ((eq ch ?.) "\\.")
2912 ((eq ch ?*) "[^\000]*")
2913 ((eq ch ?+) "\\+")
2914 ((eq ch ?^) "\\^")
2915 ((eq ch ?$) "\\$")
2916 ((eq ch ?\\) "\\\\") ; probably cannot happen...
2917 ((eq ch ??) "[^\000]")
2918 (t (char-to-string ch)))))
2919 (setq i (1+ i)))))
2920 ;; Shell wildcards should match the entire filename,
2921 ;; not its part. Make the regexp say so.
2922 (concat "\\`" result "\\'")))
2923\f
21540597 2924(defcustom list-directory-brief-switches
b4da00e9 2925 (if (eq system-type 'vax-vms) "" "-CF")
21540597
RS
2926 "*Switches for list-directory to pass to `ls' for brief listing,"
2927 :type 'string
2928 :group 'dired)
b4da00e9 2929
21540597 2930(defcustom list-directory-verbose-switches
b4da00e9
RM
2931 (if (eq system-type 'vax-vms)
2932 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
2933 "-l")
21540597
RS
2934 "*Switches for list-directory to pass to `ls' for verbose listing,"
2935 :type 'string
2936 :group 'dired)
b4da00e9
RM
2937
2938(defun list-directory (dirname &optional verbose)
2939 "Display a list of files in or matching DIRNAME, a la `ls'.
2940DIRNAME is globbed by the shell if necessary.
2941Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
2942Actions controlled by variables `list-directory-brief-switches'
2943and `list-directory-verbose-switches'."
2944 (interactive (let ((pfx current-prefix-arg))
2945 (list (read-file-name (if pfx "List directory (verbose): "
2946 "List directory (brief): ")
2947 nil default-directory nil)
2948 pfx)))
2949 (let ((switches (if verbose list-directory-verbose-switches
2950 list-directory-brief-switches)))
2951 (or dirname (setq dirname default-directory))
2952 (setq dirname (expand-file-name dirname))
2953 (with-output-to-temp-buffer "*Directory*"
2954 (buffer-disable-undo standard-output)
2955 (princ "Directory ")
2956 (princ dirname)
2957 (terpri)
c3554e95
RS
2958 (save-excursion
2959 (set-buffer "*Directory*")
5a8a160e
RS
2960 (setq default-directory
2961 (if (file-directory-p dirname)
2962 (file-name-as-directory dirname)
2963 (file-name-directory dirname)))
c3554e95
RS
2964 (let ((wildcard (not (file-directory-p dirname))))
2965 (insert-directory dirname switches wildcard (not wildcard)))))))
2966
2967(defvar insert-directory-program "ls"
2968 "Absolute or relative name of the `ls' program used by `insert-directory'.")
2969
2970;; insert-directory
2971;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
2972;; FULL-DIRECTORY-P is nil.
2973;; The single line of output must display FILE's name as it was
2974;; given, namely, an absolute path name.
2975;; - must insert exactly one line for each file if WILDCARD or
2976;; FULL-DIRECTORY-P is t, plus one optional "total" line
2977;; before the file lines, plus optional text after the file lines.
2978;; Lines are delimited by "\n", so filenames containing "\n" are not
2979;; allowed.
2980;; File lines should display the basename.
2981;; - must be consistent with
2982;; - functions dired-move-to-filename, (these two define what a file line is)
2983;; dired-move-to-end-of-filename,
2984;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
2985;; dired-insert-headerline
2986;; dired-after-subdir-garbage (defines what a "total" line is)
2987;; - variable dired-subdir-regexp
2988(defun insert-directory (file switches &optional wildcard full-directory-p)
a18b7c81 2989 "Insert directory listing for FILE, formatted according to SWITCHES.
c3554e95 2990Leaves point after the inserted text.
727d277d 2991SWITCHES may be a string of options, or a list of strings.
c3554e95
RS
2992Optional third arg WILDCARD means treat FILE as shell wildcard.
2993Optional fourth arg FULL-DIRECTORY-P means file is a directory and
2994switches do not contain `d', so that a full listing is expected.
2995
2996This works by running a directory listing program
406e12d9 2997whose name is in the variable `insert-directory-program'.
c3554e95 2998If WILDCARD, it also runs the shell specified by `shell-file-name'."
c870ab8e
RS
2999 ;; We need the directory in order to find the right handler.
3000 (let ((handler (find-file-name-handler (expand-file-name file)
3001 'insert-directory)))
c3554e95
RS
3002 (if handler
3003 (funcall handler 'insert-directory file switches
3004 wildcard full-directory-p)
b4da00e9 3005 (if (eq system-type 'vax-vms)
c3554e95 3006 (vms-read-directory file switches (current-buffer))
73ba53dc
KH
3007 (let* ((coding-system-for-read
3008 (and enable-multibyte-characters
3009 (or file-name-coding-system
3010 default-file-name-coding-system)))
a9173359
KH
3011 ;; This binding is for encoding arguements by call-process.
3012 (coding-system-for-write coding-system-for-read)
73ba53dc
KH
3013 (result
3014 (if wildcard
3015 ;; Run ls in the directory of the file pattern we asked for.
3016 (let ((default-directory
3017 (if (file-name-absolute-p file)
3018 (file-name-directory file)
3019 (file-name-directory (expand-file-name file))))
3020 (pattern (file-name-nondirectory file))
3021 (beg 0))
3022 ;; Quote some characters that have special meanings in shells;
3023 ;; but don't quote the wildcards--we want them to be special.
3024 ;; We also currently don't quote the quoting characters
3025 ;; in case people want to use them explicitly to quote
3026 ;; wildcard characters.
3027 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3028 (setq pattern
3029 (concat (substring pattern 0 (match-beginning 0))
3030 "\\"
3031 (substring pattern (match-beginning 0)))
3032 beg (1+ (match-end 0))))
3033 (call-process shell-file-name nil t nil
3034 "-c" (concat "\\";; Disregard shell aliases!
3035 insert-directory-program
3036 " -d "
3037 (if (stringp switches)
3038 switches
3039 (mapconcat 'identity switches " "))
3040 " -- "
a9173359 3041 pattern)))
73ba53dc
KH
3042 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3043 ;; directory if FILE is a symbolic link.
3044 (apply 'call-process
3045 insert-directory-program nil t nil
3046 (let (list)
3047 (if (listp switches)
3048 (setq list switches)
3049 (if (not (equal switches ""))
3050 (progn
3051 ;; Split the switches at any spaces
3052 ;; so we can pass separate options as separate args.
3053 (while (string-match " " switches)
3054 (setq list (cons (substring switches 0 (match-beginning 0))
3055 list)
3056 switches (substring switches (match-end 0))))
3057 (setq list (nreverse (cons switches list))))))
3058 (append list
3059 ;; Avoid lossage if FILE starts with `-'.
3060 '("--")
3061 (list
a9173359
KH
3062 (if full-directory-p
3063 (concat (file-name-as-directory file) ".")
3064 file))))))))
73ba53dc
KH
3065 (if (/= result 0)
3066 ;; We get here if ls failed.
3067 ;; Access the file to get a suitable error.
3068 (access-file file "Reading directory")))))))
b4da00e9 3069
88902b35 3070(defvar kill-emacs-query-functions nil
65d5c6de 3071 "Functions to call with no arguments to query about killing Emacs.
78c793d1
RS
3072If any of these functions returns nil, killing Emacs is cancelled.
3073`save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3074but `kill-emacs', the low level primitive, does not.
3075See also `kill-emacs-hook'.")
88902b35 3076
b4da00e9
RM
3077(defun save-buffers-kill-emacs (&optional arg)
3078 "Offer to save each buffer, then kill this Emacs process.
3079With prefix arg, silently save all file-visiting buffers, then kill."
3080 (interactive "P")
3081 (save-some-buffers arg t)
3082 (and (or (not (memq t (mapcar (function
3083 (lambda (buf) (and (buffer-file-name buf)
3084 (buffer-modified-p buf))))
3085 (buffer-list))))
3086 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3087 (or (not (fboundp 'process-list))
3088 ;; process-list is not defined on VMS.
3089 (let ((processes (process-list))
3090 active)
3091 (while processes
528415e7 3092 (and (memq (process-status (car processes)) '(run stop open))
b4da00e9
RM
3093 (let ((val (process-kill-without-query (car processes))))
3094 (process-kill-without-query (car processes) val)
3095 val)
3096 (setq active t))
3097 (setq processes (cdr processes)))
3098 (or (not active)
3099 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
88902b35 3100 ;; Query the user for other things, perhaps.
fb15c113 3101 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
b4da00e9
RM
3102 (kill-emacs)))
3103\f
47afc068
RS
3104;; We use /: as a prefix to "quote" a file name
3105;; so that magic file name handlers will not apply to it.
3106
3107(setq file-name-handler-alist
3108 (cons '("\\`/:" . file-name-non-special)
3109 file-name-handler-alist))
3110
3111;; We depend on being the last handler on the list,
3112;; so that anything else which does need handling
3113;; has been handled already.
3114;; So it is safe for us to inhibit *all* magic file name handlers.
3115
3116(defun file-name-non-special (operation &rest arguments)
3117 (let ((file-name-handler-alist nil)
5cb1f728
KH
3118 (default-directory
3119 (if (eq operation 'insert-directory)
3120 (directory-file-name
3121 (expand-file-name
3122 (unhandled-file-name-directory default-directory)))
3123 default-directory))
47afc068
RS
3124 ;; Get a list of the indices of the args which are file names.
3125 (file-arg-indices
3126 (cdr (or (assq operation
3127 ;; The first four are special because they
3128 ;; return a file name. We want to include the /:
3129 ;; in the return value.
3130 ;; So just avoid stripping it in the first place.
3131 '((expand-file-name . nil)
18b9dced
RS
3132 ;; `identity' means just return the first arg
3133 ;; as stripped of its quoting.
3134 (substitute-in-file-name . identity)
47afc068
RS
3135 (file-name-directory . nil)
3136 (file-name-as-directory . nil)
3137 (directory-file-name . nil)
feaec97d
RS
3138 (file-name-completion 0 1)
3139 (file-name-all-completions 0 1)
47afc068
RS
3140 (rename-file 0 1)
3141 (copy-file 0 1)
3142 (make-symbolic-link 0 1)
3143 (add-name-to-file 0 1)))
3144 ;; For all other operations, treat the first argument only
3145 ;; as the file name.
3146 '(nil 0))))
3147 ;; Copy ARGUMENTS so we can replace elements in it.
3148 (arguments (copy-sequence arguments)))
3149 ;; Strip off the /: from the file names that have this handler.
3150 (save-match-data
18b9dced 3151 (while (consp file-arg-indices)
fe4d9852
KH
3152 (let ((pair (nthcdr (car file-arg-indices) arguments)))
3153 (and (car pair)
3154 (string-match "\\`/:" (car pair))
3155 (setcar pair
3156 (if (= (length (car pair)) 2)
3157 "/"
3158 (substring (car pair) 2)))))
47afc068 3159 (setq file-arg-indices (cdr file-arg-indices))))
18b9dced
RS
3160 (if (eq file-arg-indices 'identity)
3161 (car arguments)
3162 (apply operation arguments))))
47afc068 3163\f
b4da00e9 3164(define-key ctl-x-map "\C-f" 'find-file)
b4da00e9
RM
3165(define-key ctl-x-map "\C-r" 'find-file-read-only)
3166(define-key ctl-x-map "\C-v" 'find-alternate-file)
3167(define-key ctl-x-map "\C-s" 'save-buffer)
3168(define-key ctl-x-map "s" 'save-some-buffers)
3169(define-key ctl-x-map "\C-w" 'write-file)
3170(define-key ctl-x-map "i" 'insert-file)
3171(define-key esc-map "~" 'not-modified)
3172(define-key ctl-x-map "\C-d" 'list-directory)
3173(define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
3174
3175(define-key ctl-x-4-map "f" 'find-file-other-window)
3176(define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
3177(define-key ctl-x-4-map "\C-f" 'find-file-other-window)
3178(define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
924f0a24 3179(define-key ctl-x-4-map "\C-o" 'display-buffer)
5bbbceb1 3180
f98955ea
JB
3181(define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
3182(define-key ctl-x-5-map "f" 'find-file-other-frame)
3183(define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
3184(define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
c0274f38
ER
3185
3186;;; files.el ends here